Package org.elasticsearch.index.mapper

Class ConstantFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.ConstantFieldType

Direct Known Subclasses:

TypeFieldMapper.TypeFieldType, TypeFieldType

public abstract class ConstantFieldType
extends MappedFieldType

A MappedFieldType that has the same value for all documents. Factory methods for queries are called at rewrite time so they should be cheap. In particular they should not read data from disk or perform a network call. Furthermore they may only return a MatchAllDocsQuery or a MatchNoDocsQuery.

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
ConstantFieldType(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> meta)

Method Summary

Modifier and Type	Method	Description
boolean	isAggregatable()	Returns true if the field is aggregatable.
boolean	isSearchable()	Returns true if the field is searchable.
protected abstract boolean	matches(java.lang.String pattern, boolean caseInsensitive, SearchExecutionContext context)	Return whether the constant value of this field matches the provided pattern as documented in Regex.simpleMatch(java.lang.String, java.lang.String).
org.apache.lucene.search.Query	prefixQuery(java.lang.String prefix, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)
org.apache.lucene.search.Query	termQuery(java.lang.Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
org.apache.lucene.search.Query	termQueryCaseInsensitive(java.lang.Object value, SearchExecutionContext context)
org.apache.lucene.search.Query	termsQuery(java.util.Collection<?> values, SearchExecutionContext context)	Build a constant-scoring query that matches all values.
org.apache.lucene.search.Query	wildcardQuery(java.lang.String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)

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

boost, collapseType, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fielddataBuilder, fuzzyQuery, getTextSearchInfo, hasDocValues, intervals, isFieldWithinQuery, isStored, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixQuery, rangeQuery, regexpQuery, setBoost, spanPrefixQuery, typeName, valueFetcher, valueForDisplay, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

ConstantFieldType

public ConstantFieldType(java.lang.String name,
java.util.Map<java.lang.String,java.lang.String> meta)

Method Details

isSearchable

public final boolean isSearchable()

Description copied from class: MappedFieldType

Returns true if the field is searchable.

Overrides:

isSearchable in class MappedFieldType

isAggregatable

public final boolean isAggregatable()

Description copied from class: MappedFieldType

Returns true if the field is aggregatable.

Overrides:

isAggregatable in class MappedFieldType

matches

protected abstract boolean matches(java.lang.String pattern,
boolean caseInsensitive,
SearchExecutionContext context)

Return whether the constant value of this field matches the provided pattern as documented in Regex.simpleMatch(java.lang.String, java.lang.String).

termQuery

public final org.apache.lucene.search.Query termQuery(java.lang.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, boosted by MappedFieldType.boost().

Specified by:

termQuery in class MappedFieldType

termQueryCaseInsensitive

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

Overrides:

termQueryCaseInsensitive in class MappedFieldType

termsQuery

public final org.apache.lucene.search.Query termsQuery(java.util.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 MappedFieldType

prefixQuery

public final org.apache.lucene.search.Query prefixQuery(java.lang.String prefix,
@Nullable
org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
boolean caseInsensitive,
SearchExecutionContext context)

Overrides:

prefixQuery in class MappedFieldType

wildcardQuery

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

Overrides:

wildcardQuery in class MappedFieldType