FieldData (core 5.6.7 API)

java.lang.Object
- java.lang.Enum<FieldData>
- - org.elasticsearch.index.fielddata.FieldData

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FieldData>
```
public enum FieldData
extends java.lang.Enum<FieldData>
```
Utility methods, similar to Lucene's DocValues.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SortedNumericDoubleValues`	`castToDouble(org.apache.lucene.index.SortedNumericDocValues values)` Wrap the provided `SortedNumericDocValues` instance to cast all values to doubles.
`static org.apache.lucene.index.SortedNumericDocValues`	`castToLong(SortedNumericDoubleValues values)` Wrap the provided `SortedNumericDoubleValues` instance to cast all values to longs.
`static org.apache.lucene.util.Bits`	`docsWithValue(MultiGeoPointValues dv, int maxDoc)` Returns a Bits representing all documents from `dv` that have a value.
`static org.apache.lucene.util.Bits`	`docsWithValue(SortedBinaryDocValues dv, int maxDoc)` Returns a `Bits` representing all documents from `dv` that have a value.
`static org.apache.lucene.util.Bits`	`docsWithValue(SortedNumericDoubleValues dv, int maxDoc)` Returns a Bits representing all documents from `dv` that have a value.
`static GeoPointValues`	`emptyGeoPoint()`
`static MultiGeoPointValues`	`emptyMultiGeoPoints(int maxDoc)` Return a `SortedNumericDoubleValues` that doesn't contain any value.
`static NumericDoubleValues`	`emptyNumericDouble()` Return a `NumericDoubleValues` that doesn't contain any value.
`static SortedBinaryDocValues`	`emptySortedBinary(int maxDoc)` Return a `SortedBinaryDocValues` that doesn't contain any value.
`static SortedNumericDoubleValues`	`emptySortedNumericDoubles(int maxDoc)` Return a `SortedNumericDoubleValues` that doesn't contain any value.
`static boolean`	`isMultiValued(MultiGeoPointValues values)` Returns whether the provided values might be multi-valued.
`static boolean`	`isMultiValued(SortedBinaryDocValues values)` Returns whether the provided values might be multi-valued.
`static boolean`	`isMultiValued(org.apache.lucene.index.SortedNumericDocValues values)` Returns whether the provided values might be multi-valued.
`static boolean`	`isMultiValued(SortedNumericDoubleValues values)` Returns whether the provided values might be multi-valued.
`static boolean`	`isMultiValued(org.apache.lucene.index.SortedSetDocValues values)` Returns whether the provided values might be multi-valued.
`static org.apache.lucene.index.RandomAccessOrds`	`maybeSlowRandomAccessOrds(org.apache.lucene.index.SortedSetDocValues dv)` If `dv` is an instance of `RandomAccessOrds`, then return it, otherwise wrap it into a slow wrapper that implements random access.
`static SortedBinaryDocValues`	`singleton(org.apache.lucene.index.BinaryDocValues values, org.apache.lucene.util.Bits docsWithField)` Returns a multi-valued view over the provided `BinaryDocValues`.
`static MultiGeoPointValues`	`singleton(GeoPointValues values, org.apache.lucene.util.Bits docsWithField)` Returns a multi-valued view over the provided `GeoPointValues`.
`static SortedNumericDoubleValues`	`singleton(NumericDoubleValues values, org.apache.lucene.util.Bits docsWithField)` Returns a multi-valued view over the provided `NumericDoubleValues`.
`static SortedNumericDoubleValues`	`sortableLongBitsToDoubles(org.apache.lucene.index.SortedNumericDocValues values)` Given a `SortedNumericDocValues`, return a `SortedNumericDoubleValues` instance that will translate long values to doubles using `NumericUtils.sortableLongToDouble(long)`.
`static org.apache.lucene.index.SortedNumericDocValues`	`toSortableLongBits(SortedNumericDoubleValues values)` Given a `SortedNumericDoubleValues`, return a `SortedNumericDocValues` instance that will translate double values to sortable long bits using `NumericUtils.doubleToSortableLong(double)`.
`static SortedBinaryDocValues`	`toString(MultiGeoPointValues values)` Return a `String` representation of the provided values.
`static SortedBinaryDocValues`	`toString(org.apache.lucene.index.RandomAccessOrds values)` Return a `String` representation of the provided values.
`static SortedBinaryDocValues`	`toString(org.apache.lucene.index.SortedNumericDocValues values)` Return a `String` representation of the provided values.
`static SortedBinaryDocValues`	`toString(SortedNumericDoubleValues values)` Return a `String` representation of the provided values.
`static GeoPointValues`	`unwrapSingleton(MultiGeoPointValues values)` Returns a single-valued view of the `MultiGeoPointValues`, if it was previously wrapped with `singleton(GeoPointValues, Bits)`, or null.
`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, Bits)`, or null.
`static NumericDoubleValues`	`unwrapSingleton(SortedNumericDoubleValues values)` Returns a single-valued view of the `SortedNumericDoubleValues`, if it was previously wrapped with `DocValues.singleton(NumericDocValues, Bits)`, or null.
`static org.apache.lucene.util.Bits`	`unwrapSingletonBits(MultiGeoPointValues values)` Returns the documents with a value for the `MultiGeoPointValues`, if it was previously wrapped with `singleton(GeoPointValues, Bits)`, or null.
`static org.apache.lucene.util.Bits`	`unwrapSingletonBits(SortedBinaryDocValues values)` Returns the documents with a value for the `SortedBinaryDocValues`, if it was previously wrapped with `singleton(BinaryDocValues, Bits)`, or null.
`static org.apache.lucene.util.Bits`	`unwrapSingletonBits(SortedNumericDoubleValues dv)` Returns the documents with a value for the `SortedNumericDoubleValues`, if it was previously wrapped with `singleton(NumericDoubleValues, Bits)`, or null.
`static FieldData`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static FieldData[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - values
```
public static FieldData[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FieldData c : FieldData.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FieldData valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - emptySortedBinary
```
public static SortedBinaryDocValues emptySortedBinary(int maxDoc)
```
    Return a SortedBinaryDocValues that doesn't contain any value.
  - emptyNumericDouble
```
public static NumericDoubleValues emptyNumericDouble()
```
    Return a NumericDoubleValues that doesn't contain any value.
  - emptySortedNumericDoubles
```
public static SortedNumericDoubleValues emptySortedNumericDoubles(int maxDoc)
```
    Return a SortedNumericDoubleValues that doesn't contain any value.
  - emptyGeoPoint
```
public static GeoPointValues emptyGeoPoint()
```
  - emptyMultiGeoPoints
```
public static MultiGeoPointValues emptyMultiGeoPoints(int maxDoc)
```
    Return a SortedNumericDoubleValues that doesn't contain any value.
  - docsWithValue
```
public static org.apache.lucene.util.Bits docsWithValue(SortedBinaryDocValues dv,
                                                        int maxDoc)
```
    Returns a Bits representing all documents from dv that have a value.
  - docsWithValue
```
public static org.apache.lucene.util.Bits docsWithValue(MultiGeoPointValues dv,
                                                        int maxDoc)
```
    Returns a Bits representing all documents from dv that have a value.
  - docsWithValue
```
public static org.apache.lucene.util.Bits docsWithValue(SortedNumericDoubleValues dv,
                                                        int maxDoc)
```
    Returns a Bits representing all documents from dv that have a value.
  - toSortableLongBits
```
public static org.apache.lucene.index.SortedNumericDocValues 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(org.apache.lucene.index.SortedNumericDocValues values)
```
    Given a SortedNumericDocValues, return a SortedNumericDoubleValues instance that will translate long values to doubles using NumericUtils.sortableLongToDouble(long).
  - castToDouble
```
public static SortedNumericDoubleValues castToDouble(org.apache.lucene.index.SortedNumericDocValues values)
```
    Wrap the provided SortedNumericDocValues instance to cast all values to doubles.
  - castToLong
```
public static org.apache.lucene.index.SortedNumericDocValues castToLong(SortedNumericDoubleValues values)
```
    Wrap the provided SortedNumericDoubleValues instance to cast all values to longs.
  - singleton
```
public static SortedNumericDoubleValues singleton(NumericDoubleValues values,
                                                  org.apache.lucene.util.Bits docsWithField)
```
    Returns a multi-valued view over the provided NumericDoubleValues.
  - unwrapSingleton
```
public static NumericDoubleValues unwrapSingleton(SortedNumericDoubleValues values)
```
    Returns a single-valued view of the SortedNumericDoubleValues, if it was previously wrapped with DocValues.singleton(NumericDocValues, Bits), or null.
    
    See Also:
    
    DocValues.unwrapSingletonBits(SortedNumericDocValues)
  - unwrapSingletonBits
```
public static org.apache.lucene.util.Bits unwrapSingletonBits(SortedNumericDoubleValues dv)
```
    Returns the documents with a value for the SortedNumericDoubleValues, if it was previously wrapped with singleton(NumericDoubleValues, Bits), or null.
  - singleton
```
public static MultiGeoPointValues singleton(GeoPointValues values,
                                            org.apache.lucene.util.Bits docsWithField)
```
    Returns a multi-valued view over the provided GeoPointValues.
  - unwrapSingleton
```
public static GeoPointValues unwrapSingleton(MultiGeoPointValues values)
```
    Returns a single-valued view of the MultiGeoPointValues, if it was previously wrapped with singleton(GeoPointValues, Bits), or null.
    
    See Also:
    
    unwrapSingletonBits(MultiGeoPointValues)
  - unwrapSingletonBits
```
public static org.apache.lucene.util.Bits unwrapSingletonBits(MultiGeoPointValues values)
```
    Returns the documents with a value for the MultiGeoPointValues, if it was previously wrapped with singleton(GeoPointValues, Bits), or null.
  - singleton
```
public static SortedBinaryDocValues singleton(org.apache.lucene.index.BinaryDocValues values,
                                              org.apache.lucene.util.Bits docsWithField)
```
    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, Bits), or null.
    
    See Also:
    
    unwrapSingletonBits(SortedBinaryDocValues)
  - unwrapSingletonBits
```
public static org.apache.lucene.util.Bits unwrapSingletonBits(SortedBinaryDocValues values)
```
    Returns the documents with a value for the SortedBinaryDocValues, if it was previously wrapped with singleton(BinaryDocValues, Bits), or null.
  - isMultiValued
```
public static boolean isMultiValued(org.apache.lucene.index.SortedSetDocValues values)
```
    Returns whether the provided values *might* be multi-valued. There is no guarantee that this method will return false in the single-valued case.
  - isMultiValued
```
public static boolean isMultiValued(org.apache.lucene.index.SortedNumericDocValues values)
```
    Returns whether the provided values *might* be multi-valued. There is no guarantee that this method will return false in the single-valued case.
  - isMultiValued
```
public static boolean isMultiValued(SortedNumericDoubleValues values)
```
    Returns whether the provided values *might* be multi-valued. There is no guarantee that this method will return false in the single-valued case.
  - isMultiValued
```
public static boolean isMultiValued(SortedBinaryDocValues values)
```
    Returns whether the provided values *might* be multi-valued. There is no guarantee that this method will return false in the single-valued case.
  - isMultiValued
```
public static boolean isMultiValued(MultiGeoPointValues values)
```
    Returns whether the provided values *might* be multi-valued. There is no guarantee that this method will return false in the single-valued case.
  - toString
```
public static SortedBinaryDocValues toString(org.apache.lucene.index.SortedNumericDocValues 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 SortedBinaryDocValues toString(org.apache.lucene.index.RandomAccessOrds 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!
  - maybeSlowRandomAccessOrds
```
public static org.apache.lucene.index.RandomAccessOrds maybeSlowRandomAccessOrds(org.apache.lucene.index.SortedSetDocValues dv)
```
    If dv is an instance of RandomAccessOrds, then return it, otherwise wrap it into a slow wrapper that implements random access.

Enum FieldData

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Method Detail

values

valueOf

emptySortedBinary

emptyNumericDouble

emptySortedNumericDoubles

emptyGeoPoint

emptyMultiGeoPoints

docsWithValue

docsWithValue

docsWithValue

toSortableLongBits

sortableLongBitsToDoubles

castToDouble

castToLong

singleton

unwrapSingleton

unwrapSingletonBits

singleton

unwrapSingleton

unwrapSingletonBits

singleton

unwrapSingleton

unwrapSingletonBits

isMultiValued

isMultiValued

isMultiValued

isMultiValued

isMultiValued

toString

toString

toString

toString

maybeSlowRandomAccessOrds