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:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

Direct Known Subclasses:

AbstractPointGeometryFieldMapper, AbstractShapeGeometryFieldMapper

public abstract class AbstractGeometryFieldMapper<T>
extends FieldMapper

Base field mapper class for all spatial field types

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractGeometryFieldMapper.AbstractGeometryFieldType<T>
static class	AbstractGeometryFieldMapper.Parser<T>	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, hasScript, IGNORE_MALFORMED_SETTING, indexAnalyzers, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGeometryFieldMapper(String simpleName, MappedFieldType mappedFieldType, Map<String,NamedAnalyzer> indexAnalyzers, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> ignoreZValue, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, AbstractGeometryFieldMapper.Parser<T> parser)
protected	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, String onScriptError)

Method Summary

Modifier and Type	Method	Description
AbstractGeometryFieldMapper.AbstractGeometryFieldType<T>	fieldType()
boolean	ignoreMalformed()
static FieldMapper.Parameter<Explicit<Boolean>>	ignoreMalformedParam(Function<FieldMapper,Explicit<Boolean>> initializer, boolean ignoreMalformedByDefault)
boolean	ignoreZValue()
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 geometry
final void	parse(DocumentParserContext context)	Parse the field value using the provided DocumentParserContext.
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
final boolean	parsesArrayValue()	Whether this mapper can handle an array value during document parsing.

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper

checkIncomingMergeType, contentType, copyTo, doValidate, doXContentBody, executeScript, getMergeBuilder, hasScript, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, name, notInMultiFields, toXContent, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

simpleName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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,
 Map<String,NamedAnalyzer> indexAnalyzers,
 Explicit<Boolean> ignoreMalformed,
 Explicit<Boolean> ignoreZValue,
 FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo,
 AbstractGeometryFieldMapper.Parser<T> parser)

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,
 String 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

public AbstractGeometryFieldMapper.AbstractGeometryFieldType<T> fieldType()

Overrides:

fieldType in class FieldMapper

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

index

protected abstract void index(DocumentParserContext context,
 T geometry)
                       throws IOException

Build an index document using a parsed geometry

Parameters:

context - the ParseContext holding the document

geometry - the parsed geometry object

Throws:

IOException

parse

public final void parse(DocumentParserContext context)
                 throws IOException

Description copied from class: FieldMapper

Parse the field value using the provided DocumentParserContext.

Overrides:

parse in class FieldMapper

Throws:

IOException

ignoreMalformed

public boolean ignoreMalformed()

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 class FieldMapper