org.elasticsearch.index.mapper.core

Class StringFieldMapper

java.lang.Object

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

org.elasticsearch.index.mapper.core.StringFieldMapper

All Implemented Interfaces:

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

public class StringFieldMapper
extends AbstractFieldMapper<String>
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.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.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.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

StringFieldMapper(FieldMapper.Names names, float boost, org.apache.lucene.document.FieldType fieldType, org.apache.lucene.document.FieldType defaultFieldType, Boolean docValues, String nullValue, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, NamedAnalyzer searchQuotedAnalyzer, int positionOffsetGap, int ignoreAbove, PostingsFormatProvider postingsFormat, DocValuesFormatProvider docValuesFormat, SimilarityProvider similarity, FieldMapper.Loading normsLoading, Settings fieldDataSettings, Settings indexSettings, AbstractFieldMapper.MultiFields multiFields, AbstractFieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method and Description
protected String	contentType()
protected boolean	customBoost() Derived classes can override it to specify that boost value is set by derived classes.
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
int	getPositionOffsetGap()
void	includeInAll(Boolean includeInAll)
void	includeInAllIfNotSet(Boolean includeInAll)
void	merge(Mapper mergeWith, MergeContext mergeContext)
org.apache.lucene.search.Filter	nullValueFilter() Null value filter, returns null if there is no null value associated with the field.
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.
org.apache.lucene.analysis.Analyzer	searchQuoteAnalyzer() The analyzer that will be used for quoted search on the field.
void	unsetIncludeInAll()
String	value(Object value) Returns the actual value of the field.

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

boost, close, copyTo, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, fieldDataTermsFilter, fieldDataType, fieldType, fuzzyQuery, hasDocValues, indexAnalyzer, indexedValueForSearch, indexOptionToString, indexTokenizeOptionToString, isGenerated, isNumeric, isSortable, name, names, normsLoading, parse, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, rangeFilter, rangeQuery, regexpFilter, regexpQuery, searchAnalyzer, similarity, stats, supportsNullValue, termFilter, termQuery, termsFilter, termVectorOptionsToString, toXContent, traverse, traverse, useTermQueryWithQueryString, valueForSearch

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

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

StringFieldMapper

protected StringFieldMapper(FieldMapper.Names names,
                            float boost,
                            org.apache.lucene.document.FieldType fieldType,
                            org.apache.lucene.document.FieldType defaultFieldType,
                            Boolean docValues,
                            String nullValue,
                            NamedAnalyzer indexAnalyzer,
                            NamedAnalyzer searchAnalyzer,
                            NamedAnalyzer searchQuotedAnalyzer,
                            int positionOffsetGap,
                            int ignoreAbove,
                            PostingsFormatProvider postingsFormat,
                            DocValuesFormatProvider docValuesFormat,
                            SimilarityProvider similarity,
                            FieldMapper.Loading normsLoading,
                            @Nullable
                            Settings fieldDataSettings,
                            Settings indexSettings,
                            AbstractFieldMapper.MultiFields multiFields,
                            AbstractFieldMapper.CopyTo copyTo)

Method Detail

defaultFieldType

public org.apache.lucene.document.FieldType defaultFieldType()

Specified by:

defaultFieldType in class AbstractFieldMapper<String>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<String>

includeInAll

public void includeInAll(Boolean includeInAll)

Specified by:

includeInAll in interface AllFieldMapper.IncludeInAll

includeInAllIfNotSet

public void includeInAllIfNotSet(Boolean includeInAll)

Specified by:

includeInAllIfNotSet in interface AllFieldMapper.IncludeInAll

unsetIncludeInAll

public void unsetIncludeInAll()

Specified by:

unsetIncludeInAll in interface AllFieldMapper.IncludeInAll

value

public String value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

Specified by:

value in interface FieldMapper<String>

customBoost

protected boolean customBoost()

Description copied from class: AbstractFieldMapper

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

Overrides:

customBoost in class AbstractFieldMapper<String>

getPositionOffsetGap

public int getPositionOffsetGap()

searchQuoteAnalyzer

public org.apache.lucene.analysis.Analyzer searchQuoteAnalyzer()

Description copied from interface: FieldMapper

The analyzer that will be used for quoted search on the field.

Specified by:

searchQuoteAnalyzer in interface FieldMapper<String>

Overrides:

searchQuoteAnalyzer in class AbstractFieldMapper<String>

nullValueFilter

public org.apache.lucene.search.Filter nullValueFilter()

Description copied from interface: FieldMapper

Null value filter, returns null if there is no null value associated with the field.

Specified by:

nullValueFilter in interface FieldMapper<String>

Overrides:

nullValueFilter in class AbstractFieldMapper<String>

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.

Specified by:

parseCreateField in class AbstractFieldMapper<String>

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 AbstractFieldMapper<String>

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<String>

Throws:

MergeMappingException

doXContentBody

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

Overrides:

doXContentBody in class AbstractFieldMapper<String>

Throws:

IOException