Package adams.data.conversion.mapobject
Class SimpleReportRectangleGenerator
- 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.MapRectangle>
-
- adams.data.conversion.mapobject.AbstractReportMapRectangleGenerator
-
- adams.data.conversion.mapobject.SimpleReportRectangleGenerator
-
- 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 SimpleReportRectangleGenerator extends AbstractReportMapRectangleGenerator
Generates rectangles.
-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
-top-left-latitude <adams.data.report.Field> (property: topLeftLatitude) The field containing the latitude of the top-left corner. default: top-left-lat[N]
-top-left-longitude <adams.data.report.Field> (property: topLeftLongitude) The field containing the longitude of the top-left corner. default: top-left-lon[N]
-bottom-right-latitude <adams.data.report.Field> (property: bottomRightLatitude) The field containing the latitude of the bottom-right corner. default: bottom-right-lat[N]
-bottom-right-longitude <adams.data.report.Field> (property: bottomRightLongitude) The field containing the longitude of the bottom-right corner. default: bottom-right-lat[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:
-rectangle-color <java.awt.Color> (property: rectangleColor) The rectangle color. default: #0000ff
-fill-color <java.awt.Color> (property: fillColor) The fill color for the rectangle. default: #c8c8c8c8
-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_FillColor
the fill color of the rectangle.protected Font
m_Font
the font to use.protected adams.data.report.Field
m_Name
the field with the name information (optional).protected Color
m_RectangleColor
the color of the rectangle.-
Fields inherited from class adams.data.conversion.mapobject.AbstractReportMapRectangleGenerator
m_BottomRightLatitude, m_BottomRightLongitude, m_TopLeftLatitude, m_TopLeftLongitude
-
Fields inherited from class adams.data.conversion.mapobject.AbstractReportMapObjectGenerator
m_AdditionalAttributes, m_DateFormat, m_DateTimeFormat, m_Layer, m_Timestamp
-
-
Constructor Summary
Constructors Constructor Description SimpleReportRectangleGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle
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
getFillColor()
Returns the fill color for the collection.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.Color
getRectangleColor()
Returns the rectangle color for the collection.String
globalInfo()
Returns a string describing the object.String
nameTipText()
Returns the tip text for this property.String
rectangleColorTipText()
Returns the tip text for this property.void
setFillColor(Color value)
Sets the fill color for the collection.void
setFont(Font value)
Sets the font for the text.void
setName(adams.data.report.Field value)
Sets the field containing the name.void
setRectangleColor(Color value)
Sets the rectangle color for the collection.-
Methods inherited from class adams.data.conversion.mapobject.AbstractReportMapRectangleGenerator
bottomRightLatitudeTipText, bottomRightLongitudeTipText, check, generates, getBottomRightLatitude, getBottomRightLongitude, getTopLeftLatitude, getTopLeftLongitude, setBottomRightLatitude, setBottomRightLongitude, setTopLeftLatitude, setTopLeftLongitude, topLeftLatitudeTipText, topLeftLongitudeTipText
-
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
-
-
-
-
Field Detail
-
m_Name
protected adams.data.report.Field m_Name
the field with the name information (optional).
-
m_RectangleColor
protected Color m_RectangleColor
the color of the rectangle.
-
m_FillColor
protected Color m_FillColor
the fill color of the rectangle.
-
m_Font
protected Font m_Font
the font to use.
-
-
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 classAbstractReportMapRectangleGenerator
-
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.
-
setRectangleColor
public void setRectangleColor(Color value)
Sets the rectangle color for the collection.- Parameters:
value
- the rectangle color
-
getRectangleColor
public Color getRectangleColor()
Returns the rectangle color for the collection.- Returns:
- the rectangle color
-
rectangleColorTipText
public String rectangleColorTipText()
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 collection.- Parameters:
value
- the fill color
-
getFillColor
public Color getFillColor()
Returns the fill color for the collection.- 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 classAbstractReportMapRectangleGenerator
- Returns:
- null if no info available, otherwise short string
-
doGenerate
protected org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle doGenerate(adams.data.report.Report report)
Performs the actual generation of the layer.- Specified by:
doGenerate
in classAbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>
- Parameters:
sheet
- the spreadsheet to use- Returns:
- the generated layer
-
-