Package adams.flow.sink.openstreetmapviewer

Class OpenStreetMapCachedLoader

  • 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 OpenStreetMapCachedLoader
extends AbstractTileLoaderProvider
    Returns the default OpenStreetMap file cache tile loader. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -cache-dir <adams.core.io.PlaceholderDirectory> (property: cacheDir)
    The cache directory to use.
    default: ${TMP}
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    OsmTileLoader, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.io.PlaceholderDirectory m_CacheDir
      the cache directory.

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String cacheDirTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected org.openstreetmap.gui.jmapviewer.interfaces.TileLoader doGenerate​(org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener listener)
      Performs the actual instantiation of the tileloader.
      adams.core.io.PlaceholderDirectory getCacheDir()
      Returns the cache directory.
      String globalInfo()
      Returns a string describing the object.
      void setCacheDir​(adams.core.io.PlaceholderDirectory value)
      Sets the cache directory.

      • 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_CacheDir

        protected adams.core.io.PlaceholderDirectory m_CacheDir
        the cache directory.

    • Constructor Detail

      • OpenStreetMapCachedLoader

        public OpenStreetMapCachedLoader()

    • 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

      • setCacheDir

        public void setCacheDir​(adams.core.io.PlaceholderDirectory value)
        Sets the cache directory.
        Parameters:
        value - the directory

      • getCacheDir

        public adams.core.io.PlaceholderDirectory getCacheDir()
        Returns the cache directory.
        Returns:
        the directory

      • cacheDirTipText

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

      • doGenerate

        protected org.openstreetmap.gui.jmapviewer.interfaces.TileLoader doGenerate​(org.openstreetmap.gui.jmapviewer.interfaces.TileLoaderListener listener)
                                                                     throws Exception
        Performs the actual instantiation of the tileloader.
        Specified by:
        doGenerate in class AbstractTileLoaderProvider
        Parameters:
        listener - the listener to use for instantiating
        Returns:
        the instantiated tileloader
        Throws:
        Exception - if generation fails for some reason