Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class TermsIncludingScoreQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.join.TermsIncludingScoreQuery

All Implemented Interfaces:

Accountable

class TermsIncludingScoreQuery
extends Query
implements Accountable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	TermsIncludingScoreQuery.MVInOrderScorer
(package private) class	TermsIncludingScoreQuery.SVInOrderScorer

Field Summary

Fields

Modifier and Type	Field	Description
protected static final long	BASE_RAM_BYTES
private final String	fromField
private final Query	fromQuery
private final boolean	multipleValuesPerDocument
private final int[]	ords
private final long	ramBytesUsed
private final ScoreMode	scoreMode
private final float[]	scores
private final BytesRefHash	terms
private final String	toField
private final Object	topReaderContextId

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
TermsIncludingScoreQuery(ScoreMode scoreMode, String toField, boolean multipleValuesPerDocument, BytesRefHash terms, float[] scores, String fromField, Query fromQuery, Object indexReaderContextId)

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(TermsIncludingScoreQuery other)
int	hashCode()	Override and implement query hash code properly in a subclass.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
String	toString(String string)	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, rewrite, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

BASE_RAM_BYTES

protected static final long BASE_RAM_BYTES

scoreMode

private final ScoreMode scoreMode

toField

private final String toField

multipleValuesPerDocument

private final boolean multipleValuesPerDocument

terms

private final BytesRefHash terms

scores

private final float[] scores

ords

private final int[] ords

fromQuery

private final Query fromQuery

fromField

private final String fromField

topReaderContextId

private final Object topReaderContextId

ramBytesUsed

private final long ramBytesUsed

Constructor Details

TermsIncludingScoreQuery

TermsIncludingScoreQuery(ScoreMode scoreMode,
 String toField,
 boolean multipleValuesPerDocument,
 BytesRefHash terms,
 float[] scores,
 String fromField,
 Query fromQuery,
 Object indexReaderContextId)

Method Details

toString

public String toString(String string)

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

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

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

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

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