org.elasticsearch.index.mapper.internal
Class IdFieldMapper

java.lang.Object
  org.elasticsearch.index.mapper.core.AbstractFieldMapper<java.lang.String>
      org.elasticsearch.index.mapper.internal.IdFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<java.lang.String>, InternalMapper, Mapper, RootMapper

public class IdFieldMapper
extends AbstractFieldMapper<java.lang.String>
implements InternalMapper, RootMapper

Nested Class Summary

static class	IdFieldMapper.Builder
static class	IdFieldMapper.Defaults
static class	IdFieldMapper.TypeParser

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

AbstractFieldMapper.OpenBuilder<T extends AbstractFieldMapper.Builder,Y extends AbstractFieldMapper>

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

Mapper.BuilderContext

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

ToXContent.MapParams, ToXContent.Params

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

FieldMapper.Names

Field Summary

static java.lang.String	CONTENT_TYPE
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, index, indexAnalyzer, indexOptions, names, omitNorms, omitTermFreqAndPositions, searchAnalyzer, store, termVector

Fields inherited from interface org.elasticsearch.index.mapper.Mapper

EMPTY_ARRAY

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

EMPTY_PARAMS

Constructor Summary

	IdFieldMapper()
	IdFieldMapper(org.apache.lucene.document.Field.Index index)
protected	IdFieldMapper(java.lang.String name, java.lang.String indexName, org.apache.lucene.document.Field.Index index)
protected	IdFieldMapper(java.lang.String name, java.lang.String indexName, org.apache.lucene.document.Field.Index index, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.TermVector termVector, float boost, boolean omitNorms, boolean omitTermFreqAndPositions, java.lang.String path)

Method Summary

protected java.lang.String	contentType()
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
java.lang.String	indexedValue(java.lang.String value) Returns the indexed value.
void	merge(Mapper mergeWith, MergeContext mergeContext)
void	parse(ParseContext context)
protected org.apache.lucene.document.Field	parseCreateField(ParseContext context)
java.lang.String	path()
void	postParse(ParseContext context)
void	preParse(ParseContext context)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validate(ParseContext context)
java.lang.String	value(org.apache.lucene.document.Document document)
java.lang.String	value(org.apache.lucene.document.Fieldable field) Returns the actual value of the field.
java.lang.String	valueAsString(org.apache.lucene.document.Fieldable field) Returns the actual value of the field as string.
java.lang.String	valueFromString(java.lang.String value)

Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

analyzed, boost, close, customBoost, doXContentBody, fieldDataType, fieldFilter, fieldQuery, fuzzyQuery, fuzzyQuery, index, indexAnalyzer, indexed, name, names, omitNorms, omitTermFreqAndPositions, queryStringTermQuery, rangeFilter, rangeQuery, searchAnalyzer, store, stored, termVector, traverse, traverse, useFieldQueryWithQueryString, valueForSearch

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.Mapper

close, name, traverse, traverse

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

IdFieldMapper

public IdFieldMapper()

IdFieldMapper

public IdFieldMapper(org.apache.lucene.document.Field.Index index)

IdFieldMapper

protected IdFieldMapper(java.lang.String name,
                        java.lang.String indexName,
                        org.apache.lucene.document.Field.Index index)

IdFieldMapper

protected IdFieldMapper(java.lang.String name,
                        java.lang.String indexName,
                        org.apache.lucene.document.Field.Index index,
                        org.apache.lucene.document.Field.Store store,
                        org.apache.lucene.document.Field.TermVector termVector,
                        float boost,
                        boolean omitNorms,
                        boolean omitTermFreqAndPositions,
                        java.lang.String path)

Method Detail

path

public java.lang.String path()

value

public java.lang.String value(org.apache.lucene.document.Document document)

value

public java.lang.String value(org.apache.lucene.document.Fieldable field)

Description copied from interface: FieldMapper

Returns the actual value of the field.

Specified by:

value in interface FieldMapper<java.lang.String>

valueFromString

public java.lang.String valueFromString(java.lang.String value)

Specified by:

valueFromString in interface FieldMapper<java.lang.String>

valueAsString

public java.lang.String valueAsString(org.apache.lucene.document.Fieldable field)

Description copied from interface: FieldMapper

Returns the actual value of the field as string.

Specified by:

valueAsString in interface FieldMapper<java.lang.String>

indexedValue

public java.lang.String indexedValue(java.lang.String value)

Description copied from interface: FieldMapper

Returns the indexed value.

Specified by:

indexedValue in interface FieldMapper<java.lang.String>

Overrides:

indexedValue in class AbstractFieldMapper<java.lang.String>

preParse

public void preParse(ParseContext context)
              throws java.io.IOException

Specified by:

preParse in interface RootMapper

Throws:

java.io.IOException

postParse

public void postParse(ParseContext context)
               throws java.io.IOException

Specified by:

postParse in interface RootMapper

Throws:

java.io.IOException

parse

public void parse(ParseContext context)
           throws java.io.IOException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<java.lang.String>

Throws:

java.io.IOException

validate

public void validate(ParseContext context)
              throws MapperParsingException

Specified by:

validate in interface RootMapper

Throws:

MapperParsingException

includeInObject

public boolean includeInObject()

Description copied from interface: RootMapper

Should the mapper be included in the root ObjectMapper.

Specified by:

includeInObject in interface RootMapper

parseCreateField

protected org.apache.lucene.document.Field parseCreateField(ParseContext context)
                                                     throws java.io.IOException

Specified by:

parseCreateField in class AbstractFieldMapper<java.lang.String>

Throws:

java.io.IOException

contentType

protected java.lang.String contentType()

Specified by:

contentType in class AbstractFieldMapper<java.lang.String>

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractFieldMapper<java.lang.String>

Throws:

java.io.IOException

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<java.lang.String>

Throws:

MergeMappingException