| java.lang.Object
 org.apache.solr.request.SolrParams
All known Subclasses: org.apache.solr.request.RequiredSolrParams, org.apache.solr.request.MultiMapSolrParams, org.apache.solr.request.MapSolrParams, org.apache.solr.request.DefaultSolrParams,
| SolrParams | | abstract public class SolrParams (Code) | | SolrParams hold request parameters.
author:
yonik
version:
$Id$ |
| Inner Class :public enum EchoParamStyle | |
| Method Summary | |
| protected String | fpname(String field, String param)
| | abstract public String | get(String param)
| | public String | get(String param, String def)
| | public Boolean | getBool(String param)
| | public boolean | getBool(String param, boolean def)
| | public 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. | | public 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. | | public Float | getFieldFloat(String field, String param)
Returns the float value of the field param. | | public 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. | | public 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. | | public 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. | | public 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. | | public 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. | | public 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. | | public Float | getFloat(String param)
| | public float | getFloat(String param, float def)
| | public Integer | getInt(String param)
| | public int | getInt(String param, int def)
| | abstract public Iterator<String> | getParameterNamesIterator()
| | abstract public String[] | getParams(String param)
| | protected boolean | parseBool(String s)
how to transform a String into a boolean... | | public RequiredSolrParams | required()
| | public static Map<String, String> | toMap(NamedList params)
| | public static Map<String, String[]> | toMultiMap(NamedList params)
| | public NamedList<Object> | toNamedList()
| | public static SolrParams | toSolrParams(NamedList params)
Create SolrParams from NamedList. |
| DEBUG_QUERY | | final public static String DEBUG_QUERY(Code) | | whether to include debug data
|
| EXPLAIN_OTHER | | final public static String EXPLAIN_OTHER(Code) | | another query to explain against
|
| FACET | | final public static String FACET(Code) | | Should facet counts be calculated?
|
| FACET_ENUM_CACHE_MINDF | | final public static String FACET_ENUM_CACHE_MINDF(Code) | | When faceting by enumerating the terms in a field,
only use the filterCache for terms with a df >= to this parameter.
|
| FACET_FIELD | | final public static String FACET_FIELD(Code) | | Any field whose terms the user wants to enumerate over for
Facet Contraint Counts (multi-value)
|
| FACET_LIMIT | | final public static String FACET_LIMIT(Code) | | Numeric option indicating the maximum number of facet field counts
be included in the response for each field - in descending order of count.
Can be overriden on a per field basis.
|
| FACET_MINCOUNT | | final public static String FACET_MINCOUNT(Code) | | Numeric option indicating the minimum number of hits before a facet should
be included in the response. Can be overriden on a per field basis.
|
| FACET_MISSING | | final public static String FACET_MISSING(Code) | | Boolean option indicating whether the response should include a
facet field count for all records which have no value for the
facet field. Can be overriden on a per field basis.
|
| FACET_OFFSET | | final public static String FACET_OFFSET(Code) | | The offset into the list of facets.
Can be overriden on a per field basis.
|
| FACET_PREFIX | | final public static String FACET_PREFIX(Code) | | Only return constraints of a facet field with the given prefix.
|
| FACET_QUERY | | final public static String FACET_QUERY(Code) | | Any lucene formated queries the user would like to use for
Facet Contraint Counts (multi-value)
|
| FACET_SORT | | final public static String FACET_SORT(Code) | | Boolean option: true causes facets to be sorted
by the count, false results in natural index order.
|
| FACET_ZEROS | | final public static String FACET_ZEROS(Code) | | Boolean option indicating whether facet field counts of "0" should
be included in the response. Can be overriden on a per field basis.
|
| FL | | final public static String FL(Code) | | query and init param for field list
|
| FQ | | final public static String FQ(Code) | | Lucene query string(s) for filtering the results without affecting scoring
|
| HEADER_ECHO_HANDLER | | final public static String HEADER_ECHO_HANDLER(Code) | | 'true' if the header should include the handler name
|
| HEADER_ECHO_PARAMS | | final public static String HEADER_ECHO_PARAMS(Code) | | include the parameters in the header *
|
| QT | | final public static String QT(Code) | | the query type - which query handler should handle the request
|
| ROWS | | final public static String ROWS(Code) | | number of documents to return starting at "start"
|
| START | | final public static String START(Code) | | zero based offset of matching documents to retrieve
|
| STREAM_BODY | | final public static String STREAM_BODY(Code) | | If the content stream should come directly from a field
|
| STREAM_CONTENTTYPE | | final public static String STREAM_CONTENTTYPE(Code) | | Explicity set the content type for the input stream
If multiple streams are specified, the explicit contentType
will be used for all of them.
|
| STREAM_FILE | | final public static String STREAM_FILE(Code) | | If the content stream should come from a File (using FileReader)
|
| STREAM_URL | | final public static String STREAM_URL(Code) | | If the content stream should come from a URL (using URLConnection)
|
| VERSION | | final public static String VERSION(Code) | | stylesheet to apply to XML results
|
| WT | | final public static String WT(Code) | | the response writer type - the format of the response
|
| XSL | | final public static String XSL(Code) | | stylesheet to apply to XML results
|
| get | | abstract public String get(String param)(Code) | | returns the String value of a param, or null if not set
|
| getBool | | public Boolean getBool(String param)(Code) | | Returns the Boolean value of the param, or null if not set
|
| getBool | | public boolean getBool(String param, boolean def)(Code) | | Returns the boolean value of the param, or def if not set
|
| getFieldBool | | public Boolean getFieldBool(String field, String param)(Code) | | Returns the Boolean value of the field param,
or the value for param, or null if neither is set.
|
| getFieldBool | | public boolean getFieldBool(String field, String param, boolean def)(Code) | | Returns the boolean value of the field param,
or the value for param, or def if neither is set.
|
| getFieldFloat | | public Float getFieldFloat(String field, String param)(Code) | | Returns the float value of the field param.
|
| getFieldFloat | | public float getFieldFloat(String field, String param, float def)(Code) | | Returns the float value of the field param,
or the value for param, or def if neither is set.
|
| getFieldInt | | public Integer getFieldInt(String field, String param)(Code) | | Returns the int value of the field param,
or the value for param, or def if neither is set.
|
| getFieldInt | | public int getFieldInt(String field, String param, int def)(Code) | | Returns the int value of the field param,
or the value for param, or def if neither is set.
|
| getFieldParam | | public String getFieldParam(String field, String param)(Code) | | returns the String value of the field parameter, "f.field.param", or
the value for "param" if that is not set.
|
| getFieldParam | | public String getFieldParam(String field, String param, String def)(Code) | | 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
|
| getFieldParams | | public String[] getFieldParams(String field, String param)(Code) | | returns the String values of the field parameter, "f.field.param", or
the values for "param" if that is not set.
|
| getFloat | | public Float getFloat(String param)(Code) | | Returns the Float value of the param, or null if not set
|
| getFloat | | public float getFloat(String param, float def)(Code) | | Returns the float value of the param, or def if not set
|
| getInt | | public Integer getInt(String param)(Code) | | Returns the Integer value of the param, or null if not set
|
| getInt | | public int getInt(String param, int def)(Code) | | Returns the int value of the param, or def if not set
|
| getParameterNamesIterator | | abstract public Iterator<String> getParameterNamesIterator()(Code) | | returns an Iterator over the parameter names
|
| getParams | | abstract public String[] getParams(String param)(Code) | | returns an array of the String values of a param, or null if none
|
| parseBool | | protected boolean parseBool(String s)(Code) | | how to transform a String into a boolean... more flexible than
Boolean.parseBoolean() to enable easier integration with html forms.
|
|
|