X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2FDBRefEntryI.java;h=52ee381454316a90ba1cd0b3d268c1c5bf688204;hb=ac93424cd4c19aa35f7831e4f3da7bbcaf6baf15;hp=701acb663ce60ad3b3e5fe30fa5d437f5b40a210;hpb=168ef5a045478ef56a5d9f8c71fbddb53a6b8a58;p=jalview.git diff --git a/src/jalview/api/DBRefEntryI.java b/src/jalview/api/DBRefEntryI.java index 701acb6..52ee381 100644 --- a/src/jalview/api/DBRefEntryI.java +++ b/src/jalview/api/DBRefEntryI.java @@ -72,26 +72,23 @@ public interface DBRefEntryI public boolean updateFrom(DBRefEntryI otherEntry); /** - * Method to distinguish between direct and indirect database references - * - * primary references indicate the local sequence data directly corresponds - * with the database record. All other references are secondary. direct + * Answers true if the ref looks like a primary (direct) database reference.
+ * The only way a dbref's mappings can be fully verified is via the local + * sequence frame, so rather than use isPrimaryCandidate directly, please use + * SequenceI.getPrimaryDbRefs().
+ * Primary references indicate the local sequence data directly corresponds + * with the database record. All other references are secondary. Direct * references indicate that part or all of the local sequence data can be * mapped with another sequence, enabling annotation transfer. - * cross-references indicate the local sequence data can be corresponded to - * some other linear coordinate system via a transformation. - * + * Cross-references indicate the local sequence data can be corresponded to + * some other linear coordinate system via a transformation.
* This method is also sufficient to distinguish direct DBRefEntry mappings * from other relationships - e.g. coding relationships (imply a 1:3/3:1 * mapping), but not transcript relationships, which imply a (possibly - * non-contiguous) 1:1 mapping - * - * The only way a dbref's mappings can be fully verified is via the local - * sequence frame, so rather than use isPrimary directly, please use - * SequenceI.getPrimaryDbRefs() + * non-contiguous) 1:1 mapping. * * @return true if this reference provides a primary accession for the * associated sequence object */ - public boolean isPrimary(); + public boolean isPrimaryCandidate(); }