Package adams.flow.sink.openstreetmapviewer

Class MaxAgePruner

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class MaxAgePruner
extends AbstractMapObjectPruner
    Removes map objects that are older than a specific timespan compared to the newest map object. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -max-age <adams.core.base.BaseDateTime> (property: maxAge)
    The maximum age; eg 'START -7 DAY' with 'START' being the date of the newest 
    mapobject.
    default: START -7 DAY
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.base.BaseDateTime m_MaxAge
      the maximum age.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      MaxAgePruner()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected void doPrune​(org.openstreetmap.gui.jmapviewer.JMapViewerTree tree)
      Prunes the map objects.
      adams.core.base.BaseDateTime getMaxAge()
      Returns the maximum age date.
      String globalInfo()
      Returns a string describing the object.
      String maxAgeTipText()
      Returns the tip text for this property.
      void setMaxAge​(adams.core.base.BaseDateTime value)
      Sets the maximum age date.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_MaxAge

        protected adams.core.base.BaseDateTime m_MaxAge
        the maximum age.

    • Constructor Detail

      • MaxAgePruner

        public MaxAgePruner()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setMaxAge

        public void setMaxAge​(adams.core.base.BaseDateTime value)
        Sets the maximum age date.
        Parameters:
        value - the date

      • getMaxAge

        public adams.core.base.BaseDateTime getMaxAge()
        Returns the maximum age date.
        Returns:
        the date

      • maxAgeTipText

        public String maxAgeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doPrune

        protected void doPrune​(org.openstreetmap.gui.jmapviewer.JMapViewerTree tree)
        Prunes the map objects.
        Specified by:
        doPrune in class AbstractMapObjectPruner
        Parameters:
        tree - the tree to prune