org.elasticsearch.index.mapper

Class FieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent

Direct Known Subclasses:

BaseGeoPointFieldMapper, BinaryFieldMapper, BooleanFieldMapper, CompletionFieldMapper, GeoShapeFieldMapper, MetadataFieldMapper, NumberFieldMapper, StringFieldMapper

public abstract class FieldMapper
extends Mapper
implements Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldMapper.Builder<T extends FieldMapper.Builder,Y extends FieldMapper>
static class	FieldMapper.CopyTo Represents a list of fields with optional boost factor where the current field should be copied to
static class	FieldMapper.MultiFields

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

Mapper.BuilderContext, Mapper.TypeParser

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
protected FieldMapper.CopyTo	copyTo
protected MappedFieldType	defaultFieldType
protected MappedFieldType	fieldType
protected boolean	indexCreatedBefore2x
protected FieldMapper.MultiFields	multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldMapper(String simpleName, MappedFieldType fieldType, MappedFieldType defaultFieldType, Settings indexSettings, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Methods

Modifier and Type	Method and Description
protected FieldMapper	clone()
protected abstract String	contentType()
FieldMapper.CopyTo	copyTo() List of fields where this field should be copied to
protected boolean	customBoost() Derived classes can override it to specify that boost value is set by derived classes.
protected void	doMerge(Mapper mergeWith, boolean updateAllTypes) Merge changes coming from mergeWith in place.
protected void	doXContentAnalyzers(XContentBuilder builder, boolean includeDefaults)
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
protected void	doXContentDocValues(XContentBuilder builder, boolean includeDefaults)
MappedFieldType	fieldType()
protected boolean	hasCustomFieldDataSettings()
protected static String	indexOptionToString(org.apache.lucene.index.IndexOptions indexOption)
protected static String	indexTokenizeOptionToString(boolean indexed, boolean tokenized)
boolean	isGenerated() Fields might not be available before indexing, for example _all, token_count,...
Iterator<Mapper>	iterator()
FieldMapper	merge(Mapper mergeWith, boolean updateAllTypes) Return the merge of mergeWith into this.
String	name() Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
Mapper	parse(ParseContext context) Parse using the provided ParseContext and return a mapping update if dynamic mappings modified the mappings, or null if mappings were not modified.
protected abstract void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
static String	termVectorOptionsToString(org.apache.lucene.document.FieldType fieldType)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
FieldMapper	updateFieldType(Map<String,MappedFieldType> fullNameToFieldType) Update the field type of this mapper.

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

Field Detail

fieldType

protected MappedFieldType fieldType

defaultFieldType

protected final MappedFieldType defaultFieldType

multiFields

protected FieldMapper.MultiFields multiFields

copyTo

protected FieldMapper.CopyTo copyTo

indexCreatedBefore2x

protected final boolean indexCreatedBefore2x

Constructor Detail

FieldMapper

protected FieldMapper(String simpleName,
           MappedFieldType fieldType,
           MappedFieldType defaultFieldType,
           Settings indexSettings,
           FieldMapper.MultiFields multiFields,
           FieldMapper.CopyTo copyTo)

Method Detail

name

public String name()

Description copied from class: Mapper

Returns the canonical name which uniquely identifies the mapper against other mappers in a type.

Specified by:

name in class Mapper

fieldType

public MappedFieldType fieldType()

copyTo

public FieldMapper.CopyTo copyTo()

List of fields where this field should be copied to

parse

public Mapper parse(ParseContext context)
             throws IOException

Parse using the provided ParseContext and return a mapping update if dynamic mappings modified the mappings, or null if mappings were not modified.

Throws:

IOException

parseCreateField

protected abstract void parseCreateField(ParseContext context,
                    List<org.apache.lucene.document.Field> fields)
                                  throws IOException

Parse the field value and populate fields.

Throws:

IOException

customBoost

protected boolean customBoost()

Derived classes can override it to specify that boost value is set by derived classes.

iterator

public Iterator<Mapper> iterator()

Specified by:

iterator in interface Iterable<Mapper>

clone

protected FieldMapper clone()

Overrides:

clone in class Object

merge

public FieldMapper merge(Mapper mergeWith,
                boolean updateAllTypes)

Description copied from class: Mapper

Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.

Specified by:

merge in class Mapper

doMerge

protected void doMerge(Mapper mergeWith,
           boolean updateAllTypes)

Merge changes coming from mergeWith in place.

Parameters:

updateAllTypes - TODO

updateFieldType

public FieldMapper updateFieldType(Map<String,MappedFieldType> fullNameToFieldType)

Description copied from class: Mapper

Update the field type of this mapper. This is necessary because some mapping updates can modify mappings across several types. This method must return a copy of the mapper so that the current mapper is not modified.

Specified by:

updateFieldType in class Mapper

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContentBody

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

Throws:

IOException

doXContentAnalyzers

protected final void doXContentAnalyzers(XContentBuilder builder,
                       boolean includeDefaults)
                                  throws IOException

Throws:

IOException

doXContentDocValues

protected void doXContentDocValues(XContentBuilder builder,
                       boolean includeDefaults)
                            throws IOException

Throws:

IOException

indexOptionToString

protected static String indexOptionToString(org.apache.lucene.index.IndexOptions indexOption)

termVectorOptionsToString

public static String termVectorOptionsToString(org.apache.lucene.document.FieldType fieldType)

indexTokenizeOptionToString

protected static String indexTokenizeOptionToString(boolean indexed,
                                 boolean tokenized)

hasCustomFieldDataSettings

protected boolean hasCustomFieldDataSettings()

contentType

protected abstract String contentType()

isGenerated

public boolean isGenerated()

Fields might not be available before indexing, for example _all, token_count,... When get is called and these fields are requested, this case needs special treatment.

Returns:

If the field is available before indexing or not.