Class ShapeFieldCacheDistanceValueSource

An implementation of the Lucene ValueSource that returns the spatial distance between an input point and a document's points in ShapeFieldCacheProvider<T>. The shortest distance is returned if a document has more than one point.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance

object

ValueSource

ShapeFieldCacheDistanceValueSource

Inherited Members

ValueSource.ToString()

ValueSource.CreateWeight(IDictionary, IndexSearcher)

ValueSource.NewContext(IndexSearcher)

ValueSource.GetSortField(bool)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Spatial.Util

Assembly: Lucene.Net.Spatial.dll

Syntax

public class ShapeFieldCacheDistanceValueSource : ValueSource

Constructors

ShapeFieldCacheDistanceValueSource(SpatialContext, ShapeFieldCacheProvider<IPoint>, IPoint, double)

An implementation of the Lucene ValueSource that returns the spatial distance between an input point and a document's points in ShapeFieldCacheProvider<T>. The shortest distance is returned if a document has more than one point.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

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

Parameters

Type	Name	Description
SpatialContext	ctx
ShapeFieldCacheProvider<IPoint>	provider
IPoint	from
double	multiplier

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object? o)

Parameters

Type	Name	Description
object	o

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueSource.Equals(object)

GetDescription()

description of field, used in Explain()

Declaration

public override string GetDescription()

Returns

Type	Description
string

Overrides

Lucene.Net.Queries.Function.ValueSource.GetDescription()

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

Lucene.Net.Queries.Function.ValueSource.GetHashCode()

GetValues(IDictionary, AtomicReaderContext)

Gets the values for this reader and the context that was previously passed to CreateWeight(IDictionary, IndexSearcher)

Declaration

public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)

Parameters

Type	Name	Description
IDictionary	context
AtomicReaderContext	readerContext

Returns

Type	Description
FunctionValues

Overrides

ValueSource.GetValues(IDictionary, AtomicReaderContext)