java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.ObjectMapper
- All Implemented Interfaces:
Iterable<Mapper>,ToXContent,ToXContentFragment
- Direct Known Subclasses:
NestedObjectMapper,PassThroughObjectMapper,RootObjectMapper
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic enumprotected static final recordstatic enumEnhances the previously boolean option for subobjects support with an intermediate mode `auto` that uses any objects that are present in the mappings and flattens any fields defined outside the predefined objects.static classNested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper
Mapper.SourceKeepModeNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected final ObjectMapper.Dynamicprotected final Optional<Mapper.SourceKeepMode> static final FeatureFlagprotected final Optional<ObjectMapper.Subobjects> Fields inherited from class org.elasticsearch.index.mapper.Mapper
SYNTHETIC_SOURCE_KEEP_FEATURE, SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAMFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptionprotected MapperMergeContextcreateChildContext(MapperMergeContext mapperMergeContext, String name) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) final ObjectMapper.Dynamicdynamic()findParentMapper(String leafFieldPath) fullPath()Returns the canonical name which uniquely identifies the mapper against other mappers in a type.intThe total number of fields as defined in the mapping.booleanbooleanisNested()protected booleanisRoot()iterator()merge(Mapper mergeWith, MapperMergeContext parentMergeContext) Return the merge ofmergeWithinto this.newBuilder(IndexVersion indexVersionCreated) protected voidserializeMappers(XContentBuilder builder, ToXContent.Params params) final Optional<Mapper.SourceKeepMode> final ObjectMapper.SubobjectstoXContent(XContentBuilder builder, ToXContent.Params params) typeName()Returns a name representing the type of this mapper.voidvalidate(MappingLookup mappers) Validate any cross-field references made by this mapperMethods inherited from class org.elasticsearch.index.mapper.Mapper
freezeAndDeduplicateFieldType, internFieldName, leafName, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
SUB_OBJECTS_AUTO_FEATURE_FLAG
-
CONTENT_TYPE
- See Also:
-
enabled
-
subobjects
-
sourceKeepMode
-
dynamic
-
mappers
-
-
Method Details
-
getTotalFieldsCount
public int getTotalFieldsCount()Description copied from class:MapperThe total number of fields as defined in the mapping. Defines how this mapper counts towardsMapperService.INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING.- Specified by:
getTotalFieldsCountin classMapper
-
newBuilder
- Returns:
- a Builder that will produce an empty ObjectMapper with the same configuration as this one
-
fullPath
Description copied from class:MapperReturns the canonical name which uniquely identifies the mapper against other mappers in a type. -
typeName
Description copied from class:MapperReturns a name representing the type of this mapper. -
isEnabled
public boolean isEnabled() -
isNested
public boolean isNested() -
getMapper
-
iterator
-
dynamic
-
subobjects
-
sourceKeepMode
-
validate
Description copied from class:MapperValidate any cross-field references made by this mapper- Specified by:
validatein classMapper- Parameters:
mappers- aMappingLookupthat can produce references to other mappers
-
createChildContext
-
merge
Description copied from class:MapperReturn the merge ofmergeWithinto this. BoththisandmergeWithwill be left unmodified. -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Throws:
IOException
-
serializeMappers
protected void serializeMappers(XContentBuilder builder, ToXContent.Params params) throws IOException - Throws:
IOException
-
doXContent
- Throws:
IOException
-
findParentMapper
-
isRoot
protected boolean isRoot()
-