Class ResultItem

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, Serializable

    public class ResultItem
    extends AbstractNestableResultItem
    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.classifiers.Evaluation m_Evaluation
        the evaluation object.
      • m_FoldEvaluations

        protected weka.classifiers.Evaluation[] m_FoldEvaluations
        the evaluation objects from the folds.
      • m_RunEvaluations

        protected weka.classifiers.Evaluation[] m_RunEvaluations
        the evaluation objects from the runs.
      • m_Template

        protected weka.classifiers.Classifier m_Template
        the template.
      • m_Model

        protected weka.classifiers.Classifier m_Model
        the model.
      • m_FoldModels

        protected weka.classifiers.Classifier[] m_FoldModels
        the fold models.
      • m_RunModels

        protected weka.classifiers.Classifier[] m_RunModels
        the run models.
      • m_RunInformation

        protected adams.data.spreadsheet.MetaData m_RunInformation
        the run information.
      • m_OriginalIndices

        protected int[] m_OriginalIndices
        the original indices.
      • m_FoldOriginalIndices

        protected int[][] m_FoldOriginalIndices
        the original indices (folds).
      • m_RunOriginalIndices

        protected int[][] m_RunOriginalIndices
        the original indices (runs).
      • m_AdditionalAttributes

        protected adams.data.spreadsheet.SpreadSheet m_AdditionalAttributes
        additional attributes.
    • Constructor Detail

      • ResultItem

        public ResultItem​(weka.classifiers.Classifier 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​(adams.data.spreadsheet.MetaData runInfo)
        Updates the item.
        Parameters:
        runInfo - the meta-data for the run
        Returns:
        itself
      • update

        public ResultItem update​(weka.classifiers.Evaluation evaluation)
        Updates the item.
        Parameters:
        evaluation - the evaluation
        Returns:
        itself
      • update

        public ResultItem update​(weka.classifiers.Classifier model)
        Updates the item.
        Parameters:
        model - the model
        Returns:
        itself
      • update

        public ResultItem update​(int[] original)
        Updates the item.
        Parameters:
        original - the original indices
        Returns:
        itself
      • update

        public ResultItem update​(adams.data.spreadsheet.SpreadSheet additional)
        Updates the item.
        Parameters:
        additional - the additional attributes
        Returns:
        itself
      • updateFolds

        public ResultItem updateFolds​(weka.classifiers.Evaluation[] foldEvaluations)
        Updates the item.
        Parameters:
        foldEvaluations - the evaluations per fold
        Returns:
        itself
      • updateFolds

        public ResultItem updateFolds​(weka.classifiers.Classifier[] foldModels)
        Updates the item.
        Parameters:
        foldModels - the models per fold
        Returns:
        itself
      • updateFolds

        public ResultItem updateFolds​(int[][] foldOriginal)
        Updates the item.
        Parameters:
        foldOriginal - the original indices per fold
        Returns:
        itself
      • updateRuns

        public ResultItem updateRuns​(weka.classifiers.Evaluation[] runEvaluations)
        Updates the item.
        Parameters:
        runEvaluations - the evaluations per run
        Returns:
        itself
      • updateRuns

        public ResultItem updateRuns​(weka.classifiers.Classifier[] runModels)
        Updates the item.
        Parameters:
        runModels - the models per run
        Returns:
        itself
      • updateRuns

        public ResultItem updateRuns​(int[][] runOriginal)
        Updates the item.
        Parameters:
        runOriginal - the original indices per run
        Returns:
        itself
      • hasEvaluation

        public boolean hasEvaluation()
        Returns whether an Evaluation object is present.
        Returns:
        true if available
      • getEvaluation

        public weka.classifiers.Evaluation getEvaluation()
        Returns the stored Evaluation object.
        Returns:
        the evaluation, null if not present
      • hasFoldEvaluations

        public boolean hasFoldEvaluations()
        Returns whether Evaluation objects per fold are present.
        Returns:
        true if available
      • getFoldEvaluations

        public weka.classifiers.Evaluation[] getFoldEvaluations()
        Returns the stored Evaluation objects per fold.
        Returns:
        the evaluations per fold, null if not present
      • getFoldEvaluation

        public weka.classifiers.Evaluation getFoldEvaluation​(int index)
        Returns the stored Evaluation objects per specified fold.
        Parameters:
        index - the index of the fold to return
        Returns:
        the evaluation for the fold, null if not present
      • hasRunEvaluations

        public boolean hasRunEvaluations()
        Returns whether Evaluation objects per run are present.
        Returns:
        true if available
      • getRunEvaluations

        public weka.classifiers.Evaluation[] getRunEvaluations()
        Returns the stored Evaluation objects per run.
        Returns:
        the evaluations per run, null if not present
      • getRunEvaluation

        public weka.classifiers.Evaluation getRunEvaluation​(int index)
        Returns the stored Evaluation objects per specified run.
        Parameters:
        index - the index of the run to return
        Returns:
        the evaluation for the run, null if not present
      • setTemplate

        public void setTemplate​(weka.classifiers.Classifier value)
        Sets the stored template object.
        Parameters:
        value - the template
      • getTemplate

        public weka.classifiers.Classifier getTemplate()
        Returns the stored template object.
        Returns:
        the template
      • hasModel

        public boolean hasModel()
        Returns whether an model object is present.
        Returns:
        true if available
      • setModel

        public void setModel​(weka.classifiers.Classifier value)
        Sets the model to make available.
        Parameters:
        value - the model
      • getModel

        public weka.classifiers.Classifier getModel()
        Returns the stored model object.
        Returns:
        the model, null if not present
      • hasFoldModels

        public boolean hasFoldModels()
        Returns whether Classifier objects per fold are present.
        Returns:
        true if available
      • getFoldModels

        public weka.classifiers.Classifier[] getFoldModels()
        Returns the stored Classifier objects per fold.
        Returns:
        the classifiers per fold, null if not present
      • getFoldModel

        public weka.classifiers.Classifier getFoldModel​(int index)
        Returns the stored Classifier object for the specified fold.
        Parameters:
        index - the index of the fold
        Returns:
        the classifier for the fold, null if not present
      • hasRunModels

        public boolean hasRunModels()
        Returns whether Classifier objects per run are present.
        Returns:
        true if available
      • getRunModels

        public weka.classifiers.Classifier[] getRunModels()
        Returns the stored Classifier objects per run.
        Returns:
        the classifiers per run, 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
      • hasOriginalIndices

        public boolean hasOriginalIndices()
        Returns whether the original indices are present.
        Returns:
        true if available
      • getOriginalIndices

        public int[] getOriginalIndices()
        Returns the stored original indices.
        Returns:
        the indices, null if not present
      • hasFoldOriginalIndices

        public boolean hasFoldOriginalIndices()
        Returns whether the original indices per fold are present.
        Returns:
        true if available
      • getFoldOriginalIndices

        public int[][] getFoldOriginalIndices()
        Returns the stored original indices per fold.
        Returns:
        the indices, null if not present
      • getFoldOriginalIndices

        public int[] getFoldOriginalIndices​(int index)
        Returns the stored original indices for the specified fold.
        Parameters:
        index - the index of the fold to return
        Returns:
        the indices for the fold, null if not present
      • hasRunOriginalIndices

        public boolean hasRunOriginalIndices()
        Returns whether the original indices per run are present.
        Returns:
        true if available
      • getRunOriginalIndices

        public int[][] getRunOriginalIndices()
        Returns the stored original indices per run.
        Returns:
        the indices, null if not present
      • getRunOriginalIndices

        public int[] getRunOriginalIndices​(int index)
        Returns the stored original indices for the specified run.
        Parameters:
        index - the index of the run to return
        Returns:
        the indices for the run, null if not present
      • hasAdditionalAttributes

        public boolean hasAdditionalAttributes()
        Returns whether additional attributes data is present.
        Returns:
        true if available
      • setAdditionalAttributes

        public void setAdditionalAttributes​(adams.data.spreadsheet.SpreadSheet value)
        Sets the additional attributes data.
        Parameters:
        value - the data, null if not present
      • getAdditionalAttributes

        public adams.data.spreadsheet.SpreadSheet getAdditionalAttributes()
        Returns the stored additional attributes data.
        Returns:
        the data, null if not present
      • toString

        public String toString()
        Returns a short description of the container.
        Specified by:
        toString in class AbstractResultItem
        Returns:
        the description