Package org.apache.solr.search

Class JoinQParserPlugin

java.lang.Object

org.apache.solr.search.QParserPlugin

org.apache.solr.search.JoinQParserPlugin

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, NamedListInitializedPlugin

public class JoinQParserPlugin
extends QParserPlugin

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
JoinQParserPlugin()

Method Summary

Modifier and Type	Method	Description
static org.apache.lucene.search.Query	createJoinQuery(org.apache.lucene.search.Query subQuery, String fromField, String toField, String method)	A helper method for other plugins to create (non-scoring) JoinQueries wrapped around arbitrary queries against the same core.
QParser	createParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req)	return a QParser
void	init(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

JoinQParserPlugin

public JoinQParserPlugin()

Method Detail

init

public void init(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,
                            SolrParams localParams,
                            SolrParams params,
                            SolrQueryRequest req)

Description copied from class: QParserPlugin

return a QParser

Specified by:

createParser in class QParserPlugin

createJoinQuery

public static org.apache.lucene.search.Query createJoinQuery(org.apache.lucene.search.Query subQuery,
                                                             String fromField,
                                                             String toField,
                                                             String method)

A helper method for other plugins to create (non-scoring) JoinQueries wrapped around arbitrary queries against the same core.

Parameters:

subQuery - the query to define the starting set of documents on the "left side" of the join

fromField - "left side" field name to use in the join

toField - "right side" field name to use in the join

method - indicates which implementation should be used to process the join. Currently only 'index', 'dvWithScore', and 'topLevelDV' are supported.