Package org.elasticsearch.index.mapper
Class FieldMapper
java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
- All Implemented Interfaces:
Cloneable
,Iterable<Mapper>
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentFragment
- Direct Known Subclasses:
AbstractGeometryFieldMapper
,BinaryFieldMapper
,BooleanFieldMapper
,CompletionFieldMapper
,DateFieldMapper
,FlattenedFieldMapper
,IpFieldMapper
,KeywordFieldMapper
,MetadataFieldMapper
,NumberFieldMapper
,RangeFieldMapper
,TextFieldMapper
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A Builder for a ParametrizedFieldMapperstatic final class
static class
Represents a list of fields with optional boost factor where the current field should be copied toprotected static interface
static final class
static final class
A configurable parameter for a field mapperstatic interface
Serializes a parameterstatic interface
Check on whether or not a parameter should be serializedstatic final class
TypeParser implementation that automatically handles parsingNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Modifier and TypeFieldDescriptionprotected final FieldMapper.CopyTo
protected final boolean
protected final Map<String,
NamedAnalyzer> protected final MappedFieldType
protected final FieldMapper.MultiFields
protected final String
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ModifierConstructorDescriptionprotected
FieldMapper
(String simpleName, MappedFieldType mappedFieldType, Map<String, NamedAnalyzer> indexAnalyzers, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, boolean hasScript, String onScriptError) Create a FieldMapper that indexes into multiple analyzed fieldsprotected
FieldMapper
(String simpleName, MappedFieldType mappedFieldType, NamedAnalyzer indexAnalyzer, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo) Create a FieldMapper with a single associated index analyzerprotected
FieldMapper
(String simpleName, MappedFieldType mappedFieldType, NamedAnalyzer indexAnalyzer, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, boolean hasScript, String onScriptError) Create a FieldMapper with a single associated index analyzerprotected
FieldMapper
(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo) Create a FieldMapper with no index analyzersprotected
FieldMapper
(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, boolean hasScript, String onScriptError) Create a FieldMapper with no index analyzers -
Method Summary
Modifier and TypeMethodDescriptionprotected void
checkIncomingMergeType
(FieldMapper mergeWith) protected abstract String
copyTo()
List of fields where this field should be copied toprotected void
doValidate
(MappingLookup mappers) protected void
doXContentBody
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) final void
executeScript
(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext) Execute the index-time script associated with this field mapper.abstract FieldMapper.Builder
Returns aFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
final boolean
final Map<String,
NamedAnalyzer> protected void
indexScriptValues
(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext) Run the script associated with the field and index the values that it emits This method should only be called ifhasScript()
has returnedtrue
iterator()
final FieldMapper
Return the merge ofmergeWith
into this.name()
Returns the canonical name which uniquely identifies the mapper against other mappers in a type.static BiConsumer<String,
MappingParserContext> notInMultiFields
(String type) void
parse
(DocumentParserContext context) Parse the field value using the providedDocumentParserContext
.protected abstract void
parseCreateField
(DocumentParserContext context) Parse the field value and populate the fields onDocumentParserContext.doc()
.boolean
Whether this mapper can handle an array value during document parsing.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) typeName()
Returns a name representing the type of this mapper.final void
validate
(MappingLookup mappers) Validate any cross-field references made by this mapperMethods inherited from class org.elasticsearch.index.mapper.Mapper
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
-
IGNORE_MALFORMED_SETTING
-
COERCE_SETTING
-
mappedFieldType
-
indexAnalyzers
-
multiFields
-
copyTo
-
hasScript
protected final boolean hasScript -
onScriptError
-
-
Constructor Details
-
FieldMapper
protected FieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo) Create a FieldMapper with no index analyzers- Parameters:
simpleName
- the leaf name of the mappermappedFieldType
- the MappedFieldType associated with this mappermultiFields
- sub fields of this mappercopyTo
- copyTo fields of this mapper
-
FieldMapper
protected FieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, boolean hasScript, String onScriptError) Create a FieldMapper with no index analyzers- Parameters:
simpleName
- the leaf name of the mappermappedFieldType
- the MappedFieldType associated with this mappermultiFields
- sub fields of this mappercopyTo
- copyTo fields of this mapperhasScript
- whether a script is defined for the fieldonScriptError
- the behaviour for when the defined script fails at runtime
-
FieldMapper
protected FieldMapper(String simpleName, MappedFieldType mappedFieldType, NamedAnalyzer indexAnalyzer, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo) Create a FieldMapper with a single associated index analyzer- Parameters:
simpleName
- the leaf name of the mappermappedFieldType
- the MappedFieldType associated with this mapperindexAnalyzer
- the index-time analyzer to use for this fieldmultiFields
- sub fields of this mappercopyTo
- copyTo fields of this mapper
-
FieldMapper
protected FieldMapper(String simpleName, MappedFieldType mappedFieldType, NamedAnalyzer indexAnalyzer, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, boolean hasScript, String onScriptError) Create a FieldMapper with a single associated index analyzer- Parameters:
simpleName
- the leaf name of the mappermappedFieldType
- the MappedFieldType associated with this mapperindexAnalyzer
- the index-time analyzer to use for this fieldmultiFields
- sub fields of this mappercopyTo
- copyTo fields of this mapperhasScript
- whether a script is defined for the fieldonScriptError
- the behaviour for when the defined script fails at runtime
-
FieldMapper
protected FieldMapper(String simpleName, MappedFieldType mappedFieldType, Map<String, NamedAnalyzer> indexAnalyzers, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, boolean hasScript, String onScriptError) Create a FieldMapper that indexes into multiple analyzed fields- Parameters:
simpleName
- the leaf name of the mappermappedFieldType
- the MappedFieldType associated with this mapperindexAnalyzers
- a map of field names to analyzers, one for each analyzed field the mapper will addmultiFields
- sub fields of this mappercopyTo
- copyTo fields of this mapperhasScript
- whether a script is defined for the fieldonScriptError
- the behaviour for when the defined script fails at runtime
-
-
Method Details
-
name
Description copied from class:Mapper
Returns the canonical name which uniquely identifies the mapper against other mappers in a type. -
typeName
Description copied from class:Mapper
Returns a name representing the type of this mapper. -
fieldType
-
copyTo
List of fields where this field should be copied to -
multiFields
-
parsesArrayValue
public boolean parsesArrayValue()Whether this mapper can handle an array value during document parsing. If true, when an array is encountered during parsing, the document parser will pass the whole array to the mapper. If false, the array is split into individual values and each value is passed to the mapper for parsing. -
parse
Parse the field value using the providedDocumentParserContext
.- Throws:
IOException
-
parseCreateField
Parse the field value and populate the fields onDocumentParserContext.doc()
. Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token- Throws:
IOException
-
hasScript
public final boolean hasScript()- Returns:
- whether this field mapper uses a script to generate its values
-
executeScript
public final void executeScript(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext) Execute the index-time script associated with this field mapper. This method should only be called ifhasScript()
has returnedtrue
- Parameters:
searchLookup
- a SearchLookup to be passed the scriptreaderContext
- a LeafReaderContext exposing values from an incoming documentdoc
- the id of the document to execute the script againstdocumentParserContext
- the ParseContext over the incoming document
-
indexScriptValues
protected void indexScriptValues(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext) Run the script associated with the field and index the values that it emits This method should only be called ifhasScript()
has returnedtrue
- Parameters:
searchLookup
- a SearchLookup to be passed the scriptreaderContext
- a LeafReaderContext exposing values from an incoming documentdoc
- the id of the document to execute the script againstdocumentParserContext
- the ParseContext over the incoming document
-
iterator
-
validate
Description copied from class:Mapper
Validate any cross-field references made by this mapper- Specified by:
validate
in classMapper
- Parameters:
mappers
- aMappingLookup
that can produce references to other mappers
-
doValidate
-
getMergeBuilder
Returns aFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
-
merge
Description copied from class:Mapper
Return the merge ofmergeWith
into this. Boththis
andmergeWith
will be left unmodified. -
checkIncomingMergeType
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
doXContentBody
protected void doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Throws:
IOException
-
contentType
-
indexAnalyzers
-
notInMultiFields
-