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

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2 Copyright @ 1999-2004, The Institute for Genomic Research (TIGR).
2 26 Feb 07 jari 3 All rights reserved.
2 26 Feb 07 jari 4  */
2 26 Feb 07 jari 5 /*
2 26 Feb 07 jari 6  * ScriptDocument.java
2 26 Feb 07 jari 7  *
2 26 Feb 07 jari 8  * Created on February 27, 2004, 9:59 PM
2 26 Feb 07 jari 9  */
2 26 Feb 07 jari 10
2 26 Feb 07 jari 11 package org.tigr.microarray.mev.script;
2 26 Feb 07 jari 12
2 26 Feb 07 jari 13 import org.tigr.microarray.mev.script.util.DocumentBase;
2 26 Feb 07 jari 14
2 26 Feb 07 jari 15 /** The ScriptDocument class contains script attributes
2 26 Feb 07 jari 16  * such as script name and script description.  ScriptDocument
2 26 Feb 07 jari 17  * extends <CODE>DocumentBase</CODE> which handles the script
2 26 Feb 07 jari 18  * content as a DOM.
2 26 Feb 07 jari 19  *
2 26 Feb 07 jari 20  * @author braisted
2 26 Feb 07 jari 21  */
2 26 Feb 07 jari 22 public class ScriptDocument extends DocumentBase {
2 26 Feb 07 jari 23     
2 26 Feb 07 jari 24     /** Script id
2 26 Feb 07 jari 25      */    
2 26 Feb 07 jari 26     private int id;
2 26 Feb 07 jari 27     /** Script name
2 26 Feb 07 jari 28      */    
2 26 Feb 07 jari 29     private String name;
2 26 Feb 07 jari 30     /** Script file name, if set
2 26 Feb 07 jari 31      */    
2 26 Feb 07 jari 32     private String fileName;    
2 26 Feb 07 jari 33     /** Script description
2 26 Feb 07 jari 34      */    
2 26 Feb 07 jari 35     private String description;
2 26 Feb 07 jari 36     /** Creation date
2 26 Feb 07 jari 37      */    
2 26 Feb 07 jari 38     private String date;
2 26 Feb 07 jari 39     
2 26 Feb 07 jari 40     /** Constructs a new ScriptDocument.
2 26 Feb 07 jari 41      * @param manager script manager
2 26 Feb 07 jari 42      * @param sid Script ID
2 26 Feb 07 jari 43      * @param fileName script file input file name
2 26 Feb 07 jari 44      */    
2 26 Feb 07 jari 45     public ScriptDocument(int sid, String fileName, ScriptManager manager) {
2 26 Feb 07 jari 46         super(manager);
2 26 Feb 07 jari 47         id = sid;
2 26 Feb 07 jari 48         this.fileName = fileName;
2 26 Feb 07 jari 49     }
2 26 Feb 07 jari 50
2 26 Feb 07 jari 51     /** Creates a new instance of ScriptDocument
2 26 Feb 07 jari 52      * @param manager script manager
2 26 Feb 07 jari 53      * @param id Script ID
2 26 Feb 07 jari 54      * @param name Script name attribute
2 26 Feb 07 jari 55      * @param description Script Description
2 26 Feb 07 jari 56      * @param date Creation data
2 26 Feb 07 jari 57      */
2 26 Feb 07 jari 58     public ScriptDocument(int id, String name, String description, String date, ScriptManager manager) {
2 26 Feb 07 jari 59         super(date, name, description, manager);
2 26 Feb 07 jari 60         this.id = id;
2 26 Feb 07 jari 61         this.name = name;
2 26 Feb 07 jari 62         this.description = description;
2 26 Feb 07 jari 63         this.date = date;
2 26 Feb 07 jari 64     }
2 26 Feb 07 jari 65     
2 26 Feb 07 jari 66     
2 26 Feb 07 jari 67     
2 26 Feb 07 jari 68     public ScriptDocument(ScriptDocument doc) {
2 26 Feb 07 jari 69         super(doc);
2 26 Feb 07 jari 70         this.id = doc.getDocumentID();
2 26 Feb 07 jari 71         this.name = doc.getDocumentName();
2 26 Feb 07 jari 72         this.description = doc.getDescription();        
2 26 Feb 07 jari 73     }
2 26 Feb 07 jari 74     
2 26 Feb 07 jari 75     /** Returns the document's name, or null if not set.
2 26 Feb 07 jari 76      * @return  */  
2 26 Feb 07 jari 77     
2 26 Feb 07 jari 78     public String getDocumentName() {
2 26 Feb 07 jari 79         return name;
2 26 Feb 07 jari 80     }
2 26 Feb 07 jari 81     
2 26 Feb 07 jari 82     /** Sets the document's file name.
2 26 Feb 07 jari 83      * @param name file name
2 26 Feb 07 jari 84      */    
2 26 Feb 07 jari 85     public void setDocumentFileName(String name) {
2 26 Feb 07 jari 86         fileName = name;
2 26 Feb 07 jari 87     }
2 26 Feb 07 jari 88     
2 26 Feb 07 jari 89     /** Returns the document's file name.
2 26 Feb 07 jari 90      * @return  */    
2 26 Feb 07 jari 91     public String getDocumentFileName() {
2 26 Feb 07 jari 92         if(fileName != null)
2 26 Feb 07 jari 93             return fileName;
2 26 Feb 07 jari 94         return "Not Assigned";
2 26 Feb 07 jari 95     }
2 26 Feb 07 jari 96     
2 26 Feb 07 jari 97     /** Returns the document ID.
2 26 Feb 07 jari 98      * @return  */    
2 26 Feb 07 jari 99     public int getDocumentID() {
2 26 Feb 07 jari 100         return id;
2 26 Feb 07 jari 101     }
2 26 Feb 07 jari 102     
2 26 Feb 07 jari 103     /** Returns the script description, or null if not set.
2 26 Feb 07 jari 104      */    
2 26 Feb 07 jari 105     public String getDescription() {
2 26 Feb 07 jari 106         return description;
2 26 Feb 07 jari 107     }
2 26 Feb 07 jari 108     
2 26 Feb 07 jari 109     /** Sets the script ID.
2 26 Feb 07 jari 110      * @param docID document id
2 26 Feb 07 jari 111      */        
2 26 Feb 07 jari 112     public void setID(int docID) {
2 26 Feb 07 jari 113         id = docID;
2 26 Feb 07 jari 114     }
2 26 Feb 07 jari 115         
2 26 Feb 07 jari 116     /** Sets the script name
2 26 Feb 07 jari 117      * @param docName document name
2 26 Feb 07 jari 118      */    
2 26 Feb 07 jari 119     public void setName(String docName) {
2 26 Feb 07 jari 120         name = docName;
2 26 Feb 07 jari 121     }
2 26 Feb 07 jari 122                 
2 26 Feb 07 jari 123     /** Sets script description.
2 26 Feb 07 jari 124      * @param docDesc script description
2 26 Feb 07 jari 125      */    
2 26 Feb 07 jari 126     public void setDescription(String docDesc) {
2 26 Feb 07 jari 127         description = docDesc;
2 26 Feb 07 jari 128     }
2 26 Feb 07 jari 129
2 26 Feb 07 jari 130 }

Generated on Thu Jul 20 09:30:44 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)