Package adams.gui.visualization.jfreechart.dataset

Class DefaultXYZ

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.jfreechart.dataset.AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

adams.gui.visualization.jfreechart.dataset.DefaultXYZ

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class DefaultXYZ
extends AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

Generates DefaultXYZDataset datasets.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_X	the X column.
protected SpreadSheetColumnIndex	m_Y	the Y column.
protected SpreadSheetColumnIndex	m_Z	the Z column.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(SpreadSheet data)	Hook method for checks before generating the dataset.
void	defineOptions()	Adds options to the internal list of options.
protected org.jfree.data.xy.DefaultXYZDataset	doAddSeries(org.jfree.data.general.Dataset dataset, SpreadSheet data)	Performs the actual addition of the series to the dataset.
protected org.jfree.data.xy.DefaultXYZDataset	doGenerate(SpreadSheet data)	Performs the actual generation of the dataset.
Class<? extends org.jfree.data.general.Dataset>	generates()	Returns the class of dataset that it generates.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
SpreadSheetColumnIndex	getX()	Returns the index of the column to act as X axis.
SpreadSheetColumnIndex	getY()	Returns the index of column to use as Y.
SpreadSheetColumnIndex	getZ()	Returns the index of column to use as Z.
String	globalInfo()	Returns a string describing the object.
void	setX(SpreadSheetColumnIndex value)	Sets the index of the column to act as X axis.
void	setY(SpreadSheetColumnIndex value)	Sets the index of column to use as Y.
void	setZ(SpreadSheetColumnIndex value)	Sets the index of column to use as Z.
String	XTipText()	Returns the tip text for this property.
String	YTipText()	Returns the tip text for this property.
String	ZTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.jfreechart.dataset.AbstractDatasetGenerator

addSeries, checkAddSeries, generate

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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_X

protected SpreadSheetColumnIndex m_X

the X column.

m_Y

protected SpreadSheetColumnIndex m_Y

the Y column.

m_Z

protected SpreadSheetColumnIndex m_Z

the Z column.

Constructor Detail

DefaultXYZ

public DefaultXYZ()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setX

public void setX(SpreadSheetColumnIndex value)

Sets the index of the column to act as X axis.

Parameters:

value - the index

getX

public SpreadSheetColumnIndex getX()

Returns the index of the column to act as X axis.

Returns:

the index

XTipText

public String XTipText()

Returns the tip text for this property.

Returns:

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

setY

public void setY(SpreadSheetColumnIndex value)

Sets the index of column to use as Y.

Parameters:

value - the index

getY

public SpreadSheetColumnIndex getY()

Returns the index of column to use as Y.

Returns:

the index

YTipText

public String YTipText()

Returns the tip text for this property.

Returns:

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

setZ

public void setZ(SpreadSheetColumnIndex value)

Sets the index of column to use as Z.

Parameters:

value - the index

getZ

public SpreadSheetColumnIndex getZ()

Returns the index of column to use as Z.

Returns:

the index

ZTipText

public String ZTipText()

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 actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

Returns:

null if no info available, otherwise short string

generates

public Class<? extends org.jfree.data.general.Dataset> generates()

Returns the class of dataset that it generates.

Specified by:

generates in class AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

Returns:

the dataset class

check

protected String check(SpreadSheet data)

Hook method for checks before generating the dataset.

Overrides:

check in class AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

Parameters:

data - the data to use

Returns:

null if checks passed, otherwise error message

doGenerate

protected org.jfree.data.xy.DefaultXYZDataset doGenerate(SpreadSheet data)

Performs the actual generation of the dataset.

Specified by:

doGenerate in class AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

Parameters:

data - the data to use

Returns:

the dataset

doAddSeries

protected org.jfree.data.xy.DefaultXYZDataset doAddSeries(org.jfree.data.general.Dataset dataset,
                                                          SpreadSheet data)

Performs the actual addition of the series to the dataset.

Specified by:

doAddSeries in class AbstractDatasetGenerator<org.jfree.data.xy.DefaultXYZDataset>

Parameters:

dataset - the dataset to add the series to

data - the data to use

Returns:

the dataset