org.elasticsearch.index.mapper.internal

Class IdFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.core.AbstractFieldMapper<String>

org.elasticsearch.index.mapper.internal.IdFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<String>, InternalMapper, Mapper, RootMapper

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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.CopyTo, AbstractFieldMapper.MultiFields

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.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

FieldMapper.Loading, FieldMapper.Names

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE
static String	NAME

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

boost, copyTo, customFieldDataSettings, docValues, docValuesFormat, fieldDataType, fieldType, indexAnalyzer, multiFields, names, normsLoading, postingsFormat, searchAnalyzer, similarity

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

EMPTY_ARRAY

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

EMPTY_PARAMS

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

DOC_VALUES_FORMAT

Constructor Summary

Constructors

Modifier	Constructor and Description
	IdFieldMapper()
	IdFieldMapper(org.apache.lucene.document.FieldType fieldType)
protected	IdFieldMapper(String name, String indexName, org.apache.lucene.document.FieldType fieldType, Boolean docValues)
protected	IdFieldMapper(String name, String indexName, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, String path, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, Settings fieldDataSettings, Settings indexSettings)

Method Summary

Modifier and Type	Method and Description
protected String	contentType()
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
void	merge(Mapper mergeWith, MergeContext mergeContext)
void	parse(ParseContext context)
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
String	path()
void	postParse(ParseContext context) Called after Mapper.parse(ParseContext) on the RootObjectMapper.
org.apache.lucene.search.Filter	prefixFilter(Object value, QueryParseContext context)
org.apache.lucene.search.Query	prefixQuery(Object value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
void	preParse(ParseContext context) Called before Mapper.parse(ParseContext) on the RootObjectMapper.
org.apache.lucene.search.Filter	regexpFilter(Object value, int flags, int maxDeterminizedStates, QueryParseContext context)
org.apache.lucene.search.Query	regexpQuery(Object value, int flags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
org.apache.lucene.search.Filter	termFilter(Object value, QueryParseContext context)
org.apache.lucene.search.Query	termQuery(Object value, QueryParseContext context)
org.apache.lucene.search.Filter	termsFilter(List values, QueryParseContext context)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
boolean	useTermQueryWithQueryString() Should the field query FieldMapper.termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.
String	value(Object value) Returns the actual value of the field.

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

boost, close, copyTo, customBoost, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, doXContentBody, fieldDataTermsFilter, fieldDataType, fieldType, fuzzyQuery, hasDocValues, indexAnalyzer, indexedValueForSearch, indexOptionToString, indexTokenizeOptionToString, isGenerated, isNumeric, isSortable, name, names, normsLoading, nullValueFilter, postingsFormatProvider, queryStringTermQuery, rangeFilter, rangeQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termVectorOptionsToString, traverse, traverse, 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 String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

IdFieldMapper

public IdFieldMapper()

IdFieldMapper

public IdFieldMapper(org.apache.lucene.document.FieldType fieldType)

IdFieldMapper

protected IdFieldMapper(String name,
                        String indexName,
                        org.apache.lucene.document.FieldType fieldType,
                        Boolean docValues)

IdFieldMapper

protected IdFieldMapper(String name,
                        String indexName,
                        float boost,
                        org.apache.lucene.document.FieldType fieldType,
                        Boolean docValues,
                        String path,
                        PostingsFormatProvider postingsProvider,
                        DocValuesFormatProvider docValuesProvider,
                        @Nullable
                        Settings fieldDataSettings,
                        Settings indexSettings)

Method Detail

path

public String path()

defaultFieldType

public org.apache.lucene.document.FieldType defaultFieldType()

Specified by:

defaultFieldType in class AbstractFieldMapper<String>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<String>

value

public String value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

Specified by:

value in interface FieldMapper<String>

useTermQueryWithQueryString

public boolean useTermQueryWithQueryString()

Description copied from interface: FieldMapper

Should the field query FieldMapper.termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.

Specified by:

useTermQueryWithQueryString in interface FieldMapper<String>

Overrides:

useTermQueryWithQueryString in class AbstractFieldMapper<String>

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
                                                @Nullable
                                                QueryParseContext context)

Specified by:

termQuery in interface FieldMapper<String>

Overrides:

termQuery in class AbstractFieldMapper<String>

termFilter

public org.apache.lucene.search.Filter termFilter(Object value,
                                                  @Nullable
                                                  QueryParseContext context)

Specified by:

termFilter in interface FieldMapper<String>

Overrides:

termFilter in class AbstractFieldMapper<String>

termsFilter

public org.apache.lucene.search.Filter termsFilter(List values,
                                                   @Nullable
                                                   QueryParseContext context)

Specified by:

termsFilter in interface FieldMapper<String>

Overrides:

termsFilter in class AbstractFieldMapper<String>

prefixQuery

public org.apache.lucene.search.Query prefixQuery(Object value,
                                                  @Nullable
                                                  org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                                  @Nullable
                                                  QueryParseContext context)

Specified by:

prefixQuery in interface FieldMapper<String>

Overrides:

prefixQuery in class AbstractFieldMapper<String>

prefixFilter

public org.apache.lucene.search.Filter prefixFilter(Object value,
                                                    @Nullable
                                                    QueryParseContext context)

Specified by:

prefixFilter in interface FieldMapper<String>

Overrides:

prefixFilter in class AbstractFieldMapper<String>

regexpQuery

public org.apache.lucene.search.Query regexpQuery(Object value,
                                                  int flags,
                                                  int maxDeterminizedStates,
                                                  @Nullable
                                                  org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                                  @Nullable
                                                  QueryParseContext context)

Specified by:

regexpQuery in interface FieldMapper<String>

Overrides:

regexpQuery in class AbstractFieldMapper<String>

regexpFilter

public org.apache.lucene.search.Filter regexpFilter(Object value,
                                                    int flags,
                                                    int maxDeterminizedStates,
                                                    @Nullable
                                                    QueryParseContext context)

Specified by:

regexpFilter in interface FieldMapper<String>

Overrides:

regexpFilter in class AbstractFieldMapper<String>

preParse

public void preParse(ParseContext context)
              throws IOException

Description copied from interface: RootMapper

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

Specified by:

preParse in interface RootMapper

Throws:

IOException

postParse

public void postParse(ParseContext context)
               throws IOException

Description copied from interface: RootMapper

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

Specified by:

postParse in interface RootMapper

Throws:

IOException

parse

public void parse(ParseContext context)
           throws IOException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<String>

Throws:

IOException

includeInObject

public boolean includeInObject()

Description copied from interface: RootMapper

Should the mapper be included in the root ObjectMapper. If this method returns true, then Mapper.parse(ParseContext) will be called if the context has a property that matches the name of this RootMapper. Otherwise Mapper.parse(ParseContext) will not be called.

Specified by:

includeInObject in interface RootMapper

parseCreateField

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

Description copied from class: AbstractFieldMapper

Parse the field value and populate fields.

Specified by:

parseCreateField in class AbstractFieldMapper<String>

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<String>

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractFieldMapper<String>

Throws:

IOException

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<String>

Throws:

MergeMappingException