mev-4.0.01/source/org/tigr/microarray/mev/cluster/algorithm/impl/ease/EaseDataElement.java

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2 Copyright @ 1999-2003, 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  * $RCSfile: EaseDataElement.java,v $
2 26 Feb 07 jari 7  * $Revision: 1.1 $
2 26 Feb 07 jari 8  * $Date: 2004/02/06 22:55:36 $
2 26 Feb 07 jari 9  * $Author: braisted $
2 26 Feb 07 jari 10  * $State: Exp $
2 26 Feb 07 jari 11  */
2 26 Feb 07 jari 12 package org.tigr.microarray.mev.cluster.algorithm.impl.ease;
2 26 Feb 07 jari 13
2 26 Feb 07 jari 14 import java.util.Vector;
2 26 Feb 07 jari 15 /** This class encapsulates data structurs for encapsulating mappings between gene indices.
2 26 Feb 07 jari 16  * @author braisted
2 26 Feb 07 jari 17  */
2 26 Feb 07 jari 18 public class EaseDataElement {
2 26 Feb 07 jari 19     
2 26 Feb 07 jari 20     /** The element's index value
2 26 Feb 07 jari 21      */    
2 26 Feb 07 jari 22     private int index;
2 26 Feb 07 jari 23     /** This is a single key provided from mev annotation.
2 26 Feb 07 jari 24      */    
2 26 Feb 07 jari 25     private String mevKey;
2 26 Feb 07 jari 26     /** This is a set of values associated with the mev side key.  The structure
2 26 Feb 07 jari 27      * permits one to many associations.
2 26 Feb 07 jari 28      */    
2 26 Feb 07 jari 29     private Vector easeKeys;
2 26 Feb 07 jari 30     
2 26 Feb 07 jari 31     /** Creates a new instance of EaseDataElement
2 26 Feb 07 jari 32      * @param index Index value
2 26 Feb 07 jari 33      * @param mevKey annotation key
2 26 Feb 07 jari 34      */
2 26 Feb 07 jari 35     public EaseDataElement(int index, String mevKey) {
2 26 Feb 07 jari 36         this.index = index;
2 26 Feb 07 jari 37         this.mevKey = mevKey;
2 26 Feb 07 jari 38         this.easeKeys = new Vector();
2 26 Feb 07 jari 39     }
2 26 Feb 07 jari 40     
2 26 Feb 07 jari 41     /** Returns all Ease Keys as a <CODE>Vector</CODE>
2 26 Feb 07 jari 42      * @return
2 26 Feb 07 jari 43      */    
2 26 Feb 07 jari 44     public Vector getEaseKeys(){
2 26 Feb 07 jari 45         return easeKeys;
2 26 Feb 07 jari 46     }
2 26 Feb 07 jari 47     
2 26 Feb 07 jari 48     /** Adds an ease key (value) if the element's
2 26 Feb 07 jari 49      * key exists.
2 26 Feb 07 jari 50      * @param key mev key
2 26 Feb 07 jari 51      * @param value ease annotation index (ease key)
2 26 Feb 07 jari 52      * @return
2 26 Feb 07 jari 53      */    
2 26 Feb 07 jari 54     public boolean ifEqualsAdd(String key, String value){
2 26 Feb 07 jari 55         if(this.mevKey.equals(key)){
2 26 Feb 07 jari 56             //System.out.println("equal key = ***"+key+"*** value = ***"+value+"***");
2 26 Feb 07 jari 57             easeKeys.addElement(value);
2 26 Feb 07 jari 58             return true;
2 26 Feb 07 jari 59         }
2 26 Feb 07 jari 60         return false;        
2 26 Feb 07 jari 61     }
2 26 Feb 07 jari 62     
2 26 Feb 07 jari 63     /** Returns Vector of values if the key matches. (else null)
2 26 Feb 07 jari 64      * @param key
2 26 Feb 07 jari 65      * @return  */    
2 26 Feb 07 jari 66     public Vector ifEqualsGetEaseKeys(String key){
2 26 Feb 07 jari 67         if(mevKey.equals(key) && easeKeys.size() > 0)
2 26 Feb 07 jari 68             return easeKeys;
2 26 Feb 07 jari 69         return null;       
2 26 Feb 07 jari 70     }
2 26 Feb 07 jari 71     
2 26 Feb 07 jari 72     /** Returns an element's index.
2 26 Feb 07 jari 73      * @return  */    
2 26 Feb 07 jari 74     public int getIndex(){
2 26 Feb 07 jari 75         return index;
2 26 Feb 07 jari 76     }
2 26 Feb 07 jari 77     
2 26 Feb 07 jari 78     /** Returns the element's key value
2 26 Feb 07 jari 79      * @return  */    
2 26 Feb 07 jari 80     public String getMevKey(){
2 26 Feb 07 jari 81         return this.mevKey;
2 26 Feb 07 jari 82     }
2 26 Feb 07 jari 83     
2 26 Feb 07 jari 84     /** Returns the element's key value if it contains the argument as a value.
2 26 Feb 07 jari 85      */    
2 26 Feb 07 jari 86     public int ifContainsValueGetIndex(String value){
2 26 Feb 07 jari 87         if(this.easeKeys.contains(value))
2 26 Feb 07 jari 88             return index;
2 26 Feb 07 jari 89         return -1;
2 26 Feb 07 jari 90     }
2 26 Feb 07 jari 91     
2 26 Feb 07 jari 92     /** Adds the value passed if the EaseDataElement doesn't contain the value.
2 26 Feb 07 jari 93      * This maintains a unique value list.
2 26 Feb 07 jari 94      * @param value
2 26 Feb 07 jari 95      */    
2 26 Feb 07 jari 96     public void addValue(String value){
2 26 Feb 07 jari 97         if(!this.easeKeys.contains(value))
2 26 Feb 07 jari 98             this.easeKeys.addElement(value);
2 26 Feb 07 jari 99     }
2 26 Feb 07 jari 100 }

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