Package adams.data.conversion.mapobject

Class AbstractReportMapMarkerGenerator

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.MapMarker>

adams.data.conversion.mapobject.AbstractReportMapMarkerGenerator

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:

SimpleReportCircleMarkerGenerator, SimpleReportDotMarkerGenerator

public abstract class AbstractReportMapMarkerGenerator
extends AbstractReportMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapMarker>

Ancestor for generators that generate MapMarker objects.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.data.report.Field	m_Latitude	the field in the report to use as latitude.
protected adams.data.report.Field	m_Longitude	the field in the report to use as longitude.

Fields inherited from class adams.data.conversion.mapobject.AbstractReportMapObjectGenerator

m_AdditionalAttributes, m_DateFormat, m_DateTimeFormat, m_Layer, m_Timestamp

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractReportMapMarkerGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	check(adams.data.report.Report report)	Checks the report and throws an exception if it fails.
void	defineOptions()	Adds options to the internal list of options.
Class	generates()	Returns the type of data the generator creates.
adams.data.report.Field	getLatitude()	Returns the field in use for latitude.
adams.data.report.Field	getLongitude()	Returns the field in use for longitude.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	latitudeTipText()	Returns the tip text for this property.
String	longitudeTipText()	Returns the tip text for this property.
void	setLatitude(adams.data.report.Field value)	Sets the field to use for latitude.
void	setLongitude(adams.data.report.Field value)	Sets the field to use for longitude.

Methods inherited from class adams.data.conversion.mapobject.AbstractReportMapObjectGenerator

additionalAttributesTipText, addMetaData, addTimestamp, doGenerate, 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, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Latitude

protected adams.data.report.Field m_Latitude

the field in the report to use as latitude.

m_Longitude

protected adams.data.report.Field m_Longitude

the field in the report to use as longitude.

Constructor Detail

AbstractReportMapMarkerGenerator

public AbstractReportMapMarkerGenerator()

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.MapMarker>

setLatitude

public void setLatitude(adams.data.report.Field value)

Sets the field to use for latitude.

Parameters:

value - the field

getLatitude

public adams.data.report.Field getLatitude()

Returns the field in use for latitude.

Returns:

the field

latitudeTipText

public String latitudeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setLongitude

public void setLongitude(adams.data.report.Field value)

Sets the field to use for longitude.

Parameters:

value - the field

getLongitude

public adams.data.report.Field getLongitude()

Returns the field in use for longitude.

Returns:

the field

longitudeTipText

public String longitudeTipText()

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.MapMarker>

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.MapMarker>

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.MapMarker>

Parameters:

report - the report to check