Module org.elasticsearch.server

Package org.elasticsearch.script

Class GeometryFieldScript

java.lang.Object

org.elasticsearch.script.DocBasedScript

org.elasticsearch.script.AbstractFieldScript

org.elasticsearch.script.GeometryFieldScript

public abstract class GeometryFieldScript
extends AbstractFieldScript

Script producing geometries. It generates a unique Geometry for each document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeometryFieldScript.Emit
static interface	GeometryFieldScript.Factory
static interface	GeometryFieldScript.LeafFactory

Field Summary

Fields

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

Fields inherited from class org.elasticsearch.script.AbstractFieldScript

fieldName, MAX_VALUES, source

Fields inherited from class org.elasticsearch.script.DocBasedScript

docReader

Constructor Summary

Constructors

Constructor	Description
GeometryFieldScript(String fieldName, Map<String,Object> params, SearchLookup searchLookup, OnScriptError onScriptError, org.apache.lucene.index.LeafReaderContext ctx)

Method Summary

Modifier and Type	Method	Description
final int	count()	The number of results produced the last time AbstractFieldScript.runForDoc(int) was called.
protected void	emitFromObject(Object value)
final Geometry	geometry()	Geometry from the last time AbstractFieldScript.runForDoc(int) was called.
static GeometryFieldScript.Factory	leafAdapter(Function<SearchLookup,CompositeFieldScript.LeafFactory> parentFactory)
protected void	prepareExecute()
final void	runForDoc(int docId, Consumer<Geometry> consumer)	Execute the script for the provided docId, passing results to the consumer

Methods inherited from class org.elasticsearch.script.AbstractFieldScript

checkMaxSize, emitFromCompositeScript, emitFromSource, emitValueFromCompositeScript, execute, extractFromSource, getParams, newContext, runForDoc

Methods inherited from class org.elasticsearch.script.DocBasedScript

docAsMap, field, fields, getDoc, setDocument, source

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT

public static final ScriptContext<GeometryFieldScript.Factory> CONTEXT

PARSE_FROM_SOURCE

public static final GeometryFieldScript.Factory PARSE_FROM_SOURCE

PARAMETERS

public static final String[] PARAMETERS

Constructor Details

GeometryFieldScript

public GeometryFieldScript(String fieldName,
 Map<String,Object> params,
 SearchLookup searchLookup,
 OnScriptError onScriptError,
 org.apache.lucene.index.LeafReaderContext ctx)

Method Details

leafAdapter

public static GeometryFieldScript.Factory leafAdapter(Function<SearchLookup,CompositeFieldScript.LeafFactory> parentFactory)

prepareExecute

protected void prepareExecute()

Specified by:

prepareExecute in class AbstractFieldScript

runForDoc

public final void runForDoc(int docId,
 Consumer<Geometry> consumer)

Execute the script for the provided docId, passing results to the consumer

geometry

public final Geometry geometry()

Geometry from the last time AbstractFieldScript.runForDoc(int) was called.

count

public final int count()

The number of results produced the last time AbstractFieldScript.runForDoc(int) was called. It is 1 if the document exists, otherwise 0.

emitFromObject

protected void emitFromObject(Object value)

Specified by:

emitFromObject in class AbstractFieldScript