weka.gui.beans.IncrementalClassifierEvent Maven / Gradle / Ivy

/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 *    IncrementalClassifierEvent.java
 *    Copyright (C) 2002-2012 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.gui.beans;

import java.util.EventObject;

import weka.classifiers.Classifier;
import weka.core.Instance;
import weka.core.Instances;

/**
 * Class encapsulating an incrementally built classifier and current instance
 *
 * @author Mark Hall
 * @version $Revision: 8034 $
 * @since 1.0
 * @see EventObject
 */
public class IncrementalClassifierEvent
  extends EventObject {

  /** for serialization */
  private static final long serialVersionUID = 28979464317643232L;

  public static final int NEW_BATCH = 0;
  public static final int WITHIN_BATCH = 1;
  public static final int BATCH_FINISHED = 2;

  private Instances m_structure;
  private int m_status;
  protected Classifier m_classifier;
  protected Instance m_currentInstance;

  /**
   * Creates a new IncrementalClassifierEvent instance.
   *
   * @param source the source of the event
   * @param scheme the classifier
   * @param currentI the current instance
   * @param status the status
   */
  public IncrementalClassifierEvent(Object source, Classifier scheme,
			 Instance currentI, int status) {
    super(source);
    //    m_trainingSet = trnI;
    m_classifier = scheme;
    m_currentInstance = currentI;
    m_status = status;
  }

  /**
   * Creates a new incremental classifier event that encapsulates
   * header information and classifier.
   *
   * @param source an Object value
   * @param scheme a Classifier value
   * @param structure an Instances value
   */
  public IncrementalClassifierEvent(Object source, Classifier scheme,
				    Instances structure) {
    super(source);
    m_structure = structure;
    m_status = NEW_BATCH;
    m_classifier = scheme;
  }

  public IncrementalClassifierEvent(Object source) {
    super(source);
  }

  /**
   * Get the classifier
   *
   * @return the classifier
   */
  public Classifier getClassifier() {
    return m_classifier;
  }
  
  public void setClassifier(Classifier c) {
    m_classifier = c;
  }

  /**
   * Get the current instance
   *
   * @return the current instance
   */
  public Instance getCurrentInstance() {
    return m_currentInstance;
  }

  /**
   * Set the current instance for this event
   *
   * @param i an Instance value
   */
  public void setCurrentInstance(Instance i) {
    m_currentInstance = i;
  }

  /**
   * Get the status
   *
   * @return an int value
   */
  public int getStatus() {
    return m_status;
  }

  /**
   * Set the status
   *
   * @param s an int value
   */
  public void setStatus(int s) {
    m_status = s;
  }

  /**
   * Set the instances structure
   *
   * @param structure an Instances value
   */
  public void setStructure(Instances structure) {
    m_structure = structure;
    m_currentInstance = null;
    m_status = NEW_BATCH;
  }

  /**
   * Get the instances structure (may be null if this is not
   * a NEW_BATCH event)
   *
   * @return an Instances value
   */
  public Instances getStructure() {
    return m_structure;
  }
}