org.apache.solr.common.params

类 ModifiableSolrParams

java.lang.Object

org.apache.solr.common.params.SolrParams

org.apache.solr.common.params.ModifiableSolrParams

所有已实现的接口:

Serializable, Iterable<Map.Entry<String,String[]>>, MapSerializable, MapWriter, NavigableObject

直接已知子类:

SolrQuery

public class ModifiableSolrParams
extends SolrParams

This class is similar to MultiMapSolrParams except you can edit the parameters after it is initialized. It has helper functions to set/add integer and boolean param values.

从以下版本开始:

solr 1.3

另请参阅:

序列化表格

嵌套类概要

从接口继承的嵌套类/接口 org.apache.solr.common.MapWriter

MapWriter.EntryWriter

构造器概要

构造器

构造器和说明
ModifiableSolrParams()
ModifiableSolrParams(Map<String,String[]> v) Constructs a new ModifiableSolrParams directly using the provided Map<String,String[]>
ModifiableSolrParams(SolrParams params) Constructs a new ModifiableSolrParams, copying values from an existing SolrParams

方法概要

限定符和类型	方法和说明
void	add(SolrParams params) Add all of the params provided in the parameter to this params.
ModifiableSolrParams	add(String name, String... val) Add the given values to any existing name
void	clear() clear all parameters
String	get(String param) Returns the first String value of a param, or null if not set.
Map<String,String[]>	getMap()
Set<String>	getParameterNames()
Iterator<String>	getParameterNamesIterator() Returns an Iterator over the parameter names.
String[]	getParams(String param) returns an array of the String values of a param, or null if no mapping for the param exists.
Iterator<Map.Entry<String,String[]>>	iterator() Returns an Iterator of Map.Entry providing a multi-map view.
static ModifiableSolrParams	of(SolrParams params) If the input params are of type MofifiableSolrParams, returns the input, otherwise, constructs a new ModifiableSolrParams, copying values from the given params.
String[]	remove(String name) remove a field at the given name
boolean	remove(String name, String value) remove the given value for the given name
ModifiableSolrParams	set(String name, boolean val)
ModifiableSolrParams	set(String name, int val)
ModifiableSolrParams	set(String name, String... val) Replace any existing parameter with the given name.
ModifiableSolrParams	setNonNull(String name, Object val)
int	size()

从类继承的方法 org.apache.solr.common.params.SolrParams

fpname, get, getAll, getAll, getBool, getBool, getDouble, getDouble, getFieldBool, getFieldBool, getFieldDouble, getFieldDouble, getFieldFloat, getFieldFloat, getFieldInt, getFieldInt, getFieldParam, getFieldParam, getFieldParams, getFloat, getFloat, getInt, getInt, getLong, getLong, getPrimitiveBool, getPrimitiveFieldBool, getPrimitiveFieldFloat, getPrimitiveInt, required, stream, toFilteredSolrParams, toLocalParamsString, toMap, toMultiMap, toNamedList, toQueryString, toSolrParams, toString, wrapAppended, wrapDefaults, writeMap

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.solr.common.MapWriter

jsonStr, toMap

从接口继承的方法 org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

从接口继承的方法 java.lang.Iterable

forEach, spliterator

构造器详细资料

ModifiableSolrParams

public ModifiableSolrParams()

ModifiableSolrParams

public ModifiableSolrParams(Map<String,String[]> v)

Constructs a new ModifiableSolrParams directly using the provided Map<String,String[]>

ModifiableSolrParams

public ModifiableSolrParams(SolrParams params)

Constructs a new ModifiableSolrParams, copying values from an existing SolrParams

方法详细资料

of

public static ModifiableSolrParams of(SolrParams params)

If the input params are of type MofifiableSolrParams, returns the input, otherwise, constructs a new ModifiableSolrParams, copying values from the given params. If params is null, returns an empty ModifiableSolrParams instance.

size

public int size()

getMap

public Map<String,String[]> getMap()

setNonNull

public ModifiableSolrParams setNonNull(String name,
                                       Object val)

set

public ModifiableSolrParams set(String name,
                                String... val)

Replace any existing parameter with the given name. if val==null remove key from params completely.

set

public ModifiableSolrParams set(String name,
                                int val)

set

public ModifiableSolrParams set(String name,
                                boolean val)

add

public ModifiableSolrParams add(String name,
                                String... val)

Add the given values to any existing name

参数:

name - Key

val - Array of value(s) added to the name. NOTE: If val is null or a member of val is null, then a corresponding null reference will be included when a get method is called on the key later.

返回:

this

add

public void add(SolrParams params)

Add all of the params provided in the parameter to this params. Any current value(s) for the same key will be overridden.

remove

public String[] remove(String name)

remove a field at the given name

clear

public void clear()

clear all parameters

remove

public boolean remove(String name,
                      String value)

remove the given value for the given name

返回:

true if the item was removed, false if null or not present

get

public String get(String param)

从类复制的说明: SolrParams

Returns the first String value of a param, or null if not set. To get all, call SolrParams.getParams(String) instead.

指定者:

get 在类中 SolrParams

getParameterNamesIterator

public Iterator<String> getParameterNamesIterator()

从类复制的说明: SolrParams

Returns an Iterator over the parameter names. If you were to call a getter for this parameter, you should get a non-null value. Since you probably want the value, consider using Java 5 for-each style instead for convenience since a SolrParams implements Iterable.

指定者:

getParameterNamesIterator 在类中 SolrParams

getParameterNames

public Set<String> getParameterNames()

getParams

public String[] getParams(String param)

从类复制的说明: SolrParams

returns an array of the String values of a param, or null if no mapping for the param exists.

指定者:

getParams 在类中 SolrParams

iterator

public Iterator<Map.Entry<String,String[]>> iterator()

从类复制的说明: SolrParams

Returns an Iterator of Map.Entry providing a multi-map view. Treat it as read-only.

指定者:

iterator 在接口中 Iterable<Map.Entry<String,String[]>>

覆盖:

iterator 在类中 SolrParams