org.apache.lucene.spatial.vector

Class DistanceValueSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.spatial.vector.DistanceValueSource

public class DistanceValueSource
extends DoubleValuesSource

A DoubleValuesSource that returns the distance for a PointVectorStrategy.

Field Summary

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

SCORES

Constructor Summary

Constructors

Constructor and Description
DistanceValueSource(PointVectorStrategy strategy, org.locationtech.spatial4j.shape.Point from, double multiplier) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
DoubleValues	getValues(LeafReaderContext readerContext, DoubleValues scores) Returns the FunctionValues used by the function query.
int	hashCode()
boolean	needsScores() Return true if document scores are needed to calculate values
java.lang.String	toString() Returns the ValueSource description.

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

DistanceValueSource

public DistanceValueSource(PointVectorStrategy strategy,
                           org.locationtech.spatial4j.shape.Point from,
                           double multiplier)

Constructor.

Method Detail

toString

public java.lang.String toString()

Returns the ValueSource description.

Specified by:

toString in class DoubleValuesSource

getValues

public DoubleValues getValues(LeafReaderContext readerContext,
                              DoubleValues scores)
                       throws java.io.IOException

Returns the FunctionValues used by the function query.

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