Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class UnsearchableFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.UnsearchableFieldType

public final class UnsearchableFieldType
extends MappedFieldType

MappedFieldType that throws IllegalArgumentException for query or fetch access

Nested Class Summary

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

MappedFieldType.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation

Field Summary

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

indexType

Constructor Summary

Constructors

Constructor	Description
UnsearchableFieldType(String name, String type, String reason, Map<String,String> meta)

Method Summary

Modifier and Type	Method	Description
IndexFieldData.Builder	fielddataBuilder(FieldDataContext fieldDataContext)	Return a fielddata builder for this field
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context)	Factory method for range queries.
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
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.

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

automatonQuery, blockLoader, checkNoFormat, checkNoTimeZone, collapseType, dimensions, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, existsQuery, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fieldHasValue, fuzzyQuery, fuzzyQuery, getDefaultHighlighter, getMetricType, getTerms, getTextSearchInfo, hasDocValues, hasScriptValues, indexType, isAggregatable, isDimension, isFieldWithinQuery, isSearchable, isStored, isVectorEmbedding, mayExistInIndex, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixQuery, prefixQuery, regexpQuery, spanPrefixQuery, supportsBlockLoaderConfig, termQueryCaseInsensitive, termsQuery, validateMatchedRoutingPath, valueForDisplay, wildcardLikeQuery, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

UnsearchableFieldType

public UnsearchableFieldType(String name,
 String type,
 String reason,
 Map<String,String> meta)

Method Details

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

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

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

Specified by:

termQuery in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 ShapeRelation relation,
 ZoneId timeZone,
 DateMathParser parser,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Factory method for range queries.

Overrides:

rangeQuery in class MappedFieldType

Parameters:

relation - the relation, nulls should be interpreted like INTERSECTS

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