org.apache.lucene.spatial.util

Class ShapeFieldCacheDistanceValueSource

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.lucene.spatial.util.ShapeFieldCacheDistanceValueSource

public class ShapeFieldCacheDistanceValueSource
extends ValueSource

An implementation of the Lucene ValueSource 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.

Constructor Summary

Constructors

Constructor and Description
ShapeFieldCacheDistanceValueSource(com.spatial4j.core.context.SpatialContext ctx, ShapeFieldCacheProvider<com.spatial4j.core.shape.Point> provider, com.spatial4j.core.shape.Point from, double multiplier)

Method Summary

Modifier and Type	Method and Description
String	description() description of field, used in explain()
boolean	equals(Object o)
FunctionValues	getValues(Map context, LeafReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight()
int	hashCode()

Methods inherited from class org.apache.lucene.queries.function.ValueSource

createWeight, getSortField, newContext, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapeFieldCacheDistanceValueSource

public ShapeFieldCacheDistanceValueSource(com.spatial4j.core.context.SpatialContext ctx,
                                          ShapeFieldCacheProvider<com.spatial4j.core.shape.Point> provider,
                                          com.spatial4j.core.shape.Point from,
                                          double multiplier)

Method Detail

description

public String description()

Description copied from class: ValueSource

description of field, used in explain()

Specified by:

description in class ValueSource

getValues

public FunctionValues getValues(Map context,
                                LeafReaderContext readerContext)
                         throws IOException

Description copied from class: ValueSource

Gets the values for this reader and the context that was previously passed to createWeight()

Specified by:

getValues in class ValueSource

Throws:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class ValueSource

hashCode

public int hashCode()

Specified by:

hashCode in class ValueSource