Class ScaledFloatFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.ScaledFloatFieldMapper

All Implemented Interfaces:

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

public class ScaledFloatFieldMapper
extends ParametrizedFieldMapper

A FieldMapper for scaled floats. Values are internally multiplied by a scaling factor and rounded to the closest long.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScaledFloatFieldMapper.Builder
static final class	ScaledFloatFieldMapper.ScaledFloatFieldType

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.core.xcontent.ToXContent

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final ParametrizedFieldMapper.TypeParser	PARSER

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

copyTo, derivedFieldGenerator, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected void	canDeriveSourceInternal()
protected ScaledFloatFieldMapper	clone()
protected String	contentType()
protected DerivedFieldGenerator	derivedFieldGenerator()	1.
ScaledFloatFieldMapper.ScaledFloatFieldType	fieldType()
ParametrizedFieldMapper.Builder	getMergeBuilder()
protected Explicit<Boolean>	ignoreMalformed()
protected void	parseCreateField(ParseContext context)

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

doXContentBody, merge, mergeOptions

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

canDeriveSource, copyTo, createFieldNamesField, deriveSource, docValuesByDefault, doValidate, doXContentAnalyzers, getDerivedFieldGenerator, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parsesArrayValue, setDerivedFieldGenerator, 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.core.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final ParametrizedFieldMapper.TypeParser PARSER

Method Details

ignoreMalformed

protected Explicit<Boolean> ignoreMalformed()

Overrides:

ignoreMalformed in class FieldMapper

fieldType

public ScaledFloatFieldMapper.ScaledFloatFieldType fieldType()

Overrides:

fieldType in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

getMergeBuilder

public ParametrizedFieldMapper.Builder getMergeBuilder()

Specified by:

getMergeBuilder in class ParametrizedFieldMapper

clone

protected ScaledFloatFieldMapper clone()

Overrides:

clone in class FieldMapper

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws IOException

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

canDeriveSourceInternal

protected void canDeriveSourceInternal()

Overrides:

canDeriveSourceInternal in class FieldMapper

derivedFieldGenerator

protected DerivedFieldGenerator derivedFieldGenerator()

1. If it has doc values, build source using doc values 2. If doc_values is disabled in field mapping, then build source using stored field

Considerations: 1. When using doc values, for multi value field, result would be in sorted order 2. There might be precision loss as values are stored as long after multiplying it with "scaling_factor" for both doc values and stored field

Overrides:

derivedFieldGenerator in class FieldMapper