org.elasticsearch.index.mapper.core

Class AbstractFieldMapper<T>

java.lang.Object

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

All Implemented Interfaces:

ToXContent, FieldMapper<T>, Mapper

Direct Known Subclasses:

AllFieldMapper, BinaryFieldMapper, BooleanFieldMapper, CompletionFieldMapper, FieldNamesFieldMapper, GeoPointFieldMapper, GeoShapeFieldMapper, IdFieldMapper, IndexFieldMapper, NumberFieldMapper, ParentFieldMapper, RoutingFieldMapper, SourceFieldMapper, StringFieldMapper, TypeFieldMapper, UidFieldMapper, VersionFieldMapper

public abstract class AbstractFieldMapper<T>
extends Object
implements FieldMapper<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFieldMapper.Builder<T extends AbstractFieldMapper.Builder,Y extends AbstractFieldMapper>
static class	AbstractFieldMapper.CopyTo Represents a list of fields with optional boost factor where the current field should be copied to
static class	AbstractFieldMapper.Defaults
static class	AbstractFieldMapper.MultiFields

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

FieldMapper.Loading, FieldMapper.Names

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

Mapper.BuilderContext, Mapper.TypeParser

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
protected float	boost
protected AbstractFieldMapper.CopyTo	copyTo
protected Settings	customFieldDataSettings
protected boolean	docValues
protected DocValuesFormatProvider	docValuesFormat
protected FieldDataType	fieldDataType
protected org.apache.lucene.document.FieldType	fieldType
protected NamedAnalyzer	indexAnalyzer
protected AbstractFieldMapper.MultiFields	multiFields
protected FieldMapper.Names	names
protected FieldMapper.Loading	normsLoading
protected PostingsFormatProvider	postingsFormat
protected NamedAnalyzer	searchAnalyzer
protected SimilarityProvider	similarity

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

DOC_VALUES_FORMAT

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

EMPTY_ARRAY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFieldMapper(FieldMapper.Names names, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, PostingsFormatProvider postingsFormat, DocValuesFormatProvider docValuesFormat, SimilarityProvider similarity, FieldMapper.Loading normsLoading, Settings fieldDataSettings, Settings indexSettings)
protected	AbstractFieldMapper(FieldMapper.Names names, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, 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
float	boost()
void	close()
protected abstract String	contentType()
AbstractFieldMapper.CopyTo	copyTo() List of fields where this field should be copied to
protected boolean	customBoost() Derived classes can override it to specify that boost value is set by derived classes.
protected String	defaultDocValuesFormat()
abstract FieldDataType	defaultFieldDataType()
abstract org.apache.lucene.document.FieldType	defaultFieldType()
protected String	defaultPostingFormat()
DocValuesFormatProvider	docValuesFormatProvider()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
org.apache.lucene.search.Filter	fieldDataTermsFilter(List values, QueryParseContext context) A terms filter based on the field data cache
FieldDataType	fieldDataType()
org.apache.lucene.document.FieldType	fieldType()
org.apache.lucene.search.Query	fuzzyQuery(String value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
boolean	hasDocValues()
org.apache.lucene.analysis.Analyzer	indexAnalyzer() The analyzer that will be used to index the field.
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value) Returns the indexed value used to construct search "values".
protected static String	indexOptionToString(org.apache.lucene.index.FieldInfo.IndexOptions indexOption)
protected static String	indexTokenizeOptionToString(boolean indexed, boolean tokenized)
boolean	isGenerated() Returns if this field is only generated when indexing.
boolean	isNumeric()
boolean	isSortable()
void	merge(Mapper mergeWith, MergeContext mergeContext)
String	name()
FieldMapper.Names	names()
FieldMapper.Loading	normsLoading(FieldMapper.Loading defaultLoading)
org.apache.lucene.search.Filter	nullValueFilter() Null value filter, returns null if there is no null value associated with the field.
void	parse(ParseContext context)
protected abstract void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
PostingsFormatProvider	postingsFormatProvider()
org.apache.lucene.search.Filter	prefixFilter(Object value, QueryParseContext context)
org.apache.lucene.search.Query	prefixQuery(Object value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
org.apache.lucene.search.Query	queryStringTermQuery(org.apache.lucene.index.Term term) A term query to use when parsing a query string.
org.apache.lucene.search.Filter	rangeFilter(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
org.apache.lucene.search.Filter	regexpFilter(Object value, int flags, int maxDeterminizedStates, QueryParseContext parseContext)
org.apache.lucene.search.Query	regexpQuery(Object value, int flags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
org.apache.lucene.analysis.Analyzer	searchAnalyzer() The analyzer that will be used to search the field.
org.apache.lucene.analysis.Analyzer	searchQuoteAnalyzer() The analyzer that will be used for quoted search on the field.
SimilarityProvider	similarity() Similarity used for scoring queries on the field
FieldStats	stats(org.apache.lucene.index.Terms terms, int maxDoc)
boolean	supportsNullValue()
org.apache.lucene.search.Filter	termFilter(Object value, QueryParseContext context)
org.apache.lucene.search.Query	termQuery(Object value, QueryParseContext context)
org.apache.lucene.search.Filter	termsFilter(List values, QueryParseContext context)
static String	termVectorOptionsToString(org.apache.lucene.document.FieldType fieldType)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	traverse(FieldMapperListener fieldMapperListener)
void	traverse(ObjectMapperListener objectMapperListener)
boolean	useTermQueryWithQueryString() Should the field query FieldMapper.termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.
Object	valueForSearch(Object value) Returns the value that will be used as a result for search.

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

value

Field Detail

names

protected final FieldMapper.Names names

boost

protected float boost

fieldType

protected org.apache.lucene.document.FieldType fieldType

docValues

protected final boolean docValues

indexAnalyzer

protected final NamedAnalyzer indexAnalyzer

searchAnalyzer

protected NamedAnalyzer searchAnalyzer

postingsFormat

protected PostingsFormatProvider postingsFormat

docValuesFormat

protected DocValuesFormatProvider docValuesFormat

similarity

protected final SimilarityProvider similarity

normsLoading

protected FieldMapper.Loading normsLoading

customFieldDataSettings

protected Settings customFieldDataSettings

fieldDataType

protected FieldDataType fieldDataType

multiFields

protected final AbstractFieldMapper.MultiFields multiFields

copyTo

protected AbstractFieldMapper.CopyTo copyTo

Constructor Detail

AbstractFieldMapper

protected AbstractFieldMapper(FieldMapper.Names names,
                              float boost,
                              org.apache.lucene.document.FieldType fieldType,
                              Boolean docValues,
                              NamedAnalyzer indexAnalyzer,
                              NamedAnalyzer searchAnalyzer,
                              PostingsFormatProvider postingsFormat,
                              DocValuesFormatProvider docValuesFormat,
                              SimilarityProvider similarity,
                              FieldMapper.Loading normsLoading,
                              @Nullable
                              Settings fieldDataSettings,
                              Settings indexSettings)

AbstractFieldMapper

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

Method Detail

defaultPostingFormat

@Nullable
protected String defaultPostingFormat()

defaultDocValuesFormat

@Nullable
protected String defaultDocValuesFormat()

name

public String name()

Specified by:

name in interface Mapper

names

public FieldMapper.Names names()

Specified by:

names in interface FieldMapper<T>

defaultFieldType

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

defaultFieldDataType

public abstract FieldDataType defaultFieldDataType()

fieldDataType

public final FieldDataType fieldDataType()

Specified by:

fieldDataType in interface FieldMapper<T>

fieldType

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

Specified by:

fieldType in interface FieldMapper<T>

boost

public float boost()

Specified by:

boost in interface FieldMapper<T>

indexAnalyzer

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

Description copied from interface: FieldMapper

The analyzer that will be used to index the field.

Specified by:

indexAnalyzer in interface FieldMapper<T>

searchAnalyzer

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

Description copied from interface: FieldMapper

The analyzer that will be used to search the field.

Specified by:

searchAnalyzer in interface FieldMapper<T>

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<T>

similarity

public SimilarityProvider similarity()

Description copied from interface: FieldMapper

Similarity used for scoring queries on the field

Specified by:

similarity in interface FieldMapper<T>

copyTo

public AbstractFieldMapper.CopyTo copyTo()

Description copied from interface: FieldMapper

List of fields where this field should be copied to

Specified by:

copyTo in interface FieldMapper<T>

parse

public void parse(ParseContext context)
           throws IOException

Specified by:

parse in interface Mapper

Throws:

IOException

parseCreateField

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

Parse the field value and populate fields.

Throws:

IOException

customBoost

protected boolean customBoost()

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

traverse

public void traverse(FieldMapperListener fieldMapperListener)

Specified by:

traverse in interface Mapper

traverse

public void traverse(ObjectMapperListener objectMapperListener)

Specified by:

traverse in interface Mapper

valueForSearch

public Object valueForSearch(Object value)

Description copied from interface: FieldMapper

Returns the value that will be used as a result for search. Can be only of specific types... .

Specified by:

valueForSearch in interface FieldMapper<T>

indexedValueForSearch

public org.apache.lucene.util.BytesRef indexedValueForSearch(Object value)

Description copied from interface: FieldMapper

Returns the indexed value used to construct search "values".

Specified by:

indexedValueForSearch in interface FieldMapper<T>

queryStringTermQuery

public org.apache.lucene.search.Query queryStringTermQuery(org.apache.lucene.index.Term term)

Description copied from interface: FieldMapper

A term query to use when parsing a query string. Can return null.

Specified by:

queryStringTermQuery in interface FieldMapper<T>

useTermQueryWithQueryString

public boolean useTermQueryWithQueryString()

Description copied from interface: FieldMapper

Should the field query FieldMapper.termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.

Specified by:

useTermQueryWithQueryString in interface FieldMapper<T>

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
                                                @Nullable
                                                QueryParseContext context)

Specified by:

termQuery in interface FieldMapper<T>

termFilter

public org.apache.lucene.search.Filter termFilter(Object value,
                                                  @Nullable
                                                  QueryParseContext context)

Specified by:

termFilter in interface FieldMapper<T>

termsFilter

public org.apache.lucene.search.Filter termsFilter(List values,
                                                   @Nullable
                                                   QueryParseContext context)

Specified by:

termsFilter in interface FieldMapper<T>

fieldDataTermsFilter

public org.apache.lucene.search.Filter fieldDataTermsFilter(List values,
                                                            @Nullable
                                                            QueryParseContext context)

A terms filter based on the field data cache

Specified by:

fieldDataTermsFilter in interface FieldMapper<T>

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
                                                 Object upperTerm,
                                                 boolean includeLower,
                                                 boolean includeUpper,
                                                 @Nullable
                                                 QueryParseContext context)

Specified by:

rangeQuery in interface FieldMapper<T>

rangeFilter

public org.apache.lucene.search.Filter rangeFilter(Object lowerTerm,
                                                   Object upperTerm,
                                                   boolean includeLower,
                                                   boolean includeUpper,
                                                   @Nullable
                                                   QueryParseContext context)

Specified by:

rangeFilter in interface FieldMapper<T>

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(String value,
                                                 Fuzziness fuzziness,
                                                 int prefixLength,
                                                 int maxExpansions,
                                                 boolean transpositions)

Specified by:

fuzzyQuery in interface FieldMapper<T>

prefixQuery

public org.apache.lucene.search.Query prefixQuery(Object value,
                                                  @Nullable
                                                  org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                                  @Nullable
                                                  QueryParseContext context)

Specified by:

prefixQuery in interface FieldMapper<T>

prefixFilter

public org.apache.lucene.search.Filter prefixFilter(Object value,
                                                    @Nullable
                                                    QueryParseContext context)

Specified by:

prefixFilter in interface FieldMapper<T>

regexpQuery

public org.apache.lucene.search.Query regexpQuery(Object value,
                                                  int flags,
                                                  int maxDeterminizedStates,
                                                  @Nullable
                                                  org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                                  @Nullable
                                                  QueryParseContext context)

Specified by:

regexpQuery in interface FieldMapper<T>

regexpFilter

public org.apache.lucene.search.Filter regexpFilter(Object value,
                                                    int flags,
                                                    int maxDeterminizedStates,
                                                    @Nullable
                                                    QueryParseContext parseContext)

Specified by:

regexpFilter in interface FieldMapper<T>

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<T>

merge

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

Specified by:

merge in interface Mapper

Throws:

MergeMappingException

postingsFormatProvider

public PostingsFormatProvider postingsFormatProvider()

Specified by:

postingsFormatProvider in interface FieldMapper<T>

docValuesFormatProvider

public DocValuesFormatProvider docValuesFormatProvider()

Specified by:

docValuesFormatProvider in interface FieldMapper<T>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContentBody

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

Throws:

IOException

indexOptionToString

protected static String indexOptionToString(org.apache.lucene.index.FieldInfo.IndexOptions indexOption)

termVectorOptionsToString

public static String termVectorOptionsToString(org.apache.lucene.document.FieldType fieldType)

indexTokenizeOptionToString

protected static String indexTokenizeOptionToString(boolean indexed,
                                                    boolean tokenized)

contentType

protected abstract String contentType()

close

public void close()

Specified by:

close in interface Mapper

isNumeric

public boolean isNumeric()

Specified by:

isNumeric in interface FieldMapper<T>

isSortable

public boolean isSortable()

Specified by:

isSortable in interface FieldMapper<T>

supportsNullValue

public boolean supportsNullValue()

Specified by:

supportsNullValue in interface FieldMapper<T>

hasDocValues

public boolean hasDocValues()

Specified by:

hasDocValues in interface FieldMapper<T>

normsLoading

public FieldMapper.Loading normsLoading(FieldMapper.Loading defaultLoading)

Specified by:

normsLoading in interface FieldMapper<T>

isGenerated

public boolean isGenerated()

Returns if this field is only generated when indexing. For example, the field of type token_count

Specified by:

isGenerated in interface FieldMapper<T>

Returns:

If the field is available before indexing or not.

stats

public FieldStats stats(org.apache.lucene.index.Terms terms,
                        int maxDoc)
                 throws IOException

Specified by:

stats in interface FieldMapper<T>

Returns:

a FieldStats instance that maps to the type of this field based on the provided Terms instance.

Throws:

IOException