java.lang.Object

java.lang.Enum<FieldData>

org.elasticsearch.index.fielddata.FieldData

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<FieldData>, java.lang.constant.Constable

public enum FieldData
extends java.lang.Enum<FieldData>

Utility methods, similar to Lucene's DocValues.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Method Summary

Modifier and Type	Method	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 DocValueBits`	`docsWithValue(org.apache.lucene.index.SortedNumericDocValues docValues)`	Returns a `DocValueBits` representing all documents from `docValues` that have a value.
`static DocValueBits`	`docsWithValue(org.apache.lucene.index.SortedSetDocValues docValues)`	Returns a `DocValueBits` representing all documents from `docValues` that have a value.
`static DocValueBits`	`docsWithValue(MultiGeoPointValues pointValues)`	Returns a `DocValueBits` representing all documents from `pointValues` that have a value.
`static DocValueBits`	`docsWithValue(SortedBinaryDocValues values)`	Returns a `DocValueBits` representing all documents from `values` that have a value.
`static DocValueBits`	`docsWithValue(SortedNumericDoubleValues doubleValues)`	Returns a `DocValueBits` representing all documents from `doubleValues` that have a value.
`static GeoPointValues`	`emptyGeoPoint()`
`static MultiGeoPointValues`	`emptyMultiGeoPoints()`	Return a `SortedNumericDoubleValues` that doesn't contain any value.
`static NumericDoubleValues`	`emptyNumericDouble()`	Return a `NumericDoubleValues` that doesn't contain any value.
`static SortedBinaryDocValues`	`emptySortedBinary()`	Return a `SortedBinaryDocValues` that doesn't contain any value.
`static SortedNumericDoubleValues`	`emptySortedNumericDoubles()`	Return a `SortedNumericDoubleValues` that doesn't contain any value.
`static boolean`	`isMultiValued(org.apache.lucene.index.SortedSetDocValues values)`	Returns whether the provided values might be multi-valued.
`static org.apache.lucene.index.NumericDocValues`	`replaceMissing(org.apache.lucene.index.NumericDocValues 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.
`static NumericDoubleValues`	`replaceMissing(NumericDoubleValues values, double missing)`	Return a `NumericDoubleValues` 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.
`static SortedBinaryDocValues`	`singleton(org.apache.lucene.index.BinaryDocValues values)`	Returns a multi-valued view over the provided `BinaryDocValues`.
`static MultiGeoPointValues`	`singleton(GeoPointValues values)`	Returns a multi-valued view over the provided `GeoPointValues`.
`static SortedNumericDoubleValues`	`singleton(NumericDoubleValues values)`	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(org.apache.lucene.index.SortedNumericDocValues values)`	Return a `String` representation of the provided values.
`static SortedBinaryDocValues`	`toString(org.apache.lucene.index.SortedSetDocValues values)`	Return a `String` representation of the provided values.
`static SortedBinaryDocValues`	`toString(MultiGeoPointValues 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)`, 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)`, or null.
`static NumericDoubleValues`	`unwrapSingleton(SortedNumericDoubleValues values)`	Returns a single-valued view of the `SortedNumericDoubleValues`, if it was previously wrapped with `DocValues.singleton(NumericDocValues)`, 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details
- values
  
  public static FieldData[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  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()
  
  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()
  
  Return a SortedNumericDoubleValues that doesn't contain any value.
- emptyGeoPoint
  
  public static GeoPointValues emptyGeoPoint()
- emptyMultiGeoPoints
  
  public static MultiGeoPointValues emptyMultiGeoPoints()
  
  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(MultiGeoPointValues 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(org.apache.lucene.index.SortedNumericDocValues docValues)
  
  Returns a DocValueBits representing all documents from docValues 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)
  
  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), or null.
- singleton
  
  public static MultiGeoPointValues singleton(GeoPointValues values)
  
  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), or null.
- 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.
- 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.
- 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.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 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!
- replaceMissing
  
  public static org.apache.lucene.index.NumericDocValues replaceMissing(org.apache.lucene.index.NumericDocValues 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 NumericDoubleValues replaceMissing(NumericDoubleValues values, double missing)
  
  Return a NumericDoubleValues 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.

Enum FieldData

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Method Details