Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class TextFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.TextFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public final class TextFieldMapper
extends FieldMapper

A FieldMapper for full-text fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextFieldMapper.Builder
static class	TextFieldMapper.ConstantScoreTextFieldType
static class	TextFieldMapper.Defaults
static class	TextFieldMapper.SyntheticSourceHelper
static class	TextFieldMapper.TextFieldType

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

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TextFamilyBuilder, FieldMapper.TypeParser

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

Mapper.IgnoreAbove, Mapper.SourceKeepMode

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

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

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

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

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

SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
static org.apache.lucene.search.Query	createPhrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream, String field, int slop, int maxExpansions, String prefixField, IntPredicate usePrefixField)
static org.apache.lucene.search.Query	createPhraseQuery(org.apache.lucene.analysis.TokenStream stream, String field, int slop, boolean enablePositionIncrements)
protected void	doXContentBody(XContentBuilder builder, ToXContent.Params params)
TextFieldMapper.TextFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
Map<String,NamedAnalyzer>	indexAnalyzers()
static boolean	keywordMultiFieldsNotStoredWhenIgnoredIndexVersionCheck(IndexVersion indexCreatedVersion)	Returns whether the current index version supports not storing keyword multi fields when they trip ignore_above.
static boolean	multiFieldsNotStoredByDefaultIndexVersionCheck(IndexVersion indexCreatedVersion)	Returns whether the current index version supports not storing fields by default when they're multi fields.
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
protected FieldMapper.SyntheticSourceSupport	syntheticSourceSupport()	Returns implementation of synthetic source support for the mapper.

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

checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doParseMultiFields, doValidate, executeScript, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, syntheticVectorsLoader, throwIndexingWithScriptParam, toXContent, typeName, validate

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

freezeAndDeduplicateFieldType, getOffsetFieldName, internFieldName, leafName, supportStoringArrayOffsets, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final FieldMapper.TypeParser PARSER

Method Details

indexAnalyzers

public Map<String,NamedAnalyzer> indexAnalyzers()

Overrides:

indexAnalyzers in class FieldMapper

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

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

Specified by:

getMergeBuilder in class FieldMapper

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

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

keywordMultiFieldsNotStoredWhenIgnoredIndexVersionCheck

public static boolean keywordMultiFieldsNotStoredWhenIgnoredIndexVersionCheck(IndexVersion indexCreatedVersion)

Returns whether the current index version supports not storing keyword multi fields when they trip ignore_above. The consequence of this check is that the store parameter will be simplified and defaulted to false.

multiFieldsNotStoredByDefaultIndexVersionCheck

public static boolean multiFieldsNotStoredByDefaultIndexVersionCheck(IndexVersion indexCreatedVersion)

Returns whether the current index version supports not storing fields by default when they're multi fields.

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

fieldType

public TextFieldMapper.TextFieldType fieldType()

Overrides:

fieldType in class FieldMapper

createPhraseQuery

public static org.apache.lucene.search.Query createPhraseQuery(org.apache.lucene.analysis.TokenStream stream,
 String field,
 int slop,
 boolean enablePositionIncrements)
                                                        throws IOException

Throws:

IOException

createPhrasePrefixQuery

public static org.apache.lucene.search.Query createPhrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream,
 String field,
 int slop,
 int maxExpansions,
 String prefixField,
 IntPredicate usePrefixField)
                                                              throws IOException

Throws:

IOException

doXContentBody

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

Overrides:

doXContentBody in class FieldMapper

Throws:

IOException

syntheticSourceSupport

protected FieldMapper.SyntheticSourceSupport syntheticSourceSupport()

Description copied from class: FieldMapper

Returns implementation of synthetic source support for the mapper.
By default (meaning FieldMapper.SyntheticSourceSupport.Fallback), an exact full copy of parsed field value is stored separately and used for synthetic source.

Field mappers must override this method if they provide a more efficient field-specific implementation of synthetic source.

Overrides:

syntheticSourceSupport in class FieldMapper

Returns:

FieldMapper.SyntheticSourceMode