Class DistanceValueSource

An implementation of the Lucene Lucene.Net.Queries.Function.ValueSource model that returns the distance for a PointVectorStrategy.

Note

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

Inheritance

System.Object

Lucene.Net.Queries.Function.ValueSource

DistanceValueSource

Inherited Members

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

Lucene.Net.Queries.Function.ValueSource.CreateWeight(System.Collections.IDictionary, Lucene.Net.Search.IndexSearcher)

Lucene.Net.Queries.Function.ValueSource.NewContext(Lucene.Net.Search.IndexSearcher)

Lucene.Net.Queries.Function.ValueSource.GetSortField(System.Boolean)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Spatial.Vector

Assembly: Lucene.Net.Spatial.dll

Syntax

public class DistanceValueSource : ValueSource

Constructors

DistanceValueSource(PointVectorStrategy, IPoint, Double)

Constructor.

Declaration

public DistanceValueSource(PointVectorStrategy strategy, IPoint from, double multiplier)

Parameters

Type	Name	Description
PointVectorStrategy	strategy
Spatial4n.Shapes.IPoint	from
System.Double	multiplier

Exceptions

Type	Condition
System.ArgumentNullException	strategy or from is null.

Methods

Equals(Object)

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
System.Object	o

Returns

Type	Description
System.Boolean

Overrides

Lucene.Net.Queries.Function.ValueSource.Equals(System.Object)

GetDescription()

Returns the Lucene.Net.Queries.Function.ValueSource description.

Declaration

public override string GetDescription()

Returns

Type	Description
System.String

Overrides

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

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

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

GetValues(IDictionary, AtomicReaderContext)

Returns the Lucene.Net.Queries.Function.FunctionValues used by the function query.

Declaration

public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)

Parameters

Type	Name	Description
System.Collections.IDictionary	context
Lucene.Net.Index.AtomicReaderContext	readerContext

Returns

Type	Description
Lucene.Net.Queries.Function.FunctionValues

Overrides

Lucene.Net.Queries.Function.ValueSource.GetValues(System.Collections.IDictionary, Lucene.Net.Index.AtomicReaderContext)