Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class KeywordScriptFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.AbstractScriptFieldType<StringFieldScript.LeafFactory>

org.elasticsearch.index.mapper.KeywordScriptFieldType

public final class KeywordScriptFieldType
extends AbstractScriptFieldType<StringFieldScript.LeafFactory>

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

Modifier and Type	Field	Description
static final RuntimeField.Parser	PARSER

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

DEFAULT_SCRIPT, script

Constructor Summary

Constructors

Constructor	Description
KeywordScriptFieldType(String name, StringFieldScript.Factory scriptFactory, Script script, Map<String,String> meta, OnScriptError onScriptError)

Method Summary

Modifier and Type	Method	Description
BlockLoader	blockLoader(MappedFieldType.BlockLoaderContext blContext)	Returns a loader for ESQL or null if the field doesn't support ESQL.
org.apache.lucene.search.Query	existsQuery(SearchExecutionContext context)
StringScriptFieldData.Builder	fielddataBuilder(FieldDataContext fieldDataContext)	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.search.MultiTermQuery.RewriteMethod rewriteMethod)
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, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context)
org.apache.lucene.search.Query	regexpQuery(String value, int syntaxFlags, int matchFlags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, SearchExecutionContext context)
static RuntimeField	sourceOnly(String name)
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
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)

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

applyScriptContext, fieldHasValue, isAggregatable, isSearchable, leafFactory, leafFactory, multiPhraseQuery, phrasePrefixQuery, phraseQuery, rangeQuery, spanPrefixQuery, validateMatchedRoutingPath, valueFetcher

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

checkNoFormat, checkNoTimeZone, collapseType, dimensions, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fuzzyIntervals, fuzzyQuery, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isDimension, isFieldWithinQuery, isIndexed, isStored, mayExistInIndex, meta, name, pointReaderIfPossible, prefixIntervals, prefixQuery, termIntervals, wildcardIntervals, wildcardQuery

Methods inherited from class java.lang.Object

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

Field Details

PARSER

public static final RuntimeField.Parser PARSER

Constructor Details

KeywordScriptFieldType

public KeywordScriptFieldType(String name,
 StringFieldScript.Factory scriptFactory,
 Script script,
 Map<String,String> meta,
 OnScriptError onScriptError)

Method Details

sourceOnly

public static RuntimeField sourceOnly(String name)

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

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

blockLoader

public BlockLoader blockLoader(MappedFieldType.BlockLoaderContext blContext)

Description copied from class: MappedFieldType

Returns a loader for ESQL or null if the field doesn't support ESQL.

Overrides:

blockLoader in class MappedFieldType

fielddataBuilder

public StringScriptFieldData.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

existsQuery

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

Overrides:

existsQuery in class MappedFieldType

fuzzyQuery

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

Overrides:

fuzzyQuery in class AbstractScriptFieldType<StringFieldScript.LeafFactory>

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 AbstractScriptFieldType<StringFieldScript.LeafFactory>

rangeQuery

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

Specified by:

rangeQuery in class AbstractScriptFieldType<StringFieldScript.LeafFactory>

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 AbstractScriptFieldType<StringFieldScript.LeafFactory>

termQueryCaseInsensitive

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

Overrides:

termQueryCaseInsensitive 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

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 MappedFieldType

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 AbstractScriptFieldType<StringFieldScript.LeafFactory>

normalizedWildcardQuery

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

Overrides:

normalizedWildcardQuery in class MappedFieldType