org.ka2ddo.yaac.filter

Class MicEFilter

java.lang.Object

org.ka2ddo.yaac.filter.Filter

org.ka2ddo.yaac.filter.MicEFilter

All Implemented Interfaces:

java.lang.Cloneable

public class MicEFilter
extends Filter
implements java.lang.Cloneable

This filter selects messages by the MicE status code. PositionMessages (or stations with PositionMessages) report the MicE status (if any) reported in the message, which will be used to decide if that message/station will be seen.

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
MicEFilter() Create a Filter that selects based on the Mic-E status of the message or station.

Method Summary

Modifier and Type	Method and Description
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.
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.
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	isEnabled(int index) Test whether the specified Mic-E status code is acceptable by this filter.
void	removeFilterChangeListener(FilterChangeListener l) Deregisters a listener.
void	setEnabled(int index, boolean enabled) Specify whether the specified Mic-E status code is acceptable by 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 java.lang.Object

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

Constructor Detail

MicEFilter

public MicEFilter()

Create a Filter that selects based on the Mic-E status of the message or station.

Method Detail

isEnabled

public boolean isEnabled(int index)

Test whether the specified Mic-E status code is acceptable by this filter.

Parameters:

index - int index of status code, where 0=no MicE status code, 1=emergency, 2-8 are normal codes 1-7, and 9-15 are custom codes 1-7

Returns:

boolean true if this MicE status code is acceptable

setEnabled

public void setEnabled(int index,
                       boolean enabled)

Specify whether the specified Mic-E status code is acceptable by this filter.

Parameters:

index - int index of status code, where 0=no MicE status code, 1=emergency, 2-8 are normal codes 1-7, and 9-15 are custom codes 1-7

enabled - boolean true if this MicE status code is acceptable

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

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.

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.

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()

clone

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

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement. By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass(). By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

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