Lucene.Net.Spatial.Vector.DistanceValueSource Class Reference

An implementation of the Lucene ValueSource model that returns the distance. More...

Inherits Lucene.Net.Search.Function.ValueSource.

Classes
class	DistanceDocValues

Public Member Functions
	DistanceValueSource (PointVectorStrategy strategy, Point from)
override DocValues	GetValues (IndexReader reader)
	Return the DocValues used by the function query.
override string	Description ()
	description of field, used in explain()
override bool	Equals (object o)
override int	GetHashCode ()
	Needed for possible caching of query results - used by ValueSourceQuery.GetHashCode().
Public Member Functions inherited from Lucene.Net.Search.Function.ValueSource
override System.String	ToString ()
abstract override bool	Equals (System.Object o)
	Needed for possible caching of query results - used by ValueSourceQuery.Equals(Object).

Detailed Description

An implementation of the Lucene ValueSource model that returns the distance.

Definition at line 32 of file DistanceValueSource.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Vector.DistanceValueSource.DistanceValueSource	(	PointVectorStrategy	strategy,
		Point	from
	)

Definition at line 37 of file DistanceValueSource.cs.

Member Function Documentation

override string Lucene.Net.Spatial.Vector.DistanceValueSource.Description ( )

virtual

description of field, used in explain()

Implements Lucene.Net.Search.Function.ValueSource.

Definition at line 95 of file DistanceValueSource.cs.

override bool Lucene.Net.Spatial.Vector.DistanceValueSource.Equals

(

object

o

)

Definition at line 100 of file DistanceValueSource.cs.

override int Lucene.Net.Spatial.Vector.DistanceValueSource.GetHashCode ( )

virtual

Needed for possible caching of query results - used by ValueSourceQuery.GetHashCode().

See Also

Object.GetHashCode()

Implements Lucene.Net.Search.Function.ValueSource.

Definition at line 113 of file DistanceValueSource.cs.

override DocValues Lucene.Net.Spatial.Vector.DistanceValueSource.GetValues ( IndexReader  reader )

virtual

Return the DocValues used by the function query.

Parameters

reader

the IndexReader used to read these values. If any caching is involved, that caching would also be IndexReader based.

<throws> IOException for any error. </throws>

Implements Lucene.Net.Search.Function.ValueSource.

Definition at line 90 of file DistanceValueSource.cs.

---

The documentation for this class was generated from the following file:

• contrib/Spatial/Vector/DistanceValueSource.cs