Package org.apache.solr.search

Class XmlQParserPlugin

java.lang.Object

org.apache.solr.search.QParserPlugin

org.apache.solr.search.XmlQParserPlugin

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, NamedListInitializedPlugin

public class XmlQParserPlugin
extends QParserPlugin

The XmlQParserPlugin extends the QParserPlugin and supports the creation of queries from XML.

Example:

 <BooleanQuery fieldName="description">
 <Clause occurs="must">
 <TermQuery>shirt</TermQuery>
 </Clause>
 <Clause occurs="mustnot">
 <TermQuery>plain</TermQuery>
 </Clause>
 <Clause occurs="should">
 <TermQuery>cotton</TermQuery>
 </Clause>
 <Clause occurs="must">
 <BooleanQuery fieldName="size">
 <Clause occurs="should">
 <TermsQuery>S M L</TermsQuery>
 </Clause>
 </BooleanQuery>
 </Clause>
 </BooleanQuery>
 

You can configure your own custom query builders for additional XML elements. The custom builders need to extend the SolrQueryBuilder or the SolrSpanQueryBuilder class.

Example solrconfig.xml snippet:

<queryParser name="xmlparser" class="XmlQParserPlugin">
 <str name="MyCustomQuery">com.mycompany.solr.search.MyCustomQueryBuilder</str>
 </queryParser>
 

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	Description
static String	NAME

Fields inherited from class org.apache.solr.search.QParserPlugin

DEFAULT_QTYPE, standardPlugins

Constructor Summary

Constructors

Constructor	Description
XmlQParserPlugin()

Method Summary

Modifier and Type	Method	Description
QParser	createParser(String qstr, org.apache.solr.common.params.SolrParams localParams, org.apache.solr.common.params.SolrParams params, SolrQueryRequest req)	return a QParser
void	init(org.apache.solr.common.util.NamedList<?> args)	init will be called just once, immediately after creation.

Methods inherited from class org.apache.solr.search.QParserPlugin

getCategory, getDescription, getName, getSolrMetricsContext, initializeMetrics

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.metrics.SolrMetricProducer

close

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

XmlQParserPlugin

public XmlQParserPlugin()

Method Detail

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from interface: NamedListInitializedPlugin

init will be called just once, immediately after creation.

Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself

Parameters:

args - non-null list of initialization parameters (may be empty)

createParser

public QParser createParser(String qstr,
                            org.apache.solr.common.params.SolrParams localParams,
                            org.apache.solr.common.params.SolrParams params,
                            SolrQueryRequest req)

Description copied from class: QParserPlugin

return a QParser

Specified by:

createParser in class QParserPlugin