Package adams.flow.sink.openstreetmapviewer

Class CustomMapnikSource

  • 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 CustomMapnikSource
extends AbstractTileSourceProvider
    Returns a tile source for a custom Mapnik server. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -url <adams.core.base.BaseURL> (property: URL)
    The URL of the custom Mapnik server to use.
    default: http://tile.openstreetmap.org
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CustomMapnikSource.Mapnik
      The custom "Mapnik" OSM tile source.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.base.BaseURL m_URL
      the server URL.

      • 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
      void defineOptions()
      Adds options to the internal list of options.
      protected org.openstreetmap.gui.jmapviewer.interfaces.TileSource doGenerate()
      Performs the actual instantiation of the tilesource.
      adams.core.base.BaseURL getURL()
      Returns the Mapnik server URL.
      String globalInfo()
      Returns a string describing the object.
      void setURL​(adams.core.base.BaseURL value)
      Sets the Mapnik server URL.
      String URLTipText()
      Returns the tip text for this property.

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

        protected adams.core.base.BaseURL m_URL
        the server URL.

    • Constructor Detail

      • CustomMapnikSource

        public CustomMapnikSource()

    • 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

      • setURL

        public void setURL​(adams.core.base.BaseURL value)
        Sets the Mapnik server URL.
        Parameters:
        value - the URL

      • getURL

        public adams.core.base.BaseURL getURL()
        Returns the Mapnik server URL.
        Returns:
        the URL

      • URLTipText

        public String URLTipText()
        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.TileSource doGenerate()
                                                                     throws Exception
        Performs the actual instantiation of the tilesource.
        Specified by:
        doGenerate in class AbstractTileSourceProvider
        Returns:
        the instantiated tilesource
        Throws:
        Exception - if generation fails for some reason