Package org.opensearch.script

Class StringSortScript

java.lang.Object

org.opensearch.script.StringSortScript

All Implemented Interfaces:

ScorerAware

public abstract class StringSortScript
extends Object

Script for sorting strings

Opensearch.internal:

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptContext<StringSortScript.Factory>	CONTEXT
static final String[]	PARAMETERS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract String	execute()
double	get_score()	Return the score of the current document.
Map<String,ScriptDocValues<?>>	getDoc()	The doc lookup for the Lucene segment this script was created for.
Map<String,Object>	getParams()	Return the parameters for this script.
void	setDocument(int docid)	Set the current document to run the script on next.
void	setScorer(org.apache.lucene.search.Scorable scorer)

Methods inherited from class java.lang.Object

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

Field Details

PARAMETERS

public static final String[] PARAMETERS

CONTEXT

public static final ScriptContext<StringSortScript.Factory> CONTEXT

Constructor Details

StringSortScript

public StringSortScript(Map<String,Object> params,
 SearchLookup lookup,
 org.apache.lucene.index.LeafReaderContext leafContext)

Method Details

execute

public abstract String execute()

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

setScorer

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

Specified by:

setScorer in interface ScorerAware

get_score

public double get_score()

Return the score of the current document.

getDoc

public Map<String,ScriptDocValues<?>> 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.