Package adams.gui.visualization.jfreechart.chart

Class FlowPlot

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.jfreechart.chart.AbstractChartGenerator

adams.gui.visualization.jfreechart.chart.FlowPlot

All Implemented Interfaces:

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

public class FlowPlot
extends AbstractChartGenerator

Generates a flow plot form a FlowDataset. Similar to a Sankey diagram.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColorProvider	m_ColorProvider	the color provider.
protected Color	m_NodeLabelColor	the color for the node labels.

Fields inherited from class adams.gui.visualization.jfreechart.chart.AbstractChartGenerator

m_Legend, m_Title, m_ToolTips

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

Method Summary

Modifier and Type	Method	Description
String	colorProviderTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected org.jfree.chart.JFreeChart	doGenerate(org.jfree.data.general.Dataset data)	Performs the actual generation of the chart.
ColorProvider	getColorProvider()	Returns the color provider for the plot.
Color	getNodeLabelColor()	Returns the color for the node labels.
String	globalInfo()	Returns a string describing the object.
String	nodeLabelColorTipText()	Returns the tip text for this property.
void	setColorProvider(ColorProvider value)	Sets the color provider for the plot.
void	setNodeLabelColor(Color value)	Sets the color for the node labels.

Methods inherited from class adams.gui.visualization.jfreechart.chart.AbstractChartGenerator

check, generate, getLegend, getQuickInfo, getTitle, getToolTips, legendTipText, setLegend, setTitle, setToolTips, titleTipText, toolTipsTipText

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_NodeLabelColor

protected Color m_NodeLabelColor

the color for the node labels.

m_ColorProvider

protected ColorProvider m_ColorProvider

the color provider.

Constructor Detail

FlowPlot

public FlowPlot()

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 AbstractChartGenerator

setNodeLabelColor

public void setNodeLabelColor(Color value)

Sets the color for the node labels.

Parameters:

value - the color

getNodeLabelColor

public Color getNodeLabelColor()

Returns the color for the node labels.

Returns:

the color

nodeLabelColorTipText

public String nodeLabelColorTipText()

Returns the tip text for this property.

Returns:

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

setColorProvider

public void setColorProvider(ColorProvider value)

Sets the color provider for the plot.

Parameters:

value - the provider

getColorProvider

public ColorProvider getColorProvider()

Returns the color provider for the plot.

Returns:

the provider

colorProviderTipText

public String colorProviderTipText()

Returns the tip text for this property.

Returns:

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

doGenerate

protected org.jfree.chart.JFreeChart doGenerate(org.jfree.data.general.Dataset data)

Performs the actual generation of the chart.

Specified by:

doGenerate in class AbstractChartGenerator

Parameters:

data - the data to use

Returns:

the chart