Package adams.data.conversion.mapobject

Class SimpleReportCircleMarkerGenerator

  • 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
    public class SimpleReportCircleMarkerGenerator
extends AbstractReportMapMarkerGenerator
    Generates circle markers. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -layer <java.lang.String> (property: layer)
    The name of the layer.
    default: Default
 
    -latitude <adams.data.report.Field> (property: latitude)
    The field in the report that contains the latitude.
    default: lat[N]
 
    -longitude <adams.data.report.Field> (property: longitude)
    The field in the report that contains the longitude.
    default: lon[N]
 
    -radius <adams.data.report.Field> (property: radius)
    The field containing the radius.
    default: radius[N]
 
    -name <adams.data.report.Field> (property: name)
    The field containing the name (optional).
    default: name[S]
 
    -timestamp <adams.data.report.Field> (property: timestamp)
    The field to obtain the timestamp from for the map object (optional).
    default: timestamp[S]
 
    -additional-attributes <adams.data.report.Field> [-additional-attributes ...] (property: additionalAttributes)
    The fields to add to the map object as well.
    default: 
 
    -circle-color <java.awt.Color> (property: circleColor)
    The circle color for the point.
    default: #ffc800
 
    -fill-color <java.awt.Color> (property: fillColor)
    The fill color for the point.
    default: #32646464
 
    -font <java.awt.Font> (property: font)
    The font to use for the text.
    default: helvetica-PLAIN-12
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Radius

        protected adams.data.report.Field m_Radius
        the field with the radius information.

      • m_Name

        protected adams.data.report.Field m_Name
        the field with the name information (optional).

      • m_CircleColor

        protected Color m_CircleColor
        the color of the circle.

      • m_FillColor

        protected Color m_FillColor
        the fill color of the circle.

      • m_Font

        protected Font m_Font
        the font to use.

    • Constructor Detail

      • SimpleReportCircleMarkerGenerator

        public SimpleReportCircleMarkerGenerator()

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

      • setRadius

        public void setRadius​(adams.data.report.Field value)
        Sets the field containing the radius.
        Parameters:
        value - the field

      • getRadius

        public adams.data.report.Field getRadius()
        Returns the field containing the radius.
        Returns:
        the field

      • radiusTipText

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

      • setName

        public void setName​(adams.data.report.Field value)
        Sets the field containing the name.
        Parameters:
        value - the field

      • getName

        public adams.data.report.Field getName()
        Returns the field containing the name.
        Returns:
        the field

      • nameTipText

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

      • setCircleColor

        public void setCircleColor​(Color value)
        Sets the circle color for the circle.
        Parameters:
        value - the circle color

      • getCircleColor

        public Color getCircleColor()
        Returns the circle color for the circle.
        Returns:
        the circle color

      • circleColorTipText

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

      • setFillColor

        public void setFillColor​(Color value)
        Sets the fill color for the circle.
        Parameters:
        value - the fill color

      • getFillColor

        public Color getFillColor()
        Returns the fill color for the circle.
        Returns:
        the fill color

      • fillColorTipText

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

      • setFont

        public void setFont​(Font value)
        Sets the font for the text.
        Parameters:
        value - the font

      • getFont

        public Font getFont()
        Returns the font for the text.
        Returns:
        the font

      • fontTipText

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

      • 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 AbstractReportMapMarkerGenerator
        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 AbstractReportMapMarkerGenerator
        Parameters:
        report - the report to check

      • doGenerate

        protected org.openstreetmap.gui.jmapviewer.interfaces.MapMarker doGenerate​(adams.data.report.Report report)
        Performs the actual generation of the layer.
        Specified by:
        doGenerate in class AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>
        Parameters:
        sheet - the spreadsheet to use
        Returns:
        the generated layer