org.apache.lucene.spatial.util

Class DistanceToShapeValueSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.spatial.util.DistanceToShapeValueSource

public class DistanceToShapeValueSource
extends DoubleValuesSource

The distance from a provided Point to a Point retrieved from an ShapeValuesSource. The distance is calculated via a DistanceCalculator.

Field Summary

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

SCORES

Constructor Summary

Constructors

Constructor and Description
DistanceToShapeValueSource(ShapeValuesSource shapeValueSource, org.locationtech.spatial4j.shape.Point queryPoint, double multiplier, org.locationtech.spatial4j.context.SpatialContext ctx)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.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	needsScores() Return true if document scores are needed to calculate values
java.lang.String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DistanceToShapeValueSource

public DistanceToShapeValueSource(ShapeValuesSource shapeValueSource,
                                  org.locationtech.spatial4j.shape.Point queryPoint,
                                  double multiplier,
                                  org.locationtech.spatial4j.context.SpatialContext ctx)

Method Detail

toString

public java.lang.String toString()

Specified by:

toString in class DoubleValuesSource

getValues

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

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class DoubleValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class DoubleValuesSource