Module org.elasticsearch.server
Package org.elasticsearch.index.mapper
Class PassThroughObjectMapper
java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.ObjectMapper
org.elasticsearch.index.mapper.PassThroughObjectMapper
- All Implemented Interfaces:
Iterable<Mapper>
,ToXContent
,ToXContentFragment
Mapper for pass-through objects.
Pass-through objects allow creating fields inside them that can also be referenced directly in search queries.
They also include parameters that affect how nested fields get configured. For instance, if parameter "time_series_dimension"
is set, eligible subfields are marked as dimensions and keyword fields are additionally included in routing and tsid calculations.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.ObjectMapper
ObjectMapper.Defaults, ObjectMapper.Dynamic, ObjectMapper.MergeResult
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Field Summary
Fields inherited from class org.elasticsearch.index.mapper.ObjectMapper
dynamic, enabled, mappers, subobjects
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionboolean
merge
(ObjectMapper mergeWith, MapperService.MergeReason reason, MapperMergeContext parentBuilderContext) newBuilder
(IndexVersion indexVersionCreated) toXContent
(XContentBuilder builder, ToXContent.Params params) Methods inherited from class org.elasticsearch.index.mapper.ObjectMapper
createChildContext, doXContent, dynamic, fullPath, getMapper, getTotalFieldsCount, isEnabled, isNested, iterator, merge, merge, name, serializeMappers, startSyntheticField, subobjects, syntheticFieldLoader, syntheticFieldLoader, typeName, validate
Methods inherited from class org.elasticsearch.index.mapper.Mapper
freezeAndDeduplicateFieldType, internFieldName, simpleName, 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
-
CONTENT_TYPE
- See Also:
-
-
Method Details
-
containsDimensions
public boolean containsDimensions() -
newBuilder
- Overrides:
newBuilder
in classObjectMapper
- Returns:
- a Builder that will produce an empty ObjectMapper with the same configuration as this one
-
merge
public PassThroughObjectMapper merge(ObjectMapper mergeWith, MapperService.MergeReason reason, MapperMergeContext parentBuilderContext) -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Overrides:
toXContent
in classObjectMapper
- Throws:
IOException
-