weka.gui.scripting.ScriptingPanel Maven / Gradle / Ivy

Go to download
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 .
 */

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

package weka.gui.scripting;

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.io.File;
import java.io.InputStreamReader;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.io.Reader;
import java.util.HashSet;
import java.util.Iterator;

import javax.swing.ImageIcon;
import javax.swing.JFrame;
import javax.swing.JMenuBar;
import javax.swing.JPanel;
import javax.swing.JTextPane;

import weka.core.Tee;
import weka.gui.PropertyDialog;
import weka.gui.ReaderToTextPane;
import weka.gui.scripting.event.TitleUpdatedEvent;
import weka.gui.scripting.event.TitleUpdatedListener;

/**
 * Abstract ancestor for scripting panels.
 * 
 * @author  fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 15290 $
 */
public abstract class ScriptingPanel
  extends JPanel
  implements TitleUpdatedListener {

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

  /** The new output stream for System.out. */
  protected PipedOutputStream m_POO;

  /** The new output stream for System.err. */
  protected PipedOutputStream m_POE;

  /** The thread that sends output from m_POO to the output box. */
  protected ReaderToTextPane m_OutRedirector;

  /** The thread that sends output from m_POE to the output box. */
  protected ReaderToTextPane m_ErrRedirector;

  /** The Tee that the output stream will be part of. We need a reference to
   * it at the class level so that we can remove the stream from it when
   * the panel is terminated. */
  protected Tee m_Tee;

  /** The print stream that is wrapped around the piped output stream. We need a
   * a reference to it at the class level so that we can remove it from the tee
   * when the panel is terminated.
   */
  protected PrintStream m_PrintStream;

  /** The Tee that the err stream will be part of. We need a reference to
   * it at the class level so that we can remove the stream from it when
   * the panel is terminated. */
  protected Tee m_ErrTee;

  /** The print stream that is wrapped around the piped error output stream. We need a
   * a reference to it at the class level so that we can remove it from the tee
   * when the panel is terminated.
   */
  protected PrintStream m_ErrPrintStream;
  /** whether debug mode is on. */
  protected boolean m_Debug;
  
  /** the listeners for the changes in the title. */
  protected HashSet m_TitleUpdatedListeners;

  /**
   * Default constructor.
   */
  public ScriptingPanel() {
    super();
    
    initialize();
    initGUI();
    initFinish();
  }
  
  /**
   * For initializing member variables.
   */
  protected void initialize() {
    m_POO            = new PipedOutputStream();
    m_POE            = new PipedOutputStream();
    m_Debug          = false;
    m_TitleUpdatedListeners = new HashSet();
  }
  
  /**
   * Sets up the GUI after initializing the members.
   * The JTextArea returned via getOutputArea() must be setup here.
   * 
   * @see	#initialize()
   * @see	#getOutput()
   */
  protected void initGUI() {
  }
  
  /**
   * Finishes up after initializing members and setting up the GUI.
   * Redirects stdout and stderr using getOutputArea().
   * 
   * @see	#initialize()
   * @see	#initGUI()
   * @see	#getOutput()
   */
  protected void initFinish() {
    // Redirect System.out to the text area
    try {
      PipedInputStream pio = new PipedInputStream(m_POO);
      m_Tee = new Tee(System.out);
      System.setOut(m_Tee);
      m_PrintStream = new PrintStream(m_POO);
      m_Tee.add(m_PrintStream);
      Reader reader = new InputStreamReader(pio);
      m_OutRedirector = new ReaderToTextPane(reader, getOutput(), Color.BLACK);
      m_OutRedirector.start();
    }
    catch (Exception e) {
      System.err.println("Error redirecting stdout");
      e.printStackTrace();
      m_OutRedirector = null;
    }

    // Redirect System.err to the text area
    try {
      PipedInputStream pie = new PipedInputStream(m_POE);
      m_ErrTee = new Tee(System.err);
      System.setErr(m_ErrTee);
      m_ErrPrintStream = new PrintStream(m_POE);
      m_ErrTee.add(m_ErrPrintStream);
      Reader reader = new InputStreamReader(pie);
      m_ErrRedirector = new ReaderToTextPane(reader, getOutput(), Color.RED);
      m_ErrRedirector.start();
    }
    catch (Exception e) {
      System.err.println("Error redirecting stderr");
      e.printStackTrace();
      m_ErrRedirector = null;
    }

    addTitleUpdatedListener(this);
  }

  /**
   * Terminates this panel, i.e., terminates the output threads it started. Removes
   * the output and error streams from the corresponding tees as well so that garbage collection succeeds.
   */
  public void terminate() {

    m_ErrRedirector.interrupt();
    m_OutRedirector.interrupt();
    m_Tee.remove(m_PrintStream);
    m_ErrTee.remove(m_ErrPrintStream);

  }

  /**
   * Returns an icon to be used in a frame.
   * 
   * @return		the icon
   */
  public abstract ImageIcon getIcon();
  
  /**
   * Returns the current title for the frame/dialog.
   * 
   * @return		the title
   */
  public abstract String getTitle();
  
  /**
   * Returns the text area that is used for displaying output on stdout
   * and stderr.
   * 
   * @return		the JTextArea
   */
  public abstract JTextPane getOutput();
  
  /**
   * Returns the menu bar to to be displayed in the frame.
   * 
   * @return		the menu bar, null if not applicable
   */
  public abstract JMenuBar getMenuBar();
  
  /**
   * Turns on/off debugging mode.
   * 
   * @param value	if true, debug mode is turned on
   */
  public void setDebug(boolean value) {
    m_Debug = value;
  }
  
  /**
   * Returns whether debugging mode is on.
   * 
   * @return		true if debug mode is turned on
   */
  public boolean getDebug() {
    return m_Debug;
  }
  
  /**
   * Adds the listener to the internal list.
   * 
   * @param l		the listener to add
   */
  public void addTitleUpdatedListener(TitleUpdatedListener l) {
    m_TitleUpdatedListeners.add(l);
  }
  
  /**
   * Removes the listener from the internal list.
   * 
   * @param l		the listener to remove
   */
  public void removeTitleUpdatedListener(TitleUpdatedListener l) {
    m_TitleUpdatedListeners.remove(l);
  }
  
  /**
   * Sends the event to all listeners for title updates.
   * 
   * @param e		the event to send
   */
  protected void notifyTitleUpdatedListeners(TitleUpdatedEvent e) {
    Iterator	iter;
    
    iter = m_TitleUpdatedListeners.iterator();
    while (iter.hasNext())
      iter.next().titleUpdated(e);
  }
  
  /**
   * Gets called when the title of the frame/dialog needs updating.
   * 
   * @param event	the event that got sent
   */
  public void titleUpdated(TitleUpdatedEvent event) {
    if (PropertyDialog.getParentDialog(ScriptingPanel.this) != null)
      PropertyDialog.getParentDialog(ScriptingPanel.this).setTitle(getTitle());
    else if (PropertyDialog.getParentFrame(ScriptingPanel.this) != null)
      PropertyDialog.getParentFrame(ScriptingPanel.this).setTitle(getTitle());
  }
  
  /**
   * Displays the panel in a frame.
   * 
   * @param panel	the panel to display
   * @param args	currently ignored commandline parameters
   */
  public static void showPanel(ScriptingPanel panel, String[] args) {
    showPanel(panel, args, 800, 600);
  }
  
  /**
   * Displays the panel in a frame.
   * 
   * @param panel	the panel to display
   * @param args	currently ignored commandline parameters
   * @param width	the width of the frame
   * @param height	the height of the frame
   */
  public static void showPanel(ScriptingPanel panel, String[] args, int width, int height) {
    try {
      JFrame frame = new JFrame();
      frame.getContentPane().setLayout(new BorderLayout());
      frame.getContentPane().add(panel, BorderLayout.CENTER);
      frame.setJMenuBar(panel.getMenuBar());
      frame.setSize(new Dimension(width, height));
      frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
      frame.setTitle(panel.getTitle());
      frame.setIconImage(panel.getIcon().getImage());
      frame.setLocationRelativeTo(null);
      if ((args.length > 0) && (panel instanceof FileScriptingPanel))
	((FileScriptingPanel) panel).open(new File(args[0]));
      frame.setVisible(true);
    }
    catch (Exception e) {
      e.printStackTrace();
    }
  }
}