Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class NumberFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.NumberFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class NumberFieldMapper
extends FieldMapper

A FieldMapper for numeric types: byte, short, int, long, float and double.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NumberFieldMapper.Builder
static class	NumberFieldMapper.NumberFieldType
static enum	NumberFieldMapper.NumberType

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

FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.TypeParser

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	COERCE_SETTING

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

copyTo, deprecationLogger, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
void	doValidate(MappingLookup lookup)
NumberFieldMapper.NumberFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
boolean	ignoreMalformed()	Will this field ignore malformed values for this field and accept the document (true) or will it reject documents with malformed values for this field (false).
protected void	indexScriptValues(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext)	Run the script associated with the field and index the values that it emits This method should only be called if FieldMapper.hasScript() has returned true
void	indexValue(DocumentParserContext context, Number numericValue)	Index a value for this field.
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
SourceLoader.SyntheticFieldLoader	syntheticFieldLoader()	Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.
Number	value(XContentParser parser)	Read the value at the current position of the parser.

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

checkIncomingMergeType, copyTo, doXContentBody, executeScript, hasScript, indexAnalyzers, iterator, merge, multiFields, name, notInMultiFields, parse, parsesArrayValue, toXContent, typeName, validate

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

internFieldName, simpleName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

COERCE_SETTING

public static final Setting<Boolean> COERCE_SETTING

Method Details

ignoreMalformed

public boolean ignoreMalformed()

Description copied from class: FieldMapper

Will this field ignore malformed values for this field and accept the document (true) or will it reject documents with malformed values for this field (false). Some fields don't have a concept of "malformed" and will return false here.

Overrides:

ignoreMalformed in class FieldMapper

fieldType

public NumberFieldMapper.NumberFieldType fieldType()

Overrides:

fieldType in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

value

public Number value(XContentParser parser)
             throws IllegalArgumentException,
IOException

Read the value at the current position of the parser. For numeric fields this is called by parseCreateField(org.elasticsearch.index.mapper.DocumentParserContext) but it is public so it can be used by other fields that want to share the behavior of numeric fields.

Throws:

IllegalArgumentException - if there was an error parsing the value from the json

IOException - if there was any other IO error

indexValue

public void indexValue(DocumentParserContext context,
 Number numericValue)

Index a value for this field. For numeric fields this is called by parseCreateField(org.elasticsearch.index.mapper.DocumentParserContext) but it is public so it can be used by other fields that want to share the behavior of numeric fields.

indexScriptValues

protected void indexScriptValues(SearchLookup searchLookup,
 org.apache.lucene.index.LeafReaderContext readerContext,
 int doc,
 DocumentParserContext documentParserContext)

Description copied from class: FieldMapper

Run the script associated with the field and index the values that it emits This method should only be called if FieldMapper.hasScript() has returned true

Overrides:

indexScriptValues in class FieldMapper

Parameters:

searchLookup - a SearchLookup to be passed the script

readerContext - a LeafReaderContext exposing values from an incoming document

doc - the id of the document to execute the script against

documentParserContext - the ParseContext over the incoming document

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class FieldMapper

doValidate

public void doValidate(MappingLookup lookup)

Overrides:

doValidate in class FieldMapper

syntheticFieldLoader

public SourceLoader.SyntheticFieldLoader syntheticFieldLoader()

Description copied from class: Mapper

Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.

Overrides:

syntheticFieldLoader in class Mapper