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:

java.lang.Cloneable, java.lang.Iterable<Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public 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.Defaults
static class	TextFieldMapper.TextFieldType
static class	TextFieldMapper.TypeParser

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONTENT_TYPE
static java.lang.String	FAST_PHRASE_SUFFIX

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

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextFieldMapper(java.lang.String simpleName, org.apache.lucene.document.FieldType fieldType, TextFieldMapper.TextFieldType mappedFieldType, int positionIncrementGap, org.elasticsearch.index.mapper.TextFieldMapper.PrefixFieldMapper prefixFieldMapper, org.elasticsearch.index.mapper.TextFieldMapper.PhraseFieldMapper phraseFieldMapper, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method	Description
protected TextFieldMapper	clone()
protected java.lang.String	contentType()
static org.apache.lucene.search.Query	createPhrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream, java.lang.String field, int slop, int maxExpansions, java.lang.String prefixField, java.util.function.IntPredicate usePrefixField)
static org.apache.lucene.search.Query	createPhraseQuery(org.apache.lucene.analysis.TokenStream stream, java.lang.String field, int slop, boolean enablePositionIncrements)
protected boolean	docValuesByDefault()
protected void	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params)
TextFieldMapper.TextFieldType	fieldType()
int	getPositionIncrementGap()
java.util.Iterator<Mapper>	iterator()
protected void	mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)	Merge type-specific options and check for incompatible settings in mappings to be merged
protected void	parseCreateField(ParseContext context)	Parse the field value and populate the fields on ParseContext.doc().

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

copyTo, createFieldNamesField, doXContentAnalyzers, indexedByDefault, indexOptionToString, merge, name, parse, parsesArrayValue, storedByDefault, termVectorOptionsToString, toXContent, typeName

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isFragment

Field Details

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

FAST_PHRASE_SUFFIX

public static final java.lang.String FAST_PHRASE_SUFFIX

See Also:

Constant Field Values

Constructor Details

TextFieldMapper

protected TextFieldMapper(java.lang.String simpleName, org.apache.lucene.document.FieldType fieldType, TextFieldMapper.TextFieldType mappedFieldType, int positionIncrementGap, org.elasticsearch.index.mapper.TextFieldMapper.PrefixFieldMapper prefixFieldMapper, org.elasticsearch.index.mapper.TextFieldMapper.PhraseFieldMapper phraseFieldMapper, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Details

clone

protected TextFieldMapper clone()

Overrides:

clone in class FieldMapper

getPositionIncrementGap

public int getPositionIncrementGap()

parseCreateField

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

Description copied from class: FieldMapper

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

java.io.IOException

iterator

public java.util.Iterator<Mapper> iterator()

Specified by:

iterator in interface java.lang.Iterable<Mapper>

Overrides:

iterator in class FieldMapper

contentType

protected java.lang.String contentType()

Specified by:

contentType in class FieldMapper

mergeOptions

protected void mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)

Description copied from class: FieldMapper

Merge type-specific options and check for incompatible settings in mappings to be merged

Specified by:

mergeOptions in class FieldMapper

fieldType

public TextFieldMapper.TextFieldType fieldType()

Overrides:

fieldType in class FieldMapper

docValuesByDefault

protected boolean docValuesByDefault()

Overrides:

docValuesByDefault in class FieldMapper

doXContentBody

protected void doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Overrides:

doXContentBody in class FieldMapper

Throws:

java.io.IOException

createPhraseQuery

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

Throws:

java.io.IOException

createPhrasePrefixQuery

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

Throws:

java.io.IOException