org.elasticsearch.script

Interface NativeScriptFactory

public interface NativeScriptFactory

A factory to create instances of either ExecutableScript or SearchScript. Note, if this factory creates SearchScript, it must extend AbstractSearchScript.

See Also:

AbstractExecutableScript, AbstractSearchScript, AbstractLongSearchScript, AbstractDoubleSearchScript

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the script factory
boolean	needsScores() Indicates if document scores may be needed by the produced scripts.
ExecutableScript	newScript(java.util.Map<java.lang.String,java.lang.Object> params) Creates a new instance of either a ExecutableScript or a SearchScript.

Method Detail

newScript

ExecutableScript newScript(@Nullable
                           java.util.Map<java.lang.String,java.lang.Object> params)

Creates a new instance of either a ExecutableScript or a SearchScript.

Parameters:

params - The parameters passed to the script. Can be null.

needsScores

boolean needsScores()

Indicates if document scores may be needed by the produced scripts.

Returns:

true if scores are needed.

getName

java.lang.String getName()

Returns the name of the script factory