org.ka2ddo.yaac.filter
Class SendingStationFilter

java.lang.Object
  extended by org.ka2ddo.yaac.filter.Filter
      extended by org.ka2ddo.yaac.filter.SendingStationFilter
All Implemented Interfaces:
java.lang.Cloneable

public final class SendingStationFilter
extends Filter
implements java.lang.Cloneable

This filter selects all stations that match (or don't match) an entry in a list of station identifiers. It does not persist any filter changes.


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
SendingStationFilter()
          Create a new SendingStationFilter.
 
Method Summary
 int acceptAX25Frame(AX25Frame frame)
          Indicate whether the specified message should be displayed.
 int acceptMessage(AX25Message msg)
          Indicate whether the specified message should be displayed.
 int acceptStation(StationState ss)
          Indicate whether the specified station should be displayed.
 void addFilterChangeListener(FilterChangeListener l)
          Register a listener for changes of this Filter.
 java.lang.Object clone()
          Creates and returns a copy of this object.
 void fireFilterChange(boolean changedByUser)
           
 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.
 boolean isSelectAll()
          Report if this filter will pass all traffic regardless of the sending station callsign/SSID.
 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.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SendingStationFilter

public SendingStationFilter()
Create a new SendingStationFilter.

Method Detail

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

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

acceptAX25Frame

public int acceptAX25Frame(AX25Frame frame)
Indicate whether the specified message should be displayed.

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.

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.

Specified by:
acceptStation in class Filter
Parameters:
ss - StationState record to analyze
Returns:
RESULT_xxx constant indicating if station information should be displayed

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

isSelectAll

public boolean isSelectAll()
Report if this filter will pass all traffic regardless of the sending station callsign/SSID.

Returns:
boolean true if this is passall

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)

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