org.elasticsearch.index.mapper

Class ArrayMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.ArrayMapper

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<org.elasticsearch.index.mapper.Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.index.mapper.object.ArrayValueMapperParser

public class ArrayMapper
extends org.elasticsearch.index.mapper.FieldMapper
implements org.elasticsearch.index.mapper.object.ArrayValueMapperParser

fieldmapper for encoding and handling arrays explicitly

handler for type "array".

accepts mappings like:

"array_field": { "type": "array", "inner": { "type": "boolean", "null_value": true } }

This would be parsed as a array of booleans. This field now only accepts arrays, no single values. So inserting a document like:

{ "array_field": true }

will fail, while a document like:

{ "array_field": [true] }

will pass.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrayMapper.Builder
static class	ArrayMapper.BuilderFactory
static class	ArrayMapper.TypeParser

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

org.elasticsearch.index.mapper.FieldMapper.CopyTo, org.elasticsearch.index.mapper.FieldMapper.MultiFields

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

org.elasticsearch.index.mapper.Mapper.BuilderContext

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE
static org.elasticsearch.common.xcontent.XContentBuilderString	INNER

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

copyTo, defaultFieldType, fieldType, indexCreatedBefore2x, multiFields

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArrayMapper(java.lang.String simpleName, org.elasticsearch.index.mapper.MappedFieldType fieldType, org.elasticsearch.index.mapper.MappedFieldType defaultFieldType, org.elasticsearch.common.settings.Settings indexSettings, org.elasticsearch.index.mapper.FieldMapper.MultiFields multiFields, org.elasticsearch.index.mapper.FieldMapper.CopyTo copyTo, org.elasticsearch.index.mapper.Mapper innerMapper)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	contentType()
protected void	doMerge(org.elasticsearch.index.mapper.Mapper mergeWith, boolean updateAllTypes)
java.util.Iterator<org.elasticsearch.index.mapper.Mapper>	iterator()
org.elasticsearch.index.mapper.Mapper	parse(org.elasticsearch.index.mapper.ParseContext context)
protected void	parseCreateField(org.elasticsearch.index.mapper.ParseContext context, java.util.List<org.apache.lucene.document.Field> fields)
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)

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

clone, copyTo, customBoost, doXContentAnalyzers, doXContentBody, doXContentDocValues, fieldType, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, isGenerated, merge, name, termVectorOptionsToString, updateFieldType

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

simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

INNER

public static final org.elasticsearch.common.xcontent.XContentBuilderString INNER

Constructor Detail

ArrayMapper

protected ArrayMapper(java.lang.String simpleName,
                      org.elasticsearch.index.mapper.MappedFieldType fieldType,
                      org.elasticsearch.index.mapper.MappedFieldType defaultFieldType,
                      org.elasticsearch.common.settings.Settings indexSettings,
                      org.elasticsearch.index.mapper.FieldMapper.MultiFields multiFields,
                      org.elasticsearch.index.mapper.FieldMapper.CopyTo copyTo,
                      org.elasticsearch.index.mapper.Mapper innerMapper)

Method Detail

contentType

protected java.lang.String contentType()

Specified by:

contentType in class org.elasticsearch.index.mapper.FieldMapper

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
                                                                    org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws java.io.IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Overrides:

toXContent in class org.elasticsearch.index.mapper.FieldMapper

Throws:

java.io.IOException

iterator

public java.util.Iterator<org.elasticsearch.index.mapper.Mapper> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.elasticsearch.index.mapper.Mapper>

Overrides:

iterator in class org.elasticsearch.index.mapper.FieldMapper

doMerge

protected void doMerge(org.elasticsearch.index.mapper.Mapper mergeWith,
                       boolean updateAllTypes)

Overrides:

doMerge in class org.elasticsearch.index.mapper.FieldMapper

parse

public org.elasticsearch.index.mapper.Mapper parse(org.elasticsearch.index.mapper.ParseContext context)
                                            throws java.io.IOException

Overrides:

parse in class org.elasticsearch.index.mapper.FieldMapper

Throws:

java.io.IOException

parseCreateField

protected void parseCreateField(org.elasticsearch.index.mapper.ParseContext context,
                                java.util.List<org.apache.lucene.document.Field> fields)
                         throws java.io.IOException

Specified by:

parseCreateField in class org.elasticsearch.index.mapper.FieldMapper

Throws:

java.io.IOException