The DocValues type exposes the following members.

Methods

  NameDescription
Public methodDoubleVal
Return doc value as a double.

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

Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExplain
Explain the scoring value for the input doc.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFloatVal
Return doc value as a float.

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

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

This operation is optional

Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetInnerArray
Expert: for test purposes only, return the inner array of values, or null if not applicable.

Allows tests to verify that loaded values are:

  1. indeed cached/reused.
  2. stored in the expected size/type (byte/short/int/float).
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.
Public methodGetMaxValue
Returns the maximum of all values or
CopyC#
Float.NaN
if this DocValues instance does not contain any value.

This operation is optional

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

This operation is optional

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIntVal
Return doc value as an int.

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

Public methodLongVal
Return doc value as a long.

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

Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStrVal
Return doc value as a string.

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

Public methodToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodToString(Int32)
Return a string representation of a doc value, as reuired for Explanations.

See Also