Package org.apache.solr.search
Class XmlQParserPlugin
- java.lang.Object
-
- org.apache.solr.search.QParserPlugin
-
- org.apache.solr.search.XmlQParserPlugin
-
- All Implemented Interfaces:
SolrInfoBean
,NamedListInitializedPlugin
public class XmlQParserPlugin extends QParserPlugin
TheXmlQParserPlugin
extends theQParserPlugin
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 theSolrQueryBuilder
or theSolrSpanQueryBuilder
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QParser
createParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req)
return aQParser
void
init(NamedList args)
-
Methods inherited from class org.apache.solr.search.QParserPlugin
getCategory, getDescription, getMetricNames, getName
-
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
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
init
public void init(NamedList args)
- Specified by:
init
in interfaceNamedListInitializedPlugin
- Overrides:
init
in classQParserPlugin
-
createParser
public QParser createParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req)
Description copied from class:QParserPlugin
return aQParser
- Specified by:
createParser
in classQParserPlugin
-
-