weka.gui.explorer

Class AbstractPlotInstances

java.lang.Object

weka.gui.explorer.AbstractPlotInstances

All Implemented Interfaces:

java.io.Serializable, OptionHandler

Direct Known Subclasses:

ClassifierErrorsPlotInstances, ClustererAssignmentsPlotInstances

public abstract class AbstractPlotInstances
extends java.lang.Object
implements java.io.Serializable, OptionHandler

Abstract superclass for generating plottable instances.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_FinishUpCalled whether processing has been finished up already.
protected Instances	m_Instances the full dataset.
protected Instances	m_PlotInstances the plotable instances.

Constructor Summary

Constructors

Constructor and Description
AbstractPlotInstances() Initializes the container.

Method Summary

Modifier and Type	Method and Description
boolean	canPlot(boolean setup) Returns whether all the data is available and the plot instances can be used for plotting.
protected void	check() Default implementation only ensures that a dataset has been set.
void	cleanUp() For freeing up memory.
protected abstract PlotData2D	createPlotData(java.lang.String name) Assembles and returns the plot.
protected abstract void	determineFormat() Sets up the structure for the plot instances.
protected void	finishUp() Performs optional post-processing.
Instances	getInstances() Returns the training data.
java.lang.String[]	getOptions() Gets the current option settings for the OptionHandler.
PlotData2D	getPlotData(java.lang.String name) Assembles and returns the plot.
Instances	getPlotInstances() Returns the generated plot instances.
protected void	initialize() Initializes the member variables.
java.util.Enumeration<Option>	listOptions() Returns an enumeration of all the available options.
void	setInstances(Instances value) Sets the instances that are the basis for the plot instances.
void	setOptions(java.lang.String[] options) Sets the OptionHandler's options using the given list.
void	setUp() Performs checks, sets up the structure for the plot instances.

Methods inherited from class java.lang.Object

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

Field Detail

m_Instances

protected Instances m_Instances

the full dataset.

m_PlotInstances

protected Instances m_PlotInstances

the plotable instances.

m_FinishUpCalled

protected boolean m_FinishUpCalled

whether processing has been finished up already.

Constructor Detail

AbstractPlotInstances

public AbstractPlotInstances()

Initializes the container.

Method Detail

initialize

protected void initialize()

Initializes the member variables.

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration of all the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Sets the OptionHandler's options using the given list. All options will be set (or reset) during this call (i.e. incremental setting of options is not possible).

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current option settings for the OptionHandler.

Specified by:

getOptions in interface OptionHandler

Returns:

the list of current option settings as an array of strings

determineFormat

protected abstract void determineFormat()

Sets up the structure for the plot instances.

setInstances

public void setInstances(Instances value)

Sets the instances that are the basis for the plot instances.

Parameters:

value - the training data to initialize with

getInstances

public Instances getInstances()

Returns the training data.

Returns:

the training data

check

protected void check()

Default implementation only ensures that a dataset has been set.

setUp

public void setUp()

Performs checks, sets up the structure for the plot instances.

finishUp

protected void finishUp()

Performs optional post-processing.

canPlot

public boolean canPlot(boolean setup)

Returns whether all the data is available and the plot instances can be used for plotting.

Parameters:

setup - whether to call setup as well

Returns:

true if operational for plotting

getPlotInstances

public Instances getPlotInstances()

Returns the generated plot instances.

Returns:

the instances to plot

createPlotData

protected abstract PlotData2D createPlotData(java.lang.String name)
                                      throws java.lang.Exception

Assembles and returns the plot. The relation name of the dataset gets added automatically.

Parameters:

name - the name of the plot

Returns:

the plot

Throws:

java.lang.Exception - if plot generation fails

getPlotData

public PlotData2D getPlotData(java.lang.String name)
                       throws java.lang.Exception

Assembles and returns the plot. The relation name of the dataset gets added automatically.

Parameters:

name - the name of the plot

Returns:

the plot

Throws:

java.lang.Exception - if plot generation fails

cleanUp

public void cleanUp()

For freeing up memory. Plot data cannot be generated after this call!