Package adams.data.conversion.mapobject
Class SimpleReportPolygonGenerator
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.conversion.mapobject.AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapPolygon>
-
- adams.data.conversion.mapobject.AbstractReportMapPolygonGenerator
-
- adams.data.conversion.mapobject.SimpleReportPolygonGenerator
-
- 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 SimpleReportPolygonGenerator extends AbstractReportMapPolygonGenerator
Generates polygons.
-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> [-latitude ...] (property: latitudes) The fields containing the latitudes for the polygons. default:
-longitude <adams.data.report.Field> [-longitude ...] (property: longitudes) The fields containing the longitudes for the polygons. default:
-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:
-border-color <java.awt.Color> (property: borderColor) The border color for the polygon. default: #0000ff
-fill-color <java.awt.Color> (property: fillColor) The fill color for the polygon. 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 Summary
Fields Modifier and Type Field Description protected Color
m_BorderColor
the color of the border.protected Color
m_FillColor
the fill color of the circle.protected Font
m_Font
the font to use.protected adams.data.report.Field
m_Name
the field with the name information (optional).-
Fields inherited from class adams.data.conversion.mapobject.AbstractReportMapPolygonGenerator
m_Latitudes, m_Longitudes
-
Fields inherited from class adams.data.conversion.mapobject.AbstractReportMapObjectGenerator
m_AdditionalAttributes, m_DateFormat, m_DateTimeFormat, m_Layer, m_Timestamp
-
-
Constructor Summary
Constructors Constructor Description SimpleReportPolygonGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
borderColorTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected org.openstreetmap.gui.jmapviewer.interfaces.MapPolygon
doGenerate(adams.data.report.Report report)
Performs the actual generation of the layer.String
fillColorTipText()
Returns the tip text for this property.String
fontTipText()
Returns the tip text for this property.Color
getBorderColor()
Returns the circle color for the collection.Color
getFillColor()
Returns the fill color for the polygon.Font
getFont()
Returns the font for the text.adams.data.report.Field
getName()
Returns the field containing the name.String
getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.String
globalInfo()
Returns a string describing the object.String
nameTipText()
Returns the tip text for this property.void
setBorderColor(Color value)
Sets the circle color for the collection.void
setFillColor(Color value)
Sets the fill color for the polygon.void
setFont(Font value)
Sets the font for the text.void
setName(adams.data.report.Field value)
Sets the field containing the name.-
Methods inherited from class adams.data.conversion.mapobject.AbstractReportMapPolygonGenerator
check, generates, getLatitudes, getLongitudes, latitudesTipText, longitudesTipText, setLatitudes, setLongitudes
-
Methods inherited from class adams.data.conversion.mapobject.AbstractReportMapObjectGenerator
additionalAttributesTipText, addMetaData, addTimestamp, generate, getAdditionalAttributes, getDefaultLayer, getLayer, getNumericValue, getTimestamp, initialize, layerTipText, postProcess, setAdditionalAttributes, setLayer, setTimestamp, shallowCopy, shallowCopy, timestampTipText
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.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 interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classAbstractReportMapPolygonGenerator
-
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.
-
setBorderColor
public void setBorderColor(Color value)
Sets the circle color for the collection.- Parameters:
value
- the circle color
-
getBorderColor
public Color getBorderColor()
Returns the circle color for the collection.- Returns:
- the circle color
-
borderColorTipText
public String borderColorTipText()
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 polygon.- Parameters:
value
- the fill color
-
getFillColor
public Color getFillColor()
Returns the fill color for the polygon.- 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 interfaceadams.core.QuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractReportMapPolygonGenerator
- Returns:
- null if no info available, otherwise short string
-
doGenerate
protected org.openstreetmap.gui.jmapviewer.interfaces.MapPolygon doGenerate(adams.data.report.Report report)
Performs the actual generation of the layer.- Specified by:
doGenerate
in classAbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapPolygon>
- Parameters:
sheet
- the spreadsheet to use- Returns:
- the generated layer
-
-