Package org.elasticsearch.index.mapper.flattened

Class FlattenedFieldMapper.KeyedFlattenedFieldType

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.KeyedFlattenedFieldType

Enclosing class:

FlattenedFieldMapper

public static final class FlattenedFieldMapper.KeyedFlattenedFieldType
extends StringFieldType

A field type that represents the values under a particular JSON key, used when searching under a specific key as in 'my_flattened.key: some_value'.

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.Query	existsQuery(SearchExecutionContext context)
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName, Supplier<SearchLookup> searchLookup)	Return a fielddata builder for this field
org.apache.lucene.search.Query	fuzzyQuery(Object value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions, SearchExecutionContext context)
org.apache.lucene.index.TermsEnum	getTerms(boolean caseInsensitive, String string, SearchExecutionContext queryShardContext, String searchAfter)	This method is used to support auto-complete services and implementations are expected to find terms beginning with the provided string very quickly.
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value)	Returns the indexed value used to construct search "values".
String	key()
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, SearchExecutionContext context)	Same as SimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, SearchExecutionContext) but without the trouble of relations or date-specific options.
org.apache.lucene.search.Query	regexpQuery(String value, int syntaxFlags, int matchFlags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, SearchExecutionContext context)
org.apache.lucene.search.Query	termQueryCaseInsensitive(Object value, 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.
org.apache.lucene.search.Query	wildcardQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)

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

normalizedWildcardQuery, normalizeWildcardPattern, prefixQuery, wildcardQuery

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

termQuery, termsQuery

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

rangeQuery

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

boost, collapseType, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fuzzyIntervals, getTextSearchInfo, hasDocValues, isAggregatable, isFieldWithinQuery, isSearchable, isStored, meta, multiPhraseQuery, name, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, setBoost, spanPrefixQuery, termIntervals, valueForDisplay, wildcardIntervals, wildcardQuery

Methods inherited from class java.lang.Object

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

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

key

public String key()

existsQuery

public org.apache.lucene.search.Query existsQuery(SearchExecutionContext context)

Overrides:

existsQuery in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 SearchExecutionContext context)

Description copied from class: SimpleMappedFieldType

Same as SimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, SearchExecutionContext) but without the trouble of relations or date-specific options.

Overrides:

rangeQuery in class StringFieldType

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(Object value,
 Fuzziness fuzziness,
 int prefixLength,
 int maxExpansions,
 boolean transpositions,
 SearchExecutionContext context)

Overrides:

fuzzyQuery in class StringFieldType

regexpQuery

public org.apache.lucene.search.Query regexpQuery(String value,
 int syntaxFlags,
 int matchFlags,
 int maxDeterminizedStates,
 org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
 SearchExecutionContext context)

Overrides:

regexpQuery in class StringFieldType

wildcardQuery

public org.apache.lucene.search.Query wildcardQuery(String value,
 org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
 boolean caseInsensitive,
 SearchExecutionContext context)

Overrides:

wildcardQuery in class StringFieldType

termQueryCaseInsensitive

public org.apache.lucene.search.Query termQueryCaseInsensitive(Object value,
 SearchExecutionContext context)

Overrides:

termQueryCaseInsensitive in class TermBasedFieldType

getTerms

public org.apache.lucene.index.TermsEnum getTerms(boolean caseInsensitive,
 String string,
 SearchExecutionContext queryShardContext,
 String searchAfter)
                                           throws IOException

Description copied from class: MappedFieldType

This method is used to support auto-complete services and implementations are expected to find terms beginning with the provided string very quickly. If fields cannot look up matching terms quickly they should return null. The returned TermEnum should implement next(), term() and doc_freq() methods but postings etc are not required.

Overrides:

getTerms in class MappedFieldType

Parameters:

caseInsensitive - if matches should be case insensitive

string - the partially complete word the user has typed (can be empty)

queryShardContext - the shard context

searchAfter - - usually null. If supplied the TermsEnum result must be positioned after the provided term (used for pagination)

Returns:

null or an enumeration of matching terms and their doc frequencies

Throws:

IOException - Errors accessing data

indexedValueForSearch

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

Description copied from class: TermBasedFieldType

Returns the indexed value used to construct search "values". This method is used for the default implementations of most query factory methods such as TermBasedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.SearchExecutionContext).

Overrides:

indexedValueForSearch in class TermBasedFieldType

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName,
 Supplier<SearchLookup> searchLookup)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fullyQualifiedIndexName - the name of the index this field-data is build for

searchLookup - a SearchLookup supplier to allow for accessing other fields values in the context of runtime fields

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