org.elasticsearch.index.mapper.internal
Class BoostFieldMapper

java.lang.Object
  extended by org.elasticsearch.index.mapper.core.AbstractFieldMapper<T>
      extended by org.elasticsearch.index.mapper.core.NumberFieldMapper<java.lang.Float>
          extended by org.elasticsearch.index.mapper.internal.BoostFieldMapper
All Implemented Interfaces:
ToXContent, FieldMapper<java.lang.Float>, AllFieldMapper.IncludeInAll, InternalMapper, Mapper, RootMapper

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


Nested Class Summary
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.CustomNumericField
 
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
AbstractFieldMapper.OpenBuilder<T extends AbstractFieldMapper.Builder,Y extends AbstractFieldMapper>
 
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.MapParams, ToXContent.Params
 
Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.FieldMapper
FieldMapper.Names
 
Field Summary
static java.lang.String CONTENT_TYPE
           
static java.lang.String NAME
           
 
Fields inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper
dFuzzyFactor, fuzzyFactor, includeInAll, precisionStep
 
Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
boost, index, indexAnalyzer, indexOptions, names, omitNorms, omitTermFreqAndPositions, searchAnalyzer, store, termVector
 
Fields inherited from interface org.elasticsearch.index.mapper.Mapper
EMPTY_ARRAY
 
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
 
Constructor Summary
  BoostFieldMapper()
           
protected BoostFieldMapper(java.lang.String name, java.lang.String indexName)
           
protected BoostFieldMapper(java.lang.String name, java.lang.String indexName, int precisionStep, org.apache.lucene.document.Field.Index index, org.apache.lucene.document.Field.Store store, float boost, boolean omitNorms, boolean omitTermFreqAndPositions, java.lang.Float nullValue)
           
 
Method Summary
protected  java.lang.String contentType()
           
 FieldDataType fieldDataType()
           
 org.apache.lucene.search.Query fuzzyQuery(java.lang.String value, double minSim, int prefixLength, int maxExpansions)
           
 org.apache.lucene.search.Query fuzzyQuery(java.lang.String value, java.lang.String minSim, int prefixLength, int maxExpansions)
           
 boolean includeInObject()
          Should the mapper be included in the root ObjectMapper.
 java.lang.String indexedValue(java.lang.String value)
          Returns the indexed value.
protected  int maxPrecisionStep()
           
 void merge(Mapper mergeWith, MergeContext mergeContext)
           
 void parse(ParseContext context)
           
protected  org.apache.lucene.document.Fieldable parseCreateField(ParseContext context)
           
 void postParse(ParseContext context)
           
 void preParse(ParseContext context)
           
 org.apache.lucene.search.Filter rangeFilter(FieldDataCache fieldDataCache, java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper)
          A range filter based on the field data cache.
 org.apache.lucene.search.Filter rangeFilter(java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper)
          Constructs a range query filter based on the mapper.
 org.apache.lucene.search.Query rangeQuery(java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper)
          Constructs a range query based on the mapper.
 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params)
           
 void validate(ParseContext context)
           
 java.lang.Float value(org.apache.lucene.document.Fieldable field)
          Returns the actual value of the field.
 java.lang.Float valueFromString(java.lang.String value)
           
 
Methods inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper
close, fieldFilter, fieldQuery, includeInAll, includeInAllIfNotSet, parseFuzzyFactor, popCachedStream, precisionStep, useFieldQueryWithQueryString, valueAsString, valueForSearch
 
Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
analyzed, boost, customBoost, doXContentBody, index, indexAnalyzer, indexed, name, names, omitNorms, omitTermFreqAndPositions, queryStringTermQuery, searchAnalyzer, store, stored, termVector, 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 java.lang.String CONTENT_TYPE
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Constructor Detail

BoostFieldMapper

public BoostFieldMapper()

BoostFieldMapper

protected BoostFieldMapper(java.lang.String name,
                           java.lang.String indexName)

BoostFieldMapper

protected BoostFieldMapper(java.lang.String name,
                           java.lang.String indexName,
                           int precisionStep,
                           org.apache.lucene.document.Field.Index index,
                           org.apache.lucene.document.Field.Store store,
                           float boost,
                           boolean omitNorms,
                           boolean omitTermFreqAndPositions,
                           java.lang.Float nullValue)
Method Detail

maxPrecisionStep

protected int maxPrecisionStep()
Specified by:
maxPrecisionStep in class NumberFieldMapper<java.lang.Float>

value

public java.lang.Float value(org.apache.lucene.document.Fieldable field)
Description copied from interface: FieldMapper
Returns the actual value of the field.

Specified by:
value in interface FieldMapper<java.lang.Float>

valueFromString

public java.lang.Float valueFromString(java.lang.String value)
Specified by:
valueFromString in interface FieldMapper<java.lang.Float>

indexedValue

public java.lang.String indexedValue(java.lang.String value)
Description copied from interface: FieldMapper
Returns the indexed value.

Specified by:
indexedValue in interface FieldMapper<java.lang.Float>
Overrides:
indexedValue in class AbstractFieldMapper<java.lang.Float>

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(java.lang.String value,
                                                 java.lang.String minSim,
                                                 int prefixLength,
                                                 int maxExpansions)
Specified by:
fuzzyQuery in interface FieldMapper<java.lang.Float>
Specified by:
fuzzyQuery in class NumberFieldMapper<java.lang.Float>

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(java.lang.String value,
                                                 double minSim,
                                                 int prefixLength,
                                                 int maxExpansions)
Specified by:
fuzzyQuery in interface FieldMapper<java.lang.Float>
Specified by:
fuzzyQuery in class NumberFieldMapper<java.lang.Float>

rangeQuery

public org.apache.lucene.search.Query rangeQuery(java.lang.String lowerTerm,
                                                 java.lang.String upperTerm,
                                                 boolean includeLower,
                                                 boolean includeUpper)
Description copied from interface: FieldMapper
Constructs a range query based on the mapper.

Specified by:
rangeQuery in interface FieldMapper<java.lang.Float>
Specified by:
rangeQuery in class NumberFieldMapper<java.lang.Float>

rangeFilter

public org.apache.lucene.search.Filter rangeFilter(java.lang.String lowerTerm,
                                                   java.lang.String upperTerm,
                                                   boolean includeLower,
                                                   boolean includeUpper)
Description copied from interface: FieldMapper
Constructs a range query filter based on the mapper.

Specified by:
rangeFilter in interface FieldMapper<java.lang.Float>
Specified by:
rangeFilter in class NumberFieldMapper<java.lang.Float>

rangeFilter

public org.apache.lucene.search.Filter rangeFilter(FieldDataCache fieldDataCache,
                                                   java.lang.String lowerTerm,
                                                   java.lang.String upperTerm,
                                                   boolean includeLower,
                                                   boolean includeUpper)
Description copied from class: NumberFieldMapper
A range filter based on the field data cache.

Specified by:
rangeFilter in class NumberFieldMapper<java.lang.Float>

preParse

public void preParse(ParseContext context)
              throws java.io.IOException
Specified by:
preParse in interface RootMapper
Throws:
java.io.IOException

postParse

public void postParse(ParseContext context)
               throws java.io.IOException
Specified by:
postParse in interface RootMapper
Throws:
java.io.IOException

validate

public void validate(ParseContext context)
              throws MapperParsingException
Specified by:
validate in interface RootMapper
Throws:
MapperParsingException

includeInObject

public boolean includeInObject()
Description copied from interface: RootMapper
Should the mapper be included in the root ObjectMapper.

Specified by:
includeInObject in interface RootMapper

parse

public void parse(ParseContext context)
           throws java.io.IOException
Specified by:
parse in interface Mapper
Overrides:
parse in class AbstractFieldMapper<java.lang.Float>
Throws:
java.io.IOException

parseCreateField

protected org.apache.lucene.document.Fieldable parseCreateField(ParseContext context)
                                                         throws java.io.IOException
Specified by:
parseCreateField in class AbstractFieldMapper<java.lang.Float>
Throws:
java.io.IOException

fieldDataType

public FieldDataType fieldDataType()
Specified by:
fieldDataType in interface FieldMapper<java.lang.Float>
Specified by:
fieldDataType in class NumberFieldMapper<java.lang.Float>

contentType

protected java.lang.String contentType()
Specified by:
contentType in class AbstractFieldMapper<java.lang.Float>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException
Specified by:
toXContent in interface ToXContent
Overrides:
toXContent in class AbstractFieldMapper<java.lang.Float>
Throws:
java.io.IOException

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException
Specified by:
merge in interface Mapper
Overrides:
merge in class NumberFieldMapper<java.lang.Float>
Throws:
MergeMappingException