Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | List of all members
Lucene.Net.Search.Function.DocValues Class Referenceabstract

Expert: represents field values as different types. Normally created via a ValueSuorce for a particular field and reader. More...

Inherited by Lucene.Net.Search.Function.ByteFieldSource.AnonymousClassDocValues, Lucene.Net.Search.Function.FloatFieldSource.AnonymousClassDocValues, Lucene.Net.Search.Function.IntFieldSource.AnonymousClassDocValues, Lucene.Net.Search.Function.OrdFieldSource.AnonymousClassDocValues, Lucene.Net.Search.Function.ReverseOrdFieldSource.AnonymousClassDocValues, Lucene.Net.Search.Function.ShortFieldSource.AnonymousClassDocValues, Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource.BBoxSimilarityValueSourceDocValues, Lucene.Net.Spatial.Util.CachingDoubleValueSource.CachingDoubleDocValue, Lucene.Net.Spatial.Util.ReciprocalFloatFunction.FloatDocValues, Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.CachedDistanceDocValues, and Lucene.Net.Spatial.Vector.DistanceValueSource.DistanceDocValues.

Public Member Functions

abstract float FloatVal (int doc)
 Return doc value as a float. Mandatory: every DocValues implementation must implement at least this method.
 
virtual int IntVal (int doc)
 Return doc value as an int. Optional: DocValues implementation can (but don't have to) override this method.
 
virtual long LongVal (int doc)
 Return doc value as a long. Optional: DocValues implementation can (but don't have to) override this method.
 
virtual double DoubleVal (int doc)
 Return doc value as a double. Optional: DocValues implementation can (but don't have to) override this method.
 
virtual System.String StrVal (int doc)
 Return doc value as a string. Optional: DocValues implementation can (but don't have to) override this method.
 
abstract System.String ToString (int doc)
 Return a string representation of a doc value, as reuired for Explanations.
 
virtual Explanation Explain (int doc)
 Explain the scoring value for the input doc.
 
virtual float GetMinValue ()
 Returns the minimum of all values or Float.NaN if this DocValues instance does not contain any value. This operation is optional
 
virtual float GetMaxValue ()
 Returns the maximum of all values or Float.NaN if this DocValues instance does not contain any value. This operation is optional
 
virtual float GetAverageValue ()
 Returns the average of all values or Float.NaN if this DocValues instance does not contain any value. * This operation is optional
 

Detailed Description

Expert: represents field values as different types. Normally created via a ValueSuorce for a particular field and reader.

<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 37 of file DocValues.cs.

Member Function Documentation

virtual double Lucene.Net.Search.Function.DocValues.DoubleVal ( int  doc)
virtual

Return doc value as a double. Optional: DocValues implementation can (but don't have to) override this method.

Parameters
docdocument whose double value is requested.

Reimplemented in Lucene.Net.Spatial.Vector.DistanceValueSource.DistanceDocValues, Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.CachedDistanceDocValues, and Lucene.Net.Spatial.Util.CachingDoubleValueSource.CachingDoubleDocValue.

Definition at line 80 of file DocValues.cs.

virtual Explanation Lucene.Net.Search.Function.DocValues.Explain ( int  doc)
virtual

Explain the scoring value for the input doc.

Definition at line 99 of file DocValues.cs.

abstract float Lucene.Net.Search.Function.DocValues.FloatVal ( int  doc)
pure virtual
virtual float Lucene.Net.Search.Function.DocValues.GetAverageValue ( )
virtual

Returns the average of all values or Float.NaN if this DocValues instance does not contain any value. * This operation is optional

Returns
the average of all values or Float.NaN if this DocValues instance does not contain any value

Definition at line 200 of file DocValues.cs.

virtual float Lucene.Net.Search.Function.DocValues.GetMaxValue ( )
virtual

Returns the maximum of all values or Float.NaN if this DocValues instance does not contain any value. This operation is optional

Returns
the maximum of all values or Float.NaN if this DocValues instance does not contain any value.

Definition at line 183 of file DocValues.cs.

virtual float Lucene.Net.Search.Function.DocValues.GetMinValue ( )
virtual

Returns the minimum of all values or Float.NaN if this DocValues instance does not contain any value. This operation is optional

Returns
the minimum of all values or Float.NaN if this DocValues instance does not contain any value.

Definition at line 166 of file DocValues.cs.

virtual int Lucene.Net.Search.Function.DocValues.IntVal ( int  doc)
virtual

Return doc value as an int. Optional: DocValues implementation can (but don't have to) override this method.

Parameters
docdocument whose int value is requested.

Definition at line 60 of file DocValues.cs.

virtual long Lucene.Net.Search.Function.DocValues.LongVal ( int  doc)
virtual

Return doc value as a long. Optional: DocValues implementation can (but don't have to) override this method.

Parameters
docdocument whose long value is requested.

Definition at line 70 of file DocValues.cs.

virtual System.String Lucene.Net.Search.Function.DocValues.StrVal ( int  doc)
virtual

Return doc value as a string. Optional: DocValues implementation can (but don't have to) override this method.

Parameters
docdocument whose string value is requested.

Definition at line 90 of file DocValues.cs.

abstract System.String Lucene.Net.Search.Function.DocValues.ToString ( int  doc)
pure virtual

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