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

Class 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 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

      • update

        public ResultItem update​(weka.clusterers.ClusterEvaluation evaluation)
        Updates the item.
        Parameters:
        evaluation - the evaluation, can be null
        Returns:
        itself

      • update

        public ResultItem update​(weka.clusterers.Clusterer model)
        Updates the item.
        Parameters:
        model - the model, can be null
        Returns:
        itself

      • update

        public ResultItem update​(adams.data.spreadsheet.MetaData runInfo)
        Updates the item.
        Parameters:
        runInfo - the run information, can be null
        Returns:
        itself

      • updateSupplementary

        public ResultItem updateSupplementary​(String supplementaryName)
        Updates the item.
        Parameters:
        supplementaryName - the name for the supplementary data, can be null
        Returns:
        itself

      • updateSupplementary

        public ResultItem updateSupplementary​(Serializable supplementaryData)
        Updates the item.
        Parameters:
        supplementaryData - the supplementary data, can be null
        Returns:
        itself

      • 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