Package org.elasticsearch.index.mapper

Class KeywordScriptFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.KeywordScriptFieldType

All Implemented Interfaces:

org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, RuntimeField

public final class KeywordScriptFieldType
extends MappedFieldType

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.RuntimeField

RuntimeField.Parser

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static RuntimeField.Parser	PARSER
protected Script	script

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
KeywordScriptFieldType(String name)
KeywordScriptFieldType(String name, StringFieldScript.Factory scriptFactory, Script script, Map<String,String> meta, org.elasticsearch.common.xcontent.ToXContent toXContent)

Method Summary

Modifier and Type	Method	Description
Collection<MappedFieldType>	asMappedFieldTypes()	Exposes the MappedFieldTypes backing this runtime field, used to execute queries, run aggs etc.
protected void	checkAllowExpensiveQueries(SearchExecutionContext context)
void	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)	Prints out the parameters that subclasses expose
org.apache.lucene.search.Query	existsQuery(SearchExecutionContext context)
StringScriptFieldData.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)
boolean	isAggregatable()	Returns true if the field is aggregatable.
boolean	isSearchable()	Returns true if the field is searchable.
protected StringFieldScript.LeafFactory	leafFactory(SearchExecutionContext context)	Create a script leaf factory for queries.
protected StringFieldScript.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)
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	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.search.spans.SpanQuery	spanPrefixQuery(String value, org.apache.lucene.search.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod 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
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)

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

boost, collapseType, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fuzzyIntervals, getTerms, getTextSearchInfo, hasDocValues, isFieldWithinQuery, isStored, meta, name, normalizedWildcardQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, setBoost, termIntervals, wildcardIntervals, wildcardQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.RuntimeField

name, toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

PARSER

public static final RuntimeField.Parser PARSER

script

protected final Script script

Constructor Details

KeywordScriptFieldType

public KeywordScriptFieldType(String name)

KeywordScriptFieldType

public KeywordScriptFieldType(String name,
 StringFieldScript.Factory scriptFactory,
 Script script,
 Map<String,String> meta,
 org.elasticsearch.common.xcontent.ToXContent toXContent)

Method Details

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 interface RuntimeField

Specified by:

typeName in class MappedFieldType

Returns:

type of the field

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

fielddataBuilder

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

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)

prefixQuery

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

rangeQuery

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

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)

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, boosted by MappedFieldType.boost().

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)

asMappedFieldTypes

public final Collection<MappedFieldType> asMappedFieldTypes()

Description copied from interface: RuntimeField

Exposes the MappedFieldTypes backing this runtime field, used to execute queries, run aggs etc.

Specified by:

asMappedFieldTypes in interface RuntimeField

Returns:

the MappedFieldTypes backing this runtime field

doXContentBody

public final void doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                          throws IOException

Description copied from interface: RuntimeField

Prints out the parameters that subclasses expose

Specified by:

doXContentBody in interface RuntimeField

Throws:

IOException

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

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.search.spans.SpanQuery spanPrefixQuery(String value,
 org.apache.lucene.search.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method,
 SearchExecutionContext context)

Overrides:

spanPrefixQuery in class MappedFieldType

checkAllowExpensiveQueries

protected final void checkAllowExpensiveQueries(SearchExecutionContext context)

valueFetcher

public final 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 StringFieldScript.LeafFactory leafFactory(SearchLookup searchLookup)

Create a script leaf factory.

leafFactory

protected final StringFieldScript.LeafFactory leafFactory(SearchExecutionContext context)

Create a script leaf factory for queries.