org.apache.solr.common.params

类 RequiredSolrParams

java.lang.Object

org.apache.solr.common.params.SolrParams

org.apache.solr.common.params.RequiredSolrParams

所有已实现的接口:

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

public class RequiredSolrParams
extends SolrParams

This is a simple wrapper to SolrParams that will throw a 400 exception if you ask for a parameter that does not exist. Fields specified with In short, any value you for from a RequiredSolrParams will return a valid non-null value or throw a 400 exception. (If you pass in null as the default value, you can get a null return value)

从以下版本开始:

solr 1.2

另请参阅:

序列化表格

嵌套类概要

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

MapWriter.EntryWriter

字段概要

字段

限定符和类型	字段和说明
protected SolrParams	params

构造器概要

构造器

构造器和说明
RequiredSolrParams(SolrParams params)

方法概要

限定符和类型	方法和说明
void	check(String... params)
String	get(String param) get the param from params, fail if not found
String	get(String param, String def) returns the value of the param, or def if not set
boolean	getBool(String param, boolean def) Returns the boolean value of the param, or def if not set
boolean	getFieldBool(String field, String param, boolean def) Returns the boolean value of the field param, or the value for param, or def if neither is set.
float	getFieldFloat(String field, String param, float def) Returns the float value of the field param, or the value for param, or def if neither is set.
int	getFieldInt(String field, String param, int def) Returns the int value of the field param, or the value for param, or def if neither is set.
String	getFieldParam(String field, String param) returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set.
String	getFieldParam(String field, String param, String def) returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set.
String[]	getFieldParams(String field, String param) returns the String values of the field parameter, "f.field.param", or the values for "param" if that is not set.
float	getFloat(String param, float def) Returns the float value of the param, or def if not set
int	getInt(String param, int def) Returns the int value of the param, or def if not set
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.
String	toString() Like SolrParams.toQueryString(), but only replacing enough chars so that the URL may be unambiguously pasted back into a browser.

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

fpname, getAll, getAll, getBool, getDouble, getDouble, getFieldBool, getFieldDouble, getFieldDouble, getFieldFloat, getFieldInt, getFloat, getInt, getLong, getLong, getPrimitiveBool, getPrimitiveFieldBool, getPrimitiveFieldFloat, getPrimitiveInt, iterator, required, stream, toFilteredSolrParams, toLocalParamsString, toMap, toMultiMap, toNamedList, toQueryString, toSolrParams, 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

字段详细资料

params

protected final SolrParams params

构造器详细资料

RequiredSolrParams

public RequiredSolrParams(SolrParams params)

方法详细资料

get

public String get(String param)

get the param from params, fail if not found

指定者:

get 在类中 SolrParams

getFieldParam

public String getFieldParam(String field,
                            String param)

从类复制的说明: SolrParams

returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set.

覆盖:

getFieldParam 在类中 SolrParams

getFieldParams

public String[] getFieldParams(String field,
                               String param)

从类复制的说明: SolrParams

returns the String values of the field parameter, "f.field.param", or the values for "param" if that is not set.

覆盖:

getFieldParams 在类中 SolrParams

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

getParameterNamesIterator

public Iterator<String> getParameterNamesIterator()

returns an Iterator over the parameter names

指定者:

getParameterNamesIterator 在类中 SolrParams

toString

public String toString()

从类复制的说明: SolrParams

Like SolrParams.toQueryString(), but only replacing enough chars so that the URL may be unambiguously pasted back into a browser. This method can be used to properly log query parameters without making them unreadable.

Characters with a numeric value less than 32 are encoded. &,=,%,+,space are encoded.

覆盖:

toString 在类中 SolrParams

get

public String get(String param,
                  String def)

从类复制的说明: SolrParams

returns the value of the param, or def if not set

覆盖:

get 在类中 SolrParams

getInt

public int getInt(String param,
                  int def)

从类复制的说明: SolrParams

Returns the int value of the param, or def if not set

覆盖:

getInt 在类中 SolrParams

getFloat

public float getFloat(String param,
                      float def)

从类复制的说明: SolrParams

Returns the float value of the param, or def if not set

覆盖:

getFloat 在类中 SolrParams

getBool

public boolean getBool(String param,
                       boolean def)

从类复制的说明: SolrParams

Returns the boolean value of the param, or def if not set

覆盖:

getBool 在类中 SolrParams

getFieldInt

public int getFieldInt(String field,
                       String param,
                       int def)

从类复制的说明: SolrParams

Returns the int value of the field param, or the value for param, or def if neither is set.

覆盖:

getFieldInt 在类中 SolrParams

getFieldBool

public boolean getFieldBool(String field,
                            String param,
                            boolean def)

从类复制的说明: SolrParams

Returns the boolean value of the field param, or the value for param, or def if neither is set.

覆盖:

getFieldBool 在类中 SolrParams

getFieldFloat

public float getFieldFloat(String field,
                           String param,
                           float def)

从类复制的说明: SolrParams

Returns the float value of the field param, or the value for param, or def if neither is set.

覆盖:

getFieldFloat 在类中 SolrParams

getFieldParam

public String getFieldParam(String field,
                            String param,
                            String def)

从类复制的说明: SolrParams

returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set. If that is not set, def

覆盖:

getFieldParam 在类中 SolrParams

check

public void check(String... params)