org.elasticsearch.index.mapper.core

Class BooleanFieldMapper

java.lang.Object

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

org.elasticsearch.index.mapper.core.BooleanFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<Boolean>, Mapper

public class BooleanFieldMapper
extends AbstractFieldMapper<Boolean>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BooleanFieldMapper.Builder
static class	BooleanFieldMapper.Defaults
static class	BooleanFieldMapper.TypeParser
static class	BooleanFieldMapper.Values

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

FieldMapper.Loading, FieldMapper.Names

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

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

BooleanFieldMapper(FieldMapper.Names names, float boost, org.apache.lucene.document.FieldType fieldType, Boolean nullValue, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, 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()
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
boolean	hasDocValues()
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value) Returns the indexed value used to construct search "values".
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.
boolean	useTermQueryWithQueryString() Should the field query FieldMapper.termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.
Boolean	value(Object value) Returns the actual value of the field.
Object	valueForSearch(Object value) Returns the value that will be used as a result for search.

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

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

Methods inherited from class java.lang.Object

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

BooleanFieldMapper

protected BooleanFieldMapper(FieldMapper.Names names,
                             float boost,
                             org.apache.lucene.document.FieldType fieldType,
                             Boolean nullValue,
                             PostingsFormatProvider postingsProvider,
                             DocValuesFormatProvider docValuesProvider,
                             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<Boolean>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<Boolean>

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

Overrides:

useTermQueryWithQueryString in class AbstractFieldMapper<Boolean>

value

public Boolean value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

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

Overrides:

valueForSearch in class AbstractFieldMapper<Boolean>

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

Overrides:

indexedValueForSearch in class AbstractFieldMapper<Boolean>

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

Overrides:

nullValueFilter in class AbstractFieldMapper<Boolean>

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

Throws:

IOException

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<Boolean>

Throws:

MergeMappingException

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<Boolean>

doXContentBody

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

Overrides:

doXContentBody in class AbstractFieldMapper<Boolean>

Throws:

IOException

hasDocValues

public boolean hasDocValues()

Specified by:

hasDocValues in interface FieldMapper<Boolean>

Overrides:

hasDocValues in class AbstractFieldMapper<Boolean>