com.redhat.thermostat.common

Class Filter<T>

java.lang.Object

com.redhat.thermostat.common.Filter<T>

Direct Known Subclasses:

AllPassFilter, NameMatchingRefFilter, ReferenceFilter

@ExtensionPoint
public abstract class Filter<T>
extends Object

A Filter decides if some information matches what this filter is designed to work with. The exact meaning of the word "match" depends on the context this filter is applied.

For example, a String filter that match for all the input containing the word "test" would return true for both "a test" or "testing", but false for the mispelled word "tesst". This example filter could then be used to implement a search function, by testing various strings and only showing the ones that match this filter.

Filters may change their behavior due to external events in a certain context. In such cases, the filter managers specific to those context should register as Filter.FilterEvent listeners and the Filter implementation should notify of Filter.FilterEvent.FILTER_CHANGED events.

As an example let's take again our String filter. If such filter was used in a search context, the filter could react to user input and change the string to be used as matcher. At each matcher change, it should notify its listeners that such change occurred in order to allow correct re-processing of the filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.FilterEvent

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
void	addFilterEventListener(ActionListener<Filter.FilterEvent> listener)
abstract boolean	matches(T toMatch) Return true if this filter match the given input, false otherwise.
protected void	notify(Filter.FilterEvent action) Notify all the listeners that a change occurred in this filter.
void	removeFilterEventListener(ActionListener<Filter.FilterEvent> listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

matches

public abstract boolean matches(T toMatch)

Return true if this filter match the given input, false otherwise.

addFilterEventListener

public void addFilterEventListener(ActionListener<Filter.FilterEvent> listener)

removeFilterEventListener

public void removeFilterEventListener(ActionListener<Filter.FilterEvent> listener)

notify

protected void notify(Filter.FilterEvent action)

Notify all the listeners that a change occurred in this filter.