Package org.apache.lucene.search.join

Class ToChildBlockJoinQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.join.ToChildBlockJoinQuery

public class ToChildBlockJoinQuery
extends Query

Just like ToParentBlockJoinQuery, except this query joins in reverse: you provide a Query matching parent documents and it joins down to child documents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ToChildBlockJoinQuery.ToChildBlockJoinScorer
private static class	ToChildBlockJoinQuery.ToChildBlockJoinWeight

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	ILLEGAL_ADVANCE_ON_PARENT
(package private) static java.lang.String	INVALID_QUERY_MESSAGE	Message thrown from ToChildBlockJoinQuery.ToChildBlockJoinScorer.validateParentDoc() on misuse, when the parent query incorrectly returns child docs.
private Query	parentQuery
private BitSetProducer	parentsFilter

Constructor Summary

Constructors

Constructor	Description
ToChildBlockJoinQuery(Query parentQuery, BitSetProducer parentsFilter)	Create a ToChildBlockJoinQuery.

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(java.lang.Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(ToChildBlockJoinQuery other)
Query	getParentQuery()	Return our parent query.
int	hashCode()	Override and implement query hash code properly in a subclass.
Query	rewrite(IndexReader reader)	Expert: called to re-write queries into primitive queries.
java.lang.String	toString(java.lang.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 Detail

INVALID_QUERY_MESSAGE

static final java.lang.String INVALID_QUERY_MESSAGE

Message thrown from ToChildBlockJoinQuery.ToChildBlockJoinScorer.validateParentDoc() on misuse, when the parent query incorrectly returns child docs.

See Also:

Constant Field Values

ILLEGAL_ADVANCE_ON_PARENT

static final java.lang.String ILLEGAL_ADVANCE_ON_PARENT

See Also:

Constant Field Values

parentsFilter

private final BitSetProducer parentsFilter

parentQuery

private final Query parentQuery

Constructor Detail

ToChildBlockJoinQuery

public ToChildBlockJoinQuery(Query parentQuery,
                             BitSetProducer parentsFilter)

Create a ToChildBlockJoinQuery.

Parameters:

parentQuery - Query that matches parent documents

parentsFilter - Filter identifying the parent documents.

Method Detail

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries

Overrides:

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 java.io.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

scoreMode - How the produced scorers will be consumed.

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

Throws:

java.io.IOException

getParentQuery

public Query getParentQuery()

Return our parent query.

rewrite

public Query rewrite(IndexReader reader)
              throws java.io.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.

Overrides:

rewrite in class Query

Throws:

java.io.IOException

toString

public java.lang.String toString(java.lang.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

equals

public boolean equals(java.lang.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 that 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(ToChildBlockJoinQuery other)

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)