org.elasticsearch.index.mapper.internal

Class FieldNamesFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.internal.FieldNamesFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent

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 and Description
static class	FieldNamesFieldMapper.Builder
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 and Description
static String	CONTENT_TYPE
static String	NAME

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

copyTo, defaultFieldType, fieldType, indexCreatedBefore2x, multiFields

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

EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
protected String	contentType()
FieldNamesFieldMapper.FieldNamesFieldType	fieldType()
boolean	isGenerated() Fields might not be available before indexing, for example _all, token_count,...
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 void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> 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, customBoost, doMerge, doXContentAnalyzers, doXContentBody, doXContentDocValues, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, iterator, name, termVectorOptionsToString, 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

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)
              throws IOException

Description copied from class: MetadataFieldMapper

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

Specified by:

preParse in class MetadataFieldMapper

Throws:

IOException

postParse

public void postParse(ParseContext context)
               throws IOException

Description copied from class: MetadataFieldMapper

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

Specified by:

postParse in class MetadataFieldMapper

Throws:

IOException

parse

public Mapper parse(ParseContext context)
             throws IOException

Description copied from class: FieldMapper

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

Overrides:

parse in class FieldMapper

Throws:

IOException

parseCreateField

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

Description copied from class: FieldMapper

Parse the field value and populate fields.

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

isGenerated

public boolean isGenerated()

Description copied from class: FieldMapper

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.

Overrides:

isGenerated in class FieldMapper

Returns:

If the field is available before indexing or not.