/*
!=======================================================================
!
!  PROGRAM  PHASE-Viewer  (PHASE-Viewer 2014.01 ver.3.3.0)
!
!  Created on 2006/06/22, 17:23
!  AUTHOR(S): KOGA, Junichiro
!  File : Monitorable.java
!  
!  Contact address :  Phase System Consortium
!                     E-mail: phase_system@nims.go.jp URL https://azuma.nims.go.jp
!
!
!   Since 2002, this program set had been intensively developed as a part of the following 
!  national projects supported by the Ministry of Education, Culture, Sports, Science and
!  Technology (MEXT) of Japan; "Frontier Simulation Software for Industrial Science
!  (FSIS)" from 2002 to 2005, "Revolutionary Simulation Software (RSS21)" from 2006 to
!  2008. "Research and Development of Innovative Simulation Software (RISS)" from 2008
!  to 2013. These projects is lead by the Center for Research on Innovative Simulation 
!  Software (CISS), the Institute of Industrial Science (IIS), the University of Tokyo.
!   Since 2013, this program set has been further developed centering on PHASE System
!  Consortium. 
!   The activity of development of this program set has been supervised by Takahisa Ohno.
!
!=======================================================================
 */

package ciss.phase_viewer.file;

import javax.swing.JTextArea;

import ciss.phase_viewer.jobcontrol.MonitorPanelInterface;

import com.jcraft.jsch.Session;

/**
 * ジョブ実行中に「監視可能」なファイルはこのインターフェースを実装する. JobMonitorerなるクラスで利用される?
 * 
 * @author
 */
public interface Monitorable {

    /**
     * このメソッドが呼ばれたらモニターを開始する.
     * 
     * @param session
     *            モニターに必要なセッション; nullの場合はたぶんlocalhost.
     * @param textArea
     *            結果をここへ書き出す.
     */
    public void monitor(Session session, JTextArea textArea);

    /**
     * モニターを中止するメソッド.
     */
    public void stopMonitor();

    /**
     * モニターしている結果を元にグラフを作成する.
     * 
     * @param textArea
     *            このテキストコンポーネントの内容を参照してグラフを動的に作成.
     */
    public void createGraphFrom(JTextArea textArea);

    /**
     * グラフを非表示に. 必ず実装しなければならない, というほどでもないか?
     */
    public void destroyGraph();

    /**
     * 現在, このファイルが「モニター可能」ならば真を返す.
     * 
     * @return モニター可能な場合true.
     */
    public boolean isMonitorable();

    /**
     * 現在, グラフを作成することが可能ならば真を返す.
     * 
     * @param textArea
     *            このテキストコンポーネントの情報から判断する.
     * @return グラフ作成可能な場合は真.
     */
    public boolean isGraphCreatable(JTextArea textArea);

    /**
     * モニターしたいファイルを取得.
     * 
     * @return 対象となるファイル
     */
    public ChaseFile getChaseFile();

    /**
     * "モニター用GUI"をセット
     * 
     * @param モニター用のGUI
     *            .
     */
    public void setMonitorPanel(MonitorPanelInterface monitorPanel);
}
