io.warp10.script.filter

Class FilterByMetadata

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.filter.FilterByMetadata

All Implemented Interfaces:

WarpScriptFilterFunction

public class FilterByMetadata
extends NamedWarpScriptFunction
implements WarpScriptFilterFunction

Filter GTS by retaining those whose metadata is included in a set

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterByMetadata.Builder

Constructor Summary

Constructors

Constructor and Description
FilterByMetadata(java.lang.String name, java.util.List<GeoTimeSerie> selector)

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.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

FilterByMetadata

public FilterByMetadata(java.lang.String name,
                        java.util.List<GeoTimeSerie> selector)

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

toString

public java.lang.String toString()

Overrides:

toString in class NamedWarpScriptFunction