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

Show more of this group Show more artifacts with this name
Show all versions of weka-dev Show documentation

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This version represents the developer version, the "bleeding edge" of development, you could say. New functionality gets added to this version.

There is a newer version: 3.9.6

Show newest version

/*
 *   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 .
 */

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

package weka.gui.beans;

import java.util.EventObject;

import weka.core.Instance;
import weka.core.Instances;

/**
 * Event that encapsulates a single instance or header information only
 * 
 * @author Mark Hall
 * @version $Revision: 9205 $
 * @see EventObject
 */
public class InstanceEvent extends EventObject {

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

  public static final int FORMAT_AVAILABLE = 0;
  public static final int INSTANCE_AVAILABLE = 1;
  public static final int BATCH_FINISHED = 2;

  private Instances m_structure;
  private Instance m_instance;
  private int m_status;

  /**
   * for FORMAT_AVAILABLE, if this is true then it indicates that this is not
   * the actual start of stream processing, but rather that a file/source has
   * changed via the user from the UI
   */
  protected boolean m_formatNotificationOnly = false;

  /**
   * Creates a new InstanceEvent instance that encapsulates a
   * single instance only.
   * 
   * @param source the source of the event
   * @param instance the instance
   * @param status status code (either INSTANCE_AVAILABLE or BATCH_FINISHED)
   */
  public InstanceEvent(Object source, Instance instance, int status) {
    super(source);
    m_instance = instance;
    m_status = status;
  }

  /**
   * Creates a new InstanceEvent instance which encapsulates header
   * information only.
   * 
   * @param source an Object value
   * @param structure an Instances value
   */
  public InstanceEvent(Object source, Instances structure) {
    super(source);
    m_structure = structure;
    m_status = FORMAT_AVAILABLE;
  }

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

  /**
   * Get the instance
   * 
   * @return an Instance value
   */
  public Instance getInstance() {
    return m_instance;
  }

  /**
   * Set the instance
   * 
   * @param i an Instance value
   */
  public void setInstance(Instance i) {
    m_instance = 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;

    if (m_status != FORMAT_AVAILABLE) {
      m_formatNotificationOnly = false;
    }
  }

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

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