org.apache.solr.search

Class QParserPlugin

java.lang.Object

org.apache.solr.search.QParserPlugin

All Implemented Interfaces:

SolrInfoBean, NamedListInitializedPlugin

Direct Known Subclasses:

BlockJoinParentQParserPlugin, BoolQParserPlugin, BoostQParserPlugin, CollapsingQParserPlugin, ComplexPhraseQParserPlugin, DisMaxQParserPlugin, ExportQParserPlugin, ExtendedDismaxQParserPlugin, FieldQParserPlugin, FiltersQParserPlugin, FunctionQParserPlugin, FunctionRangeQParserPlugin, GraphQParserPlugin, GraphTermsQParserPlugin, HashQParserPlugin, IGainTermsQParserPlugin, JoinQParserPlugin, LuceneQParserPlugin, MinHashQParserPlugin, MLTQParserPlugin, NestedQParserPlugin, PayloadCheckQParserPlugin, PayloadScoreQParserPlugin, PrefixQParserPlugin, RawQParserPlugin, ReRankQParserPlugin, ScoreJoinQParserPlugin, SignificantTermsQParserPlugin, SimpleQParserPlugin, SpatialFilterQParserPlugin, SurroundQParserPlugin, SwitchQParserPlugin, TermQParserPlugin, TermsQParserPlugin, TextLogisticRegressionQParserPlugin, XmlQParserPlugin

public abstract class QParserPlugin
extends Object
implements NamedListInitializedPlugin, SolrInfoBean

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_QTYPE internal use - name of the default parser
static Map<String,QParserPlugin>	standardPlugins Internal use - name to parser for the builtin parsers.

Constructor Summary

Constructors

Constructor and Description
QParserPlugin()

Method Summary

Modifier and Type	Method and Description
abstract QParser	createParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req) return a QParser
SolrInfoBean.Category	getCategory() Category of this component
String	getDescription() Simple one or two line description
Set<String>	getMetricNames() Modifiable set of metric names that this component reports (default is null, which means none).
String	getName() Simple common usage name, e.g.
void	init(NamedList args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getMetricRegistry, getMetricsSnapshot, registerMetricName

Field Detail

DEFAULT_QTYPE

public static final String DEFAULT_QTYPE

internal use - name of the default parser

See Also:

Constant Field Values

standardPlugins

public static final Map<String,QParserPlugin> standardPlugins

Internal use - name to parser for the builtin parsers. Each query parser plugin extending QParserPlugin has own instance of standardPlugins. This leads to cyclic dependencies of static fields and to case when NAME field is not yet initialized. This result to NPE during initialization. For every plugin, listed here, NAME field has to be final and static.

Constructor Detail

QParserPlugin

public QParserPlugin()

Method Detail

createParser

public abstract QParser createParser(String qstr,
                                     SolrParams localParams,
                                     SolrParams params,
                                     SolrQueryRequest req)

return a QParser

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

getName

public String getName()

Description copied from interface: SolrInfoBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

Specified by:

getName in interface SolrInfoBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

getMetricNames

public Set<String> getMetricNames()

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean