io.warp10.script.functions

Class CHUNK

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.ElementOrListStackFunction

io.warp10.script.functions.CHUNK

All Implemented Interfaces:

WarpScriptStackFunction

public class CHUNK
extends ElementOrListStackFunction

Apply chunk on GTS or GTSEncoder instances

CHUNK expects the following parameters on the stack:

5: lastchunk end Timestamp of the most recent chunk to create 4: chunkwidth Width of each chunk in time units 3: chunkcount Number of chunks GTS to produce 2: chunklabel Name of the label containing the id of the chunk 1: keepempty Should we keep empty chunks

Nested Class Summary

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

ElementOrListStackFunction.ElementStackFunction

Constructor Summary

Constructors

Constructor and Description
CHUNK(java.lang.String name, boolean withOverlap)

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

CHUNK

public CHUNK(java.lang.String name,
             boolean withOverlap)

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