Package org.elasticsearch.index.mapper

Class KeywordFieldMapper.KeywordFieldType

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.KeywordFieldMapper.KeywordFieldType

Enclosing class:

KeywordFieldMapper

public static final class KeywordFieldMapper.KeywordFieldType
extends StringFieldType

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
KeywordFieldType(String name)
KeywordFieldType(String name, boolean isIndexed, boolean hasDocValues, Map<String,String> meta)
KeywordFieldType(String name, org.apache.lucene.document.FieldType fieldType)
KeywordFieldType(String name, org.apache.lucene.document.FieldType fieldType, NamedAnalyzer normalizer, NamedAnalyzer searchAnalyzer, NamedAnalyzer quoteAnalyzer, KeywordFieldMapper.Builder builder)
KeywordFieldType(String name, NamedAnalyzer analyzer)

Method Summary

Modifier and Type	Method	Description
MappedFieldType.CollapseType	collapseType()	Returns the collapse type of the field CollapseType.NONE means the field can'be used for collapsing.
boolean	eagerGlobalOrdinals()
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.
int	ignoreAbove()	Values that have more chars than the return value of this method will be skipped at parsing time.
protected org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value)	Returns the indexed value used to construct search "values".
boolean	isDimension()
boolean	isSearchable()	Returns true if the field is searchable.
org.apache.lucene.search.Query	normalizedWildcardQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, SearchExecutionContext context)
org.apache.lucene.search.Query	prefixQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)
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	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
org.apache.lucene.search.Query	termQueryCaseInsensitive(Object value, SearchExecutionContext context)
org.apache.lucene.search.Query	termsQuery(Collection<?> values, SearchExecutionContext context)	Build a constant-scoring query that matches all values.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
void	validateMatchedRoutingPath()	Validate that this field can be the target of IndexMetadata.INDEX_ROUTING_PATH.
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.
org.apache.lucene.search.Query	wildcardQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)	Wildcard queries on keyword fields use the normalizer of the underlying field, regardless of their case sensitivity option

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

normalizeWildcardPattern, wildcardQuery

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

mayExistInIndex

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

rangeQuery

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

KeywordFieldType

public KeywordFieldType(String name,
 org.apache.lucene.document.FieldType fieldType,
 NamedAnalyzer normalizer,
 NamedAnalyzer searchAnalyzer,
 NamedAnalyzer quoteAnalyzer,
 KeywordFieldMapper.Builder builder)

KeywordFieldType

public KeywordFieldType(String name,
 boolean isIndexed,
 boolean hasDocValues,
 Map<String,String> meta)

KeywordFieldType

public KeywordFieldType(String name)

KeywordFieldType

public KeywordFieldType(String name,
 org.apache.lucene.document.FieldType fieldType)

KeywordFieldType

public KeywordFieldType(String name,
 NamedAnalyzer analyzer)

Method Details

isSearchable

public boolean isSearchable()

Description copied from class: MappedFieldType

Returns true if the field is searchable.

Overrides:

isSearchable in class MappedFieldType

termQuery

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

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes

Overrides:

termQuery in class TermBasedFieldType

termsQuery

public org.apache.lucene.search.Query termsQuery(Collection<?> values,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Build a constant-scoring query that matches all values. The default implementation uses a ConstantScoreQuery around a BooleanQuery whose BooleanClause.Occur.SHOULD clauses are generated with MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.SearchExecutionContext).

Overrides:

termsQuery in class TermBasedFieldType

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

prefixQuery

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

Overrides:

prefixQuery 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

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

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

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

indexedValueForSearch

protected 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

wildcardQuery

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

Wildcard queries on keyword fields use the normalizer of the underlying field, regardless of their case sensitivity option

Overrides:

wildcardQuery in class StringFieldType

normalizedWildcardQuery

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

Overrides:

normalizedWildcardQuery 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

collapseType

public MappedFieldType.CollapseType collapseType()

Description copied from class: MappedFieldType

Returns the collapse type of the field CollapseType.NONE means the field can'be used for collapsing.

Overrides:

collapseType in class MappedFieldType

Returns:

collapse type of the field

ignoreAbove

public int ignoreAbove()

Values that have more chars than the return value of this method will be skipped at parsing time.

isDimension

public boolean isDimension()

Overrides:

isDimension in class MappedFieldType

Returns:

true if field has been marked as a dimension field

validateMatchedRoutingPath

public void validateMatchedRoutingPath()

Description copied from class: MappedFieldType

Validate that this field can be the target of IndexMetadata.INDEX_ROUTING_PATH.

Overrides:

validateMatchedRoutingPath in class MappedFieldType