Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class RangeFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.RangeFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class RangeFieldMapper
extends FieldMapper

A FieldMapper for indexing numeric and date ranges, and creating queries

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RangeFieldMapper.Builder
static class	RangeFieldMapper.Defaults
static class	RangeFieldMapper.Range	Class defining a range
static final class	RangeFieldMapper.RangeFieldType

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

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TypeParser

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

Mapper.SourceKeepMode

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 NodeFeature	DATE_RANGE_INDEXING_FIX
static final boolean	DEFAULT_INCLUDE_LOWER
static final boolean	DEFAULT_INCLUDE_UPPER

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

builderParams, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

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

SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
RangeFieldMapper.RangeFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
protected boolean	supportsParsingObject()	Whether this mapper can handle an object value during document parsing.
protected FieldMapper.SyntheticSourceSupport	syntheticSourceSupport()	Returns implementation of synthetic source support for the mapper.

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

checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doValidate, doXContentBody, executeScript, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, syntheticFieldLoader, toXContent, typeName, validate

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

freezeAndDeduplicateFieldType, internFieldName, leafName, 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

DATE_RANGE_INDEXING_FIX

public static final NodeFeature DATE_RANGE_INDEXING_FIX

DEFAULT_INCLUDE_UPPER

public static final boolean DEFAULT_INCLUDE_UPPER

See Also:

• Constant Field Values

DEFAULT_INCLUDE_LOWER

public static final boolean DEFAULT_INCLUDE_LOWER

See Also:

• Constant Field Values

Method Details

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

fieldType

public RangeFieldMapper.RangeFieldType fieldType()

Overrides:

fieldType in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

supportsParsingObject

protected boolean supportsParsingObject()

Description copied from class: FieldMapper

Whether this mapper can handle an object value during document parsing. When the subobjects property is set to false, and we encounter an object while parsing we need a way to understand if its fieldMapper is able to parse an object. If that's the case we can provide the entire object to the FieldMapper otherwise its name becomes the part of the dotted field name of each internal value.

Overrides:

supportsParsingObject 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

syntheticSourceSupport

protected FieldMapper.SyntheticSourceSupport syntheticSourceSupport()

Description copied from class: FieldMapper

Returns implementation of synthetic source support for the mapper.
By default (meaning FieldMapper.SyntheticSourceSupport.Fallback), an exact full copy of parsed field value is stored separately and used for synthetic source.

Field mappers must override this method if they provide a more efficient field-specific implementation of synthetic source.

Overrides:

syntheticSourceSupport in class FieldMapper

Returns:

FieldMapper.SyntheticSourceMode