Package org.opensearch.index.mapper

Class TokenCountFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.TokenCountFieldMapper

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<Mapper>, ToXContent, ToXContentFragment

public class TokenCountFieldMapper
extends ParametrizedFieldMapper

A FieldMapper that takes a string and writes a count of the tokens in that string to the index. In most ways the mapper acts just like an NumberFieldMapper.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TokenCountFieldMapper.Builder

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

ParametrizedFieldMapper.Parameter<T extends java.lang.Object>, ParametrizedFieldMapper.Serializer<T extends java.lang.Object>, ParametrizedFieldMapper.SerializerCheck<T extends java.lang.Object>, 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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

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

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

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TokenCountFieldMapper(java.lang.String simpleName, MappedFieldType defaultFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, TokenCountFieldMapper.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	analyzer()	Name of analyzer.
protected java.lang.String	contentType()
boolean	enablePositionIncrements()	Indicates if position increments are counted.
ParametrizedFieldMapper.Builder	getMergeBuilder()
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

clone, copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, fieldType, 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 Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

PARSER

public static ParametrizedFieldMapper.TypeParser PARSER

Constructor Detail

TokenCountFieldMapper

protected TokenCountFieldMapper(java.lang.String simpleName,
                                MappedFieldType defaultFieldType,
                                FieldMapper.MultiFields multiFields,
                                FieldMapper.CopyTo copyTo,
                                TokenCountFieldMapper.Builder builder)

Method Detail

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws java.io.IOException

Specified by:

parseCreateField in class FieldMapper

Throws:

java.io.IOException

analyzer

public java.lang.String analyzer()

Name of analyzer.

Returns:

name of analyzer

enablePositionIncrements

public boolean enablePositionIncrements()

Indicates if position increments are counted.

Returns:

true if position increments are counted

contentType

protected java.lang.String contentType()

Specified by:

contentType in class FieldMapper

getMergeBuilder

public ParametrizedFieldMapper.Builder getMergeBuilder()

Specified by:

getMergeBuilder in class ParametrizedFieldMapper