lux.solr

Class XQueryComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.QueryComponent

lux.solr.XQueryComponent

All Implemented Interfaces:

org.apache.solr.core.SolrInfoMBean, org.apache.solr.util.plugin.NamedListInitializedPlugin, org.apache.solr.util.plugin.SolrCoreAware

Direct Known Subclasses:

AppServerComponent

public class XQueryComponent
extends org.apache.solr.handler.component.QueryComponent
implements org.apache.solr.util.plugin.SolrCoreAware

This component executes searches expressed as XPath or XQuery. Its queries will match documents that have been indexed using XmlIndexer.

Nested Class Summary

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

org.apache.solr.core.SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	fields
static String	LUX_PATH_INFO
static String	LUX_XQUERY
protected String	queryPath
protected org.apache.solr.handler.component.SearchHandler	searchHandler
protected SolrIndexConfig	solrIndexConfig
static String	XQUERY_COMPONENT_NAME

Fields inherited from class org.apache.solr.handler.component.QueryComponent

COMPONENT_NAME

Constructor Summary

Constructors

Constructor and Description
XQueryComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addResult(org.apache.solr.common.util.NamedList<Object> xpathResults, net.sf.saxon.s9api.XdmItem item)
int	distributedProcess(org.apache.solr.handler.component.ResponseBuilder rb) Process for a distributed search.
protected void	doCommit()
protected void	evaluateQuery(org.apache.solr.handler.component.ResponseBuilder rb, int start, int len)
protected net.sf.saxon.om.FingerprintedQName	fQNameFor(String prefix, String namespace, String name)
org.apache.solr.core.SolrCore	getCore()
String[]	getCurrentShards()
String[]	getCurrentSlices()
String	getDefaultSerialization()
String	getDescription()
Evaluator	getEvaluator()
org.apache.solr.handler.component.SearchHandler	getSearchHandler()
ArrayList<String>	getShardURLs(boolean includeSelf)
SolrIndexConfig	getSolrIndexConfig()
String	getSource()
String	getVersion()
void	inform(org.apache.solr.core.SolrCore solrCore)
void	prepare(org.apache.solr.handler.component.ResponseBuilder rb)
void	process(org.apache.solr.handler.component.ResponseBuilder rb)
protected net.sf.saxon.s9api.QName	qnameFor(String localName)
protected net.sf.saxon.s9api.QName	qnameFor(String namespace, String localName)
protected String	safeAddResult(org.apache.solr.common.util.NamedList<Object> xpathResults, net.sf.saxon.s9api.XdmItem item)

Methods inherited from class org.apache.solr.handler.component.QueryComponent

doFieldSortValues, doPrefetch, finishStage, getDocs, handleResponses

Methods inherited from class org.apache.solr.handler.component.SearchComponent

getCategory, getName, getStatistics, init, modifyRequest, setName

Methods inherited from class java.lang.Object

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

Field Detail

LUX_XQUERY

public static final String LUX_XQUERY

See Also:

Constant Field Values

LUX_PATH_INFO

public static final String LUX_PATH_INFO

See Also:

Constant Field Values

fields

protected Set<String> fields

solrIndexConfig

protected SolrIndexConfig solrIndexConfig

searchHandler

protected org.apache.solr.handler.component.SearchHandler searchHandler

queryPath

protected String queryPath

XQUERY_COMPONENT_NAME

public static final String XQUERY_COMPONENT_NAME

See Also:

Constant Field Values

Constructor Detail

XQueryComponent

public XQueryComponent()

Method Detail

inform

public void inform(org.apache.solr.core.SolrCore solrCore)

Specified by:

inform in interface org.apache.solr.util.plugin.SolrCoreAware

prepare

public void prepare(org.apache.solr.handler.component.ResponseBuilder rb)
             throws IOException

Overrides:

prepare in class org.apache.solr.handler.component.QueryComponent

Throws:

IOException

getShardURLs

public ArrayList<String> getShardURLs(boolean includeSelf)

getDefaultSerialization

public String getDefaultSerialization()

process

public void process(org.apache.solr.handler.component.ResponseBuilder rb)
             throws IOException

Overrides:

process in class org.apache.solr.handler.component.QueryComponent

Throws:

IOException

distributedProcess

public int distributedProcess(org.apache.solr.handler.component.ResponseBuilder rb)
                       throws IOException

Process for a distributed search. This method is called at various stages during the processing of a request: During ResponseBuilder.STAGE_PARSE_QUERY we parse, optimize, compile and execute the XQuery query. When a lux:search call is encountered, it will create a SearchResultIterator, which creates a Lucene Query and calls back into the SearchHandler; then subsequent phases are handled by the normal QueryComponent.

Overrides:

distributedProcess in class org.apache.solr.handler.component.QueryComponent

Returns:

the next stage for this component

Throws:

IOException

evaluateQuery

protected void evaluateQuery(org.apache.solr.handler.component.ResponseBuilder rb,
                 int start,
                 int len)

doCommit

protected void doCommit()

safeAddResult

protected String safeAddResult(org.apache.solr.common.util.NamedList<Object> xpathResults,
                   net.sf.saxon.s9api.XdmItem item)

addResult

protected void addResult(org.apache.solr.common.util.NamedList<Object> xpathResults,
             net.sf.saxon.s9api.XdmItem item)
                  throws net.sf.saxon.s9api.SaxonApiException

Throws:

net.sf.saxon.s9api.SaxonApiException

getSolrIndexConfig

public SolrIndexConfig getSolrIndexConfig()

fQNameFor

protected net.sf.saxon.om.FingerprintedQName fQNameFor(String prefix,
                                           String namespace,
                                           String name)

qnameFor

protected net.sf.saxon.s9api.QName qnameFor(String namespace,
                                String localName)

qnameFor

protected net.sf.saxon.s9api.QName qnameFor(String localName)

getCore

public org.apache.solr.core.SolrCore getCore()

getEvaluator

public Evaluator getEvaluator()

getSearchHandler

public org.apache.solr.handler.component.SearchHandler getSearchHandler()

getCurrentShards

public String[] getCurrentShards()

getCurrentSlices

public String[] getCurrentSlices()

getDescription

public String getDescription()

Specified by:

getDescription in interface org.apache.solr.core.SolrInfoMBean

Overrides:

getDescription in class org.apache.solr.handler.component.QueryComponent

getSource

public String getSource()

Specified by:

getSource in interface org.apache.solr.core.SolrInfoMBean

Overrides:

getSource in class org.apache.solr.handler.component.QueryComponent

getVersion

public String getVersion()

Specified by:

getVersion in interface org.apache.solr.core.SolrInfoMBean

Overrides:

getVersion in class org.apache.solr.handler.component.SearchComponent