io.warp10.script

Class ElementOrListStackFunction

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.ElementOrListStackFunction

All Implemented Interfaces:

WarpScriptStackFunction

Direct Known Subclasses:

ASENCODERS, ATINDEX, CHUNK, CLIP, CLONEEMPTY, GEOCOVER, GOLDWRAP, MOTIONSPLIT, MVEXTRACT, OPTIMIZE, QUANTIZE, RELABEL, RENAME, SETATTRIBUTES, TICKINDEX, TICKLIST, TIMECLIP, TIMESCALE, TIMESHIFT, TIMESPLIT, TOSELECTOR, VALUES, WRAP

Deprecated.

@Deprecated
public abstract class ElementOrListStackFunction
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

DEPRECATED: Use ListRecursiveStackFunction instead. Abstract class to inherit when a function can be called on a single element or a list of elements. For instance for a function working on GTSs, GTSEncoders and lists thereof, including lists with mixed types. The idea is to generate a function using the parameters on the stack and then to apply this function on the element or the list of elements. This is similar to GTSStackFunction for GTSs but it is a tad faster if the function uses some parameters as this implementation does not use a Map for parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElementOrListStackFunction.ElementStackFunction Deprecated. Interface defining the function to be generated which is applied to each element.

Constructor Summary

Constructors

Constructor and Description
ElementOrListStackFunction(java.lang.String name) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack) Deprecated.
abstract ElementOrListStackFunction.ElementStackFunction	generateFunction(WarpScriptStack stack) Deprecated. Generates the function to be applied on the element(s) using the parameters on the stack.

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementOrListStackFunction

public ElementOrListStackFunction(java.lang.String name)

Deprecated.

Method Detail

generateFunction

public abstract ElementOrListStackFunction.ElementStackFunction generateFunction(WarpScriptStack stack)
                                                                          throws WarpScriptException

Deprecated.

Generates the function to be applied on the element(s) using the parameters on the stack.

Parameters:

stack - The stack to be used for parameters retrieval.

Returns:

An ElementStackFunction which will be applied on each given elements or on the given element.

Throws:

WarpScriptException

apply

public java.lang.Object apply(WarpScriptStack stack)
                       throws WarpScriptException

Deprecated.

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException