Package adams.data.conversion.mapobject

Class AbstractReportMapPolygonGenerator

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

    • Field Detail

      • m_Latitudes

        protected adams.data.report.Field[] m_Latitudes
        the fields for the polygon latitudes.

      • m_Longitudes

        protected adams.data.report.Field[] m_Longitudes
        the fields for the polygon longitudes.

    • Constructor Detail

      • AbstractReportMapPolygonGenerator

        public AbstractReportMapPolygonGenerator()

    • 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.MapPolygon>

      • setLatitudes

        public void setLatitudes​(adams.data.report.Field[] value)
        Sets the fields containing the latitudes for the polygons.
        Parameters:
        value - the fields

      • getLatitudes

        public adams.data.report.Field[] getLatitudes()
        Returns the fields containing the latitudes for the polygons.
        Returns:
        the fields

      • latitudesTipText

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

      • setLongitudes

        public void setLongitudes​(adams.data.report.Field[] value)
        Sets the fields containing the longitudes for the polygons.
        Parameters:
        value - the fields

      • getLongitudes

        public adams.data.report.Field[] getLongitudes()
        Returns the fields containing the longitudes for the polygons.
        Returns:
        the fields

      • longitudesTipText

        public String longitudesTipText()
        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.MapPolygon>
        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.MapPolygon>
        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.MapPolygon>
        Parameters:
        report - the report to check