Package org.ka2ddo.yaac.filter
Class PacketTypeFilter
java.lang.Object
org.ka2ddo.yaac.filter.Filter
org.ka2ddo.yaac.filter.PacketTypeFilter
Filter based on the type of APRS packet in the frame. This filter has no affect (positive or negative) on non-APRS packets.
The present implementation of this filter does not permit editing or modification of the filter settings. As such, it does not have an associated configuration editor class.
- 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
ConstructorDescriptionPacketTypeFilter
(String typeCodes) Create a non-modifiable PacketTypeFilter that will only pass packets matching the specified APRS packet types. -
Method Summary
Modifier and TypeMethodDescriptionint
acceptAX25Frame
(AX25Frame frame) Indicate whether the specified frame should be displayed.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
Indicate whether the specified station should be displayed.void
Register a listener for changes of this Filter.Report a tag name used to look up JavaHelp for a filter editor.Report a tag name used to look up the labelling for an editor panel for this editor instance in a ResourceBundle of translated names.Get the class name of a dynamically loadable class for the the GUI for this filter.void
Deregisters a listener.void
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
canRejectSome, clone
-
Constructor Details
-
PacketTypeFilter
Create a non-modifiable PacketTypeFilter that will only pass packets matching the specified APRS packet types. Type codes that can be specified in the parameter are:p Position packets o Objects i Items m Message q Query s Status t Telemetry u User-defined n NWS format messages and objects w Weather - Parameters:
typeCodes
- String of lowercase letters matching the types to be accepted by the filter.- Throws:
IllegalArgumentException
- if an unrecognized type code is specified in typeCodes
-
-
Method Details
-
acceptAX25Frame
Indicate whether the specified frame should be displayed.- Specified by:
acceptAX25Frame
in classFilter
- Parameters:
frame
- the timestamped AX25 frame record to analyze- Returns:
- RESULT_xxx constant indicating if message information should be displayed
-
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 classFilter
- Returns:
- String to use in looking up form label for this filter's editor
-
getFilterHelpTagName
Report a tag name used to look up JavaHelp for a filter editor.- Specified by:
getFilterHelpTagName
in classFilter
- Returns:
- String name (as defined in HelpMap.jhm) for this filter's online help, or null if there is no filter specific help
-
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 classFilter
- Returns:
- String name of GUI class for this filter
-
acceptStation
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 classFilter
- Parameters:
ss
- StationState record to analyze- Returns:
- RESULT_xxx constant indicating if station information should be displayed
-
acceptMessage
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 classFilter
- Parameters:
msg
- the APRS Message record to analyze- Returns:
- RESULT_xxx constant indicating if message information should be displayed
-
addFilterChangeListener
Register a listener for changes of this Filter.- Specified by:
addFilterChangeListener
in classFilter
- Parameters:
l
- FilterChangeListener to register
-
removeFilterChangeListener
Deregisters a listener. The listener will no longer be informed of changes to this filter.- Specified by:
removeFilterChangeListener
in classFilter
- 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. Because this filter is presently not modifiable, this method is a no-op.- Specified by:
setToPassall
in classFilter
-