org.elasticsearch.index.mapper

クラス FieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

すべての実装されたインタフェース:

Cloneable, Iterable<Mapper>, ToXContent

直系の既知のサブクラス:

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

public abstract class FieldMapper
extends Mapper
implements Cloneable

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
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

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.index.mapper.Mapper

Mapper.BuilderContext, Mapper.TypeParser

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected FieldMapper.CopyTo	copyTo
protected MappedFieldType	defaultFieldType
protected MappedFieldType	fieldType
protected boolean	indexCreatedBefore2x
protected FieldMapper.MultiFields	multiFields

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	FieldMapper(String simpleName, MappedFieldType fieldType, MappedFieldType defaultFieldType, Settings indexSettings, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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.

クラスから継承されたメソッド org.elasticsearch.index.mapper.Mapper

simpleName

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド java.lang.Iterable

forEach, spliterator

フィールドの詳細

fieldType

protected MappedFieldType fieldType

defaultFieldType

protected final MappedFieldType defaultFieldType

multiFields

protected FieldMapper.MultiFields multiFields

copyTo

protected FieldMapper.CopyTo copyTo

indexCreatedBefore2x

protected final boolean indexCreatedBefore2x

コンストラクタの詳細

FieldMapper

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

メソッドの詳細

name

public String name()

クラスからコピーされた説明: Mapper

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

定義:

name クラス内 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.

例外:

IOException

parseCreateField

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

Parse the field value and populate fields.

例外:

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()

定義:

iterator インタフェース内 Iterable<Mapper>

clone

protected FieldMapper clone()

オーバーライド:

clone クラス内 Object

merge

public FieldMapper merge(Mapper mergeWith,
                         boolean updateAllTypes)

クラスからコピーされた説明: Mapper

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

定義:

merge クラス内 Mapper

doMerge

protected void doMerge(Mapper mergeWith,
                       boolean updateAllTypes)

Merge changes coming from mergeWith in place.

パラメータ:

updateAllTypes - TODO

updateFieldType

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

クラスからコピーされた説明: 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.

定義:

updateFieldType クラス内 Mapper

toXContent

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

定義:

toXContent インタフェース内 ToXContent

例外:

IOException

doXContentBody

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

例外:

IOException

doXContentAnalyzers

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

例外:

IOException

doXContentDocValues

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

例外:

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.

戻り値:

If the field is available before indexing or not.