Package org.apache.lucene.search.function

Class DocValues

  • public abstract class DocValues
extends Object
    Expert: represents field values as different types. Normally created via a ValueSuorce for a particular field and reader.
    WARNING: This API is experimental and might change in incompatible ways in the next release.

    • Constructor Detail

      • DocValues

        public DocValues()

    • Method Detail

      • floatVal

        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.

      • intVal

        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.

      • longVal

        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.

      • doubleVal

        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.

      • strVal

        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.

      • toString

        public abstract String toString​(int doc)
        Return a string representation of a doc value, as required for Explanations.

      • explain

        public Explanation explain​(int doc)
        Explain the scoring value for the input doc.

      • getMinValue

        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.

      • getMaxValue

        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.

      • getAverageValue

        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