io.warp10.script.functions

Class RENAME

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.ElementOrListStackFunction

io.warp10.script.functions.RENAME

All Implemented Interfaces:

WarpScriptStackFunction

public class RENAME
extends ElementOrListStackFunction

Apply rename on GTS or Encoder instance or list thereof.

RENAME expects the following parameters on the stack:

1: name The new name

Nested Class Summary

Nested classes/interfaces inherited from class io.warp10.script.ElementOrListStackFunction

ElementOrListStackFunction.ElementStackFunction

Constructor Summary

Constructors

Constructor and Description
RENAME(java.lang.String name)

Method Summary

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

Methods inherited from class io.warp10.script.ElementOrListStackFunction

apply

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

RENAME

public RENAME(java.lang.String name)

Method Detail

generateFunction

public ElementOrListStackFunction.ElementStackFunction generateFunction(WarpScriptStack stack)
                                                                 throws WarpScriptException

Description copied from class: ElementOrListStackFunction

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

Specified by:

generateFunction in class ElementOrListStackFunction

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