Expert: source of values for basic function queries. At its default/simplest form, values - one per doc - are used as the score of that doc. Values are instantiated as DocValues for a particular reader. ValueSource implementations differ in RAM requirements: it would always be a factor of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8. More...

Inherited by Lucene.Net.Search.Function.FieldCacheSource, Lucene.Net.Search.Function.OrdFieldSource, Lucene.Net.Search.Function.ReverseOrdFieldSource, Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource, Lucene.Net.Spatial.Util.CachingDoubleValueSource, Lucene.Net.Spatial.Util.ReciprocalFloatFunction, Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource, and Lucene.Net.Spatial.Vector.DistanceValueSource.

Public Member Functions
abstract DocValues	GetValues (IndexReader reader)
	Return the DocValues used by the function query.

abstract System.String	Description ()
	description of field, used in explain()

override System.String	ToString ()

abstract override bool	Equals (System.Object o)
	Needed for possible caching of query results - used by ValueSourceQuery.Equals(Object).

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

Detailed Description

Expert: source of values for basic function queries.

At its default/simplest form, values - one per doc - are used as the score of that doc.

Values are instantiated as DocValues for a particular reader.

ValueSource implementations differ in RAM requirements: it would always be a factor of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.

<font color="#FF0000"> WARNING: The status of the Search.Function package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.</font>

Definition at line 40 of file ValueSource.cs.

Member Function Documentation

abstract System.String Lucene.Net.Search.Function.ValueSource.Description ( )

pure virtual

description of field, used in explain()

abstract override bool Lucene.Net.Search.Function.ValueSource.Equals ( System.Object o )

pure virtual

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

See Also: Object.Equals(Object)

Implemented in Lucene.Net.Search.Function.ReverseOrdFieldSource, Lucene.Net.Search.Function.OrdFieldSource, and Lucene.Net.Search.Function.FieldCacheSource.

abstract override int Lucene.Net.Search.Function.ValueSource.GetHashCode ( )

pure virtual

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

See Also: Object.GetHashCode()

Implemented in Lucene.Net.Search.Function.ReverseOrdFieldSource, Lucene.Net.Search.Function.OrdFieldSource, Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource, Lucene.Net.Spatial.Vector.DistanceValueSource, Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource, Lucene.Net.Spatial.Util.CachingDoubleValueSource, Lucene.Net.Spatial.Util.ReciprocalFloatFunction, and Lucene.Net.Search.Function.FieldCacheSource.

abstract DocValues Lucene.Net.Search.Function.ValueSource.GetValues ( IndexReader reader )

pure 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>

Implemented in Lucene.Net.Search.Function.ReverseOrdFieldSource, Lucene.Net.Search.Function.OrdFieldSource, Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource, Lucene.Net.Spatial.Vector.DistanceValueSource, Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource, Lucene.Net.Spatial.Util.CachingDoubleValueSource, Lucene.Net.Spatial.Util.ReciprocalFloatFunction, and Lucene.Net.Search.Function.FieldCacheSource.

override System.String Lucene.Net.Search.Function.ValueSource.ToString ( )

Definition at line 54 of file ValueSource.cs.

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

core/Search/Function/ValueSource.cs

Public Member Functions

Detailed Description

Member Function Documentation