Package adams.data.conversion.mapobject

Class AbstractReportMapRectangleGenerator

  • 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:
    SimpleReportRectangleGenerator
    public abstract class AbstractReportMapRectangleGenerator
extends AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>
    Ancestor for generators that generate MapRectangle objects.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_TopLeftLatitude

        protected adams.data.report.Field m_TopLeftLatitude
        the field of the topleft latitude.

      • m_TopLeftLongitude

        protected adams.data.report.Field m_TopLeftLongitude
        the field of the topleft longitude.

      • m_BottomRightLatitude

        protected adams.data.report.Field m_BottomRightLatitude
        the field of the bottomright latitude.

      • m_BottomRightLongitude

        protected adams.data.report.Field m_BottomRightLongitude
        the field of the bottomright longitude.

    • Constructor Detail

      • AbstractReportMapRectangleGenerator

        public AbstractReportMapRectangleGenerator()

    • 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 AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

      • setTopLeftLatitude

        public void setTopLeftLatitude​(adams.data.report.Field value)
        Sets the field containing the latitude of the top-left corner.
        Parameters:
        value - the field

      • getTopLeftLatitude

        public adams.data.report.Field getTopLeftLatitude()
        Returns the field containing the latitude of the top-left corner.
        Returns:
        the field

      • topLeftLatitudeTipText

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

      • setTopLeftLongitude

        public void setTopLeftLongitude​(adams.data.report.Field value)
        Sets the field containing the longitude of the top-left corner.
        Parameters:
        value - the field

      • getTopLeftLongitude

        public adams.data.report.Field getTopLeftLongitude()
        Returns the field containing the longitude of the top-left corner.
        Returns:
        the field

      • topLeftLongitudeTipText

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

      • setBottomRightLatitude

        public void setBottomRightLatitude​(adams.data.report.Field value)
        Sets the field containing the latitude of the bottom-right corner.
        Parameters:
        value - the field

      • getBottomRightLatitude

        public adams.data.report.Field getBottomRightLatitude()
        Returns the field containing the latitude of the bottom-right corner.
        Returns:
        the field

      • bottomRightLatitudeTipText

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

      • setBottomRightLongitude

        public void setBottomRightLongitude​(adams.data.report.Field value)
        Sets the field containing the longitude of the bottom-right corner.
        Parameters:
        value - the field

      • getBottomRightLongitude

        public adams.data.report.Field getBottomRightLongitude()
        Returns the field containing the longitude of the bottom-right corner.
        Returns:
        the field

      • bottomRightLongitudeTipText

        public String bottomRightLongitudeTipText()
        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 AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>
        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 AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>
        Returns:
        null if no info available, otherwise short string

      • check

        protected void check​(adams.data.report.Report report)
        Checks the report and throws an exception if it fails.
        Overrides:
        check in class AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>
        Parameters:
        report - the report to check