Package org.opensearch.index.mapper

Class RangeFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.RangeFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class RangeFieldMapper
extends ParametrizedFieldMapper

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

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RangeFieldMapper.Builder	Builder for range fields
static class	RangeFieldMapper.Defaults	Default parameters for range fields
static class	RangeFieldMapper.Range	Class defining a range
static final class	RangeFieldMapper.RangeFieldType	Field type for range fields

Nested classes/interfaces inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

ParametrizedFieldMapper.Parameter<T>, ParametrizedFieldMapper.Serializer<T>, ParametrizedFieldMapper.SerializerCheck<T>, ParametrizedFieldMapper.TypeParser

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_INCLUDE_LOWER
static final boolean	DEFAULT_INCLUDE_UPPER

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

copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected RangeFieldMapper	clone()
protected String	contentType()
RangeFieldMapper.RangeFieldType	fieldType()
ParametrizedFieldMapper.Builder	getMergeBuilder()	Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
protected void	parseCreateField(ParseContext context)	Parse the field value and populate the fields on ParseContext.doc().

Methods inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

doXContentBody, merge, mergeOptions

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

copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parsesArrayValue, storedByDefault, toXContent, typeName, validate

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

hasIndexCreated, simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

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 ParametrizedFieldMapper.Builder getMergeBuilder()

Description copied from class: ParametrizedFieldMapper

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

Specified by:

getMergeBuilder in class ParametrizedFieldMapper

fieldType

public RangeFieldMapper.RangeFieldType fieldType()

Overrides:

fieldType in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

clone

protected RangeFieldMapper clone()

Overrides:

clone in class FieldMapper

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on ParseContext.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