Module org.apache.lucene.core

Package org.apache.lucene.search

Class DoubleValuesSource.WeightDoubleValuesSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.search.DoubleValuesSource.WeightDoubleValuesSource

All Implemented Interfaces:

SegmentCacheable

Enclosing class:

DoubleValuesSource

private static class DoubleValuesSource.WeightDoubleValuesSource
extends DoubleValuesSource

Field Summary

Fields

Modifier and Type	Field	Description
private final Weight	weight

Fields inherited from class org.apache.lucene.search.DoubleValuesSource

SCORES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	WeightDoubleValuesSource(Weight weight)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Explanation	explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)	An explanation of the value for the named document.
DoubleValues	getValues(LeafReaderContext ctx, DoubleValues scores)	Returns a DoubleValues instance for the passed-in LeafReaderContext and scores
int	hashCode()
boolean	isCacheable(LeafReaderContext ctx)
boolean	needsScores()	Return true if document scores are needed to calculate values
DoubleValuesSource	rewrite(IndexSearcher searcher)	Return a DoubleValuesSource specialised for the given IndexSearcher
String	toString()

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

constant, fromDoubleField, fromField, fromFloatField, fromIntField, fromLongField, fromQuery, fromScorer, getSortField, similarityToQueryVector, similarityToQueryVector, toLongValuesSource

Methods inherited from class java.lang.Object

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

Field Details

weight

private final Weight weight

Constructor Details

WeightDoubleValuesSource

private WeightDoubleValuesSource(Weight weight)

Method Details

getValues

public DoubleValues getValues(LeafReaderContext ctx,
 DoubleValues scores)
                       throws IOException

Description copied from class: DoubleValuesSource

Returns a DoubleValues instance for the passed-in LeafReaderContext and scores

If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.

Specified by:

getValues in class DoubleValuesSource

Throws:

IOException

explain

public Explanation explain(LeafReaderContext ctx,
 int docId,
 Explanation scoreExplanation)
                    throws IOException

Description copied from class: DoubleValuesSource

An explanation of the value for the named document.

Overrides:

explain in class DoubleValuesSource

Parameters:

ctx - the readers context to create the Explanation for.

docId - the document's id relative to the given context's reader

Returns:

an Explanation for the value

Throws:

IOException - if an IOException occurs

needsScores

public boolean needsScores()

Description copied from class: DoubleValuesSource

Return true if document scores are needed to calculate values

Specified by:

needsScores in class DoubleValuesSource

rewrite

public DoubleValuesSource rewrite(IndexSearcher searcher)
                           throws IOException

Description copied from class: DoubleValuesSource

Return a DoubleValuesSource specialised for the given IndexSearcher

Implementations should assume that this will only be called once. IndexReader-independent implementations can just return this

Queries that use DoubleValuesSource objects should call rewrite() during Query.createWeight(IndexSearcher, ScoreMode, float) rather than during Query.rewrite(IndexSearcher) to avoid IndexReader reference leakage.

For the same reason, implementations that cache references to the IndexSearcher should return a new object from this method.

Specified by:

rewrite in class DoubleValuesSource

Throws:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class DoubleValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class DoubleValuesSource

toString

public String toString()

Specified by:

toString in class DoubleValuesSource

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf