Class DistanceToShapeValueSource

The distance from a provided Point to a Point retrieved from a ValueSource via ObjectVal(int). The distance is calculated via a Spatial4n.Distance.IDistanceCalculator.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

ValueSource

DistanceToShapeValueSource

Inherited Members

ValueSource.ToString()

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 DistanceToShapeValueSource : ValueSource

Constructors

DistanceToShapeValueSource(ValueSource, IPoint, double, SpatialContext)

The distance from a provided Point to a Point retrieved from a ValueSource via ObjectVal(int). The distance is calculated via a Spatial4n.Distance.IDistanceCalculator.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public DistanceToShapeValueSource(ValueSource shapeValueSource, IPoint queryPoint, double multiplier, SpatialContext ctx)

Parameters

Type	Name	Description
ValueSource	shapeValueSource
IPoint	queryPoint
double	multiplier
SpatialContext	ctx

Methods

CreateWeight(IDictionary, IndexSearcher)

Implementations should propagate CreateWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to GetValues() where this info can be retrieved.

Declaration

public override void CreateWeight(IDictionary context, IndexSearcher searcher)

Parameters

Type	Name	Description
IDictionary	context
IndexSearcher	searcher

Overrides

ValueSource.CreateWeight(IDictionary, IndexSearcher)

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)