org.elasticsearch.index.mapper.core

クラス StringFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.core.StringFieldMapper

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

Cloneable, Iterable<Mapper>, ToXContent, AllFieldMapper.IncludeInAll

public class StringFieldMapper
extends FieldMapper
implements AllFieldMapper.IncludeInAll

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	StringFieldMapper.Builder
static class	StringFieldMapper.Defaults
static class	StringFieldMapper.StringFieldType
static class	StringFieldMapper.TypeParser
static class	StringFieldMapper.ValueAndBoost Parsed value and boost to be returned from parseCreateFieldForString(org.elasticsearch.index.mapper.ParseContext, java.lang.String, float).

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	CONTENT_TYPE

クラスから継承されたフィールド org.elasticsearch.index.mapper.FieldMapper

copyTo, defaultFieldType, fieldType, indexCreatedBefore2x, multiFields

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

EMPTY_PARAMS

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected StringFieldMapper	clone()
protected String	contentType()
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	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
int	getIgnoreAbove()
int	getPositionIncrementGap()
StringFieldMapper	includeInAll(Boolean includeInAll) If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.
StringFieldMapper	includeInAllIfNotSet(Boolean includeInAll) If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
static StringFieldMapper.ValueAndBoost	parseCreateFieldForString(ParseContext context, String nullValue, float defaultBoost) Parse a field as though it were a string.
StringFieldMapper	unsetIncludeInAll() If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.

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

copyTo, doXContentAnalyzers, doXContentDocValues, fieldType, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, isGenerated, iterator, merge, name, parse, termVectorOptionsToString, toXContent, updateFieldType

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

simpleName

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

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

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

forEach, spliterator

フィールドの詳細

CONTENT_TYPE

public static final String CONTENT_TYPE

関連項目:

定数フィールド値

コンストラクタの詳細

StringFieldMapper

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

メソッドの詳細

clone

protected StringFieldMapper clone()

オーバーライド:

clone クラス内 FieldMapper

includeInAll

public StringFieldMapper includeInAll(Boolean includeInAll)

インタフェースからコピーされた説明: AllFieldMapper.IncludeInAll

If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.

定義:

includeInAll インタフェース内 AllFieldMapper.IncludeInAll

includeInAllIfNotSet

public StringFieldMapper includeInAllIfNotSet(Boolean includeInAll)

インタフェースからコピーされた説明: AllFieldMapper.IncludeInAll

If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.

定義:

includeInAllIfNotSet インタフェース内 AllFieldMapper.IncludeInAll

unsetIncludeInAll

public StringFieldMapper unsetIncludeInAll()

インタフェースからコピーされた説明: AllFieldMapper.IncludeInAll

If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.

定義:

unsetIncludeInAll インタフェース内 AllFieldMapper.IncludeInAll

customBoost

protected boolean customBoost()

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

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

オーバーライド:

customBoost クラス内 FieldMapper

getPositionIncrementGap

public int getPositionIncrementGap()

getIgnoreAbove

public int getIgnoreAbove()

parseCreateField

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

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

Parse the field value and populate fields.

定義:

parseCreateField クラス内 FieldMapper

例外:

IOException

parseCreateFieldForString

public static StringFieldMapper.ValueAndBoost parseCreateFieldForString(ParseContext context,
                                                                        String nullValue,
                                                                        float defaultBoost)
                                                                 throws IOException

Parse a field as though it were a string.

パラメータ:

context - parse context used during parsing

nullValue - value to use for null

defaultBoost - default boost value returned unless overwritten in the field

戻り値:

the parsed field and the boost either parsed or defaulted

例外:

IOException - if thrown while parsing

contentType

protected String contentType()

定義:

contentType クラス内 FieldMapper

doMerge

protected void doMerge(Mapper mergeWith,
                       boolean updateAllTypes)

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

Merge changes coming from mergeWith in place.

オーバーライド:

doMerge クラス内 FieldMapper

updateAllTypes - TODO

doXContentBody

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

オーバーライド:

doXContentBody クラス内 FieldMapper

例外:

IOException