|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.solr.request.SolrParams
public abstract class SolrParams
SolrParams hold request parameters.
Nested Class Summary | |
---|---|
static class |
SolrParams.EchoParamStyle
valid values for: echoParams |
Field Summary | |
---|---|
static java.lang.String |
DEBUG_QUERY
whether to include debug data |
static java.lang.String |
DF
default query field |
static java.lang.String |
EXPLAIN_OTHER
another query to explain against |
static java.lang.String |
FACET
Should facet counts be calculated? |
static java.lang.String |
FACET_ENUM_CACHE_MINDF
When faceting by enumerating the terms in a field, only use the filterCache for terms with a df >= to this parameter. |
static java.lang.String |
FACET_FIELD
Any field whose terms the user wants to enumerate over for Facet Contraint Counts (multi-value) |
static java.lang.String |
FACET_LIMIT
Numeric option indicating the maximum number of facet field counts be included in the response for each field - in descending order of count. |
static java.lang.String |
FACET_MINCOUNT
Numeric option indicating the minimum number of hits before a facet should be included in the response. |
static java.lang.String |
FACET_MISSING
Boolean option indicating whether the response should include a facet field count for all records which have no value for the facet field. |
static java.lang.String |
FACET_OFFSET
The offset into the list of facets. |
static java.lang.String |
FACET_PREFIX
Only return constraints of a facet field with the given prefix. |
static java.lang.String |
FACET_QUERY
Any lucene formated queries the user would like to use for Facet Contraint Counts (multi-value) |
static java.lang.String |
FACET_SORT
Boolean option: true causes facets to be sorted by the count, false results in natural index order. |
static java.lang.String |
FACET_ZEROS
Boolean option indicating whether facet field counts of "0" should be included in the response. |
static java.lang.String |
FL
query and init param for field list |
static java.lang.String |
FQ
Lucene query string(s) for filtering the results without affecting scoring |
static java.lang.String |
HEADER_ECHO_HANDLER
'true' if the header should include the handler name |
static java.lang.String |
HEADER_ECHO_PARAMS
include the parameters in the header |
static java.lang.String |
Q
query string |
static java.lang.String |
QT
the query type - which query handler should handle the request |
static java.lang.String |
ROWS
number of documents to return starting at "start" |
static java.lang.String |
SORT
sort order |
static java.lang.String |
START
zero based offset of matching documents to retrieve |
static java.lang.String |
STREAM_BODY
If the content stream should come directly from a field |
static java.lang.String |
STREAM_CONTENTTYPE
Explicity set the content type for the input stream If multiple streams are specified, the explicit contentType will be used for all of them. |
static java.lang.String |
STREAM_FILE
If the content stream should come from a File (using FileReader) |
static java.lang.String |
STREAM_URL
If the content stream should come from a URL (using URLConnection) |
static java.lang.String |
VERSION
stylesheet to apply to XML results |
static java.lang.String |
WT
the response writer type - the format of the response |
static java.lang.String |
XSL
stylesheet to apply to XML results |
Constructor Summary | |
---|---|
SolrParams()
|
Method Summary | |
---|---|
protected java.lang.String |
fpname(java.lang.String field,
java.lang.String param)
|
abstract java.lang.String |
get(java.lang.String param)
returns the String value of a param, or null if not set |
java.lang.String |
get(java.lang.String param,
java.lang.String def)
returns the value of the param, or def if not set |
java.lang.Boolean |
getBool(java.lang.String param)
Returns the Boolean value of the param, or null if not set |
boolean |
getBool(java.lang.String param,
boolean def)
Returns the boolean value of the param, or def if not set |
java.lang.Boolean |
getFieldBool(java.lang.String field,
java.lang.String param)
Returns the Boolean value of the field param, or the value for param, or null if neither is set. |
boolean |
getFieldBool(java.lang.String field,
java.lang.String param,
boolean def)
Returns the boolean value of the field param, or the value for param, or def if neither is set. |
java.lang.Float |
getFieldFloat(java.lang.String field,
java.lang.String param)
Returns the float value of the field param. |
float |
getFieldFloat(java.lang.String field,
java.lang.String param,
float def)
Returns the float value of the field param, or the value for param, or def if neither is set. |
java.lang.Integer |
getFieldInt(java.lang.String field,
java.lang.String param)
Returns the int value of the field param, or the value for param, or def if neither is set. |
int |
getFieldInt(java.lang.String field,
java.lang.String param,
int def)
Returns the int value of the field param, or the value for param, or def if neither is set. |
java.lang.String |
getFieldParam(java.lang.String field,
java.lang.String param)
returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set. |
java.lang.String |
getFieldParam(java.lang.String field,
java.lang.String param,
java.lang.String def)
returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set. |
java.lang.String[] |
getFieldParams(java.lang.String field,
java.lang.String param)
returns the String values of the field parameter, "f.field.param", or the values for "param" if that is not set. |
java.lang.Float |
getFloat(java.lang.String param)
Returns the Float value of the param, or null if not set |
float |
getFloat(java.lang.String param,
float def)
Returns the float value of the param, or def if not set |
java.lang.Integer |
getInt(java.lang.String param)
Returns the Integer value of the param, or null if not set |
int |
getInt(java.lang.String param,
int def)
Returns the int value of the param, or def if not set |
abstract java.util.Iterator<java.lang.String> |
getParameterNamesIterator()
returns an Iterator over the parameter names |
abstract java.lang.String[] |
getParams(java.lang.String param)
returns an array of the String values of a param, or null if none |
protected boolean |
parseBool(java.lang.String s)
how to transform a String into a boolean... |
RequiredSolrParams |
required()
returns a RequiredSolrParams wrapping this |
static java.util.Map<java.lang.String,java.lang.String> |
toMap(NamedList params)
Create a Map |
static java.util.Map<java.lang.String,java.lang.String[]> |
toMultiMap(NamedList params)
Create a Map |
NamedList<java.lang.Object> |
toNamedList()
Convert this to a NamedList |
static SolrParams |
toSolrParams(NamedList params)
Create SolrParams from NamedList. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String QT
public static final java.lang.String WT
public static final java.lang.String Q
public static final java.lang.String SORT
public static final java.lang.String FQ
public static final java.lang.String START
public static final java.lang.String ROWS
public static final java.lang.String XSL
public static final java.lang.String VERSION
public static final java.lang.String FL
public static final java.lang.String DF
public static final java.lang.String DEBUG_QUERY
public static final java.lang.String EXPLAIN_OTHER
public static final java.lang.String FACET
public static final java.lang.String FACET_QUERY
public static final java.lang.String FACET_FIELD
public static final java.lang.String FACET_OFFSET
public static final java.lang.String FACET_LIMIT
public static final java.lang.String FACET_MINCOUNT
public static final java.lang.String FACET_ZEROS
public static final java.lang.String FACET_MISSING
public static final java.lang.String FACET_SORT
public static final java.lang.String FACET_PREFIX
public static final java.lang.String FACET_ENUM_CACHE_MINDF
public static final java.lang.String STREAM_URL
public static final java.lang.String STREAM_FILE
public static final java.lang.String STREAM_BODY
public static final java.lang.String STREAM_CONTENTTYPE
public static final java.lang.String HEADER_ECHO_HANDLER
public static final java.lang.String HEADER_ECHO_PARAMS
Constructor Detail |
---|
public SolrParams()
Method Detail |
---|
public abstract java.lang.String get(java.lang.String param)
public abstract java.lang.String[] getParams(java.lang.String param)
public abstract java.util.Iterator<java.lang.String> getParameterNamesIterator()
public java.lang.String get(java.lang.String param, java.lang.String def)
public RequiredSolrParams required()
protected java.lang.String fpname(java.lang.String field, java.lang.String param)
public java.lang.String getFieldParam(java.lang.String field, java.lang.String param)
public java.lang.String getFieldParam(java.lang.String field, java.lang.String param, java.lang.String def)
public java.lang.String[] getFieldParams(java.lang.String field, java.lang.String param)
public java.lang.Boolean getBool(java.lang.String param)
public boolean getBool(java.lang.String param, boolean def)
public java.lang.Boolean getFieldBool(java.lang.String field, java.lang.String param)
public boolean getFieldBool(java.lang.String field, java.lang.String param, boolean def)
public java.lang.Integer getInt(java.lang.String param)
public int getInt(java.lang.String param, int def)
public java.lang.Integer getFieldInt(java.lang.String field, java.lang.String param)
public int getFieldInt(java.lang.String field, java.lang.String param, int def)
public java.lang.Float getFloat(java.lang.String param)
public float getFloat(java.lang.String param, float def)
public java.lang.Float getFieldFloat(java.lang.String field, java.lang.String param)
public float getFieldFloat(java.lang.String field, java.lang.String param, float def)
protected boolean parseBool(java.lang.String s)
public static java.util.Map<java.lang.String,java.lang.String> toMap(NamedList params)
public static java.util.Map<java.lang.String,java.lang.String[]> toMultiMap(NamedList params)
public static SolrParams toSolrParams(NamedList params)
public NamedList<java.lang.Object> toNamedList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |