## 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.

Nested Class Summary
`static class` `FunctionValues.ValueFiller` Abstraction of the logic required to fill the value of a specified doc into a reusable `MutableValue`.

Constructor Summary
`FunctionValues()`

Method Summary
`boolean` `boolVal(int doc)`
`boolean` `bytesVal(int doc, BytesRef target)` returns the bytes representation of the string val - TODO: should this return the indexed raw bytes not?
`byte` `byteVal(int doc)`
`void` `byteVal(int doc, byte[] vals)`
`double` `doubleVal(int doc)`
`void` `doubleVal(int doc, double[] vals)`
`boolean` `exists(int doc)` Returns true if there is a value for this document
`Explanation` `explain(int doc)`
`float` `floatVal(int doc)`
`void` `floatVal(int doc, float[] vals)`
`ValueSourceScorer` `getRangeScorer(IndexReader reader, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper)`
`ValueSourceScorer` `getScorer(IndexReader reader)`
`FunctionValues.ValueFiller` `getValueFiller()`
`int` `intVal(int doc)`
`void` `intVal(int doc, int[] vals)`
`long` `longVal(int doc)`
`void` `longVal(int doc, long[] vals)`
`int` `numOrd()`
`Object` `objectVal(int doc)` Native Java Object representation of the value
`int` `ordVal(int doc)`
`short` `shortVal(int doc)`
`void` `shortVal(int doc, short[] vals)`
`String` `strVal(int doc)`
`void` `strVal(int doc, String[] vals)`
`abstract String` `toString(int doc)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### FunctionValues

    public FunctionValues()

Method Detail

### 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()

  WARNING: This API is experimental and might change in incompatible ways in the next release.

### 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)

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.