org.ka2ddo.yaac.filter

Class AddresseeFilter

java.lang.Object

org.ka2ddo.yaac.filter.Filter

org.ka2ddo.yaac.filter.AddresseeFilter

public class AddresseeFilter
extends Filter

Filter based on the addressee in an APRS Text Message (':'). Other types of messages and packets are not filtered (positive or negative) by this Filter.

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields inherited from class org.ka2ddo.yaac.filter.Filter

RESULT_NEUTRAL, RESULT_PASS, RESULT_REJECT, RESULT_WEAK_PASS, RESULT_WEAK_REJECT

Constructor Summary

Constructors

Constructor and Description
AddresseeFilter(java.lang.String... matches) Create a AddresseeFilter with the specified set of matching callsigns (including callsigns with wildcards).

Method Summary

Modifier and Type	Method and Description
int	acceptAX25Frame(AX25Frame frame) Indicate whether the specified message should be displayed or used to determine if a station should be displayed (if recursively called from acceptStation()).
int	acceptMessage(AX25Message msg) Indicate whether the specified message should be displayed or used to determine if a station should be displayed (if recursively called from acceptStation()).
int	acceptStation(StationState ss) Indicate whether the specified station should be displayed.
void	addFilterChangeListener(FilterChangeListener l) Register a listener for changes of this Filter.
void	addPattern(java.lang.String s) Augment this filter with the specified matching pattern for the addressee.
boolean	canRejectSome() Specifies that this filter may reject some stations, messages, and/or frames.
boolean	contains(java.lang.String pattern) Test if the specified pattern is already specified in this filter.
java.lang.String	getFilterHelpTagName() Report a tag name used to look up JavaHelp for a filter editor.
java.lang.String	getFilterTypeTagName() Report a tag name used to look up the labelling for an editor panel for this editor instance in a ResourceBundle of translated names.
java.lang.String	getFilterUIName() Get the class name of a dynamically loadable class for the the GUI for this filter.
void	removeFilterChangeListener(FilterChangeListener l) Deregisters a listener.
boolean	removePattern(java.lang.String pattern) Remove the specified pattern from this filter.
void	setToPassall() Reset the filter to a configuration that would pass the maximum amount of messages, packets, and stations.

Methods inherited from class org.ka2ddo.yaac.filter.Filter

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

AddresseeFilter

public AddresseeFilter(java.lang.String... matches)

Create a AddresseeFilter with the specified set of matching callsigns (including callsigns with wildcards).

Parameters:

matches - Strings of callsign and wildcard patterns

Method Detail

contains

public boolean contains(java.lang.String pattern)

Test if the specified pattern is already specified in this filter.

Parameters:

pattern - String of either exact string, or a string with a wildcard substitution point

Returns:

boolean true if pattern already in this filter, false otherwise

addPattern

public void addPattern(java.lang.String s)

Augment this filter with the specified matching pattern for the addressee.

Parameters:

s - String of either exact string, or a string with a wildcard substitution point

removePattern

public boolean removePattern(java.lang.String pattern)

Remove the specified pattern from this filter.

Parameters:

pattern - String of either exact string, or a string with a wildcard substitution point

Returns:

boolean true if pattern removed from this filter, false otherwise

acceptAX25Frame

public int acceptAX25Frame(AX25Frame frame)

Indicate whether the specified message should be displayed or used to determine if a station should be displayed (if recursively called from acceptStation()).

Specified by:

acceptAX25Frame in class Filter

Parameters:

frame - the timestamped AX25 frame record to analyze

Returns:

RESULT_xxx constant indicating if message information should be displayed

getFilterTypeTagName

public java.lang.String getFilterTypeTagName()

Report a tag name used to look up the labelling for an editor panel for this editor instance in a ResourceBundle of translated names.

Specified by:

getFilterTypeTagName in class Filter

Returns:

String to use in looking up form label for this filter's editor

getFilterHelpTagName

public java.lang.String getFilterHelpTagName()

Report a tag name used to look up JavaHelp for a filter editor.

Specified by:

getFilterHelpTagName in class Filter

Returns:

String name (as defined in HelpMap.jhm) for this filter's online help, or null if there is no filter specific help

getFilterUIName

public java.lang.String getFilterUIName()

Get the class name of a dynamically loadable class for the the GUI for this filter. The name is allowed to have a wildcard '*' in it where a GUI type ("gui" for standard Java or "android" for Android) can be substituted.

Specified by:

getFilterUIName in class Filter

Returns:

String name of GUI class for this filter

acceptStation

public int acceptStation(StationState ss)

Indicate whether the specified station should be displayed. The acceptMessage() and acceptAX25Frame() methods may be called to assist in the determination.

Specified by:

acceptStation in class Filter

Parameters:

ss - StationState record to analyze

Returns:

RESULT_xxx constant indicating if station information should be displayed

acceptMessage

public int acceptMessage(AX25Message msg)

Indicate whether the specified message should be displayed or used to determine if a station should be displayed (if recursively called from acceptStation()).

Specified by:

acceptMessage in class Filter

Parameters:

msg - the APRS Message record to analyze

Returns:

RESULT_xxx constant indicating if message information should be displayed

addFilterChangeListener

public void addFilterChangeListener(FilterChangeListener l)

Register a listener for changes of this Filter.

Specified by:

addFilterChangeListener in class Filter

Parameters:

l - FilterChangeListener to register

removeFilterChangeListener

public void removeFilterChangeListener(FilterChangeListener l)

Deregisters a listener. The listener will no longer be informed of changes to this filter.

Specified by:

removeFilterChangeListener in class Filter

Parameters:

l - FilterChangeListener to deregister

setToPassall

public void setToPassall()

Reset the filter to a configuration that would pass the maximum amount of messages, packets, and stations.

Specified by:

setToPassall in class Filter

canRejectSome

public boolean canRejectSome()

Specifies that this filter may reject some stations, messages, and/or frames. Used to tell combining filters whether a sub-filter is in passall mode and therefore doesn't need to be checked for every call to the combiner, thereby saving CPU time when filtering when most filters are in passall mode.

Overrides:

canRejectSome in class Filter

Returns:

boolean true if this filter is currently capable of rejecting something

See Also:

setToPassall(), CumulativeBooleanAndFilter, CumulativeBooleanOrFilter