Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class BinaryFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.BinaryFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class BinaryFieldMapper
extends FieldMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BinaryFieldMapper.BinaryFieldType
static class	BinaryFieldMapper.Builder
static final class	BinaryFieldMapper.CustomBinaryDocValuesField

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

FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.TypeParser

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final FieldMapper.TypeParser	PARSER

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

COERCE_SETTING, copyTo, deprecationLogger, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BinaryFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, BinaryFieldMapper.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
void	indexValue(DocumentParserContext context, byte[] value)
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
SourceLoader.SyntheticFieldLoader	syntheticFieldLoader()	Mappers override this method with native synthetic source support.
protected FieldMapper.SyntheticSourceMode	syntheticSourceMode()	Specifies the mode of synthetic source support by the mapper.

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper

checkIncomingMergeType, copyTo, doValidate, doXContentBody, executeScript, fieldType, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourcePathUsedBy, supportsParsingObject, toXContent, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

freezeAndDeduplicateFieldType, internFieldName, leafName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final FieldMapper.TypeParser PARSER

Constructor Details

BinaryFieldMapper

protected BinaryFieldMapper(String simpleName,
 MappedFieldType mappedFieldType,
 FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo,
 BinaryFieldMapper.Builder builder)

Method Details

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

indexValue

public void indexValue(DocumentParserContext context,
 byte[] value)

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

syntheticSourceMode

protected FieldMapper.SyntheticSourceMode syntheticSourceMode()

Description copied from class: FieldMapper

Specifies the mode of synthetic source support by the mapper.
This is used to determine if a field mapper has support for constructing synthetic source. In case it doesn't (meaning FieldMapper.SyntheticSourceMode.FALLBACK), we will store raw source data for this field as is and then use it for synthetic source.

Field mappers must override this method if they provide a custom implementation of FieldMapper.syntheticFieldLoader() in order to use a more efficient field-specific implementation.

Overrides:

syntheticSourceMode in class FieldMapper

Returns:

FieldMapper.SyntheticSourceMode

syntheticFieldLoader

public SourceLoader.SyntheticFieldLoader syntheticFieldLoader()

Description copied from class: FieldMapper

Mappers override this method with native synthetic source support. If mapper does not support synthetic source, it is generated using generic implementation in DocumentParser.parseObjectOrField(org.elasticsearch.index.mapper.DocumentParserContext, org.elasticsearch.index.mapper.Mapper) and ObjectMapper.syntheticFieldLoader().

Overrides:

syntheticFieldLoader in class FieldMapper

Returns:

implementation of SourceLoader.SyntheticFieldLoader