io.warp10.script.functions

Class FETCH

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.FETCH

All Implemented Interfaces:

WarpScriptStackFunction

public class FETCH
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Fetch GeoTimeSeries from the Warp 10 Storage Engine The top of the stack must contain a list of the following parameters

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOW_PARAM_VALUE
static java.lang.String	PARAM_ACTIVE_AFTER
static java.lang.String	PARAM_BOUNDARY
static java.lang.String	PARAM_BOUNDARY_POST
static java.lang.String	PARAM_BOUNDARY_PRE
static java.lang.String	PARAM_CLASS
static java.lang.String	PARAM_COUNT
static java.lang.String	PARAM_ENCODERS
static java.lang.String	PARAM_END
static java.lang.String	PARAM_EXTRA Extra classes to retrieve after Directory have been called
static java.lang.String	PARAM_GCOUNT
static java.lang.String	PARAM_GSKIP
static java.lang.String	PARAM_GTS
static java.lang.String	PARAM_KEEPEMPTY
static java.lang.String	PARAM_LABELS
static java.lang.String	PARAM_LABELS_PRIORITY
static java.lang.String	PARAM_MERGE
static java.lang.String	PARAM_METASET
static java.lang.String	PARAM_QUIET_AFTER
static java.lang.String	PARAM_SAMPLE
static java.lang.String	PARAM_SELECTOR
static java.lang.String	PARAM_SELECTOR_PAIRS
static java.lang.String	PARAM_SELECTORS
static java.lang.String	PARAM_SHOWUUID
static java.lang.String	PARAM_SKIP
static java.lang.String	PARAM_START
static java.lang.String	PARAM_STEP
static java.lang.String	PARAM_TIMESPAN
static java.lang.String	PARAM_TIMESTEP
static java.lang.String	PARAM_TOKEN
static java.lang.String	PARAM_TTL
static java.lang.String	PARAM_TYPE
static java.lang.String	PARAM_TYPEATTR
static java.lang.String	PARAM_WRITE_TIMESTAMP
static java.lang.String	POSTFETCH_HOOK

Constructor Summary

Constructors

Constructor and Description
FETCH(java.lang.String name, GeoTimeSerie.TYPE type)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)
static java.lang.Long[]	computeTimeRange(java.lang.Object start, java.lang.String startParamName, java.lang.Object end, java.lang.String endParamName, java.lang.Object timespan, java.lang.String timespanParamName, java.lang.Object count, java.lang.String countParamName) Compute the time range given start, end, timespan and count.
static java.lang.Long	getTimestamp(java.lang.Object timestampRepresentation, java.lang.String timestampRepresentationParameterName, java.lang.Long nowTimestamp)
java.util.Map<java.lang.String,java.lang.Object>	paramsFromMap(java.util.Map<java.lang.String,java.lang.Object> map)
static java.util.Map<java.lang.String,java.lang.Object>	parseTokenAttributes(ReadToken token, java.util.Map<java.lang.String,java.lang.Object> params)

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

Field Detail

PARAM_CLASS

public static final java.lang.String PARAM_CLASS

See Also:

Constant Field Values

PARAM_EXTRA

public static final java.lang.String PARAM_EXTRA

Extra classes to retrieve after Directory have been called

See Also:

Constant Field Values

PARAM_LABELS

public static final java.lang.String PARAM_LABELS

See Also:

Constant Field Values

PARAM_SELECTOR

public static final java.lang.String PARAM_SELECTOR

See Also:

Constant Field Values

PARAM_SELECTORS

public static final java.lang.String PARAM_SELECTORS

See Also:

Constant Field Values

PARAM_SELECTOR_PAIRS

public static final java.lang.String PARAM_SELECTOR_PAIRS

See Also:

Constant Field Values

PARAM_TOKEN

public static final java.lang.String PARAM_TOKEN

See Also:

Constant Field Values

PARAM_END

public static final java.lang.String PARAM_END

See Also:

Constant Field Values

PARAM_START

public static final java.lang.String PARAM_START

See Also:

Constant Field Values

PARAM_COUNT

public static final java.lang.String PARAM_COUNT

See Also:

Constant Field Values

PARAM_TIMESPAN

public static final java.lang.String PARAM_TIMESPAN

See Also:

Constant Field Values

PARAM_TYPE

public static final java.lang.String PARAM_TYPE

See Also:

Constant Field Values

PARAM_WRITE_TIMESTAMP

public static final java.lang.String PARAM_WRITE_TIMESTAMP

See Also:

Constant Field Values

PARAM_TTL

public static final java.lang.String PARAM_TTL

See Also:

Constant Field Values

PARAM_SHOWUUID

public static final java.lang.String PARAM_SHOWUUID

See Also:

Constant Field Values

PARAM_TYPEATTR

public static final java.lang.String PARAM_TYPEATTR

See Also:

Constant Field Values

PARAM_METASET

public static final java.lang.String PARAM_METASET

See Also:

Constant Field Values

PARAM_GTS

public static final java.lang.String PARAM_GTS

See Also:

Constant Field Values

PARAM_ACTIVE_AFTER

public static final java.lang.String PARAM_ACTIVE_AFTER

See Also:

Constant Field Values

PARAM_QUIET_AFTER

public static final java.lang.String PARAM_QUIET_AFTER

See Also:

Constant Field Values

PARAM_BOUNDARY_PRE

public static final java.lang.String PARAM_BOUNDARY_PRE

See Also:

Constant Field Values

PARAM_BOUNDARY_POST

public static final java.lang.String PARAM_BOUNDARY_POST

See Also:

Constant Field Values

PARAM_BOUNDARY

public static final java.lang.String PARAM_BOUNDARY

See Also:

Constant Field Values

PARAM_SKIP

public static final java.lang.String PARAM_SKIP

See Also:

Constant Field Values

PARAM_STEP

public static final java.lang.String PARAM_STEP

See Also:

Constant Field Values

PARAM_TIMESTEP

public static final java.lang.String PARAM_TIMESTEP

See Also:

Constant Field Values

PARAM_SAMPLE

public static final java.lang.String PARAM_SAMPLE

See Also:

Constant Field Values

PARAM_LABELS_PRIORITY

public static final java.lang.String PARAM_LABELS_PRIORITY

See Also:

Constant Field Values

PARAM_ENCODERS

public static final java.lang.String PARAM_ENCODERS

See Also:

Constant Field Values

PARAM_MERGE

public static final java.lang.String PARAM_MERGE

See Also:

Constant Field Values

PARAM_GCOUNT

public static final java.lang.String PARAM_GCOUNT

See Also:

Constant Field Values

PARAM_GSKIP

public static final java.lang.String PARAM_GSKIP

See Also:

Constant Field Values

PARAM_KEEPEMPTY

public static final java.lang.String PARAM_KEEPEMPTY

See Also:

Constant Field Values

POSTFETCH_HOOK

public static final java.lang.String POSTFETCH_HOOK

See Also:

Constant Field Values

NOW_PARAM_VALUE

public static final java.lang.String NOW_PARAM_VALUE

See Also:

Constant Field Values

Constructor Detail

FETCH

public FETCH(java.lang.String name,
             GeoTimeSerie.TYPE type)

Method Detail

apply

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

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

paramsFromMap

public java.util.Map<java.lang.String,java.lang.Object> paramsFromMap(java.util.Map<java.lang.String,java.lang.Object> map)
                                                               throws WarpScriptException

Throws:

WarpScriptException

computeTimeRange

public static java.lang.Long[] computeTimeRange(java.lang.Object start,
                                                java.lang.String startParamName,
                                                java.lang.Object end,
                                                java.lang.String endParamName,
                                                java.lang.Object timespan,
                                                java.lang.String timespanParamName,
                                                java.lang.Object count,
                                                java.lang.String countParamName)
                                         throws WarpScriptException

Compute the time range given start, end, timespan and count. One of these 3 parameters must be null.

Parameters:

start - A Long, a String representing a Long, a String representing an ISO8601 date or "now". This represents the start of the time range.

startParamName - The name of the start parameter, for error generation.

end - A Long, a String representing a Long, a String representing an ISO8601 date or "now". This represents the end of the time range.

endParamName - The name of the end parameter, for error generation.

timespan - A Long, a String representing a Long or a String representing an ISO8601 duration. This represents the duration of the time range.

timespanParamName - The name of the timespan parameter, for error generation.

count - A positive Long. This represents the number of point to return in the time range.

countParamName - The name of the count parameter, for error generation.

Returns:

An array of three Longs: [start, end, timespan] with the guarantee that start and end are not null.

Throws:

WarpScriptException - If the time range specification is invalid.

getTimestamp

public static java.lang.Long getTimestamp(java.lang.Object timestampRepresentation,
                                          java.lang.String timestampRepresentationParameterName,
                                          java.lang.Long nowTimestamp)
                                   throws WarpScriptException

Throws:

WarpScriptException

parseTokenAttributes

public static java.util.Map<java.lang.String,java.lang.Object> parseTokenAttributes(ReadToken token,
                                                                                    java.util.Map<java.lang.String,java.lang.Object> params)
                                                                             throws WarpScriptException

Throws:

WarpScriptException