java.lang.Object | |
↳ | org.apache.lucene.search.function.DocValues |
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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return doc value as a double.
| |||||||||||
Explain the scoring value for the input doc.
| |||||||||||
Return doc value as a float.
| |||||||||||
Returns the average of all values or
Float.NaN if this
DocValues instance does not contain any value. | |||||||||||
Returns the maximum of all values or
Float.NaN if this
DocValues instance does not contain any value. | |||||||||||
Returns the minimum of all values or
Float.NaN if this
DocValues instance does not contain any value. | |||||||||||
Return doc value as an int.
| |||||||||||
Return doc value as a long.
| |||||||||||
Return doc value as a string.
| |||||||||||
Return a string representation of a doc value, as required for Explanations.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Return doc value as a double.
Optional: DocValues implementation can (but don't have to) override this method.
doc | document whose double value is requested. |
---|
Return doc value as a float.
Mandatory: every DocValues implementation must implement at least this method.
doc | document whose float value is requested. |
---|
Returns the average of all values or Float.NaN
if this
DocValues instance does not contain any value. *
This operation is optional
Float.NaN
if this
DocValues instance does not contain any value
Returns the maximum of all values or Float.NaN
if this
DocValues instance does not contain any value.
This operation is optional
Float.NaN
if this
DocValues instance does not contain any value.
Returns the minimum of all values or Float.NaN
if this
DocValues instance does not contain any value.
This operation is optional
Float.NaN
if this
DocValues instance does not contain any value.
Return doc value as an int.
Optional: DocValues implementation can (but don't have to) override this method.
doc | document whose int value is requested. |
---|
Return doc value as a long.
Optional: DocValues implementation can (but don't have to) override this method.
doc | document whose long value is requested. |
---|
Return doc value as a string.
Optional: DocValues implementation can (but don't have to) override this method.
doc | document whose string value is requested. |
---|
Return a string representation of a doc value, as required for Explanations.