Package adams.data.conversion.mapobject

Class AbstractMapRectangleGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.mapobject.AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

adams.data.conversion.mapobject.AbstractMapRectangleGenerator

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:

SimpleRectangleGenerator

public abstract class AbstractMapRectangleGenerator
extends AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

Ancestor for generators that generate MapRectangle 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.spreadsheet.SpreadSheetColumnIndex	m_BottomRight	the index of the bottomright coordinates column.
protected int	m_BottomRightIndex	the actual index of the bottomright coordinates column.
protected adams.data.spreadsheet.SpreadSheetColumnIndex	m_TopLeft	the index of the topleft coordinates column.
protected int	m_TopLeftIndex	the actual index of the topleft coordinates column.

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

m_AdditionalAttributes, m_AdditionalAttributesIndices, m_Layer, m_Timestamp, m_TimestampIndex

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
AbstractMapRectangleGenerator()

Method Summary

Modifier and Type	Method	Description
String	bottomRightTipText()	Returns the tip text for this property.
protected void	check(adams.data.spreadsheet.SpreadSheet sheet)	Checks the spreadsheet 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.spreadsheet.SpreadSheetColumnIndex	getBottomRight()	Returns the index of the column containing the GPS objects of the bottom-right corner.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
adams.data.spreadsheet.SpreadSheetColumnIndex	getTopLeft()	Returns the index of the column containing the GPS objects of the top-left corner.
protected void	init(adams.data.spreadsheet.SpreadSheet sheet)	Initializes the internal state with the given spreadsheet.
void	setBottomRight(adams.data.spreadsheet.SpreadSheetColumnIndex value)	Sets the index of the column containing the GPS objects of the bottom-right corner.
void	setTopLeft(adams.data.spreadsheet.SpreadSheetColumnIndex value)	Sets the index of the column containing the GPS objects of the top-left corner.
String	topLeftTipText()	Returns the tip text for this property.

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

additionalAttributesTipText, addMetaData, addTimestamp, doGenerate, generate, getAdditionalAttributes, getDefaultLayer, getLayer, 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_TopLeft

protected adams.data.spreadsheet.SpreadSheetColumnIndex m_TopLeft

the index of the topleft coordinates column.

m_TopLeftIndex

protected int m_TopLeftIndex

the actual index of the topleft coordinates column.

m_BottomRight

protected adams.data.spreadsheet.SpreadSheetColumnIndex m_BottomRight

the index of the bottomright coordinates column.

m_BottomRightIndex

protected int m_BottomRightIndex

the actual index of the bottomright coordinates column.

Constructor Detail

AbstractMapRectangleGenerator

public AbstractMapRectangleGenerator()

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 AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

setTopLeft

public void setTopLeft(adams.data.spreadsheet.SpreadSheetColumnIndex value)

Sets the index of the column containing the GPS objects of the top-left corner.

Parameters:

value - the column index

getTopLeft

public adams.data.spreadsheet.SpreadSheetColumnIndex getTopLeft()

Returns the index of the column containing the GPS objects of the top-left corner.

Returns:

the column index

topLeftTipText

public String topLeftTipText()

Returns the tip text for this property.

Returns:

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

setBottomRight

public void setBottomRight(adams.data.spreadsheet.SpreadSheetColumnIndex value)

Sets the index of the column containing the GPS objects of the bottom-right corner.

Parameters:

value - the column index

getBottomRight

public adams.data.spreadsheet.SpreadSheetColumnIndex getBottomRight()

Returns the index of the column containing the GPS objects of the bottom-right corner.

Returns:

the column index

bottomRightTipText

public String bottomRightTipText()

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 AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

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 AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

Returns:

null if no info available, otherwise short string

check

protected void check(adams.data.spreadsheet.SpreadSheet sheet)

Checks the spreadsheet and throws an exception if it fails.

Overrides:

check in class AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

Parameters:

sheet - the spreadsheet to check

init

protected void init(adams.data.spreadsheet.SpreadSheet sheet)

Initializes the internal state with the given spreadsheet.

Overrides:

init in class AbstractMapObjectGenerator<org.openstreetmap.gui.jmapviewer.interfaces.MapRectangle>

Parameters:

sheet - the spreadsheet to initialize with