org.ka2ddo.yaac.filter

Class FirstDigipeatFilter

java.lang.Object

org.ka2ddo.yaac.filter.Filter

org.ka2ddo.yaac.filter.FirstDigipeatFilter

All Implemented Interfaces:

java.lang.Cloneable, DigipeatListener, MonitoringFilter

public class FirstDigipeatFilter
extends Filter
implements MonitoringFilter, DigipeatListener, java.lang.Cloneable

This filter accepts or rejects messages based on the first station to relay the message.

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
FirstDigipeatFilter() Create a FirstDigipeatFilter.

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.
boolean	canRejectSome() Specifies that this filter may reject some stations, messages, and/or frames.
java.lang.Object	clone() Creates and returns a copy of this object.
void	digipeaterAdded(java.lang.String digipeat) Report when a new digipeater is identified.
void	digipeaterUsedAgain(java.lang.String digipeat) Report when a digipeater is used again.
void	fireFilterChange(boolean changedByUser) Tell all registered FilterChangeListeners that this LastDigipeatFilter has changed its filtering settings.
java.util.ArrayList<StationTracker.DigipeatStatistics>	getDigipeatCache() Get the local collection of digipeater statistics.
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.
void	setToPassall() Reset the filter to a configuration that would pass the maximum amount of messages, packets, and stations.
void	startRealTimeTracking() Start automatically collecting real-time data as YAAC learns about them.
void	stopRealTimeTracking() Stop automatically collecting new real-time data and keep the current cache stable.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstDigipeatFilter

public FirstDigipeatFilter()

Create a FirstDigipeatFilter.

Method Detail

startRealTimeTracking

public void startRealTimeTracking()

Start automatically collecting real-time data as YAAC learns about them.

Specified by:

startRealTimeTracking in interface MonitoringFilter

stopRealTimeTracking

public void stopRealTimeTracking()

Stop automatically collecting new real-time data and keep the current cache stable.

Specified by:

stopRealTimeTracking in interface MonitoringFilter

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

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

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

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

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

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

getDigipeatCache

public java.util.ArrayList<StationTracker.DigipeatStatistics> getDigipeatCache()

Get the local collection of digipeater statistics. Used so filter UI can provide useful statistics to the user.

Returns:

ArrayList of DigipeatStatistics objects

digipeaterAdded

public void digipeaterAdded(java.lang.String digipeat)

Report when a new digipeater is identified.

Specified by:

digipeaterAdded in interface DigipeatListener

Parameters:

digipeat - String callsign of digipeater

digipeaterUsedAgain

public void digipeaterUsedAgain(java.lang.String digipeat)

Report when a digipeater is used again.

Specified by:

digipeaterUsedAgain in interface DigipeatListener

Parameters:

digipeat - String callsign of digipeater

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

fireFilterChange

public void fireFilterChange(boolean changedByUser)

Tell all registered FilterChangeListeners that this LastDigipeatFilter has changed its filtering settings.

Parameters:

changedByUser - boolean true if change was made manually by human operator

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class Filter

Returns:

a clone of this instance.

Throws:

java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

See Also:

Cloneable