org.elasticsearch.index.mapper.internal

Class BoostFieldMapper

java.lang.Object

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

org.elasticsearch.index.mapper.core.NumberFieldMapper<Float>

org.elasticsearch.index.mapper.internal.BoostFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<Float>, AllFieldMapper.IncludeInAll, InternalMapper, Mapper, RootMapper

public class BoostFieldMapper
extends NumberFieldMapper<Float>
implements InternalMapper, RootMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoostFieldMapper.Builder
static class	BoostFieldMapper.Defaults
static class	BoostFieldMapper.TypeParser

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

NumberFieldMapper.CustomLongNumericDocValuesField, NumberFieldMapper.CustomNumericDocValuesField, NumberFieldMapper.CustomNumericField

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
static String	NAME

Fields inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper

coerce, ignoreMalformed, includeInAll, precisionStep, useSortedNumericDocValues

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
	BoostFieldMapper(Settings indexSettings)
protected	BoostFieldMapper(String name, String indexName, int precisionStep, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, Float nullValue, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, Settings fieldDataSettings, Settings indexSettings)
protected	BoostFieldMapper(String name, String indexName, Settings indexSettings)

Method Summary

Modifier and Type	Method and Description
protected String	contentType()
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
org.apache.lucene.search.Query	fuzzyQuery(String value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
boolean	hasDocValues()
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value) Returns the indexed value used to construct search "values".
protected void	innerParseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields)
protected int	maxPrecisionStep()
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.
void	parse(ParseContext context)
void	postParse(ParseContext context) Called after Mapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context) Called before Mapper.parse(ParseContext) on the RootObjectMapper.
org.apache.lucene.search.Filter	rangeFilter(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
org.apache.lucene.search.Filter	rangeFilter(QueryParseContext parseContext, Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context) A range filter based on the field data cache.
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Float	value(Object value) Returns the actual value of the field.

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

addDocValue, close, doXContentBody, fieldDataTermsFilter, includeInAll, includeInAllIfNotSet, isNumeric, parseCreateField, parseDoubleValue, parseLongValue, popCachedStream, precisionStep, termFilter, termQuery, unsetIncludeInAll, useTermQueryWithQueryString, valueForSearch

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

boost, copyTo, customBoost, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, fieldDataType, fieldType, indexAnalyzer, indexOptionToString, indexTokenizeOptionToString, isGenerated, isSortable, name, names, normsLoading, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termsFilter, termVectorOptionsToString, traverse, traverse

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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

BoostFieldMapper

public BoostFieldMapper(Settings indexSettings)

BoostFieldMapper

protected BoostFieldMapper(String name,
                           String indexName,
                           Settings indexSettings)

BoostFieldMapper

protected BoostFieldMapper(String name,
                           String indexName,
                           int precisionStep,
                           float boost,
                           org.apache.lucene.document.FieldType fieldType,
                           Boolean docValues,
                           Float nullValue,
                           PostingsFormatProvider postingsProvider,
                           DocValuesFormatProvider docValuesProvider,
                           @Nullable
                           Settings fieldDataSettings,
                           Settings indexSettings)

Method Detail

defaultFieldType

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

Specified by:

defaultFieldType in class AbstractFieldMapper<Float>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<Float>

hasDocValues

public boolean hasDocValues()

Specified by:

hasDocValues in interface FieldMapper<Float>

Overrides:

hasDocValues in class AbstractFieldMapper<Float>

maxPrecisionStep

protected int maxPrecisionStep()

Specified by:

maxPrecisionStep in class NumberFieldMapper<Float>

value

public Float value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

Specified by:

value in interface FieldMapper<Float>

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

Overrides:

indexedValueForSearch in class AbstractFieldMapper<Float>

fuzzyQuery

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

Specified by:

fuzzyQuery in interface FieldMapper<Float>

Specified by:

fuzzyQuery in class NumberFieldMapper<Float>

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

Specified by:

rangeQuery in class NumberFieldMapper<Float>

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

Specified by:

rangeFilter in class NumberFieldMapper<Float>

rangeFilter

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

Description copied from class: NumberFieldMapper

A range filter based on the field data cache.

Specified by:

rangeFilter in class NumberFieldMapper<Float>

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

Overrides:

nullValueFilter in class AbstractFieldMapper<Float>

preParse

public void preParse(ParseContext context)
              throws IOException

Description copied from interface: RootMapper

Called before Mapper.parse(ParseContext) on the RootObjectMapper.

Specified by:

preParse in interface RootMapper

Throws:

IOException

postParse

public void postParse(ParseContext context)
               throws IOException

Description copied from interface: RootMapper

Called after Mapper.parse(ParseContext) on the RootObjectMapper.

Specified by:

postParse in interface RootMapper

Throws:

IOException

includeInObject

public boolean includeInObject()

Description copied from interface: RootMapper

Should the mapper be included in the root ObjectMapper. If this method returns true, then Mapper.parse(ParseContext) will be called if the context has a property that matches the name of this RootMapper. Otherwise Mapper.parse(ParseContext) will not be called.

Specified by:

includeInObject in interface RootMapper

parse

public void parse(ParseContext context)
           throws IOException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<Float>

Throws:

IOException

innerParseCreateField

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

Specified by:

innerParseCreateField in class NumberFieldMapper<Float>

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<Float>

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractFieldMapper<Float>

Throws:

IOException

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class NumberFieldMapper<Float>

Throws:

MergeMappingException