Module org.elasticsearch.server
Package org.elasticsearch.index.mapper
Class AbstractGeometryFieldMapper<T>
java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
org.elasticsearch.index.mapper.AbstractGeometryFieldMapper<T>
- All Implemented Interfaces:
Iterable<Mapper>
,ToXContent
,ToXContentFragment
- Direct Known Subclasses:
AbstractPointGeometryFieldMapper
,AbstractShapeGeometryFieldMapper
Base field mapper class for all spatial field types
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Interface representing parser in geometry indexing pipeline.Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper
FieldMapper.Builder, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.TypeParser
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.FieldMapper
COERCE_SETTING, copyTo, deprecationLogger, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractGeometryFieldMapper
(String simpleName, MappedFieldType mappedFieldType, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> ignoreZValue, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, AbstractGeometryFieldMapper.Parser<T> parser) protected
AbstractGeometryFieldMapper
(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, AbstractGeometryFieldMapper.Parser<T> parser, OnScriptError onScriptError) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Will this field ignore malformed values for this field and accept the document (true
) or will it reject documents with malformed values for this field (false
).static FieldMapper.Parameter<Explicit<Boolean>>
ignoreMalformedParam
(Function<FieldMapper, Explicit<Boolean>> initializer, boolean ignoreMalformedByDefault) boolean
static FieldMapper.Parameter<Explicit<Boolean>>
ignoreZValueParam
(Function<FieldMapper, Explicit<Boolean>> initializer) protected abstract void
index
(DocumentParserContext context, T geometry) Build an index document using a parsed geometryfinal void
parse
(DocumentParserContext context) Parse the field value using the providedDocumentParserContext
.protected void
parseCreateField
(DocumentParserContext context) Parse the field value and populate the fields onDocumentParserContext.doc()
.final boolean
Whether this mapper can handle an array value during document parsing.protected boolean
Whether this mapper can handle an object value during document parsing.Methods inherited from class org.elasticsearch.index.mapper.FieldMapper
checkIncomingMergeType, contentType, copyTo, doValidate, doXContentBody, executeScript, getMergeBuilder, getTotalFieldsCount, hasScript, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, name, notInMultiFields, sourcePathUsedBy, toXContent, typeName, validate
Methods inherited from class org.elasticsearch.index.mapper.Mapper
freezeAndDeduplicateFieldType, internFieldName, simpleName, syntheticFieldLoader, 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
-
Constructor Details
-
AbstractGeometryFieldMapper
protected AbstractGeometryFieldMapper(String simpleName, MappedFieldType mappedFieldType, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> ignoreZValue, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, AbstractGeometryFieldMapper.Parser<T> parser) -
AbstractGeometryFieldMapper
protected AbstractGeometryFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, AbstractGeometryFieldMapper.Parser<T> parser, OnScriptError onScriptError)
-
-
Method Details
-
ignoreMalformedParam
public static FieldMapper.Parameter<Explicit<Boolean>> ignoreMalformedParam(Function<FieldMapper, Explicit<Boolean>> initializer, boolean ignoreMalformedByDefault) -
ignoreZValueParam
public static FieldMapper.Parameter<Explicit<Boolean>> ignoreZValueParam(Function<FieldMapper, Explicit<Boolean>> initializer) -
fieldType
- Overrides:
fieldType
in classFieldMapper
-
parseCreateField
Description copied from class:FieldMapper
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- Specified by:
parseCreateField
in classFieldMapper
- Throws:
IOException
-
index
Build an index document using a parsed geometry- Parameters:
context
- the ParseContext holding the documentgeometry
- the parsed geometry object- Throws:
IOException
-
supportsParsingObject
protected boolean supportsParsingObject()Description copied from class:FieldMapper
Whether this mapper can handle an object value during document parsing. When the subobjects property is set to false, and we encounter an object while parsing we need a way to understand if its fieldMapper is able to parse an object. If that's the case we can provide the entire object to the FieldMapper otherwise its name becomes the part of the dotted field name of each internal value.- Overrides:
supportsParsingObject
in classFieldMapper
-
parse
Description copied from class:FieldMapper
Parse the field value using the providedDocumentParserContext
.- Overrides:
parse
in classFieldMapper
- Throws:
IOException
-
ignoreMalformed
public boolean ignoreMalformed()Description copied from class:FieldMapper
Will this field ignore malformed values for this field and accept the document (true
) or will it reject documents with malformed values for this field (false
). Some fields don't have a concept of "malformed" and will returnfalse
here.- Overrides:
ignoreMalformed
in classFieldMapper
-
ignoreZValue
public boolean ignoreZValue() -
parsesArrayValue
public final boolean parsesArrayValue()Description copied from class:FieldMapper
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.- Overrides:
parsesArrayValue
in classFieldMapper
-