io.warp10.script.filler

Class FillerValue

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.filler.FillerValue

All Implemented Interfaces:

SNAPSHOT.Snapshotable, WarpScriptFillerFunction

public class FillerValue
extends NamedWarpScriptFunction
implements WarpScriptFillerFunction, SNAPSHOT.Snapshotable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FillerValue.Builder

Constructor Summary

Constructors

Constructor and Description
FillerValue(java.lang.String name, long latlon, long elev, java.lang.Object value)

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	apply(java.lang.Object[] args) This method will determine the tick,loc,elev,value to fill with.
int	getPostWindow() Returns the size of the post-window (in ticks)
int	getPreWindow() Returns the size of the pre-window (in number of ticks)
java.lang.String	snapshot()
java.lang.String	toString()

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

FillerValue

public FillerValue(java.lang.String name,
                   long latlon,
                   long elev,
                   java.lang.Object value)
            throws WarpScriptException

Throws:

WarpScriptException

Method Detail

apply

public java.lang.Object[] apply(java.lang.Object[] args)
                         throws WarpScriptException

Description copied from interface: WarpScriptFillerFunction

This method will determine the tick,loc,elev,value to fill with. It takes as parameters an array containing multiple arrays. An array of class, labels, class labels of the GTS being filled and of the 'other' GTS. Arrays of tick,loc,elev,value for the 'pre' window, for the current tick of the 'other' GTS and for the 'post' window. It is expected to return an array of tick,loc,elev,value which will be used to fill the current GTS.

Specified by:

apply in interface WarpScriptFillerFunction

Throws:

WarpScriptException

getPostWindow

public int getPostWindow()

Description copied from interface: WarpScriptFillerFunction

Returns the size of the post-window (in ticks)

Specified by:

getPostWindow in interface WarpScriptFillerFunction

getPreWindow

public int getPreWindow()

Description copied from interface: WarpScriptFillerFunction

Returns the size of the pre-window (in number of ticks)

Specified by:

getPreWindow in interface WarpScriptFillerFunction

snapshot

public java.lang.String snapshot()

Specified by:

snapshot in interface SNAPSHOT.Snapshotable

toString

public java.lang.String toString()

Overrides:

toString in class NamedWarpScriptFunction