org.elasticsearch.index.mapper.core

Class StringFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.core.StringFieldMapper

All Implemented Interfaces:

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

public class StringFieldMapper
extends FieldMapper
implements AllFieldMapper.IncludeInAll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringFieldMapper.Builder
static class	StringFieldMapper.Defaults
static class	StringFieldMapper.StringFieldType
static class	StringFieldMapper.TypeParser
static class	StringFieldMapper.ValueAndBoost Parsed value and boost to be returned from parseCreateFieldForString(org.elasticsearch.index.mapper.ParseContext, java.lang.String, float).

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.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	StringFieldMapper(String simpleName, MappedFieldType fieldType, MappedFieldType defaultFieldType, int positionIncrementGap, int ignoreAbove, Settings indexSettings, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Methods

Modifier and Type	Method and Description
protected StringFieldMapper	clone()
protected String	contentType()
protected boolean	customBoost() Derived classes can override it to specify that boost value is set by derived classes.
protected void	doMerge(Mapper mergeWith, boolean updateAllTypes) Merge changes coming from mergeWith in place.
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
int	getIgnoreAbove()
int	getPositionIncrementGap()
StringFieldMapper	includeInAll(Boolean includeInAll) If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.
StringFieldMapper	includeInAllIfNotSet(Boolean includeInAll) If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
static StringFieldMapper.ValueAndBoost	parseCreateFieldForString(ParseContext context, String nullValue, float defaultBoost) Parse a field as though it were a string.
StringFieldMapper	unsetIncludeInAll() If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.

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

copyTo, doXContentAnalyzers, doXContentDocValues, fieldType, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, isGenerated, 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

StringFieldMapper

protected StringFieldMapper(String simpleName,
                 MappedFieldType fieldType,
                 MappedFieldType defaultFieldType,
                 int positionIncrementGap,
                 int ignoreAbove,
                 Settings indexSettings,
                 FieldMapper.MultiFields multiFields,
                 FieldMapper.CopyTo copyTo)

Method Detail

clone

protected StringFieldMapper clone()

Overrides:

clone in class FieldMapper

includeInAll

public StringFieldMapper includeInAll(Boolean includeInAll)

Description copied from interface: AllFieldMapper.IncludeInAll

If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.

Specified by:

includeInAll in interface AllFieldMapper.IncludeInAll

includeInAllIfNotSet

public StringFieldMapper includeInAllIfNotSet(Boolean includeInAll)

Description copied from interface: AllFieldMapper.IncludeInAll

If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.

Specified by:

includeInAllIfNotSet in interface AllFieldMapper.IncludeInAll

unsetIncludeInAll

public StringFieldMapper unsetIncludeInAll()

Description copied from interface: AllFieldMapper.IncludeInAll

If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.

Specified by:

unsetIncludeInAll in interface AllFieldMapper.IncludeInAll

customBoost

protected boolean customBoost()

Description copied from class: FieldMapper

Derived classes can override it to specify that boost value is set by derived classes.

Overrides:

customBoost in class FieldMapper

getPositionIncrementGap

public int getPositionIncrementGap()

getIgnoreAbove

public int getIgnoreAbove()

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.

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

parseCreateFieldForString

public static StringFieldMapper.ValueAndBoost parseCreateFieldForString(ParseContext context,
                                                        String nullValue,
                                                        float defaultBoost)
                                                                 throws IOException

Parse a field as though it were a string.

Parameters:

context - parse context used during parsing

nullValue - value to use for null

defaultBoost - default boost value returned unless overwritten in the field

Returns:

the parsed field and the boost either parsed or defaulted

Throws:

IOException - if thrown while parsing

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

doMerge

protected void doMerge(Mapper mergeWith,
           boolean updateAllTypes)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class FieldMapper

updateAllTypes - TODO

doXContentBody

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

Overrides:

doXContentBody in class FieldMapper

Throws:

IOException