public abstract class

DocValues

extends Object
java.lang.Object
   ↳ org.apache.lucene.search.function.DocValues

Class Overview

Expert: represents field values as different types. Normally created via a ValueSuorce 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.

Summary

Public Constructors
DocValues()
Public Methods
double doubleVal(int doc)
Return doc value as a double.
Explanation explain(int doc)
Explain the scoring value for the input doc.
abstract float floatVal(int doc)
Return doc value as a float.
float getAverageValue()
Returns the average of all values or Float.NaN if this DocValues instance does not contain any value.
float getMaxValue()
Returns the maximum of all values or Float.NaN if this DocValues instance does not contain any value.
float getMinValue()
Returns the minimum of all values or Float.NaN if this DocValues instance does not contain any value.
int intVal(int doc)
Return doc value as an int.
long longVal(int doc)
Return doc value as a long.
String strVal(int doc)
Return doc value as a string.
abstract String toString(int doc)
Return a string representation of a doc value, as required for Explanations.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DocValues ()

Public Methods

public double doubleVal (int doc)

Return doc value as a double.

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

Parameters
doc document whose double value is requested.

public Explanation explain (int doc)

Explain the scoring value for the input doc.

public abstract float floatVal (int doc)

Return doc value as a float.

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

Parameters
doc document whose float value is requested.

public float getAverageValue ()

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

public float getMaxValue ()

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.

public float getMinValue ()

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.

public int intVal (int doc)

Return doc value as an int.

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

Parameters
doc document whose int value is requested.

public long longVal (int doc)

Return doc value as a long.

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

Parameters
doc document whose long value is requested.

public String strVal (int doc)

Return doc value as a string.

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

Parameters
doc document whose string value is requested.

public abstract String toString (int doc)

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