mev-4.0.01/source/org/tigr/microarray/mev/script/Script.java

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2  * Script.java
2 26 Feb 07 jari 3  *
2 26 Feb 07 jari 4  * Created on March 18, 2004, 11:40 AM
2 26 Feb 07 jari 5  */
2 26 Feb 07 jari 6
2 26 Feb 07 jari 7 package org.tigr.microarray.mev.script;
2 26 Feb 07 jari 8
2 26 Feb 07 jari 9 import org.tigr.microarray.mev.script.scriptGUI.ScriptXMLViewer;
2 26 Feb 07 jari 10 import org.tigr.microarray.mev.script.util.ScriptTree;
2 26 Feb 07 jari 11
2 26 Feb 07 jari 12 /** High level single script wrapper containing the basic script classes supporting
2 26 Feb 07 jari 13  * data storage and graphical representation.
2 26 Feb 07 jari 14  * The class encapsulates instances of <CODE>ScriptTree</CODE> <CODE>ScriptXMLViewer</CODE>
2 26 Feb 07 jari 15  * and <CODE>ScriptDocument</CODE> objects.
2 26 Feb 07 jari 16  * @author braisted
2 26 Feb 07 jari 17  */
2 26 Feb 07 jari 18 public class Script {
2 26 Feb 07 jari 19     
2 26 Feb 07 jari 20     private ScriptDocument document;
2 26 Feb 07 jari 21     private ScriptTree scriptTree;
2 26 Feb 07 jari 22     private ScriptXMLViewer xmlViewer;
2 26 Feb 07 jari 23     
2 26 Feb 07 jari 24     /** Creates a new instance of Script
2 26 Feb 07 jari 25      * @param doc Enclosed ScriptDocument object.
2 26 Feb 07 jari 26      * @param tree ScriptTree data structure.
2 26 Feb 07 jari 27      * @param xViewer XMLViewer XML based viewer option.
2 26 Feb 07 jari 28      */
2 26 Feb 07 jari 29     public Script(ScriptDocument doc, ScriptTree tree, ScriptXMLViewer xViewer) {
2 26 Feb 07 jari 30         document = doc;
2 26 Feb 07 jari 31         scriptTree = tree;
2 26 Feb 07 jari 32         xmlViewer = xViewer;
2 26 Feb 07 jari 33     }
2 26 Feb 07 jari 34
2 26 Feb 07 jari 35     /** Returns the enclosed <CODE>ScriptDocument</CODE>
2 26 Feb 07 jari 36      * @return
2 26 Feb 07 jari 37      */    
2 26 Feb 07 jari 38     public ScriptDocument getScriptDocument() {
2 26 Feb 07 jari 39         return document;
2 26 Feb 07 jari 40     }   
2 26 Feb 07 jari 41
2 26 Feb 07 jari 42     /** Returns the <CODE>ScriptTree</CODE> object.
2 26 Feb 07 jari 43      * @return
2 26 Feb 07 jari 44      */    
2 26 Feb 07 jari 45     public ScriptTree getScriptTree() {
2 26 Feb 07 jari 46         return scriptTree;
2 26 Feb 07 jari 47     }   
2 26 Feb 07 jari 48
2 26 Feb 07 jari 49     /** Returns the XML view (<CODE>ScriptXMLViewer</CODE>)of the script.
2 26 Feb 07 jari 50      */    
2 26 Feb 07 jari 51     public ScriptXMLViewer getXMLViewer() {
2 26 Feb 07 jari 52         return xmlViewer;
2 26 Feb 07 jari 53     }   
2 26 Feb 07 jari 54 }