Merge branch 'apifix/JAL-1926_JAL-2106' into develop
authorJim Procter <jprocter@issues.jalview.org>
Tue, 31 May 2016 18:02:01 +0000 (19:02 +0100)
committerJim Procter <jprocter@issues.jalview.org>
Tue, 31 May 2016 18:02:01 +0000 (19:02 +0100)
src/jalview/api/DBRefEntryI.java

index 49858cb..2ce7e4a 100644 (file)
@@ -1,6 +1,5 @@
 package jalview.api;
 
-import jalview.datamodel.DBRefEntry;
 import jalview.datamodel.Mapping;
 
 //JBPComment: this is a datamodel API - so it should be in datamodel (it's a peer of SequenceI)
@@ -74,6 +73,12 @@ public interface DBRefEntryI
    */
   public int getEndRes();
 
+  /**
+   * access a mapping, if present that can be used to map positions from the
+   * associated dataset sequence to the DBRef's sequence frame.
+   * 
+   * @return null or a valid mapping.
+   */
   public Mapping getMap();
 
   /**
@@ -90,5 +95,5 @@ public interface DBRefEntryI
    * @param otherEntry
    * @return
    */
-  public boolean updateFrom(DBRefEntry otherEntry);
+  public boolean updateFrom(DBRefEntryI otherEntry);
 }