Package adams.gui.visualization.jfreechart.dataset

Class AbstractDatasetGenerator<T extends org.jfree.data.general.Dataset>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.jfreechart.dataset.AbstractDatasetGenerator<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultCategory, DefaultXY, DefaultXYZ

public abstract class AbstractDatasetGenerator<T extends org.jfree.data.general.Dataset>
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for dataset generators.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
T	addSeries(T dataset, SpreadSheet data)	Adds the series to the dataset.
protected String	check(SpreadSheet data)	Hook method for checks before generating the dataset.
protected String	checkAddSeries(org.jfree.data.general.Dataset dataset, SpreadSheet data)	Performs checks before adding series.
protected abstract T	doAddSeries(org.jfree.data.general.Dataset dataset, SpreadSheet data)	Performs the actual addition of the series to the dataset.
protected abstract T	doGenerate(SpreadSheet data)	Performs the actual generation of the dataset.
T	generate(SpreadSheet data)	Generates the dataset.
abstract Class<? extends org.jfree.data.general.Dataset>	generates()	Returns the class of dataset that it generates.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Constructor Detail

AbstractDatasetGenerator

public AbstractDatasetGenerator()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

generates

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

Returns the class of dataset that it generates.

Returns:

the dataset class

check

protected String check(SpreadSheet data)

Hook method for checks before generating the dataset.

Parameters:

data - the data to use

Returns:

null if checks passed, otherwise error message

doGenerate

protected abstract T doGenerate(SpreadSheet data)

Performs the actual generation of the dataset.

Parameters:

data - the data to use

Returns:

the dataset

generate

public T generate(SpreadSheet data)

Generates the dataset.

Parameters:

data - the data to use

Returns:

the dataset

checkAddSeries

protected String checkAddSeries(org.jfree.data.general.Dataset dataset,
                                SpreadSheet data)

Performs checks before adding series.

Parameters:

dataset - the dataset to add the series to

data - the data to use

Returns:

null if checks passed, otherwise error message

doAddSeries

protected abstract T doAddSeries(org.jfree.data.general.Dataset dataset,
                                 SpreadSheet data)

Performs the actual addition of the series to the dataset.

Parameters:

dataset - the dataset to add the series to

data - the data to use

Returns:

the updated dataset

addSeries

public T addSeries(T dataset,
                   SpreadSheet data)

Adds the series to the dataset.

Parameters:

dataset - the dataset to add the series to

data - the data to use

Returns:

the updated dataset