org.elasticsearch.index.mapper.core

Class TokenCountFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.core.AbstractFieldMapper<T>

org.elasticsearch.index.mapper.core.NumberFieldMapper<Integer>

org.elasticsearch.index.mapper.core.IntegerFieldMapper

org.elasticsearch.index.mapper.core.TokenCountFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<Integer>, AllFieldMapper.IncludeInAll, Mapper

public class TokenCountFieldMapper
extends IntegerFieldMapper

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 IntegerFieldMapper.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenCountFieldMapper.Builder
static class	TokenCountFieldMapper.Defaults
static class	TokenCountFieldMapper.TypeParser

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

IntegerFieldMapper.CustomIntegerNumericField

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

NumberFieldMapper.CustomLongNumericDocValuesField, NumberFieldMapper.CustomNumericDocValuesField, NumberFieldMapper.CustomNumericField

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

AbstractFieldMapper.CopyTo, AbstractFieldMapper.MultiFields

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

Mapper.BuilderContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

FieldMapper.Loading, FieldMapper.Names

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE

Fields inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper

coerce, ignoreMalformed, includeInAll, precisionStep, useSortedNumericDocValues

Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, copyTo, customFieldDataSettings, docValues, docValuesFormat, fieldDataType, fieldType, indexAnalyzer, multiFields, names, normsLoading, postingsFormat, searchAnalyzer, similarity

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

EMPTY_ARRAY

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

EMPTY_PARAMS

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

DOC_VALUES_FORMAT

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

TokenCountFieldMapper(FieldMapper.Names names, int precisionStep, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, Integer nullValue, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, SimilarityProvider similarity, FieldMapper.Loading normsLoading, Settings fieldDataSettings, Settings indexSettings, NamedAnalyzer analyzer, AbstractFieldMapper.MultiFields multiFields, AbstractFieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method and Description
String	analyzer() Name of analyzer.
protected String	contentType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
boolean	isGenerated() Returns if this field is only generated when indexing.
void	merge(Mapper mergeWith, MergeContext mergeContext)
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.

Methods inherited from class org.elasticsearch.index.mapper.core.IntegerFieldMapper

addIntegerFields, customBoost, defaultFieldDataType, defaultFieldType, fuzzyQuery, indexedValueForSearch, innerParseCreateField, maxPrecisionStep, nullValue, nullValueFilter, rangeFilter, rangeFilter, rangeQuery, stats, value

Methods inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper

addDocValue, close, fieldDataTermsFilter, includeInAll, includeInAllIfNotSet, isNumeric, parseDoubleValue, parseLongValue, popCachedStream, precisionStep, termFilter, termQuery, unsetIncludeInAll, useTermQueryWithQueryString, valueForSearch

Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, copyTo, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, fieldDataType, fieldType, hasDocValues, indexAnalyzer, indexOptionToString, indexTokenizeOptionToString, isSortable, name, names, normsLoading, parse, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, supportsNullValue, termsFilter, termVectorOptionsToString, toXContent, traverse, traverse

Methods inherited from class java.lang.Object

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

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

name, parse, traverse, traverse

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

TokenCountFieldMapper

protected TokenCountFieldMapper(FieldMapper.Names names,
                                int precisionStep,
                                float boost,
                                org.apache.lucene.document.FieldType fieldType,
                                Boolean docValues,
                                Integer nullValue,
                                Explicit<Boolean> ignoreMalformed,
                                Explicit<Boolean> coerce,
                                PostingsFormatProvider postingsProvider,
                                DocValuesFormatProvider docValuesProvider,
                                SimilarityProvider similarity,
                                FieldMapper.Loading normsLoading,
                                Settings fieldDataSettings,
                                Settings indexSettings,
                                NamedAnalyzer analyzer,
                                AbstractFieldMapper.MultiFields multiFields,
                                AbstractFieldMapper.CopyTo copyTo)

Method Detail

parseCreateField

protected void parseCreateField(ParseContext context,
                                List<org.apache.lucene.document.Field> fields)
                         throws IOException

Description copied from class: AbstractFieldMapper

Parse the field value and populate fields.

Overrides:

parseCreateField in class NumberFieldMapper<Integer>

Throws:

IOException

analyzer

public String analyzer()

Name of analyzer.

Returns:

name of analyzer

contentType

protected String contentType()

Overrides:

contentType in class IntegerFieldMapper

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException

Specified by:

merge in interface Mapper

Overrides:

merge in class IntegerFieldMapper

Throws:

MergeMappingException

doXContentBody

protected void doXContentBody(XContentBuilder builder,
                              boolean includeDefaults,
                              ToXContent.Params params)
                       throws IOException

Overrides:

doXContentBody in class IntegerFieldMapper

Throws:

IOException

isGenerated

public boolean isGenerated()

Description copied from class: AbstractFieldMapper

Returns if this field is only generated when indexing. For example, the field of type token_count

Specified by:

isGenerated in interface FieldMapper<Integer>

Overrides:

isGenerated in class AbstractFieldMapper<Integer>

Returns:

If the field is available before indexing or not.