Package org.apache.lucene.spatial.util

Class ShapeFieldCacheDistanceValueSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.spatial.util.ShapeFieldCacheDistanceValueSource

All Implemented Interfaces:

SegmentCacheable

public class ShapeFieldCacheDistanceValueSource
extends DoubleValuesSource

A DoubleValuesSource that returns the spatial distance between an input point and a document's points in ShapeFieldCacheProvider. The shortest distance is returned if a document has more than one point.

Field Summary

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

SCORES

Constructor Summary

Constructors

Constructor	Description
ShapeFieldCacheDistanceValueSource(SpatialContext ctx, ShapeFieldCacheProvider<Point> provider, Point from, double multiplier)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DoubleValues	getValues(LeafReaderContext readerContext, 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.
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

Constructor Detail

ShapeFieldCacheDistanceValueSource

public ShapeFieldCacheDistanceValueSource(SpatialContext ctx,
                                          ShapeFieldCacheProvider<Point> provider,
                                          Point from,
                                          double multiplier)

Method Detail

toString

public String toString()

Specified by:

toString in class DoubleValuesSource

getValues

public DoubleValues getValues(LeafReaderContext readerContext,
                              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

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

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf

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(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:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class DoubleValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class DoubleValuesSource