Package adams.gui.tools.wekainvestigator.tab.clustertab

Class ResultItem

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.tools.wekainvestigator.output.AbstractResultItem

adams.gui.tools.wekainvestigator.tab.clustertab.ResultItem

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, Serializable

public class ResultItem
extends AbstractResultItem

Container for an evaluation, model, training set header. Used in the result history.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected weka.clusterers.ClusterEvaluation	m_Evaluation	the evaluation object.
protected weka.clusterers.Clusterer	m_Model	the model.
protected adams.data.spreadsheet.MetaData	m_RunInformation	the run information.
protected Serializable	m_SupplementaryData	supplementary data.
protected String	m_SupplementaryName	the supplementary name.
protected weka.clusterers.Clusterer	m_Template	the template.

Fields inherited from class adams.gui.tools.wekainvestigator.output.AbstractResultItem

m_Header, m_Log, m_LogPanel, m_Name, m_TabbedPane, m_Timestamp, MAX_RELATIONNAME_LENGTH

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ResultItem(weka.clusterers.Clusterer template, weka.core.Instances header)	Initializes the item.

Method Summary

Modifier and Type	Method	Description
protected String	createName()	Creates the name from the members.
weka.clusterers.ClusterEvaluation	getEvaluation()	Returns the stored Evaluation object.
weka.clusterers.Clusterer	getModel()	Returns the stored model object.
adams.data.spreadsheet.MetaData	getRunInformation()	Returns the stored run information.
Object	getSupplementaryData()	Returns the stored Supplementary object.
String	getSupplementaryName()	Returns the stored Supplementary name.
weka.clusterers.Clusterer	getTemplate()	Returns the stored template object.
boolean	hasEvaluation()	Returns whether an Evaluation object is present.
boolean	hasModel()	Returns whether an model object is present.
boolean	hasRunInformation()	Returns whether run information is present.
boolean	hasSupplementaryData()	Returns whether an Supplementary object is present.
boolean	hasSupplementaryName()	Returns whether a name for the Supplementary object is present.
void	setTemplate(weka.clusterers.Clusterer value)	Sets the stored template object.
String	toString()	Returns a short description of the container.
void	update(String supplementaryName, Serializable supplementaryData, weka.clusterers.Clusterer model, adams.data.spreadsheet.MetaData runInfo)	Updates the item.
void	update(weka.clusterers.ClusterEvaluation evaluation, String supplementaryName, Serializable supplementaryData, weka.clusterers.Clusterer model, adams.data.spreadsheet.MetaData runInfo)	Updates the item.
void	update(weka.clusterers.ClusterEvaluation evaluation, weka.clusterers.Clusterer model, adams.data.spreadsheet.MetaData runInfo)	Updates the item.

Methods inherited from class adams.gui.tools.wekainvestigator.output.AbstractResultItem

cleanUp, getHeader, getLogPanel, getName, getTabbedPane, hasHeader, invalidateName, logError, logMessage

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

Field Detail

m_Evaluation

protected weka.clusterers.ClusterEvaluation m_Evaluation

the evaluation object.

m_Template

protected weka.clusterers.Clusterer m_Template

the template.

m_Model

protected weka.clusterers.Clusterer m_Model

the model.

m_SupplementaryName

protected String m_SupplementaryName

the supplementary name.

m_SupplementaryData

protected Serializable m_SupplementaryData

supplementary data.

m_RunInformation

protected adams.data.spreadsheet.MetaData m_RunInformation

the run information.

Constructor Detail

ResultItem

public ResultItem(weka.clusterers.Clusterer template,
                  weka.core.Instances header)

Initializes the item.

Parameters:

template - the template

header - the header of the training set, can be null

Method Detail

createName

protected String createName()

Creates the name from the members.

Specified by:

createName in class AbstractResultItem

Returns:

the name

update

public void update(weka.clusterers.ClusterEvaluation evaluation,
                   weka.clusterers.Clusterer model,
                   adams.data.spreadsheet.MetaData runInfo)

Updates the item.

Parameters:

evaluation - the evaluation, can be null

model - the model, can be null

runInfo - the run information, can be null

update

public void update(String supplementaryName,
                   Serializable supplementaryData,
                   weka.clusterers.Clusterer model,
                   adams.data.spreadsheet.MetaData runInfo)

Updates the item.

Parameters:

supplementaryName - the name for the supplementary data, can be null

supplementaryData - the supplementary data, can be null

model - the model, can be null

runInfo - the run information, can be null

update

public void update(weka.clusterers.ClusterEvaluation evaluation,
                   String supplementaryName,
                   Serializable supplementaryData,
                   weka.clusterers.Clusterer model,
                   adams.data.spreadsheet.MetaData runInfo)

Updates the item.

Parameters:

evaluation - the evaluation, can be null

supplementaryName - the name for the supplementary data, can be null

supplementaryData - the supplementary data, can be null

model - the model, can be null

runInfo - the run information, can be null

hasEvaluation

public boolean hasEvaluation()

Returns whether an Evaluation object is present.

Returns:

true if available

getEvaluation

public weka.clusterers.ClusterEvaluation getEvaluation()

Returns the stored Evaluation object.

Returns:

the evaluation, null if not present

setTemplate

public void setTemplate(weka.clusterers.Clusterer value)

Sets the stored template object.

Parameters:

value - the template

getTemplate

public weka.clusterers.Clusterer getTemplate()

Returns the stored template object.

Returns:

the template, null if not present

hasModel

public boolean hasModel()

Returns whether an model object is present.

Returns:

true if available

getModel

public weka.clusterers.Clusterer getModel()

Returns the stored model object.

Returns:

the model, null if not present

hasSupplementaryName

public boolean hasSupplementaryName()

Returns whether a name for the Supplementary object is present.

Returns:

true if available

getSupplementaryName

public String getSupplementaryName()

Returns the stored Supplementary name.

Returns:

the model, null if not present

hasSupplementaryData

public boolean hasSupplementaryData()

Returns whether an Supplementary object is present.

Returns:

true if available

getSupplementaryData

public Object getSupplementaryData()

Returns the stored Supplementary object.

Returns:

the model, null if not present

hasRunInformation

public boolean hasRunInformation()

Returns whether run information is present.

Returns:

true if available

getRunInformation

public adams.data.spreadsheet.MetaData getRunInformation()

Returns the stored run information.

Returns:

the information, null if not present

toString

public String toString()

Returns a short description of the container.

Specified by:

toString in class AbstractResultItem

Returns:

the description