src/org/biojava/dasobert/feature/FeatureTrack.java

   1 /*
   2  *                  BioJava development code
   3  *
   4  * This code may be freely distributed and modified under the
   5  * terms of the GNU Lesser General Public Licence.  This should
   6  * be distributed with the code.  If you do not have a copy,
   7  * see:
   8  *
   9  *      http://www.gnu.org/copyleft/lesser.html
  10  *
  11  * Copyright for this code is held jointly by the individual
  12  * authors.  These should be listed in @author doc comments.
  13  *
  14  * For more information on the BioJava project and its aims,
  15  * or to join the biojava-l mailing list, visit the home page
  16  * at:
  17  *
  18  *      http://www.biojava.org/
  19  *
  20  * Created on Feb 9, 2005
  21  *
  22  */
  23 package org.biojava.dasobert.feature;
  24
  25 import java.util.List;
  26
  27 /**
  28  * A feature corresponds to a track in Ensembl
  29  *
  30  * @author Andreas Prlic
  31  *
  32  */
  33 public interface FeatureTrack {
  34
  35
  36         public Object clone();
  37
  38     /** returns true if the specified sequence position is within the range of this Feature
  39      *
  40      * @param seqPosition the position to check
  41      * @return true if the position is within the ranges of the segments of this feature
  42      */
  43     public boolean overlaps(int seqPosition);
  44
  45     public  String toString();
  46
  47     public  void setSource(String s);
  48
  49     public  String getSource();
  50
  51     public  void setName(String nam);
  52
  53     public  String getName();
  54
  55     public  void setMethod(String methd);
  56
  57     public  String getMethod();
  58
  59     public  void setType(String typ);
  60
  61     public  String getType();
  62
  63     public  void setNote(String nte);
  64
  65     public  String getNote();
  66
  67     public  void setLink(String lnk);
  68
  69     public  String getLink();
  70
  71     public  void setScore(String score);
  72
  73     public  String getScore();
  74
  75     public void setOrientation(String orientation);
  76
  77     public String getOrientation();
  78
  79     /** test if two features are equivalent
  80      *
  81      * @param feat feature to compare with
  82      * @return true if equivalend
  83      */
  84     public abstract boolean equals(FeatureTrack feat);
  85
  86     /** add a segment to this feature
  87      *
  88      * @param start position
  89      * @param end position
  90      * @param name of feature
  91      */
  92     public abstract void addSegment(int start, int end, String name);
  93
  94     public abstract void addSegment(Segment s);
  95
  96     public abstract List getSegments();
  97
  98     /** set the data from the DAS - type - id field
  99      * (used for Ontology support)
 100      * @param typeID
 101      */
 102     public void setTypeID(String typeID);
 103
 104     /** set the data from the DAS - type - category field
 105      * (used for Ontology support)
 106      * @param typeCategory
 107      */
 108     public void setTypeCategory(String typeCategory);
 109
 110     public String getTypeID();
 111     public String getTypeCategory();
 112
 113 }