Package org.elasticsearch.index.mapper

Class FieldNamesFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.FieldNamesFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class FieldNamesFieldMapper
extends MetadataFieldMapper

A mapper that indexes the field names of a document under _field_names. This mapper is typically useful in order to have fast exists and missing queries/filters. Added in Elasticsearch 1.3.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldNamesFieldMapper.Defaults
static class	FieldNamesFieldMapper.FieldNamesFieldType
static class	FieldNamesFieldMapper.TypeParser

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTENT_TYPE
static String	NAME

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

COERCE_SETTING, copyTo, defaultFieldType, fieldType, IGNORE_MALFORMED_SETTING, indexCreatedVersion, multiFields

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
FieldNamesFieldMapper.FieldNamesFieldType	fieldType()
void	parse(ParseContext context)	Parse the field value using the provided ParseContext.
protected void	parseCreateField(ParseContext context, List<IndexableField> fields)	Parse the field value and populate fields.
void	postParse(ParseContext context)	Called after FieldMapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context)	Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

merge

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

clone, copyTo, createFieldNamesField, doMerge, doXContentAnalyzers, doXContentBody, doXContentDocValues, indexOptionToString, iterator, name, termVectorOptionsToString, typeName, 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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

fieldType

public FieldNamesFieldMapper.FieldNamesFieldType fieldType()

Overrides:

fieldType in class FieldMapper

preParse

public void preParse(ParseContext context)

Description copied from class: MetadataFieldMapper

Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.

Specified by:

preParse in class MetadataFieldMapper

postParse

public void postParse(ParseContext context)
               throws IOException

Description copied from class: MetadataFieldMapper

Called after FieldMapper.parse(ParseContext) on the RootObjectMapper.

Overrides:

postParse in class MetadataFieldMapper

Throws:

IOException

parse

public void parse(ParseContext context)
           throws IOException

Description copied from class: FieldMapper

Parse the field value using the provided ParseContext.

Overrides:

parse in class FieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(ParseContext context,
                                List<IndexableField> fields)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate fields. Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

IOException