Module org.elasticsearch.server
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.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation -
Method Summary
Modifier and TypeMethodDescriptionbooleanfielddataBuilder(FieldDataContext fieldDataContext) Return a fielddata builder for this fieldgetChildFieldType(String childPath) Returns a dynamic MappedFieldType for the given pathbooleantypeName()Returns the name of this type, as would be specified in mapping propertiesvoidvalidateMatchedRoutingPath(String routingPath) Validate that this field can be the target ofIndexMetadata.INDEX_ROUTING_PATH.valueFetcher(SearchExecutionContext context, String format) Create a helper class to fetch field values during theFetchFieldsPhase.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, wildcardQueryMethods inherited from class org.elasticsearch.index.mapper.TermBasedFieldType
indexedValueForSearch, mayExistInIndex, termQuery, termQueryCaseInsensitive, termsQueryMethods inherited from class org.elasticsearch.index.mapper.SimpleMappedFieldType
rangeQueryMethods inherited from class org.elasticsearch.index.mapper.MappedFieldType
blockLoader, checkNoFormat, checkNoTimeZone, collapseType, distanceFeatureQuery, docValueFormat, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fieldHasValue, fuzzyIntervals, fuzzyQuery, getDefaultHighlighter, getMetricType, getTerms, getTextSearchInfo, hasDocValues, hasScriptValues, isAggregatable, isFieldWithinQuery, isIndexed, isSearchable, isStored, meta, multiPhraseQuery, name, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, rangeIntervals, regexpIntervals, spanPrefixQuery, termIntervals, wildcardIntervals, wildcardQuery
-
Method Details
-
typeName
Description copied from class:MappedFieldTypeReturns the name of this type, as would be specified in mapping properties- Specified by:
typeNamein classMappedFieldType
-
eagerGlobalOrdinals
public boolean eagerGlobalOrdinals()- Overrides:
eagerGlobalOrdinalsin classMappedFieldType- Returns:
- if this field type should load global ordinals eagerly
-
valueForDisplay
Description copied from class:MappedFieldTypeGiven 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:
valueForDisplayin classMappedFieldType
-
fielddataBuilder
Description copied from class:MappedFieldTypeReturn a fielddata builder for this field- Overrides:
fielddataBuilderin classMappedFieldType- Parameters:
fieldDataContext- the context for the fielddata
-
valueFetcher
Description copied from class:MappedFieldTypeCreate a helper class to fetch field values during theFetchFieldsPhase. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throwUnsupportedOperationExceptionsince this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.- Specified by:
valueFetcherin classMappedFieldType
-
getChildFieldType
Description copied from interface:DynamicFieldTypeReturns a dynamic MappedFieldType for the given path- Specified by:
getChildFieldTypein interfaceDynamicFieldType
-
getKeyedFieldType
-
isDimension
public boolean isDimension()- Overrides:
isDimensionin classMappedFieldType- Returns:
- true if field has been marked as a dimension field
-
dimensions
- Overrides:
dimensionsin classMappedFieldType- Returns:
- a list of dimension fields. Expected to be used by fields that have nested fields or that, in some way, identify a collection of fields by means of a top level field (like flattened fields).
-
validateMatchedRoutingPath
Description copied from class:MappedFieldTypeValidate that this field can be the target ofIndexMetadata.INDEX_ROUTING_PATH.- Overrides:
validateMatchedRoutingPathin classMappedFieldType
-