io.warp10.script.functions

Class SHRINK

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.ListRecursiveStackFunction

io.warp10.script.functions.SHRINK

All Implemented Interfaces:

WarpScriptStackFunction

public class SHRINK
extends ListRecursiveStackFunction

Shrinks the number of values of a GTS.

This function has the side effect of sorting the GTS. In case of duplicates in the input, the output will keep one of them (impossible to guess which one after the sort)

Nested Class Summary

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

ListRecursiveStackFunction.ElementStackFunction

Field Summary

Fields inherited from class io.warp10.script.ListRecursiveStackFunction

UNHANDLED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ListRecursiveStackFunction.ElementStackFunction	generateFunction(WarpScriptStack stack) Generates the function to be applied on the element(s) using the parameters on the stack.
java.lang.String	getUnhandledErrorMessage() Return the error message when the given element cannot be handled by this function.

Methods inherited from class io.warp10.script.ListRecursiveStackFunction

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

SHRINK

public SHRINK(java.lang.String name)

Method Detail

generateFunction

public ListRecursiveStackFunction.ElementStackFunction generateFunction(WarpScriptStack stack)
                                                                 throws WarpScriptException

Description copied from class: ListRecursiveStackFunction

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

Specified by:

generateFunction in class ListRecursiveStackFunction

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

getUnhandledErrorMessage

public java.lang.String getUnhandledErrorMessage()

Description copied from class: ListRecursiveStackFunction

Return the error message when the given element cannot be handled by this function.

Specified by:

getUnhandledErrorMessage in class ListRecursiveStackFunction

Returns:

An error message.