JAL-1479 added support for SIFTs mapping output viewing and implemented exception...

[jalview.git] / src / jalview / api / DBRefEntryI.java

diff --git a/src/jalview/api/DBRefEntryI.java b/src/jalview/api/DBRefEntryI.java
index 3238781..b927fa5 100644 (file)
--- a/src/jalview/api/DBRefEntryI.java
+++ b/src/jalview/api/DBRefEntryI.java
@@ -5,23 +5,68 @@ public interface DBRefEntryI
 {
   public boolean equalRef(DBRefEntryI entry);
 
+  /**
+   * 
+   * @return Source DB name for this entry
+   */
   public String getSource();
 
-  public String getVersion();
-
+  /**
+   * 
+   * @return Accession Id for this entry
+   */
   public String getAccessionId();
 
+  /**
+   * 
+   * @param accessionId
+   *          Accession Id for this entry
+   */
   public void setAccessionId(String accessionId);
 
+  /**
+   * 
+   * @param source
+   *          Source DB name for this entry
+   */
   public void setSource(String source);
 
+  /**
+   * 
+   * @return Source DB version for this entry
+   */
+  public String getVersion();
+
+  /**
+   * 
+   * @param version
+   *          Source DB version for this entry
+   */
   public void setVersion(String version);
 
+  /**
+   * 
+   * @param startRes
+   *          index of start residue in the source DB
+   */
   public void setStartRes(int startRes);
 
+  /**
+   * 
+   * @return index of start residue in the source DB
+   */
   public int getStartRes();
 
+  /**
+   * 
+   * @param endRes
+   *          index of end residue in the source DB
+   */
   public void setEndRes(int endRes);
 
+  /**
+   * 
+   * @return index of end residue in the source DB
+   */
   public int getEndRes();
 }