Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class AbstractScriptFieldType<LeafFactory>

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

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

Direct Known Subclasses:

BooleanScriptFieldType, DateScriptFieldType, DoubleScriptFieldType, GeoPointScriptFieldType, IpScriptFieldType, KeywordScriptFieldType, LongScriptFieldType

public abstract class AbstractScriptFieldType<LeafFactory>
extends MappedFieldType

Abstract base MappedFieldType for runtime fields based on a script.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractScriptFieldType.Builder<Factory>

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
protected static final Script	DEFAULT_SCRIPT
protected final Script	script

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptFieldType(String name, Function<SearchLookup,LeafFactory> factory, Script script, boolean isResultDeterministic, Map<String,String> meta)

Method Summary

Modifier and Type	Method	Description
protected final void	applyScriptContext(SearchExecutionContext context)
final boolean	fieldHasValue(org.apache.lucene.index.FieldInfos fieldInfos)	This method is used to support _field_caps when include_empty_fields is set to false.
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)
final boolean	isAggregatable()	Returns true if the field is aggregatable.
final boolean	isSearchable()	Returns true if the field is searchable.
protected final LeafFactory	leafFactory(SearchExecutionContext context)	Create a script leaf factory for queries.
protected final LeafFactory	leafFactory(SearchLookup searchLookup)	Create a script leaf factory.
org.apache.lucene.search.Query	multiPhraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePositionIncrements, SearchExecutionContext context)
org.apache.lucene.search.Query	phrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream, int slop, int maxExpansions, SearchExecutionContext context)
org.apache.lucene.search.Query	phraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePositionIncrements, SearchExecutionContext context)
org.apache.lucene.search.Query	prefixQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)
protected abstract org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context)
final 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	regexpQuery(String value, int syntaxFlags, int matchFlags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, SearchExecutionContext context)
org.apache.lucene.queries.spans.SpanQuery	spanPrefixQuery(String value, org.apache.lucene.queries.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method, SearchExecutionContext context)
void	validateMatchedRoutingPath(String routingPath)	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.
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.MappedFieldType

blockLoader, checkNoFormat, checkNoTimeZone, collapseType, dimensions, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fielddataBuilder, fuzzyIntervals, fuzzyQuery, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isDimension, isFieldWithinQuery, isIndexed, isStored, mayExistInIndex, meta, name, normalizedWildcardQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, termIntervals, termQuery, termQueryCaseInsensitive, termsQuery, typeName, valueForDisplay, wildcardIntervals, wildcardQuery

Methods inherited from class java.lang.Object

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

Field Details

script

protected final Script script

DEFAULT_SCRIPT

protected static final Script DEFAULT_SCRIPT

Constructor Details

AbstractScriptFieldType

protected AbstractScriptFieldType(String name,
 Function<SearchLookup,LeafFactory> factory,
 Script script,
 boolean isResultDeterministic,
 Map<String,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

rangeQuery

public final 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

relation - the relation, nulls should be interpreted like INTERSECTS

rangeQuery

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

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 MappedFieldType

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 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 MappedFieldType

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 MappedFieldType

phraseQuery

public org.apache.lucene.search.Query phraseQuery(org.apache.lucene.analysis.TokenStream stream,
 int slop,
 boolean enablePositionIncrements,
 SearchExecutionContext context)

Overrides:

phraseQuery in class MappedFieldType

multiPhraseQuery

public org.apache.lucene.search.Query multiPhraseQuery(org.apache.lucene.analysis.TokenStream stream,
 int slop,
 boolean enablePositionIncrements,
 SearchExecutionContext context)

Overrides:

multiPhraseQuery in class MappedFieldType

phrasePrefixQuery

public org.apache.lucene.search.Query phrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream,
 int slop,
 int maxExpansions,
 SearchExecutionContext context)

Overrides:

phrasePrefixQuery in class MappedFieldType

spanPrefixQuery

public org.apache.lucene.queries.spans.SpanQuery spanPrefixQuery(String value,
 org.apache.lucene.queries.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method,
 SearchExecutionContext context)

Overrides:

spanPrefixQuery in class MappedFieldType

applyScriptContext

protected final void applyScriptContext(SearchExecutionContext context)

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

leafFactory

protected final LeafFactory leafFactory(SearchLookup searchLookup)

Create a script leaf factory.

leafFactory

protected final LeafFactory leafFactory(SearchExecutionContext context)

Create a script leaf factory for queries.

validateMatchedRoutingPath

public void validateMatchedRoutingPath(String routingPath)

Description copied from class: MappedFieldType

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

Overrides:

validateMatchedRoutingPath in class MappedFieldType

fieldHasValue

public final boolean fieldHasValue(org.apache.lucene.index.FieldInfos fieldInfos)

Description copied from class: MappedFieldType

This method is used to support _field_caps when include_empty_fields is set to false. In that case we return only fields with value in an index. This method gets as input FieldInfos and returns if the field is non-empty. This method needs to be overwritten where fields don't have footprint in Lucene or their name differs from MappedFieldType.name()

Overrides:

fieldHasValue in class MappedFieldType

Parameters:

fieldInfos - field information

Returns:

true if field is present in fieldInfos false otherwise