Package org.apache.lucene.queries.function

Class FunctionValues

java.lang.Object
org.apache.lucene.queries.function.FunctionValues
Direct Known Subclasses:
BoolDocValues, DocTermsIndexDocValues, DoubleDocValues, FloatDocValues, IntDocValues, LongDocValues, MultiFunction.Values, StrDocValues
public abstract class FunctionValues extends Object
Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

  • Constructor Details

    • FunctionValues

      public FunctionValues()

  • Method Details

    • byteVal

      public byte byteVal(int doc)

    • shortVal

      public short shortVal(int doc)

    • floatVal

      public float floatVal(int doc)

    • intVal

      public int intVal(int doc)

    • longVal

      public long longVal(int doc)

    • doubleVal

      public double doubleVal(int doc)

    • strVal

      public String strVal(int doc)

    • boolVal

      public boolean boolVal(int doc)

    • bytesVal

      public boolean bytesVal(int doc, BytesRef target)
      returns the bytes representation of the string val - TODO: should this return the indexed raw bytes not?

    • objectVal

      public Object objectVal(int doc)
      Native Java Object representation of the value

    • exists

      public boolean exists(int doc)
      Returns true if there is a value for this document

    • ordVal

      public int ordVal(int doc)
      Parameters:
      doc - The doc to retrieve to sort ordinal for
      Returns:
      the sort ordinal for the specified doc TODO: Maybe we can just use intVal for this...

    • numOrd

      public int numOrd()
      Returns:
      the number of unique sort ordinals this instance has

    • toString

      public abstract String toString(int doc)

    • getValueFiller

      public FunctionValues.ValueFiller getValueFiller()

    • byteVal

      public void byteVal(int doc, byte[] vals)

    • shortVal

      public void shortVal(int doc, short[] vals)

    • floatVal

      public void floatVal(int doc, float[] vals)

    • intVal

      public void intVal(int doc, int[] vals)

    • longVal

      public void longVal(int doc, long[] vals)

    • doubleVal

      public void doubleVal(int doc, double[] vals)

    • strVal

      public void strVal(int doc, String[] vals)

    • explain

      public Explanation explain(int doc)

    • getScorer

      public ValueSourceScorer getScorer(IndexReader reader)

    • getRangeScorer

      public ValueSourceScorer getRangeScorer(IndexReader reader, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper)