Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class GeoPointFieldMapper.GeoPointFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

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

org.elasticsearch.index.mapper.AbstractPointGeometryFieldMapper.AbstractPointFieldType<GeoPoint>

org.elasticsearch.index.mapper.GeoPointFieldMapper.GeoPointFieldType

All Implemented Interfaces:

GeoShapeQueryable

Enclosing class:

GeoPointFieldMapper

public static class GeoPointFieldMapper.GeoPointFieldType
extends AbstractPointGeometryFieldMapper.AbstractPointFieldType<GeoPoint>
implements GeoShapeQueryable

Nested Class Summary

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

MappedFieldType.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation

Field Summary

Fields

Modifier and Type	Field	Description
static final GeoFormatterFactory<GeoPoint>	GEO_FORMATTER_FACTORY

Fields inherited from class org.elasticsearch.index.mapper.AbstractGeometryFieldMapper.AbstractGeometryFieldType

geometryParser, nullValue

Constructor Summary

Constructors

Constructor	Description
GeoPointFieldType(String name)
GeoPointFieldType(String name, TimeSeriesParams.MetricType metricType, IndexMode indexMode)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.Query	distanceFeatureQuery(Object origin, String pivot, SearchExecutionContext context)
IndexFieldData.Builder	fielddataBuilder(FieldDataContext fieldDataContext)	Return a fielddata builder for this field
org.apache.lucene.search.Query	geoShapeQuery(SearchExecutionContext context, String fieldName, ShapeRelation relation, org.apache.lucene.geo.LatLonGeometry... geometries)
protected Function<List<GeoPoint>,List<Object>>	getFormatter(String format)	Gets the formatter by name.
TimeSeriesParams.MetricType	getMetricType()	If field is a time series metric field, returns its metric type
boolean	isSearchable()	Returns true if the field is searchable.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.

Methods inherited from class org.elasticsearch.index.mapper.AbstractPointGeometryFieldMapper.AbstractPointFieldType

blockLoader, nullValueAsSource

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

blockLoaderFromSource, termQuery, valueFetcher

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

checkNoFormat, checkNoTimeZone, collapseType, dimensions, docValueFormat, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fieldHasValue, fuzzyIntervals, fuzzyQuery, fuzzyQuery, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isDimension, isFieldWithinQuery, isIndexed, isStored, mayExistInIndex, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, prefixQuery, rangeQuery, regexpQuery, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, termsQuery, validateMatchedRoutingPath, valueForDisplay, wildcardIntervals, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.GeoShapeQueryable

geoShapeQuery, geoShapeQuery

Field Details

GEO_FORMATTER_FACTORY

public static final GeoFormatterFactory<GeoPoint> GEO_FORMATTER_FACTORY

Constructor Details

GeoPointFieldType

public GeoPointFieldType(String name,
 TimeSeriesParams.MetricType metricType,
 IndexMode indexMode)

GeoPointFieldType

public GeoPointFieldType(String name)

Method Details

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

isSearchable

public boolean isSearchable()

Description copied from class: MappedFieldType

Returns true if the field is searchable.

Overrides:

isSearchable in class MappedFieldType

getFormatter

protected Function<List<GeoPoint>,List<Object>> getFormatter(String format)

Description copied from class: AbstractGeometryFieldMapper.AbstractGeometryFieldType

Gets the formatter by name.

Specified by:

getFormatter in class AbstractGeometryFieldMapper.AbstractGeometryFieldType<GeoPoint>

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw UnsupportedOperationException since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.

Overrides:

valueFetcher in class AbstractGeometryFieldMapper.AbstractGeometryFieldType<GeoPoint>

geoShapeQuery

public org.apache.lucene.search.Query geoShapeQuery(SearchExecutionContext context,
 String fieldName,
 ShapeRelation relation,
 org.apache.lucene.geo.LatLonGeometry... geometries)

Specified by:

geoShapeQuery in interface GeoShapeQueryable

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(FieldDataContext fieldDataContext)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fieldDataContext - the context for the fielddata

distanceFeatureQuery

public org.apache.lucene.search.Query distanceFeatureQuery(Object origin,
 String pivot,
 SearchExecutionContext context)

Overrides:

distanceFeatureQuery in class MappedFieldType

getMetricType

public TimeSeriesParams.MetricType getMetricType()

If field is a time series metric field, returns its metric type

Overrides:

getMetricType in class MappedFieldType

Returns:

the metric type or null