Package adams.data.conversion.mapobject

Class AbstractMapMarkerGenerator

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    Direct Known Subclasses:
    SimpleCircleMarkerGenerator, SimpleDotMarkerGenerator
    public abstract class AbstractMapMarkerGenerator
extends AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>
    Ancestor for generators that generate MapMarker objects.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_GPS

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_GPS
        the index of the GPS coordinates column.

      • m_GPSIndex

        protected int m_GPSIndex
        the actual index of the GPS coordinates column.

    • Constructor Detail

      • AbstractMapMarkerGenerator

        public AbstractMapMarkerGenerator()

    • Method Detail

      • 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 AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>

      • setGPS

        public void setGPS​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the index of the column containing the GPS objects.
        Parameters:
        value - the column index

      • getGPS

        public adams.data.spreadsheet.SpreadSheetColumnIndex getGPS()
        Returns the index of the column containing the GPS objects.
        Returns:
        the column index

      • GPSTipText

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

      • generates

        public Class generates()
        Returns the type of data the generator creates.
        Specified by:
        generates in class AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>
        Returns:
        the data type(s)

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>
        Returns:
        null if no info available, otherwise short string

      • check

        protected void check​(adams.data.spreadsheet.SpreadSheet sheet)
        Checks the spreadsheet and throws an exception if it fails.
        Overrides:
        check in class AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>
        Parameters:
        sheet - the spreadsheet to check

      • init

        protected void init​(adams.data.spreadsheet.SpreadSheet sheet)
        Initializes the internal state with the given spreadsheet.
        Overrides:
        init in class AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>
        Parameters:
        sheet - the spreadsheet to initialize with