io.warp10.script.filter

Class LatencyFilter

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.filter.LatencyFilter

All Implemented Interfaces:

WarpScriptFilterFunction

public class LatencyFilter
extends NamedWarpScriptFunction
implements WarpScriptFilterFunction

This class implements a 'latency' filter. This filter assumes that the input GTS have values which are hashes of packet payloads. It is used in the FILTER framework even though it is not a filter per se since it will produce new GTS instead of simply selecting some. The generated GTS will have the same ticks as the input ones except the value will be the packet latency in microseconds instead of the payload hash

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LatencyFilter.Builder

Constructor Summary

Constructors

Constructor and Description
LatencyFilter(java.lang.String name, long minLatency, long maxLatency, java.util.List<java.lang.Object> options)

Method Summary

Modifier and Type	Method and Description
java.util.List<GeoTimeSerie>	filter(java.util.Map<java.lang.String,java.lang.String> labels, java.util.List<GeoTimeSerie>[] series) Return the subset of 'series' which satisfies the filter.
java.util.List<GeoTimeSerie>	filterOLD(java.util.Map<java.lang.String,java.lang.String> labels, java.util.List<GeoTimeSerie>... series)
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

LatencyFilter

public LatencyFilter(java.lang.String name,
                     long minLatency,
                     long maxLatency,
                     java.util.List<java.lang.Object> options)

Method Detail

filter

public java.util.List<GeoTimeSerie> filter(java.util.Map<java.lang.String,java.lang.String> labels,
                                           java.util.List<GeoTimeSerie>[] series)
                                    throws WarpScriptException

Description copied from interface: WarpScriptFilterFunction

Return the subset of 'series' which satisfies the filter.

Specified by:

filter in interface WarpScriptFilterFunction

Parameters:

labels - Labels of the partition being filtered

series - GTS instances to filter, one list from each original GTS list, all parts of the same partition

Returns:

A list of GTS to retain. All retained GTS MUST be in 'series'

Throws:

WarpScriptException

filterOLD

public java.util.List<GeoTimeSerie> filterOLD(java.util.Map<java.lang.String,java.lang.String> labels,
                                              java.util.List<GeoTimeSerie>... series)
                                       throws WarpScriptException

Throws:

WarpScriptException

toString

public java.lang.String toString()

Overrides:

toString in class NamedWarpScriptFunction