Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Enum Class IgnoredSourceFieldMapper.IgnoredSourceFormat

java.lang.Object

java.lang.Enum<IgnoredSourceFieldMapper.IgnoredSourceFormat>

org.elasticsearch.index.mapper.IgnoredSourceFieldMapper.IgnoredSourceFormat

All Implemented Interfaces:

Serializable, Comparable<IgnoredSourceFieldMapper.IgnoredSourceFormat>, Constable

Enclosing class:

IgnoredSourceFieldMapper

public static enum IgnoredSourceFieldMapper.IgnoredSourceFormat
extends Enum<IgnoredSourceFieldMapper.IgnoredSourceFormat>

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
COALESCED_SINGLE_IGNORED_SOURCE
DOC_VALUES_IGNORED_SOURCE
LEGACY_SINGLE_IGNORED_SOURCE
NO_IGNORED_SOURCE

Method Summary

Modifier and Type	Method	Description
abstract org.apache.lucene.util.BytesRef	filterValue(org.apache.lucene.util.BytesRef value, Function<Map<String,Object>,Map<String,Object>> filter)
abstract Map<String,List<IgnoredSourceFieldMapper.NameValue>>	loadIgnoredFields(SourceFilter filter, Map<String,List<Object>> storedFields, int docId, MultiValuedSortedBinaryDocValues docValues)	Loads ignored-source entries for the given document, grouped by parent field name.
static IgnoredSourceFieldMapper.IgnoredSourceFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IgnoredSourceFieldMapper.IgnoredSourceFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
abstract void	writeIgnoredFields(Collection<IgnoredSourceFieldMapper.NameValue> ignoredFieldValues)

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

NO_IGNORED_SOURCE

public static final IgnoredSourceFieldMapper.IgnoredSourceFormat NO_IGNORED_SOURCE

LEGACY_SINGLE_IGNORED_SOURCE

public static final IgnoredSourceFieldMapper.IgnoredSourceFormat LEGACY_SINGLE_IGNORED_SOURCE

COALESCED_SINGLE_IGNORED_SOURCE

public static final IgnoredSourceFieldMapper.IgnoredSourceFormat COALESCED_SINGLE_IGNORED_SOURCE

DOC_VALUES_IGNORED_SOURCE

public static final IgnoredSourceFieldMapper.IgnoredSourceFormat DOC_VALUES_IGNORED_SOURCE

Method Details

values

public static IgnoredSourceFieldMapper.IgnoredSourceFormat[] 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 IgnoredSourceFieldMapper.IgnoredSourceFormat 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

loadIgnoredFields

public abstract Map<String,List<IgnoredSourceFieldMapper.NameValue>> loadIgnoredFields(SourceFilter filter,
 Map<String,List<Object>> storedFields,
 int docId,
 MultiValuedSortedBinaryDocValues docValues)
                                                                                throws IOException

Loads ignored-source entries for the given document, grouped by parent field name.

Parameters:

filter - optional path filter; filtered paths are excluded from the result

storedFields - pre-loaded stored fields for the document (used by stored-field-based formats)

docId - the Lucene doc ID within the current leaf

docValues - doc values instance for accessing ignored source (used by doc-values-based formats)

Returns:

map from parent field name to list of IgnoredSourceFieldMapper.NameValue, or an empty map when no entries exist

Throws:

IOException

writeIgnoredFields

public abstract void writeIgnoredFields(Collection<IgnoredSourceFieldMapper.NameValue> ignoredFieldValues)

filterValue

public abstract org.apache.lucene.util.BytesRef filterValue(org.apache.lucene.util.BytesRef value,
 Function<Map<String,Object>,Map<String,Object>> filter)
                                                     throws IOException

Throws:

IOException