Package org.elasticsearch.index.mapper

Class NumberFieldMapper.NumberFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.SimpleMappedFieldType

org.elasticsearch.index.mapper.NumberFieldMapper.NumberFieldType

Enclosing class:

NumberFieldMapper

public static class NumberFieldMapper.NumberFieldType
extends SimpleMappedFieldType

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
NumberFieldType(String name, NumberFieldMapper.NumberType type)
NumberFieldType(String name, NumberFieldMapper.NumberType type, boolean isSearchable, boolean isStored, boolean hasDocValues, boolean coerce, Number nullValue, Map<String,String> meta, FieldValues<Number> script, boolean isDimension, TimeSeriesParams.MetricType metricType)

Method Summary

Modifier and Type	Method	Description
MappedFieldType.CollapseType	collapseType()	Returns the collapse type of the field CollapseType.NONE means the field can'be used for collapsing.
DocValueFormat	docValueFormat(String format, ZoneId timeZone)	Pick a DocValueFormat that can be used to display and parse values of fields of this type.
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName, Supplier<SearchLookup> searchLookup)	Return a fielddata builder for this field
TimeSeriesParams.MetricType	getMetricType()	If field is a time series metric field, returns its metric type
boolean	isDimension()
IndexNumericFieldData.NumericType	numericType()
Number	parsePoint(byte[] value)
Function<byte[],Number>	pointReaderIfPossible()	If the field supports using the indexed data to speed up operations related to ordering of data, such as sorting or aggs, return a function for doing that.
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, SearchExecutionContext context)	Same as SimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, SearchExecutionContext) but without the trouble of relations or date-specific options.
double	reduceToStoredPrecision(double value)	This method reinterprets a double precision value based on the maximum precision of the stored number field.
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
org.apache.lucene.search.Query	termsQuery(Collection<?> values, SearchExecutionContext context)	Build a constant-scoring query that matches all values.
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.
Object	valueForDisplay(Object value)	Given a value that comes from the stored fields API, convert it to the expected type.

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

rangeQuery

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

boost, checkNoFormat, checkNoTimeZone, distanceFeatureQuery, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fuzzyIntervals, fuzzyQuery, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isFieldWithinQuery, isSearchable, isStored, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, prefixIntervals, prefixQuery, prefixQuery, regexpQuery, setBoost, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, wildcardIntervals, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

NumberFieldType

public NumberFieldType(String name,
 NumberFieldMapper.NumberType type,
 boolean isSearchable,
 boolean isStored,
 boolean hasDocValues,
 boolean coerce,
 Number nullValue,
 Map<String,String> meta,
 FieldValues<Number> script,
 boolean isDimension,
 TimeSeriesParams.MetricType metricType)

NumberFieldType

public NumberFieldType(String name,
 NumberFieldMapper.NumberType type)

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

reduceToStoredPrecision

public double reduceToStoredPrecision(double value)

This method reinterprets a double precision value based on the maximum precision of the stored number field. Mostly this corrects for unrepresentable values which have different approximations when cast from floats than when parsed as doubles. It may seem strange to convert a double to a double, and it is. This function's goal is to reduce the precision on the double in the case that the backing number type would have parsed the value differently. This is to address the problem where (e.g.) 0.04F < 0.04D, which causes problems for range aggregations.

numericType

public IndexNumericFieldData.NumericType numericType()

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes, boosted by MappedFieldType.boost().

Specified by:

termQuery in class MappedFieldType

termsQuery

public org.apache.lucene.search.Query termsQuery(Collection<?> values,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Build a constant-scoring query that matches all values. The default implementation uses a ConstantScoreQuery around a BooleanQuery whose BooleanClause.Occur.SHOULD clauses are generated with MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.SearchExecutionContext).

Overrides:

termsQuery in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 SearchExecutionContext context)

Description copied from class: SimpleMappedFieldType

Same as SimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, SearchExecutionContext) but without the trouble of relations or date-specific options.

Overrides:

rangeQuery in class SimpleMappedFieldType

pointReaderIfPossible

public Function<byte[],Number> pointReaderIfPossible()

Description copied from class: MappedFieldType

If the field supports using the indexed data to speed up operations related to ordering of data, such as sorting or aggs, return a function for doing that. If it is unsupported for this field type, there is no need to override this method.

Overrides:

pointReaderIfPossible in class MappedFieldType

Returns:

null if the optimization cannot be applied, otherwise a function to use for the optimization

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName,
 Supplier<SearchLookup> searchLookup)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fullyQualifiedIndexName - the name of the index this field-data is build for

searchLookup - a SearchLookup supplier to allow for accessing other fields values in the context of runtime fields

valueForDisplay

public Object valueForDisplay(Object value)

Description copied from class: MappedFieldType

Given a value that comes from the stored fields API, convert it to the expected type. For instance a date field would store dates as longs and format it back to a string in this method.

Overrides:

valueForDisplay in class MappedFieldType

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.

Specified by:

valueFetcher in class MappedFieldType

docValueFormat

public DocValueFormat docValueFormat(String format,
 ZoneId timeZone)

Description copied from class: MappedFieldType

Pick a DocValueFormat that can be used to display and parse values of fields of this type.

Overrides:

docValueFormat in class MappedFieldType

parsePoint

public Number parsePoint(byte[] value)

collapseType

public MappedFieldType.CollapseType collapseType()

Description copied from class: MappedFieldType

Returns the collapse type of the field CollapseType.NONE means the field can'be used for collapsing.

Overrides:

collapseType in class MappedFieldType

Returns:

collapse type of the field

isDimension

public boolean isDimension()

Overrides:

isDimension in class MappedFieldType

Returns:

true if field has been marked as a dimension field

getMetricType

public TimeSeriesParams.MetricType getMetricType()

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

Returns:

the metric type or null