org.elasticsearch.index.mapper.core

Class BinaryFieldMapper

java.lang.Object

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

org.elasticsearch.index.mapper.core.BinaryFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<BytesReference>, Mapper

public class BinaryFieldMapper
extends AbstractFieldMapper<BytesReference>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BinaryFieldMapper.Builder
static class	BinaryFieldMapper.CustomBinaryDocValuesField
static class	BinaryFieldMapper.Defaults
static class	BinaryFieldMapper.TypeParser

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	BinaryFieldMapper(FieldMapper.Names names, org.apache.lucene.document.FieldType fieldType, Boolean docValues, Boolean compress, long compressThreshold, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, Settings fieldDataSettings, 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)
void	merge(Mapper mergeWith, MergeContext mergeContext)
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
BytesReference	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, hasDocValues, indexAnalyzer, indexedValueForSearch, indexOptionToString, indexTokenizeOptionToString, isGenerated, isNumeric, isSortable, name, names, normsLoading, nullValueFilter, parse, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, rangeFilter, rangeQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termFilter, termQuery, termsFilter, termVectorOptionsToString, toXContent, traverse, traverse, useTermQueryWithQueryString

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

BinaryFieldMapper

protected BinaryFieldMapper(FieldMapper.Names names,
                            org.apache.lucene.document.FieldType fieldType,
                            Boolean docValues,
                            Boolean compress,
                            long compressThreshold,
                            PostingsFormatProvider postingsProvider,
                            DocValuesFormatProvider docValuesProvider,
                            @Nullable
                            Settings fieldDataSettings,
                            AbstractFieldMapper.MultiFields multiFields,
                            AbstractFieldMapper.CopyTo copyTo)

Method Detail

defaultFieldType

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

Specified by:

defaultFieldType in class AbstractFieldMapper<BytesReference>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<BytesReference>

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

Overrides:

valueForSearch in class AbstractFieldMapper<BytesReference>

value

public BytesReference value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

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

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<BytesReference>

doXContentBody

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

Overrides:

doXContentBody in class AbstractFieldMapper<BytesReference>

Throws:

IOException

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<BytesReference>

Throws:

MergeMappingException