org.elasticsearch.index.mapper.core

Class TokenCountFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.core.NumberFieldMapper

org.elasticsearch.index.mapper.core.IntegerFieldMapper

org.elasticsearch.index.mapper.core.TokenCountFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, AllFieldMapper.IncludeInAll

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

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

NumberFieldMapper.CustomLongNumericDocValuesField, NumberFieldMapper.CustomNumericDocValuesField, NumberFieldMapper.CustomNumericField, NumberFieldMapper.NumberFieldType

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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, useSortedNumericDocValues

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

copyTo, defaultFieldType, fieldType, indexCreatedBefore2x, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TokenCountFieldMapper(String simpleName, MappedFieldType fieldType, MappedFieldType defaultFieldType, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, Settings indexSettings, NamedAnalyzer analyzer, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Methods

Modifier and Type	Method and Description
String	analyzer() Name of analyzer.
protected String	contentType()
protected void	doMerge(Mapper mergeWith, boolean updateAllTypes) Merge changes coming from mergeWith in place.
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
boolean	isGenerated() Fields might not be available before indexing, for example _all, token_count,...
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, fieldType, innerParseCreateField

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

addDocValue, clone, includeInAll, includeInAllIfNotSet, parseDoubleValue, parseLongValue, unsetIncludeInAll

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

copyTo, doXContentAnalyzers, doXContentDocValues, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, iterator, merge, name, parse, termVectorOptionsToString, toXContent, updateFieldType

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

simpleName

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

TokenCountFieldMapper

protected TokenCountFieldMapper(String simpleName,
                     MappedFieldType fieldType,
                     MappedFieldType defaultFieldType,
                     Explicit<Boolean> ignoreMalformed,
                     Explicit<Boolean> coerce,
                     Settings indexSettings,
                     NamedAnalyzer analyzer,
                     FieldMapper.MultiFields multiFields,
                     FieldMapper.CopyTo copyTo)

Method Detail

parseCreateField

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

Description copied from class: FieldMapper

Parse the field value and populate fields.

Overrides:

parseCreateField in class NumberFieldMapper

Throws:

IOException

analyzer

public String analyzer()

Name of analyzer.

Returns:

name of analyzer

contentType

protected String contentType()

Overrides:

contentType in class IntegerFieldMapper

doMerge

protected void doMerge(Mapper mergeWith,
           boolean updateAllTypes)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class NumberFieldMapper

updateAllTypes - TODO

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: FieldMapper

Fields might not be available before indexing, for example _all, token_count,... When get is called and these fields are requested, this case needs special treatment.

Overrides:

isGenerated in class FieldMapper

Returns:

If the field is available before indexing or not.