Module org.apache.lucene.facet

Package org.apache.lucene.facet

Class DrillSidewaysQuery<K extends Collector,R>

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.facet.DrillSidewaysQuery<K,R>

class DrillSidewaysQuery<K extends Collector,R>
extends Query

Only purpose is to punch through and return a DrillSidewaysScorer

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Query	baseQuery
(package private) final Query[]	drillDownQueries
(package private) final List<? extends CollectorManager<K,R>>	drillSidewaysCollectorManagers
(package private) final List<List<K>>	managedDrillSidewaysCollectors
(package private) final boolean	scoreSubDocsAtOnce

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DrillSidewaysQuery(Query baseQuery, List<? extends CollectorManager<K,R>> drillSidewaysCollectorManagers, List<List<K>> managedDrillSidewaysCollectors, Query[] drillDownQueries, boolean scoreSubDocsAtOnce)	Needed for Query.rewrite(IndexSearcher).
(package private)	DrillSidewaysQuery(Query baseQuery, List<? extends CollectorManager<K,R>> drillSidewaysCollectorManagers, Query[] drillDownQueries, boolean scoreSubDocsAtOnce)	Construct a new DrillSidewaysQuery that will create new FacetsCollectors for each LeafReaderContext using the provided FacetsCollectorManagers.

Method Summary

Modifier and Type	Method	Description
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(DrillSidewaysQuery<?,?> other)
int	hashCode()	Override and implement query hash code properly in a subclass.
Query	rewrite(IndexSearcher indexSearcher)	Expert: called to re-write queries into primitive queries.
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.
void	visit(QueryVisitor visitor)	Recurse through the query tree, visiting any child queries.

Methods inherited from class org.apache.lucene.search.Query

classHash, sameClassAs, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

baseQuery

final Query baseQuery

drillSidewaysCollectorManagers

final List<? extends CollectorManager<K extends Collector,R>> drillSidewaysCollectorManagers

managedDrillSidewaysCollectors

final List<List<K extends Collector>> managedDrillSidewaysCollectors

drillDownQueries

final Query[] drillDownQueries

scoreSubDocsAtOnce

final boolean scoreSubDocsAtOnce

Constructor Details

DrillSidewaysQuery

DrillSidewaysQuery(Query baseQuery,
 List<? extends CollectorManager<K,R>> drillSidewaysCollectorManagers,
 Query[] drillDownQueries,
 boolean scoreSubDocsAtOnce)

Construct a new DrillSidewaysQuery that will create new FacetsCollectors for each LeafReaderContext using the provided FacetsCollectorManagers.

DrillSidewaysQuery

private DrillSidewaysQuery(Query baseQuery,
 List<? extends CollectorManager<K,R>> drillSidewaysCollectorManagers,
 List<List<K>> managedDrillSidewaysCollectors,
 Query[] drillDownQueries,
 boolean scoreSubDocsAtOnce)

Needed for Query.rewrite(IndexSearcher). Ensures the same "managed" lists get used since DrillSideways accesses references to these through the original DrillSidewaysQuery.

Method Details

toString

public String toString(String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

rewrite

public Query rewrite(IndexSearcher indexSearcher)
              throws IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Callers are expected to call rewrite multiple times if necessary, until the rewritten query is the same as the original query.

The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

Overrides:

rewrite in class Query

Throws:

IOException

See Also:

• IndexSearcher.rewrite(Query)

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries.

Specified by:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

createWeight

public Weight createWeight(IndexSearcher searcher,
 ScoreMode scoreMode,
 float boost)
                    throws IOException

Description copied from class: Query

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Overrides:

createWeight in class Query

Parameters:

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

IOException

hashCode

public int hashCode()

Description copied from class: Query

Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)

equals

public boolean equals(Object other)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.

Specified by:

equals in class Query

See Also:

• Query.sameClassAs(Object)
• Query.classHash()

equalsTo

private boolean equalsTo(DrillSidewaysQuery<?,?> other)