Class DocValues

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

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.

Inheritance
System.Object
DocValues
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public abstract class DocValues : object

Properties

Name Description
InnerArray

Expert: for test purposes only, return the inner array of values, or null if not applicable.

Allows tests to verify that loaded values are:

Note: implementations of DocValues must override this method for these test elements to be tested, Otherwise the test would not fail, just print a warning.

Methods

Name Description
DoubleVal(Int32)

Return doc value as a double.

Optional: DocValues implementation can (but don't have to) override this method.

Explain(Int32)

Explain the scoring value for the input doc.
FloatVal(Int32)

Return doc value as a float.

Mandatory: every DocValues implementation must implement at least this method.

GetAverageValue()

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

This operation is optional

GetMaxValue()

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

This operation is optional

GetMinValue()

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

This operation is optional

IntVal(Int32)

Return doc value as an int.

Optional: DocValues implementation can (but don't have to) override this method.

LongVal(Int32)

Return doc value as a long.

Optional: DocValues implementation can (but don't have to) override this method.

StrVal(Int32)

Return doc value as a string.

Optional: DocValues implementation can (but don't have to) override this method.

ToString(Int32)

Return a string representation of a doc value, as reuired for Explanations.