org.elasticsearch.script

Class AbstractSearchScript

java.lang.Object

org.elasticsearch.script.AbstractExecutableScript

org.elasticsearch.script.AbstractSearchScript

All Implemented Interfaces:

ScorerAware, ExecutableScript, LeafSearchScript

Direct Known Subclasses:

AbstractDoubleSearchScript, AbstractLongSearchScript

public abstract class AbstractSearchScript
extends AbstractExecutableScript
implements LeafSearchScript

A base class for any script type that is used during the search process (custom score, aggs, and so on).

If the script returns a specific numeric type, consider overriding the type specific base classes such as AbstractDoubleSearchScript and AbstractLongSearchScript for better performance.

The use is required to implement the ExecutableScript.run() method.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchScript()

Method Summary

Modifier and Type	Method and Description
protected LeafDocLookup	doc() Returns the doc lookup allowing to access field data (cached) values as well as the current document score (where applicable).
protected ScriptDocValues.Doubles	docFieldDoubles(java.lang.String field) Returns field data double (floating point) access for the provided field.
protected ScriptDocValues.Longs	docFieldLongs(java.lang.String field) Returns field data long (integers) access for the provided field.
protected ScriptDocValues.Strings	docFieldStrings(java.lang.String field) Returns field data strings access for the provided field.
protected LeafFieldsLookup	fields() Allows to access the *stored* fields.
protected LeafIndexLookup	indexLookup() Allows to access statistics on terms and fields.
double	runAsDouble() Return the result as a double.
long	runAsLong() Return the result as a long.
protected float	score() Returns the current score and only applicable when used as a scoring script in a custom score query!.
void	setDocument(int doc) Set the document this script will process next.
void	setScorer(org.apache.lucene.search.Scorer scorer)
void	setSource(java.util.Map<java.lang.String,java.lang.Object> source) Set the source for the current document.
protected SourceLookup	source() Allows to access the actual source (loaded and parsed).

Methods inherited from class org.elasticsearch.script.AbstractExecutableScript

setNextVar

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.script.LeafSearchScript

run, setNextAggregationValue, setNextVar

Methods inherited from interface org.elasticsearch.script.ExecutableScript

unwrap

Constructor Detail

AbstractSearchScript

public AbstractSearchScript()

Method Detail

doc

protected final LeafDocLookup doc()

Returns the doc lookup allowing to access field data (cached) values as well as the current document score (where applicable).

score

protected final float score()
                     throws java.io.IOException

Returns the current score and only applicable when used as a scoring script in a custom score query!.

Throws:

java.io.IOException

docFieldStrings

protected ScriptDocValues.Strings docFieldStrings(java.lang.String field)

Returns field data strings access for the provided field.

docFieldDoubles

protected ScriptDocValues.Doubles docFieldDoubles(java.lang.String field)

Returns field data double (floating point) access for the provided field.

docFieldLongs

protected ScriptDocValues.Longs docFieldLongs(java.lang.String field)

Returns field data long (integers) access for the provided field.

source

protected final SourceLookup source()

Allows to access the actual source (loaded and parsed).

indexLookup

protected final LeafIndexLookup indexLookup()

Allows to access statistics on terms and fields.

fields

protected final LeafFieldsLookup fields()

Allows to access the *stored* fields.

setScorer

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

Specified by:

setScorer in interface ScorerAware

Specified by:

setScorer in interface LeafSearchScript

setDocument

public void setDocument(int doc)

Description copied from interface: LeafSearchScript

Set the document this script will process next.

Specified by:

setDocument in interface LeafSearchScript

setSource

public void setSource(java.util.Map<java.lang.String,java.lang.Object> source)

Description copied from interface: LeafSearchScript

Set the source for the current document.

Specified by:

setSource in interface LeafSearchScript

runAsLong

public long runAsLong()

Description copied from interface: LeafSearchScript

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

Specified by:

runAsLong in interface LeafSearchScript

runAsDouble

public double runAsDouble()

Description copied from interface: LeafSearchScript

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

Specified by:

runAsDouble in interface LeafSearchScript