Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class SourceFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.SourceFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class SourceFieldMapper
extends MetadataFieldMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SourceFieldMapper.Builder
static class	SourceFieldMapper.Defaults
static enum	SourceFieldMapper.Mode	The source mode

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MetadataFieldMapper

MetadataFieldMapper.ConfigurableTypeParser, MetadataFieldMapper.FixedTypeParser, MetadataFieldMapper.TypeParser

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper

Mapper.SourceKeepMode

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	DEPRECATION_WARNING
static final Setting<SourceFieldMapper.Mode>	INDEX_MAPPER_SOURCE_MODE_SETTING
static final String	LOSSY_PARAMETERS_ALLOWED_SETTING_NAME
static final String	NAME
static final MetadataFieldMapper.TypeParser	PARSER
static final String	RECOVERY_SOURCE_NAME
static final NodeFeature	REMOVE_SYNTHETIC_SOURCE_ONLY_VALIDATION
static final NodeFeature	SOURCE_MODE_FROM_INDEX_SETTING
static final NodeFeature	SYNTHETIC_SOURCE_COPY_TO_FIX
static final NodeFeature	SYNTHETIC_SOURCE_COPY_TO_INSIDE_OBJECTS_FIX
static final NodeFeature	SYNTHETIC_SOURCE_FALLBACK
static final NodeFeature	SYNTHETIC_SOURCE_STORED_FIELDS_ADVANCE_FIX
static final NodeFeature	SYNTHETIC_SOURCE_WITH_COPY_TO_AND_DOC_VALUES_FALSE_SUPPORT

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

Fields inherited from class org.elasticsearch.index.mapper.Mapper

SYNTHETIC_SOURCE_KEEP_FEATURE, SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
BytesReference	applyFilters(BytesReference originalSource, XContentType contentType)
protected String	contentType()
boolean	enabled()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
boolean	isComplete()
boolean	isDisabled()
boolean	isStored()
static boolean	isStored(IndexSettings indexSettings)
boolean	isSynthetic()
static boolean	isSynthetic(IndexSettings indexSettings)
SourceLoader	newSourceLoader(Mapping mapping, SourceFieldMetrics metrics)	Build something to load source _source.
void	preParse(DocumentParserContext context)	Called before FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.

Methods inherited from class org.elasticsearch.index.mapper.MetadataFieldMapper

parseCreateField, postParse, syntheticSourceSupport, toXContent, updateableBoolParam

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper

checkIncomingMergeType, copyTo, doValidate, doXContentBody, executeScript, fieldType, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

freezeAndDeduplicateFieldType, internFieldName, leafName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

SYNTHETIC_SOURCE_FALLBACK

public static final NodeFeature SYNTHETIC_SOURCE_FALLBACK

SYNTHETIC_SOURCE_STORED_FIELDS_ADVANCE_FIX

public static final NodeFeature SYNTHETIC_SOURCE_STORED_FIELDS_ADVANCE_FIX

SYNTHETIC_SOURCE_WITH_COPY_TO_AND_DOC_VALUES_FALSE_SUPPORT

public static final NodeFeature SYNTHETIC_SOURCE_WITH_COPY_TO_AND_DOC_VALUES_FALSE_SUPPORT

SYNTHETIC_SOURCE_COPY_TO_FIX

public static final NodeFeature SYNTHETIC_SOURCE_COPY_TO_FIX

SYNTHETIC_SOURCE_COPY_TO_INSIDE_OBJECTS_FIX

public static final NodeFeature SYNTHETIC_SOURCE_COPY_TO_INSIDE_OBJECTS_FIX

REMOVE_SYNTHETIC_SOURCE_ONLY_VALIDATION

public static final NodeFeature REMOVE_SYNTHETIC_SOURCE_ONLY_VALIDATION

SOURCE_MODE_FROM_INDEX_SETTING

public static final NodeFeature SOURCE_MODE_FROM_INDEX_SETTING

NAME

public static final String NAME

See Also:

• Constant Field Values

RECOVERY_SOURCE_NAME

public static final String RECOVERY_SOURCE_NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

LOSSY_PARAMETERS_ALLOWED_SETTING_NAME

public static final String LOSSY_PARAMETERS_ALLOWED_SETTING_NAME

See Also:

• Constant Field Values

INDEX_MAPPER_SOURCE_MODE_SETTING

public static final Setting<SourceFieldMapper.Mode> INDEX_MAPPER_SOURCE_MODE_SETTING

DEPRECATION_WARNING

public static final String DEPRECATION_WARNING

See Also:

• Constant Field Values

PARSER

public static final MetadataFieldMapper.TypeParser PARSER

Method Details

enabled

public boolean enabled()

isComplete

public boolean isComplete()

preParse

public void preParse(DocumentParserContext context)
              throws IOException

Description copied from class: MetadataFieldMapper

Called before FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.

Overrides:

preParse in class MetadataFieldMapper

Throws:

IOException

applyFilters

@Nullable
public BytesReference applyFilters(@Nullable
 BytesReference originalSource,
 @Nullable
 XContentType contentType)
                            throws IOException

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Overrides:

getMergeBuilder in class MetadataFieldMapper

newSourceLoader

public SourceLoader newSourceLoader(Mapping mapping,
 SourceFieldMetrics metrics)

Build something to load source _source.

isSynthetic

public boolean isSynthetic()

isSynthetic

public static boolean isSynthetic(IndexSettings indexSettings)

isStored

public static boolean isStored(IndexSettings indexSettings)

isDisabled

public boolean isDisabled()

isStored

public boolean isStored()