Package org.elasticsearch.script

Class SearchScript

java.lang.Object

org.elasticsearch.script.SearchScript

All Implemented Interfaces:

ScorerAware, ExecutableScript

public abstract class SearchScript
extends java.lang.Object
implements ScorerAware, ExecutableScript

A generic script used for per document use cases. Using a SearchScript works as follows:

1. Construct a SearchScript.Factory using ScriptService.compile(Script, ScriptContext)
2. Construct a SearchScript.LeafFactory for a an index using SearchScript.Factory.newFactory(Map, SearchLookup)
3. Construct a SearchScript for a Lucene segment using SearchScript.LeafFactory.newInstance(LeafReaderContext)
4. Call setDocument(int) to indicate which document in the segment the script should be run for next
5. Call one of the run methods: run(), runAsDouble(), or runAsLong()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchScript.Factory	A factory to construct stateful SearchScript factories for a specific index.
static interface	SearchScript.LeafFactory	A factory to construct SearchScript instances.

Field Summary

Fields

Modifier and Type	Field	Description
static ScriptContext<SearchScript.Factory>	AGGS_CONTEXT
static ScriptContext<SearchScript.Factory>	CONTEXT	The context used to compile SearchScript factories.

Fields inherited from interface org.elasticsearch.script.ExecutableScript

INGEST_CONTEXT, UPDATE_CONTEXT

Constructor Summary

Constructors

Constructor	Description
SearchScript(java.util.Map<java.lang.String,java.lang.Object> params, SearchLookup lookup, org.apache.lucene.index.LeafReaderContext leafContext)

Method Summary

Modifier and Type	Method	Description
LeafDocLookup	getDoc()	The doc lookup for the Lucene segment this script was created for.
protected org.apache.lucene.index.LeafReaderContext	getLeafContext()	The leaf context for the Lucene segment this script was created for.
protected LeafSearchLookup	getLeafLookup()	The leaf lookup for the Lucene segment this script was created for.
java.util.Map<java.lang.String,java.lang.Object>	getParams()	Return the parameters for this script.
double	getScore()	Return the score of the current document.
java.lang.Object	run()	Executes the script.
abstract double	runAsDouble()	Return the result as a double.
long	runAsLong()	Return the result as a long.
void	setDocument(int docid)	Set the current document to run the script on next.
void	setNextAggregationValue(java.lang.Object value)	Sets per-document aggregation _value.
void	setNextVar(java.lang.String field, java.lang.Object value)	Sets a runtime script parameter.
void	setScorer(org.apache.lucene.search.Scorer scorer)

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final ScriptContext<SearchScript.Factory> CONTEXT

The context used to compile SearchScript factories.

AGGS_CONTEXT

public static final ScriptContext<SearchScript.Factory> AGGS_CONTEXT

Constructor Detail

SearchScript

public SearchScript(java.util.Map<java.lang.String,java.lang.Object> params,
                    SearchLookup lookup,
                    org.apache.lucene.index.LeafReaderContext leafContext)

Method Detail

getParams

public java.util.Map<java.lang.String,java.lang.Object> getParams()

Return the parameters for this script.

getLeafLookup

protected final LeafSearchLookup getLeafLookup()

The leaf lookup for the Lucene segment this script was created for.

getLeafContext

protected final org.apache.lucene.index.LeafReaderContext getLeafContext()

The leaf context for the Lucene segment this script was created for.

getDoc

public final LeafDocLookup getDoc()

The doc lookup for the Lucene segment this script was created for.

setDocument

public void setDocument(int docid)

Set the current document to run the script on next.

setScorer

public void setScorer(org.apache.lucene.search.Scorer scorer)

Specified by:

setScorer in interface ScorerAware

getScore

public double getScore()

Return the score of the current document.

setNextAggregationValue

public void setNextAggregationValue(java.lang.Object value)

Sets per-document aggregation _value.

The default implementation just calls setNextVar("_value", value) but some engines might want to handle this differently for better performance.

Parameters:

value - per-document value, typically a String, Long, or Double

setNextVar

public void setNextVar(java.lang.String field,
                       java.lang.Object value)

Description copied from interface: ExecutableScript

Sets a runtime script parameter.

Note that this method may be slow, involving put() and get() calls to a hashmap or similar.

Specified by:

setNextVar in interface ExecutableScript

Parameters:

field - parameter name

value - parameter value

runAsLong

public long runAsLong()

Return the result as a long. This is used by aggregation scripts over long fields.

run

public java.lang.Object run()

Description copied from interface: ExecutableScript

Executes the script.

Specified by:

run in interface ExecutableScript

runAsDouble

public abstract double runAsDouble()

Return the result as a double. This is the main use case of search script, used for document scoring.