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