merge from 2_4_Release branch
[jalview.git] / src / org / biojava / dasobert / eventmodel / FeatureEvent.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 Oct 28, 2005
21  *
22  */
23 package org.biojava.dasobert.eventmodel;
24
25 import java.util.*;
26
27 import org.biojava.dasobert.dasregistry.*;
28
29 public class FeatureEvent extends AbstractDasEvent
30 {
31
32   Map[] features;
33
34   int comeBackLater;
35
36   String version;
37
38   public FeatureEvent(Map[] features, Das1Source dasSource, String version)
39   {
40     super();
41     this.features = features;
42     this.dasSource = dasSource;
43     comeBackLater = -1;
44     this.version = version;
45   }
46
47   public int getComeBackLater()
48   {
49     return comeBackLater;
50   }
51
52   public void setComeBackLater(int comeBackLater)
53   {
54     this.comeBackLater = comeBackLater;
55   }
56
57   /**
58    * get the features that have been found.
59    * 
60    * do something like Map[] features = event.getFeatures();
61    * 
62    * <pre>
63    * for (int i = 0; i &lt; features; i++)
64    * {
65    *   Map f = features[i];
66    *   String type = (String) f.get(&quot;TYPE&quot;);
67    *   System.out.println(type);
68    * }
69    * </pre>
70    * 
71    * @return a Map containng the features
72    */
73   public Map[] getFeatures()
74   {
75     return features;
76   }
77
78   /**
79    * Get the version of the reference object that has been annotated. Compare
80    * the version string with the version string obtained from the reference
81    * server. If they don;t match there is a version problem between the
82    * annotation and the reference!
83    * 
84    * @return the version string (e.g. an MD5 digest of the reference sequence)
85    */
86   public String getVersion()
87   {
88     return version;
89   }
90
91   public void setVersion(String version)
92   {
93     this.version = version;
94   }
95
96 }