Package org.elasticsearch.index.mapper
Class IdFieldMapper
java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
org.elasticsearch.index.mapper.MetadataFieldMapper
org.elasticsearch.index.mapper.IdFieldMapper
- All Implemented Interfaces:
java.lang.Cloneable
,java.lang.Iterable<Mapper>
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public class IdFieldMapper extends MetadataFieldMapper
A mapper for the _id field. It does nothing since _id is neither indexed nor
stored, but we need to keep it so that its FieldType can be used to generate
queries.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IdFieldMapper.Defaults
static class
IdFieldMapper.TypeParser
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MetadataFieldMapper
MetadataFieldMapper.Builder<T extends MetadataFieldMapper.Builder,Y extends MetadataFieldMapper>
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper
FieldMapper.CopyTo, FieldMapper.MultiFields
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper
Mapper.BuilderContext
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONTENT_TYPE
static java.lang.String
NAME
Fields inherited from class org.elasticsearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, defaultFieldType, fieldType, IGNORE_MALFORMED_SETTING, indexCreatedVersion, multiFields
-
Method Summary
Modifier and Type Method Description protected java.lang.String
contentType()
protected void
doMerge(Mapper mergeWith)
Merge changes coming frommergeWith
in place.protected void
parseCreateField(ParseContext context, java.util.List<org.apache.lucene.index.IndexableField> fields)
Parse the field value and populatefields
.void
preParse(ParseContext context)
Called beforeFieldMapper.parse(ParseContext)
on theRootObjectMapper
.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Methods inherited from class org.elasticsearch.index.mapper.FieldMapper
clone, copyTo, createFieldNamesField, doXContentAnalyzers, doXContentBody, doXContentDocValues, fieldType, indexOptionToString, iterator, name, parse, parsesArrayValue, termVectorOptionsToString, typeName, updateFieldType
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE- See Also:
- Constant Field Values
-
-
Method Details
-
preParse
Description copied from class:MetadataFieldMapper
Called beforeFieldMapper.parse(ParseContext)
on theRootObjectMapper
.- Specified by:
preParse
in classMetadataFieldMapper
- Throws:
java.io.IOException
-
parseCreateField
protected void parseCreateField(ParseContext context, java.util.List<org.apache.lucene.index.IndexableField> fields) throws java.io.IOExceptionDescription copied from class:FieldMapper
Parse the field value and populatefields
. Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token- Specified by:
parseCreateField
in classFieldMapper
- Throws:
java.io.IOException
-
contentType
protected java.lang.String contentType()- Specified by:
contentType
in classFieldMapper
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Overrides:
toXContent
in classFieldMapper
- Throws:
java.io.IOException
-
doMerge
Description copied from class:FieldMapper
Merge changes coming frommergeWith
in place.- Overrides:
doMerge
in classFieldMapper
-