org.elasticsearch.index.mapper.geo

Class GeoPointFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.core.AbstractFieldMapper<GeoPoint>

org.elasticsearch.index.mapper.geo.GeoPointFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<GeoPoint>, Mapper, ArrayValueMapperParser

public class GeoPointFieldMapper
extends AbstractFieldMapper<GeoPoint>
implements ArrayValueMapperParser

Parsing: We handle:

- "field" : "geo_hash" - "field" : "lat,lon" - "field" : { "lat" : 1.1, "lon" : 2.1 }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoPointFieldMapper.Builder
static class	GeoPointFieldMapper.CustomGeoPointDocValuesField
static class	GeoPointFieldMapper.Defaults
static class	GeoPointFieldMapper.Encoding A byte-aligned fixed-length encoding for latitudes and longitudes.
static class	GeoPointFieldMapper.Names
static class	GeoPointFieldMapper.TypeParser

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

AbstractFieldMapper.CopyTo, AbstractFieldMapper.MultiFields

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

FieldMapper.Loading

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.Mapper

Mapper.BuilderContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE

Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, copyTo, customFieldDataSettings, docValues, docValuesFormat, fieldDataType, fieldType, indexAnalyzer, multiFields, names, normsLoading, postingsFormat, searchAnalyzer, similarity

Fields inherited from interface org.elasticsearch.index.mapper.FieldMapper

DOC_VALUES_FORMAT

Fields inherited from interface org.elasticsearch.index.mapper.Mapper

EMPTY_ARRAY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description

GeoPointFieldMapper(FieldMapper.Names names, org.apache.lucene.document.FieldType fieldType, Boolean docValues, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, PostingsFormatProvider postingsFormat, DocValuesFormatProvider docValuesFormat, SimilarityProvider similarity, Settings fieldDataSettings, Settings indexSettings, ContentPath.Type pathType, boolean enableLatLon, boolean enableGeoHash, boolean enableGeohashPrefix, Integer precisionStep, int geoHashPrecision, DoubleFieldMapper latMapper, DoubleFieldMapper lonMapper, StringFieldMapper geohashMapper, boolean validateLon, boolean validateLat, boolean normalizeLon, boolean normalizeLat, AbstractFieldMapper.MultiFields multiFields)

Method Summary

Modifier and Type	Method and Description
void	close()
protected String	contentType()
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
StringFieldMapper	geoHashStringMapper()
boolean	isEnableGeohashPrefix()
boolean	isEnableLatLon()
DoubleFieldMapper	latMapper()
DoubleFieldMapper	lonMapper()
void	merge(Mapper mergeWith, MergeContext mergeContext)
void	parse(ParseContext context)
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
void	traverse(FieldMapperListener fieldMapperListener)
void	traverse(ObjectMapperListener objectMapperListener)
GeoPoint	value(Object value) Returns the actual value of the field.

Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, copyTo, customBoost, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, fieldDataTermsFilter, fieldDataType, fieldType, fuzzyQuery, hasDocValues, indexAnalyzer, indexedValueForSearch, indexOptionToString, indexTokenizeOptionToString, isGenerated, isNumeric, isSortable, name, names, normsLoading, nullValueFilter, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, rangeFilter, rangeQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termFilter, termQuery, termsFilter, termVectorOptionsToString, toXContent, useTermQueryWithQueryString, valueForSearch

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

GeoPointFieldMapper

public GeoPointFieldMapper(FieldMapper.Names names,
                           org.apache.lucene.document.FieldType fieldType,
                           Boolean docValues,
                           NamedAnalyzer indexAnalyzer,
                           NamedAnalyzer searchAnalyzer,
                           PostingsFormatProvider postingsFormat,
                           DocValuesFormatProvider docValuesFormat,
                           SimilarityProvider similarity,
                           @Nullable
                           Settings fieldDataSettings,
                           Settings indexSettings,
                           ContentPath.Type pathType,
                           boolean enableLatLon,
                           boolean enableGeoHash,
                           boolean enableGeohashPrefix,
                           Integer precisionStep,
                           int geoHashPrecision,
                           DoubleFieldMapper latMapper,
                           DoubleFieldMapper lonMapper,
                           StringFieldMapper geohashMapper,
                           boolean validateLon,
                           boolean validateLat,
                           boolean normalizeLon,
                           boolean normalizeLat,
                           AbstractFieldMapper.MultiFields multiFields)

Method Detail

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<GeoPoint>

defaultFieldType

public org.apache.lucene.document.FieldType defaultFieldType()

Specified by:

defaultFieldType in class AbstractFieldMapper<GeoPoint>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<GeoPoint>

latMapper

public DoubleFieldMapper latMapper()

lonMapper

public DoubleFieldMapper lonMapper()

geoHashStringMapper

public StringFieldMapper geoHashStringMapper()

isEnableLatLon

public boolean isEnableLatLon()

isEnableGeohashPrefix

public boolean isEnableGeohashPrefix()

value

public GeoPoint value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

Specified by:

value in interface FieldMapper<GeoPoint>

parseCreateField

protected void parseCreateField(ParseContext context,
                                List<org.apache.lucene.document.Field> fields)
                         throws IOException

Description copied from class: AbstractFieldMapper

Parse the field value and populate fields.

Specified by:

parseCreateField in class AbstractFieldMapper<GeoPoint>

Throws:

IOException

parse

public void parse(ParseContext context)
           throws IOException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<GeoPoint>

Throws:

IOException

close

public void close()

Specified by:

close in interface Mapper

Overrides:

close in class AbstractFieldMapper<GeoPoint>

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<GeoPoint>

Throws:

MergeMappingException

traverse

public void traverse(FieldMapperListener fieldMapperListener)

Specified by:

traverse in interface Mapper

Overrides:

traverse in class AbstractFieldMapper<GeoPoint>

traverse

public void traverse(ObjectMapperListener objectMapperListener)

Specified by:

traverse in interface Mapper

Overrides:

traverse in class AbstractFieldMapper<GeoPoint>

doXContentBody

protected void doXContentBody(XContentBuilder builder,
                              boolean includeDefaults,
                              ToXContent.Params params)
                       throws IOException

Overrides:

doXContentBody in class AbstractFieldMapper<GeoPoint>

Throws:

IOException