public abstract class DocValues
extends java.lang.Object
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.
Constructor and Description |
---|
DocValues() |
Modifier and Type | Method and Description |
---|---|
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.
|
float |
getMaxValue()
Optional op.
|
float |
getMinValue()
Optional op.
|
int |
intVal(int doc)
Return doc value as an int.
|
long |
longVal(int doc)
Return doc value as a long.
|
java.lang.String |
strVal(int doc)
Return doc value as a string.
|
abstract java.lang.String |
toString(int doc)
Return a string representation of a doc value, as reuired for Explanations.
|
public abstract float floatVal(int doc)
Mandatory: every DocValues implementation must implement at least this method.
doc
- document whose float value is requested.public int intVal(int doc)
Optional: DocValues implementation can (but don't have to) override this method.
doc
- document whose int value is requested.public long longVal(int doc)
Optional: DocValues implementation can (but don't have to) override this method.
doc
- document whose long value is requested.public double doubleVal(int doc)
Optional: DocValues implementation can (but don't have to) override this method.
doc
- document whose double value is requested.public java.lang.String strVal(int doc)
Optional: DocValues implementation can (but don't have to) override this method.
doc
- document whose string value is requested.public abstract java.lang.String toString(int doc)
public Explanation explain(int doc)
public float getMinValue()
public float getMaxValue()
public float getAverageValue()
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.