Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class KeywordFieldMapper.Builder

java.lang.Object

org.elasticsearch.index.mapper.Mapper.Builder

org.elasticsearch.index.mapper.FieldMapper.Builder

org.elasticsearch.index.mapper.FieldMapper.DimensionBuilder

org.elasticsearch.index.mapper.KeywordFieldMapper.Builder

All Implemented Interfaces:

ToXContent, ToXContentFragment

Enclosing class:

KeywordFieldMapper

public static final class KeywordFieldMapper.Builder
extends FieldMapper.DimensionBuilder

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

copyTo, hasScript, multiFieldsBuilder, sourceKeepMode

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Builder(String name, IndexAnalyzers indexAnalyzers, ScriptCompiler scriptCompiler, IndexSettings indexSettings, boolean forceDocValuesSkipper, boolean isWithinMultiField)
Builder(String name, IndexSettings indexSettings)
Builder(String name, IndexSettings indexSettings, boolean isWithinMultiField)
Builder(String name, MappingParserContext mappingParserContext)

Method Summary

Modifier and Type	Method	Description
KeywordFieldMapper	build(MapperBuilderContext context)	Returns a newly built mapper.
static KeywordFieldMapper.Builder	buildWithDocValuesSkipper(String name, IndexSettings indexSettings, boolean isWithinMultiField)
KeywordFieldMapper.Builder	dimension(boolean dimension)
KeywordFieldMapper.Builder	docValues(boolean hasDocValues)
protected FieldMapper.Parameter<?>[]	getParameters()
boolean	hasDocValues()
boolean	hasNormalizer()
KeywordFieldMapper.Builder	ignoreAbove(int ignoreAbove)
KeywordFieldMapper.Builder	indexed(boolean indexed)
boolean	isNormalizerSkipStoreOriginalValue()
boolean	isStored()
SimilarityProvider	similarity()
KeywordFieldMapper.Builder	stored(boolean stored)

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

inheritDimensionParameterFromParentObject

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

addMultiField, addScriptValidation, builderParams, handleUnknownParamOnLegacyIndex, init, merge, parse, toXContent, validate

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

leafName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

Builder

public Builder(String name,
 MappingParserContext mappingParserContext)

Builder

public Builder(String name,
 IndexAnalyzers indexAnalyzers,
 ScriptCompiler scriptCompiler,
 IndexSettings indexSettings,
 boolean forceDocValuesSkipper,
 boolean isWithinMultiField)

Builder

public Builder(String name,
 IndexSettings indexSettings)

Builder

public Builder(String name,
 IndexSettings indexSettings,
 boolean isWithinMultiField)

Method Details

buildWithDocValuesSkipper

public static KeywordFieldMapper.Builder buildWithDocValuesSkipper(String name,
 IndexSettings indexSettings,
 boolean isWithinMultiField)

ignoreAbove

public KeywordFieldMapper.Builder ignoreAbove(int ignoreAbove)

hasNormalizer

public boolean hasNormalizer()

isNormalizerSkipStoreOriginalValue

public boolean isNormalizerSkipStoreOriginalValue()

docValues

public KeywordFieldMapper.Builder docValues(boolean hasDocValues)

hasDocValues

public boolean hasDocValues()

similarity

public SimilarityProvider similarity()

dimension

public KeywordFieldMapper.Builder dimension(boolean dimension)

indexed

public KeywordFieldMapper.Builder indexed(boolean indexed)

stored

public KeywordFieldMapper.Builder stored(boolean stored)

isStored

public boolean isStored()

getParameters

protected FieldMapper.Parameter<?>[] getParameters()

Specified by:

getParameters in class FieldMapper.Builder

Returns:

the list of parameters defined for this mapper

build

public KeywordFieldMapper build(MapperBuilderContext context)

Description copied from class: Mapper.Builder

Returns a newly built mapper.

Specified by:

build in class FieldMapper.Builder