org.rvpf.forwarder.filter

Class PointValueFilter

Object

ForwarderFilter.Abstract

PointValueFilter

All Implemented Interfaces:

ForwarderFilter

public final class PointValueFilter
extends ForwarderFilter.Abstract

Point value filter.

Nested Class Summary

Nested classes/interfaces inherited from interface ForwarderFilter

ForwarderFilter.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	STAMP_REQUIRED_PROPERTY Stamp required property.

Fields inherited from class ForwarderFilter.Abstract

FILTER_UUID_PROPERTY, NO_MESSAGES, WARN_DROPPED_PROPERTY

Constructor Summary

Constructors

Constructor and Description
PointValueFilter()

Method Summary

Modifier and Type	Method and Description
Serializable[]	filter(Serializable message) Filters a message.
boolean	needsMetadata() Asks if this filter needs metadata.
boolean	onMetadataRefreshed() Called when the metadata should be refreshed.
protected boolean	onNewMetadata(Metadata metadata) Called on new metadata.
boolean	setUp(ForwarderModule forwarderModule, KeyedGroups filterProperties) Sets up this filter.

Methods inherited from class ForwarderFilter.Abstract

getMetadata, getModule, getThisLogger, getUUID, knownPointValue, loadMetadata, logDropped, tearDown

Methods inherited from class Object

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

Field Detail

STAMP_REQUIRED_PROPERTY

public static final String STAMP_REQUIRED_PROPERTY

Stamp required property.

See Also:

Constant Field Values

Constructor Detail

PointValueFilter

public PointValueFilter()

Method Detail

filter

public Serializable[] filter(Serializable message)

Filters a message.

Parameters:

message - The original message.

Returns:

The filtered messages.

needsMetadata

public boolean needsMetadata()

Asks if this filter needs metadata.

Specified by:

needsMetadata in interface ForwarderFilter

Overrides:

needsMetadata in class ForwarderFilter.Abstract

Returns:

True if yes.

onMetadataRefreshed

public boolean onMetadataRefreshed()

Called when the metadata should be refreshed.

Specified by:

onMetadataRefreshed in interface ForwarderFilter

Overrides:

onMetadataRefreshed in class ForwarderFilter.Abstract

Returns:

False if a restart is needed.

setUp

public boolean setUp(ForwarderModule forwarderModule,
                     KeyedGroups filterProperties)

Sets up this filter.

Specified by:

setUp in interface ForwarderFilter

Overrides:

setUp in class ForwarderFilter.Abstract

Parameters:

forwarderModule - The owner of this filter.

filterProperties - The filter properties.

Returns:

True on success.

onNewMetadata

protected boolean onNewMetadata(Metadata metadata)

Called on new metadata.

Overrides:

onNewMetadata in class ForwarderFilter.Abstract

Parameters:

metadata - The new metadata.

Returns:

False to reject the metadata.