org.elasticsearch.index.mapper.core

Class NumberFieldMapper<T extends Number>

java.lang.Object

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

org.elasticsearch.index.mapper.core.NumberFieldMapper<T>

All Implemented Interfaces:

ToXContent, FieldMapper<T>, AllFieldMapper.IncludeInAll, Mapper

Direct Known Subclasses:

BoostFieldMapper, ByteFieldMapper, DateFieldMapper, DoubleFieldMapper, FloatFieldMapper, IntegerFieldMapper, IpFieldMapper, LongFieldMapper, ShortFieldMapper

public abstract class NumberFieldMapper<T extends Number>
extends AbstractFieldMapper<T>
implements AllFieldMapper.IncludeInAll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumberFieldMapper.Builder<T extends NumberFieldMapper.Builder,Y extends NumberFieldMapper>
static class	NumberFieldMapper.CustomLongNumericDocValuesField
static class	NumberFieldMapper.CustomNumericDocValuesField
static class	NumberFieldMapper.CustomNumericField
static class	NumberFieldMapper.Defaults

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.Mapper

Mapper.BuilderContext, Mapper.TypeParser

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

FieldMapper.Loading, FieldMapper.Names

Field Summary

Fields

Modifier and Type	Field and Description
protected Explicit<Boolean>	coerce
protected Explicit<Boolean>	ignoreMalformed
protected Boolean	includeInAll
protected int	precisionStep
protected boolean	useSortedNumericDocValues True if index version is 1.4+

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.Mapper

EMPTY_ARRAY

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

EMPTY_PARAMS

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

DOC_VALUES_FORMAT

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

NumberFieldMapper(FieldMapper.Names names, int precisionStep, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, SimilarityProvider similarity, FieldMapper.Loading normsLoading, Settings fieldDataSettings, Settings indexSettings, AbstractFieldMapper.MultiFields multiFields, AbstractFieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method and Description
protected void	addDocValue(ParseContext context, List<org.apache.lucene.document.Field> fields, long value)
void	close()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
org.apache.lucene.search.Filter	fieldDataTermsFilter(List values, QueryParseContext context) A terms filter based on the field data cache for numeric fields.
abstract org.apache.lucene.search.Query	fuzzyQuery(String value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
void	includeInAll(Boolean includeInAll)
void	includeInAllIfNotSet(Boolean includeInAll)
protected abstract void	innerParseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields)
boolean	isNumeric()
protected abstract int	maxPrecisionStep()
void	merge(Mapper mergeWith, MergeContext mergeContext)
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
double	parseDoubleValue(Object value) Converts an object value into a double
long	parseLongValue(Object value) Converts an object value into a long
protected org.apache.lucene.analysis.NumericTokenStream	popCachedStream()
int	precisionStep()
abstract org.apache.lucene.search.Filter	rangeFilter(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
abstract org.apache.lucene.search.Filter	rangeFilter(QueryParseContext parseContext, Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context) A range filter based on the field data cache.
abstract org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
org.apache.lucene.search.Filter	termFilter(Object value, QueryParseContext context)
org.apache.lucene.search.Query	termQuery(Object value, QueryParseContext context)
void	unsetIncludeInAll()
boolean	useTermQueryWithQueryString() Use the field query created here when matching on numbers.
Object	valueForSearch(Object value) Override the default behavior (to return the string, and return the actual Number instance).

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

boost, contentType, copyTo, customBoost, defaultDocValuesFormat, defaultFieldDataType, defaultFieldType, defaultPostingFormat, docValuesFormatProvider, fieldDataType, fieldType, hasDocValues, indexAnalyzer, indexedValueForSearch, indexOptionToString, indexTokenizeOptionToString, isGenerated, isSortable, name, names, normsLoading, nullValueFilter, parse, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termsFilter, termVectorOptionsToString, toXContent, traverse, traverse

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.Mapper

name, parse, traverse, traverse

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

toXContent

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

value

Field Detail

precisionStep

protected int precisionStep

includeInAll

protected Boolean includeInAll

ignoreMalformed

protected Explicit<Boolean> ignoreMalformed

coerce

protected Explicit<Boolean> coerce

useSortedNumericDocValues

protected final boolean useSortedNumericDocValues

True if index version is 1.4+

In this case numerics are encoded with SORTED_NUMERIC docvalues, otherwise for older indexes we must continue to write BINARY (for now)

Constructor Detail

NumberFieldMapper

protected NumberFieldMapper(FieldMapper.Names names,
                            int precisionStep,
                            float boost,
                            org.apache.lucene.document.FieldType fieldType,
                            Boolean docValues,
                            Explicit<Boolean> ignoreMalformed,
                            Explicit<Boolean> coerce,
                            NamedAnalyzer indexAnalyzer,
                            NamedAnalyzer searchAnalyzer,
                            PostingsFormatProvider postingsProvider,
                            DocValuesFormatProvider docValuesProvider,
                            SimilarityProvider similarity,
                            FieldMapper.Loading normsLoading,
                            @Nullable
                            Settings fieldDataSettings,
                            Settings indexSettings,
                            AbstractFieldMapper.MultiFields multiFields,
                            AbstractFieldMapper.CopyTo copyTo)

Method Detail

includeInAll

public void includeInAll(Boolean includeInAll)

Specified by:

includeInAll in interface AllFieldMapper.IncludeInAll

includeInAllIfNotSet

public void includeInAllIfNotSet(Boolean includeInAll)

Specified by:

includeInAllIfNotSet in interface AllFieldMapper.IncludeInAll

unsetIncludeInAll

public void unsetIncludeInAll()

Specified by:

unsetIncludeInAll in interface AllFieldMapper.IncludeInAll

maxPrecisionStep

protected abstract int maxPrecisionStep()

precisionStep

public int precisionStep()

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<T extends Number>

Throws:

IOException

innerParseCreateField

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

Throws:

IOException

addDocValue

protected final void addDocValue(ParseContext context,
                                 List<org.apache.lucene.document.Field> fields,
                                 long value)

useTermQueryWithQueryString

public boolean useTermQueryWithQueryString()

Use the field query created here when matching on numbers.

Specified by:

useTermQueryWithQueryString in interface FieldMapper<T extends Number>

Overrides:

useTermQueryWithQueryString in class AbstractFieldMapper<T extends Number>

termQuery

public final org.apache.lucene.search.Query termQuery(Object value,
                                                      @Nullable
                                                      QueryParseContext context)

Specified by:

termQuery in interface FieldMapper<T extends Number>

Overrides:

termQuery in class AbstractFieldMapper<T extends Number>

termFilter

public final org.apache.lucene.search.Filter termFilter(Object value,
                                                        @Nullable
                                                        QueryParseContext context)

Specified by:

termFilter in interface FieldMapper<T extends Number>

Overrides:

termFilter in class AbstractFieldMapper<T extends Number>

rangeQuery

public abstract org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
                                                          Object upperTerm,
                                                          boolean includeLower,
                                                          boolean includeUpper,
                                                          @Nullable
                                                          QueryParseContext context)

Specified by:

rangeQuery in interface FieldMapper<T extends Number>

Overrides:

rangeQuery in class AbstractFieldMapper<T extends Number>

rangeFilter

public abstract org.apache.lucene.search.Filter rangeFilter(Object lowerTerm,
                                                            Object upperTerm,
                                                            boolean includeLower,
                                                            boolean includeUpper,
                                                            @Nullable
                                                            QueryParseContext context)

Specified by:

rangeFilter in interface FieldMapper<T extends Number>

Overrides:

rangeFilter in class AbstractFieldMapper<T extends Number>

fuzzyQuery

public abstract org.apache.lucene.search.Query fuzzyQuery(String value,
                                                          Fuzziness fuzziness,
                                                          int prefixLength,
                                                          int maxExpansions,
                                                          boolean transpositions)

Specified by:

fuzzyQuery in interface FieldMapper<T extends Number>

Overrides:

fuzzyQuery in class AbstractFieldMapper<T extends Number>

rangeFilter

public abstract org.apache.lucene.search.Filter rangeFilter(QueryParseContext parseContext,
                                                            Object lowerTerm,
                                                            Object upperTerm,
                                                            boolean includeLower,
                                                            boolean includeUpper,
                                                            @Nullable
                                                            QueryParseContext context)

A range filter based on the field data cache.

fieldDataTermsFilter

public org.apache.lucene.search.Filter fieldDataTermsFilter(List values,
                                                            @Nullable
                                                            QueryParseContext context)

A terms filter based on the field data cache for numeric fields.

Specified by:

fieldDataTermsFilter in interface FieldMapper<T extends Number>

Overrides:

fieldDataTermsFilter in class AbstractFieldMapper<T extends Number>

parseDoubleValue

public double parseDoubleValue(Object value)

Converts an object value into a double

parseLongValue

public long parseLongValue(Object value)

Converts an object value into a long

valueForSearch

public Object valueForSearch(Object value)

Override the default behavior (to return the string, and return the actual Number instance).

Specified by:

valueForSearch in interface FieldMapper<T extends Number>

Overrides:

valueForSearch in class AbstractFieldMapper<T extends Number>

Parameters:

value -

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<T extends Number>

Throws:

MergeMappingException

close

public void close()

Specified by:

close in interface Mapper

Overrides:

close in class AbstractFieldMapper<T extends Number>

popCachedStream

protected org.apache.lucene.analysis.NumericTokenStream popCachedStream()

doXContentBody

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

Overrides:

doXContentBody in class AbstractFieldMapper<T extends Number>

Throws:

IOException

isNumeric

public boolean isNumeric()

Specified by:

isNumeric in interface FieldMapper<T extends Number>

Overrides:

isNumeric in class AbstractFieldMapper<T extends Number>