Package org.opensearch.index.mapper

Class GeoShapeFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.AbstractGeometryFieldMapper<Parsed,Processed>

org.opensearch.index.mapper.AbstractShapeGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.Geometry>

org.opensearch.index.mapper.GeoShapeFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class GeoShapeFieldMapper
extends AbstractShapeGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.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))

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoShapeFieldMapper.Builder	Concrete builder for geo_shape types
static class	GeoShapeFieldMapper.GeoShapeFieldType	Concrete field type for geo_shape fields
static final class	GeoShapeFieldMapper.TypeParser	The type parser

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

AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType<Parsed,Processed>, AbstractShapeGeometryFieldMapper.Defaults, AbstractShapeGeometryFieldMapper.Names

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

AbstractGeometryFieldMapper.AbstractGeometryFieldType<Parsed,Processed>, AbstractGeometryFieldMapper.Indexer<Parsed,Processed>, AbstractGeometryFieldMapper.Parser<Parsed>

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

FieldMapper.CopyTo, FieldMapper.MultiFields

Nested classes/interfaces inherited from class org.opensearch.index.mapper.Mapper

Mapper.BuilderContext

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final org.apache.lucene.document.FieldType	FIELD_TYPE

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

coerce, DEPRECATED_PARAMETERS_KEY, orientation

Fields inherited from class org.opensearch.index.mapper.AbstractGeometryFieldMapper

ignoreMalformed, ignoreZValue

Fields inherited from class org.opensearch.index.mapper.FieldMapper

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoShapeFieldMapper(String simpleName, org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, Explicit<Boolean> ignoreZValue, Explicit<ShapeBuilder.Orientation> orientation, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method	Description
protected void	addDocValuesFields(String name, org.opensearch.geometry.Geometry geometry, List fields, ParseContext context)
protected void	addMultiFields(ParseContext context, org.opensearch.geometry.Geometry geometry)
protected void	addStoredFields(ParseContext context, org.opensearch.geometry.Geometry geometry)
protected String	contentType()
protected boolean	docValuesByDefault()
GeoShapeFieldMapper.GeoShapeFieldType	fieldType()
protected void	mergeGeoOptions(AbstractShapeGeometryFieldMapper<?,?> mergeWith, List<String> conflicts)

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

coerce, doXContentBody, mergeOptions, orientation, parsesArrayValue

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

ignoreMalformed, ignoreZValue, parse, parseCreateField

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

clone, copyTo, createFieldNamesField, doValidate, doXContentAnalyzers, indexedByDefault, indexOptionToString, iterator, merge, multiFields, name, storedByDefault, toXContent, typeName, validate

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

hasIndexCreated, simpleName

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

FIELD_TYPE

public static final org.apache.lucene.document.FieldType FIELD_TYPE

Constructor Details

GeoShapeFieldMapper

public GeoShapeFieldMapper(String simpleName,
 org.apache.lucene.document.FieldType fieldType,
 MappedFieldType mappedFieldType,
 Explicit<Boolean> ignoreMalformed,
 Explicit<Boolean> coerce,
 Explicit<Boolean> ignoreZValue,
 Explicit<ShapeBuilder.Orientation> orientation,
 FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo)

Method Details

addStoredFields

protected void addStoredFields(ParseContext context,
 org.opensearch.geometry.Geometry geometry)

Specified by:

addStoredFields in class AbstractGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.Geometry>

addDocValuesFields

protected void addDocValuesFields(String name,
 org.opensearch.geometry.Geometry geometry,
 List fields,
 ParseContext context)

Specified by:

addDocValuesFields in class AbstractGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.Geometry>

addMultiFields

protected void addMultiFields(ParseContext context,
 org.opensearch.geometry.Geometry geometry)

Specified by:

addMultiFields in class AbstractGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.Geometry>

mergeGeoOptions

protected void mergeGeoOptions(AbstractShapeGeometryFieldMapper<?,?> mergeWith,
 List<String> conflicts)

Specified by:

mergeGeoOptions in class AbstractShapeGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.Geometry>

fieldType

public GeoShapeFieldMapper.GeoShapeFieldType fieldType()

Overrides:

fieldType in class AbstractGeometryFieldMapper<org.opensearch.geometry.Geometry,org.opensearch.geometry.Geometry>

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

docValuesByDefault

protected boolean docValuesByDefault()

Overrides:

docValuesByDefault in class FieldMapper