org.apache.solr.request
Class RequiredSolrParams

java.lang.Object
  extended by org.apache.solr.request.SolrParams
      extended by org.apache.solr.request.RequiredSolrParams

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)

Since:
solr 1.2
Version:
$Id: RequiredSolrParams.java 542679 2007-05-29 22:28:21Z ryan $
Author:
jjl

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.solr.request.SolrParams
SolrParams.EchoParamStyle
 
Field Summary
protected  SolrParams params
           
 
Fields inherited from class org.apache.solr.request.SolrParams
DEBUG_QUERY, DF, EXPLAIN_OTHER, FACET, FACET_ENUM_CACHE_MINDF, FACET_FIELD, FACET_LIMIT, FACET_MINCOUNT, FACET_MISSING, FACET_OFFSET, FACET_PREFIX, FACET_QUERY, FACET_SORT, FACET_ZEROS, FL, FQ, HEADER_ECHO_HANDLER, HEADER_ECHO_PARAMS, Q, QT, ROWS, SORT, START, STREAM_BODY, STREAM_CONTENTTYPE, STREAM_FILE, STREAM_URL, VERSION, WT, XSL
 
Constructor Summary
RequiredSolrParams(SolrParams params)
           
 
Method Summary
 java.lang.String get(java.lang.String param)
          get the param from params, fail if not found
 java.lang.String get(java.lang.String param, java.lang.String def)
          returns the value of the param, or def if not set
 boolean getBool(java.lang.String param, boolean def)
          Returns the boolean value of the param, or def if not 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.
 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.
 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, 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.
 float getFloat(java.lang.String param, float def)
          Returns the float value of the param, or def if not set
 int getInt(java.lang.String param, int def)
          Returns the int value of the param, or def if not set
 java.util.Iterator<java.lang.String> getParameterNamesIterator()
          returns an Iterator over the parameter names
 java.lang.String[] getParams(java.lang.String param)
          returns an array of the String values of a param, or null if none
 java.lang.String toString()
           
 
Methods inherited from class org.apache.solr.request.SolrParams
fpname, getBool, getFieldBool, getFieldFloat, getFieldInt, getFieldParam, getFieldParams, getFloat, getInt, parseBool, required, toMap, toMultiMap, toNamedList, toSolrParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

params

protected final SolrParams params
Constructor Detail

RequiredSolrParams

public RequiredSolrParams(SolrParams params)
Method Detail

get

public java.lang.String get(java.lang.String param)
get the param from params, fail if not found

Specified by:
get in class SolrParams

getParams

public java.lang.String[] getParams(java.lang.String param)
Description copied from class: SolrParams
returns an array of the String values of a param, or null if none

Specified by:
getParams in class SolrParams

getParameterNamesIterator

public java.util.Iterator<java.lang.String> getParameterNamesIterator()
returns an Iterator over the parameter names

Specified by:
getParameterNamesIterator in class SolrParams

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

get

public java.lang.String get(java.lang.String param,
                            java.lang.String def)
Description copied from class: SolrParams
returns the value of the param, or def if not set

Overrides:
get in class SolrParams

getInt

public int getInt(java.lang.String param,
                  int def)
Description copied from class: SolrParams
Returns the int value of the param, or def if not set

Overrides:
getInt in class SolrParams

getFloat

public float getFloat(java.lang.String param,
                      float def)
Description copied from class: SolrParams
Returns the float value of the param, or def if not set

Overrides:
getFloat in class SolrParams

getBool

public boolean getBool(java.lang.String param,
                       boolean def)
Description copied from class: SolrParams
Returns the boolean value of the param, or def if not set

Overrides:
getBool in class SolrParams

getFieldInt

public int getFieldInt(java.lang.String field,
                       java.lang.String param,
                       int def)
Description copied from class: SolrParams
Returns the int value of the field param, or the value for param, or def if neither is set.

Overrides:
getFieldInt in class SolrParams

getFieldBool

public boolean getFieldBool(java.lang.String field,
                            java.lang.String param,
                            boolean def)
Description copied from class: SolrParams
Returns the boolean value of the field param, or the value for param, or def if neither is set.

Overrides:
getFieldBool in class SolrParams

getFieldFloat

public float getFieldFloat(java.lang.String field,
                           java.lang.String param,
                           float def)
Description copied from class: SolrParams
Returns the float value of the field param, or the value for param, or def if neither is set.

Overrides:
getFieldFloat in class SolrParams

getFieldParam

public java.lang.String getFieldParam(java.lang.String field,
                                      java.lang.String param,
                                      java.lang.String def)
Description copied from class: 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

Overrides:
getFieldParam in class SolrParams


Copyright © 2006 - 2009 The Apache Software Foundation