mev-4.0.01/source/org/tigr/microarray/mev/script/util/AlgorithmNode.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  * AlgorithmNode.java
2 26 Feb 07 jari 7  *
2 26 Feb 07 jari 8  * Created on February 28, 2004, 4:25 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.util;
2 26 Feb 07 jari 12
2 26 Feb 07 jari 13
2 26 Feb 07 jari 14 import org.tigr.microarray.mev.cluster.algorithm.AlgorithmData;
2 26 Feb 07 jari 15
2 26 Feb 07 jari 16 /** Extension of ScriptNode to represent an algorithm node.
2 26 Feb 07 jari 17  * @author braisted
2 26 Feb 07 jari 18  */
2 26 Feb 07 jari 19 public class AlgorithmNode extends ScriptNode {
2 26 Feb 07 jari 20     
2 26 Feb 07 jari 21     /** Algorithm name
2 26 Feb 07 jari 22      */    
2 26 Feb 07 jari 23     String name;
2 26 Feb 07 jari 24     /** Alg ID
2 26 Feb 07 jari 25      */    
2 26 Feb 07 jari 26     int id;
2 26 Feb 07 jari 27     /** Parent data node referenct (ID)
2 26 Feb 07 jari 28      */    
2 26 Feb 07 jari 29     int dataNodeRef;
2 26 Feb 07 jari 30     /** Algorithm class
2 26 Feb 07 jari 31      */    
2 26 Feb 07 jari 32     String algType;
2 26 Feb 07 jari 33     /** Parameter container.
2 26 Feb 07 jari 34      */    
2 26 Feb 07 jari 35     AlgorithmData data;
2 26 Feb 07 jari 36         
2 26 Feb 07 jari 37     /** Next Algorithm node within an <CODE>AlgorithmSet</CODE>.
2 26 Feb 07 jari 38      * This is an optional thread through structures to connect
2 26 Feb 07 jari 39      * algorithms.
2 26 Feb 07 jari 40      */    
2 26 Feb 07 jari 41     AlgorithmNode nextNode;
2 26 Feb 07 jari 42     
2 26 Feb 07 jari 43     /** Creates a new instance of AlgorithmNode */
2 26 Feb 07 jari 44     public AlgorithmNode() {    
2 26 Feb 07 jari 45     }
2 26 Feb 07 jari 46     
2 26 Feb 07 jari 47     /** Creates a new AlgorithmNode
2 26 Feb 07 jari 48      * @param name Node name
2 26 Feb 07 jari 49      * @param id Algorithm node id.
2 26 Feb 07 jari 50      * @param dataNodeRef parent data node reference.
2 26 Feb 07 jari 51      * @param algType Algorithm Type attribute.
2 26 Feb 07 jari 52      */    
2 26 Feb 07 jari 53     public AlgorithmNode(String name, int id, int dataNodeRef, String algType) {
2 26 Feb 07 jari 54         this.name = name; 
2 26 Feb 07 jari 55         this.id = id; 
2 26 Feb 07 jari 56         this.dataNodeRef = dataNodeRef;
2 26 Feb 07 jari 57         this.algType = algType;
2 26 Feb 07 jari 58     }
2 26 Feb 07 jari 59
2 26 Feb 07 jari 60     /** Returns the string of the node.
2 26 Feb 07 jari 61      * @return  */    
2 26 Feb 07 jari 62     public String toString() {
2 26 Feb 07 jari 63         return name;
2 26 Feb 07 jari 64     }
2 26 Feb 07 jari 65     
2 26 Feb 07 jari 66     /** Returns the algorithm id.
2 26 Feb 07 jari 67      * @return
2 26 Feb 07 jari 68      */    
2 26 Feb 07 jari 69     public int getID() {
2 26 Feb 07 jari 70         return id;
2 26 Feb 07 jari 71     }
2 26 Feb 07 jari 72     
2 26 Feb 07 jari 73     /** Sets the algorithm's ID.
2 26 Feb 07 jari 74      */    
2 26 Feb 07 jari 75     public void setID(int ID) {
2 26 Feb 07 jari 76         id = ID;
2 26 Feb 07 jari 77     }    
2 26 Feb 07 jari 78     
2 26 Feb 07 jari 79     /** Sets the algorithm node name.
2 26 Feb 07 jari 80      */    
2 26 Feb 07 jari 81     public void setName(String Name) {
2 26 Feb 07 jari 82         name = Name;
2 26 Feb 07 jari 83     }
2 26 Feb 07 jari 84     
2 26 Feb 07 jari 85     /** returns the algorithm name.
2 26 Feb 07 jari 86      * @return
2 26 Feb 07 jari 87      */    
2 26 Feb 07 jari 88     public String getAlgorithmName() {
2 26 Feb 07 jari 89         return name;
2 26 Feb 07 jari 90     }
2 26 Feb 07 jari 91     
2 26 Feb 07 jari 92     /** Returns the id of the parent data node.
2 26 Feb 07 jari 93      */    
2 26 Feb 07 jari 94     public int getDataNodeRef() {
2 26 Feb 07 jari 95         return dataNodeRef;
2 26 Feb 07 jari 96     }
2 26 Feb 07 jari 97     
2 26 Feb 07 jari 98     /** Sets the data node reference.
2 26 Feb 07 jari 99      */    
2 26 Feb 07 jari 100     public void setDataNodeRef(int ref) {
2 26 Feb 07 jari 101         dataNodeRef = ref;
2 26 Feb 07 jari 102     }
2 26 Feb 07 jari 103     
2 26 Feb 07 jari 104     /** Returns the AlgorithmData object.
2 26 Feb 07 jari 105      * @return
2 26 Feb 07 jari 106      */    
2 26 Feb 07 jari 107     public AlgorithmData getAlgorithmData() {
2 26 Feb 07 jari 108         return data;
2 26 Feb 07 jari 109     }
2 26 Feb 07 jari 110     
2 26 Feb 07 jari 111     /** Sets the data (paremeter) object.
2 26 Feb 07 jari 112      */    
2 26 Feb 07 jari 113     public void setAlgorithmData(AlgorithmData aData) {
2 26 Feb 07 jari 114         data = aData;
2 26 Feb 07 jari 115     }
2 26 Feb 07 jari 116     
2 26 Feb 07 jari 117     /** Sets a reference to the next algorithm node.
2 26 Feb 07 jari 118      */    
2 26 Feb 07 jari 119     public void setNextNode(AlgorithmNode node) {
2 26 Feb 07 jari 120         nextNode = node;
2 26 Feb 07 jari 121     }
2 26 Feb 07 jari 122     
2 26 Feb 07 jari 123     /** Returns the nodes next algorithm node.
2 26 Feb 07 jari 124      */    
2 26 Feb 07 jari 125     public AlgorithmNode nextNode() {
2 26 Feb 07 jari 126         return nextNode;
2 26 Feb 07 jari 127     }
2 26 Feb 07 jari 128     
2 26 Feb 07 jari 129     /** Sets the algorithm type attribute.
2 26 Feb 07 jari 130      */    
2 26 Feb 07 jari 131     public void setAlgorithmType(String type) {
2 26 Feb 07 jari 132         algType = type;
2 26 Feb 07 jari 133     }
2 26 Feb 07 jari 134
2 26 Feb 07 jari 135     /** Returns the algorithm type.
2 26 Feb 07 jari 136      */    
2 26 Feb 07 jari 137     public String getAlgorithmType() {
2 26 Feb 07 jari 138         return algType;
2 26 Feb 07 jari 139     }
2 26 Feb 07 jari 140 }

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