Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.flattened

Class FlattenedFieldMapper.RootFlattenedFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.SimpleMappedFieldType

org.elasticsearch.index.mapper.TermBasedFieldType

org.elasticsearch.index.mapper.StringFieldType

org.elasticsearch.index.mapper.flattened.FlattenedFieldMapper.RootFlattenedFieldType

All Implemented Interfaces:

DynamicFieldType

Enclosing class:

FlattenedFieldMapper

public static final class FlattenedFieldMapper.RootFlattenedFieldType
extends StringFieldType
implements DynamicFieldType

A field type that represents all 'root' values. This field type is used in searches on the flattened field itself, e.g. 'my_flattened: some_value'.

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
RootFlattenedFieldType(String name, boolean indexed, boolean hasDocValues, Map<String,String> meta, boolean splitQueriesOnWhitespace, boolean eagerGlobalOrdinals)

Method Summary

Modifier and Type	Method	Description
boolean	eagerGlobalOrdinals()
IndexFieldData.Builder	fielddataBuilder(FieldDataContext fieldDataContext)	Return a fielddata builder for this field
MappedFieldType	getChildFieldType(String childPath)	Returns a dynamic MappedFieldType for the given path
boolean	mayExistInIndex(SearchExecutionContext context)
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.
Object	valueForDisplay(Object value)	Given a value that comes from the stored fields API, convert it to the expected type.

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

fuzzyQuery, normalizedWildcardQuery, normalizeWildcardPattern, prefixQuery, rangeQuery, regexpQuery, wildcardQuery, wildcardQuery

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

indexedValueForSearch, termQuery, termQueryCaseInsensitive, termsQuery

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

rangeQuery

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

checkNoFormat, checkNoTimeZone, collapseType, distanceFeatureQuery, docValueFormat, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fuzzyIntervals, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isDimension, isFieldWithinQuery, isIndexed, isSearchable, isStored, meta, multiPhraseQuery, name, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, spanPrefixQuery, termIntervals, validateMatchedRoutingPath, wildcardIntervals, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

RootFlattenedFieldType

public RootFlattenedFieldType(String name,
 boolean indexed,
 boolean hasDocValues,
 Map<String,String> meta,
 boolean splitQueriesOnWhitespace,
 boolean eagerGlobalOrdinals)

Method Details

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

eagerGlobalOrdinals

public boolean eagerGlobalOrdinals()

Overrides:

eagerGlobalOrdinals in class MappedFieldType

Returns:

if this field type should load global ordinals eagerly

mayExistInIndex

public boolean mayExistInIndex(SearchExecutionContext context)

Overrides:

mayExistInIndex in class TermBasedFieldType

Returns:

if the field may have values in the underlying index Note that this should only return false if it is not possible for it to match on a term query.

See Also:

• QueryParserHelper

valueForDisplay

public Object valueForDisplay(Object value)

Description copied from class: MappedFieldType

Given a value that comes from the stored fields API, convert it to the expected type. For instance a date field would store dates as longs and format it back to a string in this method.

Overrides:

valueForDisplay in class MappedFieldType

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(FieldDataContext fieldDataContext)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fieldDataContext - the context for the fielddata

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw UnsupportedOperationException since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.

Specified by:

valueFetcher in class MappedFieldType

getChildFieldType

public MappedFieldType getChildFieldType(String childPath)

Description copied from interface: DynamicFieldType

Returns a dynamic MappedFieldType for the given path

Specified by:

getChildFieldType in interface DynamicFieldType