net.engio.pips.data.filter

Interface IDataFilter<V>

All Known Implementing Classes:

IDataFilter.ItemCountBased, IDataFilter.TimeBased

public interface IDataFilter<V>

A filter is used to control which data points may pass from one IDataProcessor to another

Author:

bennidi Date: 2/25/14

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDataFilter.ItemCountBased<V> This counter based filter will let pass only every nth data point based on the specified range.
static class	IDataFilter.TimeBased<V> Time based filtering considers the timestamps of the incoming data points as a filter criterion.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(DataPoint<V> vDataPoint) Calculate whether or not the given data point is accepted by this filter.

Method Detail

accepts

boolean accepts(DataPoint<V> vDataPoint)

Calculate whether or not the given data point is accepted by this filter. If a filter accepts the data point it will be routed along to the corresponding IDataProcessor. For an example use of filters see Sampler and corresponding filter implementations

Parameters:

vDataPoint - - The data point to be analyzed

Returns:

- Whether or not this data point may pass the filter