Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Enum Class MappedFieldType.FieldExtractPreference

java.lang.Object

java.lang.Enum<MappedFieldType.FieldExtractPreference>

org.elasticsearch.index.mapper.MappedFieldType.FieldExtractPreference

All Implemented Interfaces:

Serializable, Comparable<MappedFieldType.FieldExtractPreference>, Constable

Enclosing class:

MappedFieldType

public static enum MappedFieldType.FieldExtractPreference
extends Enum<MappedFieldType.FieldExtractPreference>

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOC_VALUES	Load the field from doc-values into a BlockLoader supporting doc-values.
EXTRACT_SPATIAL_BOUNDS	Loads the field by extracting the extent from the binary encoded representation
EXTRACT_SPATIAL_BOUNDS_AND_CENTROID	Loads the field by extracting both the spatial bounds (extent) and the centroid from the binary encoded representation
EXTRACT_SPATIAL_CENTROID	Loads the field by extracting the centroid (location and weight) from the binary encoded representation
NONE	No preference.
STORED	Prefer loading from stored fields like _source because we're loading many fields.

Method Summary

Modifier and Type	Method	Description
MappedFieldType.FieldExtractPreference	getWithSpatialBounds()
MappedFieldType.FieldExtractPreference	getWithSpatialCentroid()
static MappedFieldType.FieldExtractPreference	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MappedFieldType.FieldExtractPreference[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
MappedFieldType.FieldExtractPreference	withDocValues()

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

Enum Constant Details

EXTRACT_SPATIAL_BOUNDS_AND_CENTROID

public static final MappedFieldType.FieldExtractPreference EXTRACT_SPATIAL_BOUNDS_AND_CENTROID

Loads the field by extracting both the spatial bounds (extent) and the centroid from the binary encoded representation

EXTRACT_SPATIAL_BOUNDS

public static final MappedFieldType.FieldExtractPreference EXTRACT_SPATIAL_BOUNDS

Loads the field by extracting the extent from the binary encoded representation

EXTRACT_SPATIAL_CENTROID

public static final MappedFieldType.FieldExtractPreference EXTRACT_SPATIAL_CENTROID

Loads the field by extracting the centroid (location and weight) from the binary encoded representation

DOC_VALUES

public static final MappedFieldType.FieldExtractPreference DOC_VALUES

Load the field from doc-values into a BlockLoader supporting doc-values.

NONE

public static final MappedFieldType.FieldExtractPreference NONE

No preference. Leave the choice of where to load the field from up to the FieldType.

STORED

public static final MappedFieldType.FieldExtractPreference STORED

Prefer loading from stored fields like _source because we're loading many fields. The MappedFieldType can chose a different method to load the field if it needs to.

Method Details

values

public static MappedFieldType.FieldExtractPreference[] 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 MappedFieldType.FieldExtractPreference 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

withDocValues

public MappedFieldType.FieldExtractPreference withDocValues()

getWithSpatialBounds

public MappedFieldType.FieldExtractPreference getWithSpatialBounds()

getWithSpatialCentroid

public MappedFieldType.FieldExtractPreference getWithSpatialCentroid()