org.elasticsearch.index.mapper.internal

Class ParentFieldMapper

java.lang.Object

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

org.elasticsearch.index.mapper.internal.ParentFieldMapper

All Implemented Interfaces:

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

public class ParentFieldMapper
extends AbstractFieldMapper<Uid>
implements InternalMapper, RootMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParentFieldMapper.Builder
static class	ParentFieldMapper.Defaults
static class	ParentFieldMapper.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
	ParentFieldMapper(Settings indexSettings)
protected	ParentFieldMapper(String name, String indexName, String type, PostingsFormatProvider postingsFormat, Settings fieldDataSettings, Settings indexSettings)

Method Summary

Modifier and Type	Method and Description
boolean	active()
protected String	contentType()
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
boolean	hasDocValues()
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value) Returns the indexed value used to construct search "values".
void	merge(Mapper mergeWith, MergeContext mergeContext)
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 Mapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context) Called before Mapper.parse(ParseContext) on the RootObjectMapper.
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)
String	type()
boolean	useTermQueryWithQueryString() We don't need to analyzer the text, and we need to convert it to UID...
Uid	value(Object value) Returns the actual value of the field.
Object	valueForSearch(Object value) Returns the value that will be used as a result for search.

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

boost, close, copyTo, customBoost, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, doXContentBody, fieldDataTermsFilter, fieldDataType, fieldType, fuzzyQuery, indexAnalyzer, indexOptionToString, indexTokenizeOptionToString, isGenerated, isNumeric, isSortable, name, names, normsLoading, nullValueFilter, parse, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, rangeFilter, rangeQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termVectorOptionsToString, traverse, traverse

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, parse, 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

ParentFieldMapper

protected ParentFieldMapper(String name,
                            String indexName,
                            String type,
                            PostingsFormatProvider postingsFormat,
                            @Nullable
                            Settings fieldDataSettings,
                            Settings indexSettings)

ParentFieldMapper

public ParentFieldMapper(Settings indexSettings)

Method Detail

type

public String type()

defaultFieldType

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

Specified by:

defaultFieldType in class AbstractFieldMapper<Uid>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<Uid>

hasDocValues

public boolean hasDocValues()

Specified by:

hasDocValues in interface FieldMapper<Uid>

Overrides:

hasDocValues in class AbstractFieldMapper<Uid>

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

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<Uid>

Throws:

IOException

value

public Uid value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

Specified by:

value in interface FieldMapper<Uid>

valueForSearch

public Object valueForSearch(Object value)

Description copied from interface: FieldMapper

Returns the value that will be used as a result for search. Can be only of specific types... .

Specified by:

valueForSearch in interface FieldMapper<Uid>

Overrides:

valueForSearch in class AbstractFieldMapper<Uid>

indexedValueForSearch

public org.apache.lucene.util.BytesRef indexedValueForSearch(Object value)

Description copied from interface: FieldMapper

Returns the indexed value used to construct search "values".

Specified by:

indexedValueForSearch in interface FieldMapper<Uid>

Overrides:

indexedValueForSearch in class AbstractFieldMapper<Uid>

termQuery

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

Specified by:

termQuery in interface FieldMapper<Uid>

Overrides:

termQuery in class AbstractFieldMapper<Uid>

termFilter

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

Specified by:

termFilter in interface FieldMapper<Uid>

Overrides:

termFilter in class AbstractFieldMapper<Uid>

termsFilter

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

Specified by:

termsFilter in interface FieldMapper<Uid>

Overrides:

termsFilter in class AbstractFieldMapper<Uid>

useTermQueryWithQueryString

public boolean useTermQueryWithQueryString()

We don't need to analyzer the text, and we need to convert it to UID...

Specified by:

useTermQueryWithQueryString in interface FieldMapper<Uid>

Overrides:

useTermQueryWithQueryString in class AbstractFieldMapper<Uid>

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<Uid>

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractFieldMapper<Uid>

Throws:

IOException

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<Uid>

Throws:

MergeMappingException

active

public boolean active()

Returns:

Whether the _parent field is actually used.