Module org.elasticsearch.server
Package org.elasticsearch.index.fielddata

Enum Class FieldData

java.lang.Object
java.lang.Enum<FieldData>
org.elasticsearch.index.fielddata.FieldData
All Implemented Interfaces:
Serializable, Comparable<FieldData>, Constable
public enum FieldData extends Enum<FieldData>
Utility methods, similar to Lucene's DocValues.

  • Field Details

    • EMPTY

      public static org.apache.lucene.search.LongValues EMPTY
      A LongValues instance that does not have a value for any document

  • Method Details

    • values

      public static FieldData[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FieldData valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • emptySortedBinary

      public static SortedBinaryDocValues emptySortedBinary()
      Return a SortedBinaryDocValues that doesn't contain any value.

    • emptySortedNumericDoubles

      public static SortedNumericDoubleValues emptySortedNumericDoubles()
      Return a SortedNumericDoubleValues that doesn't contain any value.

    • docsWithValue

      public static DocValueBits docsWithValue(SortedBinaryDocValues values)
      Returns a DocValueBits representing all documents from values that have a value.

    • docsWithValue

      public static DocValueBits docsWithValue(org.apache.lucene.index.SortedSetDocValues docValues)
      Returns a DocValueBits representing all documents from docValues that have a value.

    • docsWithValue

      public static DocValueBits docsWithValue(MultiPointValues<? extends SpatialPoint> pointValues)
      Returns a DocValueBits representing all documents from pointValues that have a value.

    • docsWithValue

      public static DocValueBits docsWithValue(SortedNumericDoubleValues doubleValues)
      Returns a DocValueBits representing all documents from doubleValues that have a value.

    • docsWithValue

      public static DocValueBits docsWithValue(SortedNumericLongValues docValues)
      Returns a DocValueBits representing all documents from docValues that have a value.

    • toSortableLongBits

      public static SortedNumericLongValues toSortableLongBits(SortedNumericDoubleValues values)
      Given a SortedNumericDoubleValues, return a SortedNumericDocValues instance that will translate double values to sortable long bits using NumericUtils.doubleToSortableLong(double).

    • sortableLongBitsToDoubles

      public static SortedNumericDoubleValues sortableLongBitsToDoubles(SortedNumericLongValues values)
      Given a SortedNumericLongValues, return a SortedNumericDoubleValues instance that will translate long values to doubles using NumericUtils.sortableLongToDouble(long).

    • castToDouble

      public static SortedNumericDoubleValues castToDouble(SortedNumericLongValues values)
      Wrap the provided SortedNumericDocValues instance to cast all values to doubles.

    • castToLong

      public static SortedNumericLongValues castToLong(SortedNumericDoubleValues values)
      Wrap the provided SortedNumericDoubleValues instance to cast all values to longs.

    • singleton

      public static SortedNumericDoubleValues singleton(org.apache.lucene.search.DoubleValues values)
      Returns a multi-valued view over the provided DoubleValues.

    • unwrapSingleton

      public static org.apache.lucene.search.DoubleValues unwrapSingleton(SortedNumericDoubleValues values)
      Returns a single-valued view of the SortedNumericDoubleValues, if it was previously wrapped with DocValues.singleton(NumericDocValues), or null.

    • unwrapSingleton

      public static GeoPointValues unwrapSingleton(MultiGeoPointValues values)
      Returns a single-valued view of the MultiGeoPointValues, if the wrapped SortedNumericDocValues is a singleton.

    • singleton

      public static SortedBinaryDocValues singleton(org.apache.lucene.index.BinaryDocValues values)
      Returns a multi-valued view over the provided BinaryDocValues.

    • unwrapSingleton

      public static org.apache.lucene.index.BinaryDocValues unwrapSingleton(SortedBinaryDocValues values)
      Returns a single-valued view of the SortedBinaryDocValues, if it was previously wrapped with singleton(BinaryDocValues), or null.

    • toString

      public static SortedBinaryDocValues toString(SortedNumericLongValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is very slow!

    • toString

      public static org.apache.lucene.index.BinaryDocValues toString(org.apache.lucene.search.LongValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is very slow!

    • toString

      public static SortedBinaryDocValues toString(SortedNumericDoubleValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is very slow!

    • toString

      public static org.apache.lucene.index.BinaryDocValues toString(org.apache.lucene.search.DoubleValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is very slow!

    • toString

      public static SortedBinaryDocValues toString(org.apache.lucene.index.SortedSetDocValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is slow!

    • toString

      public static org.apache.lucene.index.BinaryDocValues toString(org.apache.lucene.index.SortedDocValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is slow!

    • toString

      public static SortedBinaryDocValues toString(MultiGeoPointValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is very slow!

    • toString

      public static org.apache.lucene.index.BinaryDocValues toString(GeoPointValues values)
      Return a String representation of the provided values. That is typically used for scripts or for the `map` execution mode of terms aggs. NOTE: this is very slow!

    • replaceMissing

      public static DenseLongValues replaceMissing(org.apache.lucene.search.LongValues values, long missing)
      Return a NumericDocValues instance that has a value for every document, returns the same value as values if there is a value for the current document and missing otherwise.

    • replaceMissing

      public static DenseDoubleValues replaceMissing(org.apache.lucene.search.DoubleValues values, double missing)
      Return a DoubleValues instance that has a value for every document, returns the same value as values if there is a value for the current document and missing otherwise.