org.apache.lucene.queries.function

Class IndexReaderFunctions.IndexReaderDoubleValuesSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.queries.function.IndexReaderFunctions.IndexReaderDoubleValuesSource

All Implemented Interfaces:

SegmentCacheable

Enclosing class:

IndexReaderFunctions

private static class IndexReaderFunctions.IndexReaderDoubleValuesSource
extends DoubleValuesSource

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description
private IndexReaderFunctions.ReaderFunction	func

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

SCORES

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IndexReaderDoubleValuesSource(IndexReaderFunctions.ReaderFunction func, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
DoubleValues	getValues(LeafReaderContext ctx, DoubleValues scores) 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.
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 Implementations should assume that this will only be called once.
java.lang.String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

func

private final IndexReaderFunctions.ReaderFunction func

description

private final java.lang.String description

Constructor Detail

IndexReaderDoubleValuesSource

private IndexReaderDoubleValuesSource(IndexReaderFunctions.ReaderFunction func,
                                      java.lang.String description)

Method Detail

getValues

public DoubleValues getValues(LeafReaderContext ctx,
                              DoubleValues scores)
                       throws java.io.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:

java.io.IOException

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 java.io.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(IndexReader) 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:

java.io.IOException

toString

public java.lang.String toString()

Specified by:

toString in class DoubleValuesSource

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class DoubleValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class DoubleValuesSource

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf