| Modifier and Type | Class and Description | 
|---|---|
class  | 
SolrQuery
This is an augmented SolrParams with get/set/add fields for common fields used
 in the Standard and Dismax request handlers 
 | 
| Modifier and Type | Method and Description | 
|---|---|
abstract SolrParams | 
SolrRequest.getParams()  | 
| Modifier and Type | Method and Description | 
|---|---|
QueryResponse | 
SolrServer.query(SolrParams params)
Performs a query to the Solr server 
 | 
QueryResponse | 
SolrServer.query(SolrParams params,
     SolrRequest.METHOD method)
Performs a query to the Solr server 
 | 
| Modifier and Type | Method and Description | 
|---|---|
SolrParams | 
QueryRequest.getParams()  | 
SolrParams | 
LukeRequest.getParams()  | 
SolrParams | 
FieldAnalysisRequest.getParams() | 
SolrParams | 
DirectXmlRequest.getParams()  | 
SolrParams | 
CoreAdminRequest.getParams()  | 
SolrParams | 
CoreAdminRequest.Create.getParams()  | 
SolrParams | 
CoreAdminRequest.Persist.getParams()  | 
SolrParams | 
CoreAdminRequest.MergeIndexes.getParams()  | 
SolrParams | 
CoreAdminRequest.Unload.getParams()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
DirectXmlRequest.setParams(SolrParams params)  | 
| Constructor and Description | 
|---|
QueryRequest(SolrParams q)  | 
QueryRequest(SolrParams q,
            SolrRequest.METHOD method)  | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
ClientUtils.toQueryString(SolrParams params,
             boolean xml)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AppendedSolrParams
SolrParams wrapper which acts similar to DefaultSolrParams except that
 it "appends" the values of multi-value params from both sub instances, so
 that all of the values are returned. 
 | 
class  | 
DefaultSolrParams  | 
class  | 
MapSolrParams  | 
class  | 
ModifiableSolrParams
This class is similar to MultiMapSolrParams except you can edit the 
 parameters after it is initialized. 
 | 
class  | 
MultiMapSolrParams  | 
class  | 
RequiredSolrParams
This is a simple wrapper to SolrParams that will throw a 400
 exception if you ask for a parameter that does not exist. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
DefaultSolrParams.defaults  | 
protected SolrParams | 
RequiredSolrParams.params  | 
protected SolrParams | 
DefaultSolrParams.params  | 
| Modifier and Type | Method and Description | 
|---|---|
static SolrParams | 
SolrParams.toSolrParams(NamedList params)
Create SolrParams from NamedList. 
 | 
static SolrParams | 
SolrParams.wrapAppended(SolrParams params,
            SolrParams defaults)  | 
static SolrParams | 
SolrParams.wrapDefaults(SolrParams params,
            SolrParams defaults)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ModifiableSolrParams.add(SolrParams params)  | 
static SolrParams | 
SolrParams.wrapAppended(SolrParams params,
            SolrParams defaults)  | 
static SolrParams | 
SolrParams.wrapDefaults(SolrParams params,
            SolrParams defaults)  | 
| Constructor and Description | 
|---|
AppendedSolrParams(SolrParams main,
                  SolrParams extra)
Deprecated. 
 
(3.6) Use  
wrapAppended(SolrParams, SolrParams) instead. | 
DefaultSolrParams(SolrParams params,
                 SolrParams defaults)
Deprecated. 
 
(3.6) Use  
wrapDefaults(SolrParams, SolrParams) instead. | 
ModifiableSolrParams(SolrParams params)
Constructs a new ModifiableSolrParams, copying values from an existing SolrParams 
 | 
RequiredSolrParams(SolrParams params)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
RequestHandlerBase.appends  | 
protected SolrParams | 
SpellCheckerRequestHandler.args
Deprecated.  
  | 
protected SolrParams | 
RequestHandlerBase.defaults  | 
protected SolrParams | 
RequestHandlerBase.invariants  | 
| Modifier and Type | Method and Description | 
|---|---|
static boolean | 
RequestHandlerUtils.handleCommit(UpdateRequestProcessor processor,
            SolrParams params,
            boolean force)
Check the request parameters and decide if it should commit or optimize. 
 | 
static boolean | 
RequestHandlerUtils.handleRollback(UpdateRequestProcessor processor,
              SolrParams params,
              boolean force)  | 
| Constructor and Description | 
|---|
MoreLikeThisHandler.MoreLikeThisHelper(SolrParams params,
                                      SolrIndexSearcher searcher)  | 
| Modifier and Type | Method and Description | 
|---|---|
abstract NamedList | 
DocumentClusteringEngine.cluster(DocSet docs,
       SolrParams solrParams)
Experimental. 
 | 
abstract NamedList | 
DocumentClusteringEngine.cluster(SolrParams solrParams)
Experimental. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected SolrParams | 
SpellCheckComponent.getCustomParams(String dictionary,
               SolrParams params,
               boolean shardRequest)
For every param that is of the form "spellcheck. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
SpellCheckComponent.addCollationsToResponse(SolrParams params,
                       SpellingResult spellingResult,
                       ResponseBuilder rb,
                       String q,
                       NamedList response)  | 
protected SolrParams | 
SpellCheckComponent.getCustomParams(String dictionary,
               SolrParams params,
               boolean shardRequest)
For every param that is of the form "spellcheck. 
 | 
protected SolrSpellChecker | 
SpellCheckComponent.getSpellChecker(SolrParams params)  | 
void | 
TermsComponent.TermsHelper.init(SolrParams params)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
SolrContentHandler.params  | 
| Modifier and Type | Method and Description | 
|---|---|
SolrContentHandler | 
SolrContentHandlerFactory.createSolrContentHandler(org.apache.tika.metadata.Metadata metadata,
                        SolrParams params,
                        IndexSchema schema)  | 
| Constructor and Description | 
|---|
SolrContentHandler(org.apache.tika.metadata.Metadata metadata,
                  SolrParams params,
                  IndexSchema schema)  | 
SolrContentHandler(org.apache.tika.metadata.Metadata metadata,
                  SolrParams params,
                  IndexSchema schema,
                  Collection<String> dateFormats)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
HighlightingPluginBase.defaults  | 
| Modifier and Type | Method and Description | 
|---|---|
protected abstract org.apache.lucene.search.vectorhighlight.BoundaryScanner | 
SolrBoundaryScanner.get(String fieldName,
   SolrParams params)  | 
protected org.apache.lucene.search.vectorhighlight.BoundaryScanner | 
SimpleBoundaryScanner.get(String fieldName,
   SolrParams params)  | 
protected org.apache.lucene.search.vectorhighlight.BoundaryScanner | 
BreakIteratorBoundaryScanner.get(String fieldName,
   SolrParams params)  | 
org.apache.lucene.search.vectorhighlight.BoundaryScanner | 
SolrBoundaryScanner.getBoundaryScanner(String fieldName,
                  SolrParams params)  | 
org.apache.lucene.search.highlight.Encoder | 
SolrEncoder.getEncoder(String fieldName,
          SolrParams params)
Return an  
Encoder appropriate for this field. | 
org.apache.lucene.search.highlight.Encoder | 
HtmlEncoder.getEncoder(String fieldName,
          SolrParams params)  | 
protected org.apache.lucene.search.highlight.Encoder | 
DefaultSolrHighlighter.getEncoder(String fieldName,
          SolrParams params)
Return an  
Encoder appropriate for this field. | 
org.apache.lucene.search.highlight.Encoder | 
DefaultEncoder.getEncoder(String fieldName,
          SolrParams params)  | 
org.apache.lucene.search.highlight.Formatter | 
SolrFormatter.getFormatter(String fieldName,
            SolrParams params)
Return a  
Formatter appropriate for this field. | 
org.apache.lucene.search.highlight.Formatter | 
HtmlFormatter.getFormatter(String fieldName,
            SolrParams params)  | 
protected org.apache.lucene.search.highlight.Formatter | 
DefaultSolrHighlighter.getFormatter(String fieldName,
            SolrParams params)
Return a  
Formatter appropriate for this field. | 
org.apache.lucene.search.vectorhighlight.FragListBuilder | 
SolrFragListBuilder.getFragListBuilder(SolrParams params)
Return a FragListBuilder. 
 | 
org.apache.lucene.search.vectorhighlight.FragListBuilder | 
SingleFragListBuilder.getFragListBuilder(SolrParams params)  | 
org.apache.lucene.search.vectorhighlight.FragListBuilder | 
SimpleFragListBuilder.getFragListBuilder(SolrParams params)  | 
protected org.apache.lucene.search.vectorhighlight.FragListBuilder | 
DefaultSolrHighlighter.getFragListBuilder(String fieldName,
                  SolrParams params)  | 
org.apache.lucene.search.highlight.Fragmenter | 
SolrFragmenter.getFragmenter(String fieldName,
             SolrParams params)
Return a  
Fragmenter appropriate for this field. | 
org.apache.lucene.search.highlight.Fragmenter | 
RegexFragmenter.getFragmenter(String fieldName,
             SolrParams params)  | 
org.apache.lucene.search.highlight.Fragmenter | 
GapFragmenter.getFragmenter(String fieldName,
             SolrParams params)  | 
protected org.apache.lucene.search.highlight.Fragmenter | 
DefaultSolrHighlighter.getFragmenter(String fieldName,
             SolrParams params)
Return a  
Fragmenter appropriate for this field. | 
org.apache.lucene.search.vectorhighlight.FragmentsBuilder | 
SolrFragmentsBuilder.getFragmentsBuilder(SolrParams params,
                   org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)
Return a  
FragmentsBuilder appropriate for this field. | 
protected abstract org.apache.lucene.search.vectorhighlight.FragmentsBuilder | 
SolrFragmentsBuilder.getFragmentsBuilder(SolrParams params,
                   String[] preTags,
                   String[] postTags,
                   org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)  | 
protected org.apache.lucene.search.vectorhighlight.FragmentsBuilder | 
SimpleFragmentsBuilder.getFragmentsBuilder(SolrParams params,
                   String[] preTags,
                   String[] postTags,
                   org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)  | 
protected org.apache.lucene.search.vectorhighlight.FragmentsBuilder | 
ScoreOrderFragmentsBuilder.getFragmentsBuilder(SolrParams params,
                   String[] preTags,
                   String[] postTags,
                   org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)  | 
protected org.apache.lucene.search.vectorhighlight.FragmentsBuilder | 
DefaultSolrHighlighter.getFragmentsBuilder(String fieldName,
                   SolrParams params)  | 
protected int | 
DefaultSolrHighlighter.getMaxSnippets(String fieldName,
              SolrParams params)
Return the max number of snippets for this field. 
 | 
protected char | 
SolrFragmentsBuilder.getMultiValuedSeparatorChar(SolrParams params)  | 
String[] | 
SolrFragmentsBuilder.getPostTags(SolrParams params,
           String fieldName)  | 
String[] | 
SolrFragmentsBuilder.getPreTags(SolrParams params,
          String fieldName)  | 
boolean | 
SolrHighlighter.isHighlightingEnabled(SolrParams params)
Check whether Highlighting is enabled for this request. 
 | 
protected boolean | 
DefaultSolrHighlighter.isMergeContiguousFragments(String fieldName,
                          SolrParams params)
Return whether adjacent fragments should be merged. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ServletSolrParams  | 
class  | 
SolrParams
Deprecated. 
 
Use org.apache.solr.common.params.SolrParams. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
SolrQueryRequestBase.origParams  | 
protected SolrParams | 
SolrQueryRequestBase.params  | 
protected SolrParams | 
SimpleFacets.params
Configuration params behavior should be driven by 
 | 
protected SolrParams | 
SimpleFacets.required  | 
| Modifier and Type | Method and Description | 
|---|---|
SolrParams | 
SolrQueryRequestBase.getOriginalParams()  | 
SolrParams | 
SolrQueryRequest.getOriginalParams()
Returns the original request parameters. 
 | 
SolrParams | 
SolrQueryRequestBase.getParams()  | 
SolrParams | 
SolrQueryRequest.getParams()
returns the current request parameters 
 | 
protected static SolrParams | 
LocalSolrQueryRequest.makeParams(String query,
          String qtype,
          int start,
          int limit,
          Map args)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
SolrQueryRequestBase.setParams(SolrParams params)  | 
void | 
SolrQueryRequest.setParams(SolrParams params)
Change the parameters for this request. 
 | 
| Constructor and Description | 
|---|
AppendedSolrParams(SolrParams main,
                  SolrParams extra)
Deprecated.  
  | 
DefaultSolrParams(SolrParams main,
                 SolrParams extra)
Deprecated.  
  | 
LocalSolrQueryRequest(SolrCore core,
                     SolrParams args)  | 
RequiredSolrParams(SolrParams params)
Deprecated.  
  | 
SimpleFacets(SolrQueryRequest req,
            DocSet docs,
            SolrParams params)  | 
SimpleFacets(SolrQueryRequest req,
            DocSet docs,
            SolrParams params,
            ResponseBuilder rb)  | 
SolrQueryRequestBase(SolrCore core,
                    SolrParams params)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
SimilarityFactory.params  | 
| Modifier and Type | Method and Description | 
|---|---|
SolrParams | 
SimilarityFactory.getParams()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
SimilarityFactory.init(SolrParams params)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
QParser.localParams  | 
protected SolrParams | 
QParser.params  | 
| Modifier and Type | Method and Description | 
|---|---|
SolrParams | 
QParser.getLocalParams()  | 
static SolrParams | 
QueryParsing.getLocalParams(String txt,
              SolrParams params)
"foo" returns null
 "{! 
 | 
SolrParams | 
QParser.getParams()  | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
DisMaxQParser.addBoostFunctions(org.apache.lucene.search.BooleanQuery query,
                 SolrParams solrParams)  | 
protected void | 
DisMaxQParser.addBoostQuery(org.apache.lucene.search.BooleanQuery query,
             SolrParams solrParams)  | 
protected boolean | 
DisMaxQParser.addMainQuery(org.apache.lucene.search.BooleanQuery query,
            SolrParams solrParams)
Adds the main query to the query argument. 
 | 
QParser | 
TermQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
SpatialFilterQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
SpatialBoxQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
RawQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
abstract QParser | 
QParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)
return a  
QParser | 
QParser | 
PrefixQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
OldLuceneQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
NestedQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
LuceneQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
FunctionRangeQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
FunctionQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
FieldQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
ExtendedDismaxQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
DisMaxQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
QParser | 
BoostQParserPlugin.createParser(String qstr,
            SolrParams localParams,
            SolrParams params,
            SolrQueryRequest req)  | 
protected org.apache.lucene.search.Query | 
DisMaxQParser.getAlternateUserQuery(SolrParams solrParams)  | 
static SolrParams | 
QueryParsing.getLocalParams(String txt,
              SolrParams params)
"foo" returns null
 "{! 
 | 
protected SolrPluginUtils.DisjunctionMaxQueryParser | 
DisMaxQParser.getParser(Map<String,Float> fields,
         String paramName,
         SolrParams solrParams,
         float tiebreaker)  | 
protected org.apache.lucene.search.Query | 
DisMaxQParser.getUserQuery(String userQuery,
            SolrPluginUtils.DisjunctionMaxQueryParser up,
            SolrParams solrParams)  | 
static org.apache.lucene.search.Query | 
QueryParsing.parseQuery(String qs,
          String defaultField,
          SolrParams params,
          IndexSchema schema)
Helper utility for parsing a query using the Lucene QueryParser syntax. 
 | 
void | 
QParser.setLocalParams(SolrParams localParams)  | 
void | 
QParser.setParams(SolrParams params)  | 
| Constructor and Description | 
|---|
DisMaxQParser(String qstr,
             SolrParams localParams,
             SolrParams params,
             SolrQueryRequest req)  | 
FunctionQParser(String qstr,
               SolrParams localParams,
               SolrParams params,
               SolrQueryRequest req)  | 
QParser(String qstr,
       SolrParams localParams,
       SolrParams params,
       SolrQueryRequest req)
Constructor for the QParser 
 | 
SpatialFilterQParser(String qstr,
                    SolrParams localParams,
                    SolrParams params,
                    SolrQueryRequest req,
                    boolean bbox)  | 
| Modifier and Type | Method and Description | 
|---|---|
SolrQueryRequest | 
SolrRequestParsers.buildRequestFrom(SolrCore core,
                SolrParams params,
                Collection<ContentStream> streams)  | 
String | 
DirectSolrConnection.request(SolrRequestHandler handler,
       SolrParams params,
       String body)  | 
| Modifier and Type | Field and Description | 
|---|---|
SolrParams | 
SpellingOptions.customParams
Any other custom params can be passed through. 
 | 
| Constructor and Description | 
|---|
SpellingOptions(Collection<org.apache.lucene.analysis.Token> tokens,
               org.apache.lucene.index.IndexReader reader,
               int count,
               boolean onlyMorePopular,
               boolean extendedResults,
               float accuracy,
               SolrParams customParams)  | 
| Modifier and Type | Field and Description | 
|---|---|
protected SolrParams | 
TikaLanguageIdentifierUpdateProcessorFactory.appends  | 
protected SolrParams | 
LangDetectLanguageIdentifierUpdateProcessorFactory.appends  | 
protected SolrParams | 
TikaLanguageIdentifierUpdateProcessorFactory.defaults  | 
protected SolrParams | 
LangDetectLanguageIdentifierUpdateProcessorFactory.defaults  | 
protected SolrParams | 
TikaLanguageIdentifierUpdateProcessorFactory.invariants  | 
protected SolrParams | 
LangDetectLanguageIdentifierUpdateProcessorFactory.invariants  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
TextProfileSignature.init(SolrParams params)  | 
void | 
Signature.init(SolrParams nl)  | 
| Constructor and Description | 
|---|
URLClassifyProcessor(SolrParams parameters,
                    SolrQueryRequest request,
                    SolrQueryResponse response,
                    UpdateRequestProcessor nextProcessor)  | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
SolrPluginUtils.resolveUpdateChainParam(SolrParams params,
                       org.slf4j.Logger log)
Deprecated.   
 | 
static void | 
SolrPluginUtils.setDefaults(SolrQueryRequest req,
           SolrParams defaults)
Set defaults on a SolrQueryRequest. 
 | 
static void | 
SolrPluginUtils.setDefaults(SolrQueryRequest req,
           SolrParams defaults,
           SolrParams appends,
           SolrParams invariants)
Set default-ish params on a SolrQueryRequest. 
 |