Package org.ka2ddo.yaac.filter

Class RelativeTimeFilter

java.lang.Object
org.ka2ddo.yaac.filter.Filter
org.ka2ddo.yaac.filter.RelativeTimeFilter
All Implemented Interfaces:
Cloneable, IrrelevantToPlaybackFilter
public class RelativeTimeFilter extends Filter implements Cloneable, IrrelevantToPlaybackFilter
This filter selects information based on relative time point boundary. Only data timestamped before or after the threshold will pass (as specified).
Author:
Andrew Pavlin, KA2DDO

  • Constructor Details

    • RelativeTimeFilter

      public RelativeTimeFilter(long relativeOffset)
      Create a TimeFilter with the specified cutoff time, and whether the pass condition should be before or after the time.
      Parameters:
      relativeOffset - long delta time in Java standard milliseconds

  • Method Details

    • getFilterUIName

      public 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

    • isFilterPlaybacks

      public boolean isFilterPlaybacks()
      Indicate whether packets from log file playbacks should be filtered or not.
      Returns:
      boolean true if playback messages (no source) will be filtered

    • setFilterPlaybacks

      public void setFilterPlaybacks(boolean filterPlaybacks)
      Specify whether packets from log file playbacks should be filtered or not.
      Parameters:
      filterPlaybacks - boolean true if this filter should apply to playback messages

    • getRelativeOffsetMsec

      public long getRelativeOffsetMsec()

    • setRelativeOffsetMsec

      public void setRelativeOffsetMsec(long relativeOffsetMsec)

    • isHardReject

      public boolean isHardReject()

    • setHardReject

      public void setHardReject(boolean hardReject)

    • getFilterTypeTagName

      public 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 String getFilterHelpTagName()
      Report a tag name used to look up JavaHelp for a filter editor.
      Specified by:
      getFilterHelpTagName in class Filter
      Returns:
      null because there is no filter specific help

    • 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

    • 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 filtering CPU time when most filters are in passall mode. Expected to be overridden by concrete subclasses that have a passall capability; the default implementation always indicates the filter can potentially reject some frames, messages, and stations.
      Overrides:
      canRejectSome in class Filter
      Returns:
      boolean true if this filter is currently capable of rejecting something
      See Also:

    • clone

      public Object clone() throws CloneNotSupportedException
      Creates and returns a copy of this object.
      Overrides:
      clone in class Filter
      Returns:
      a clone of this instance.
      Throws:
      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: