Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class GeoShapeFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.AbstractGeometryFieldMapper<T>

org.elasticsearch.index.mapper.AbstractShapeGeometryFieldMapper<Geometry>

org.elasticsearch.index.mapper.GeoShapeFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class GeoShapeFieldMapper
extends AbstractShapeGeometryFieldMapper<Geometry>

FieldMapper for indexing LatLonShapes.

Currently Shapes can only be indexed and can only be queried using GeoShapeQueryBuilder, consequently a lot of behavior in this Mapper is disabled.

Format supported:

"field" : { "type" : "polygon", "coordinates" : [ [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ] ] }

or:

"field" : "POLYGON ((100.0 0.0, 101.0 0.0, 101.0 1.0, 100.0 1.0, 100.0 0.0))

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoShapeFieldMapper.Builder
static class	GeoShapeFieldMapper.GeoShapeFieldType

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.AbstractShapeGeometryFieldMapper

AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType<T>

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.AbstractGeometryFieldMapper

AbstractGeometryFieldMapper.AbstractGeometryFieldType<T>, AbstractGeometryFieldMapper.Parser<T>

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

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

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static Mapper.TypeParser	PARSER	Deprecated.

Fields inherited from class org.elasticsearch.index.mapper.AbstractShapeGeometryFieldMapper

coerce, orientation

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_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoShapeFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, GeoShapeIndexer indexer, AbstractGeometryFieldMapper.Parser<Geometry> parser, GeoShapeFieldMapper.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
GeoShapeFieldMapper.GeoShapeFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
protected void	index(DocumentParserContext context, Geometry geometry)	Build an index document using a parsed geometry

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

coerce, coerceParam, orientation, orientationParam

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

ignoreMalformed, ignoreMalformedParam, ignoreZValue, ignoreZValueParam, parse, parseCreateField, parsesArrayValue

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

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

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

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

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

@Deprecated
public static Mapper.TypeParser PARSER

Deprecated.

Constructor Details

GeoShapeFieldMapper

public GeoShapeFieldMapper(String simpleName,
 MappedFieldType mappedFieldType,
 FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo,
 GeoShapeIndexer indexer,
 AbstractGeometryFieldMapper.Parser<Geometry> parser,
 GeoShapeFieldMapper.Builder builder)

Method Details

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class FieldMapper

index

protected void index(DocumentParserContext context,
 Geometry geometry)
              throws IOException

Description copied from class: AbstractGeometryFieldMapper

Build an index document using a parsed geometry

Specified by:

index in class AbstractGeometryFieldMapper<Geometry>

Parameters:

context - the ParseContext holding the document

geometry - the parsed geometry object

Throws:

IOException

fieldType

public GeoShapeFieldMapper.GeoShapeFieldType fieldType()

Overrides:

fieldType in class AbstractGeometryFieldMapper<Geometry>

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper