X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FDBRefEntry.java;h=0004abe7068b971dece2c1e8b87224627fc909f8;hb=a83adb45bdf9554e270921b4baad94defd314b36;hp=a641b1bfdd3300ed55c4d8044512dd27efa06448;hpb=7596cd64543481df859a9bd2e73a3b3bb6b2e42c;p=jalview.git diff --git a/src/jalview/datamodel/DBRefEntry.java b/src/jalview/datamodel/DBRefEntry.java index a641b1b..0004abe 100755 --- a/src/jalview/datamodel/DBRefEntry.java +++ b/src/jalview/datamodel/DBRefEntry.java @@ -21,10 +21,35 @@ package jalview.datamodel; import jalview.api.DBRefEntryI; +import jalview.util.DBRefUtils; +import jalview.util.MapList; + +import java.util.List; public class DBRefEntry implements DBRefEntryI { - String source = "", version = "", accessionId = ""; + /* + * the mapping to chromosome (genome) is held as an instance with + * source = speciesId + * version = assemblyId + * accessionId = "chromosome:" + chromosomeId + * map = mapping from sequence to reference assembly + */ + public static final String CHROMOSOME = "chromosome"; + + private String source = ""; + + private String version = ""; + + private String ucversion = ""; + + private String accessionId = ""; + + int sourceKey = Integer.MIN_VALUE; + + String canonicalSourceName; + + /** * maps from associated sequence to the database sequence's coordinate system */ @@ -34,8 +59,12 @@ public class DBRefEntry implements DBRefEntryI { } - - +/** + * + * @param source may not be null + * @param version may be null + * @param accessionId may be null + */ public DBRefEntry(String source, String version, String accessionId) { this(source, version, accessionId, null); @@ -44,31 +73,36 @@ public class DBRefEntry implements DBRefEntryI /** * * @param source - * canonical source (uppercase only) + * canonical source (turned to uppercase; cannot be null) * @param version - * (source dependent version string) + * (source dependent version string or null) * @param accessionId - * (source dependent accession number string) + * (source dependent accession number string or null) * @param map * (mapping from local sequence numbering to source accession - * numbering) + * numbering or null) */ public DBRefEntry(String source, String version, String accessionId, Mapping map) { + this.source = source.toUpperCase(); - this.version = version; + setVersion(version); this.accessionId = accessionId; this.map = map; } + /** + * Clone an entry, this time not allowing any null fields except map. + * + */ public DBRefEntry(DBRefEntryI entry) { this((entry.getSource() == null ? "" : new String(entry.getSource())), - (entry.getVersion() == null ? "" : new String( - entry.getVersion())), - (entry.getAccessionId() == null ? "" : new String( - entry.getAccessionId())), + (entry.getVersion() == null ? "" + : new String(entry.getVersion())), + (entry.getAccessionId() == null ? "" + : new String(entry.getAccessionId())), (entry.getMap() == null ? null : new Mapping(entry.getMap()))); } @@ -77,22 +111,28 @@ public class DBRefEntry implements DBRefEntryI { // TODO should also override hashCode to ensure equal objects have equal // hashcodes - if (o == null || !(o instanceof DBRefEntry)) - { - return false; - } - DBRefEntry entry = (DBRefEntry) o; - if (entry == this) - { - return true; - } - if (equalRef(entry) - && ((map == null && entry.map == null) || (map != null - && entry.map != null && map.equals(entry.map)))) - { - return true; - } - return false; + + +// if (o == null || !(o instanceof DBRefEntry)) +// { +// return false; +// } +// DBRefEntry entry = (DBRefEntry) o; +// if (entry == this) +// { +// return true; +// } + Mapping em; + return (o != null && o instanceof DBRefEntry + && (o == this + || equalRef((DBRefEntry) o) + && (map == null) == ((em = ((DBRefEntry) o).map) == null) + && (map == null || map.equals(em)))); +// +// { +// return true; +// } +// return false; } /** @@ -101,7 +141,8 @@ public class DBRefEntry implements DBRefEntryI * @@ -138,7 +179,8 @@ public class DBRefEntry implements DBRefEntryI String otherAccession = other.getAccessionId(); if ((accessionId == null && otherAccession != null) || (accessionId != null && otherAccession == null) - || (accessionId != null && !accessionId.equalsIgnoreCase(otherAccession))) + || (accessionId != null + && !accessionId.equalsIgnoreCase(otherAccession))) { return false; } @@ -148,7 +190,7 @@ public class DBRefEntry implements DBRefEntryI * otherwise the versions have to match */ String otherVersion = other.getVersion(); - + if ((version == null || version.equals("0") || version.endsWith(":0")) && otherVersion != null) { @@ -156,9 +198,8 @@ public class DBRefEntry implements DBRefEntryI } else { - if (version != null - && (otherVersion == null || !version - .equalsIgnoreCase(otherVersion))) + if (version != null && (otherVersion == null + || !version.equalsIgnoreCase(otherVersion))) { return false; } @@ -192,17 +233,17 @@ public class DBRefEntry implements DBRefEntryI { return true; } - if (entry != null - && (source != null && entry.getSource() != null && source - .equalsIgnoreCase(entry.getSource())) - && (accessionId != null && entry.getAccessionId() != null && accessionId - .equalsIgnoreCase(entry.getAccessionId())) - && (version != null && entry.getVersion() != null && version - .equalsIgnoreCase(entry.getVersion()))) - { - return true; - } - return false; + + // BH 2019.01.25/2019.02.04 source cannot/should not be null. + // for example, StructureChooser has dbRef.getSource().equalsIgnoreCase... + + return (entry != null + && (source != null && entry.getSource() != null + && source.equalsIgnoreCase(entry.getSource())) + && (accessionId != null && entry.getAccessionId() != null + && accessionId.equalsIgnoreCase(entry.getAccessionId())) + && (version != null && entry.getVersion() != null + && version.equalsIgnoreCase(entry.getVersion()))); } @Override @@ -211,40 +252,56 @@ public class DBRefEntry implements DBRefEntryI return source; } + public int getSourceKey() + { + return (sourceKey == Integer.MIN_VALUE ? (sourceKey = DBRefSource.getSourceKey(getCanonicalSourceName())) : sourceKey); + } + + /** + * can be null + */ @Override public String getVersion() { return version; } + /** + * can be null + */ @Override public String getAccessionId() { return accessionId; } - @Override public void setAccessionId(String accessionId) { - this.accessionId = accessionId; + this.accessionId = accessionId; +// this.accessionId = (accessionId == null ? "" : accessionId).toUpperCase(); } - + /** + * CAUTION! allows setting source null or not uppercase! + */ @Override public void setSource(String source) { - this.source = source; + this.source = source; + +// this.source = (source == null ? "" : source).toUpperCase(); +// this.canonicalSourceName = DBRefUtils.getCanonicalName(this.source); +// this.sourceKey = DBRefSource.getSourceKey(this.canonicalSourceName); } - @Override public void setVersion(String version) { this.version = version; + this.ucversion = (version == null ? null : version.toUpperCase()); } - @Override public Mapping getMap() { @@ -280,4 +337,68 @@ public class DBRefEntry implements DBRefEntryI { return getSrcAccString(); } + + @Override + public boolean isPrimaryCandidate() + { + /* + * if a map is present, unless it is 1:1 and has no SequenceI mate, it cannot be a primary reference. + */ + if (map != null) + { + SequenceI mto = map.getTo(); + if (mto != null) + { + return false; + } + MapList ml = map.getMap(); + if (ml.getFromRatio() != ml.getToRatio() + || ml.getFromRatio() != 1) + { + return false; + } + // check map is between identical single contiguous ranges + List fromRanges, toRanges; + if ((fromRanges = ml.getFromRanges()).size() != 1 || (toRanges = ml.getToRanges()).size() != 1) + { + return false; + } + if (fromRanges.get(0)[0] != toRanges.get(0)[0] + || fromRanges.get(0)[1] != toRanges.get(0)[1]) + { + return false; + } + } + if (version == null) + { + // no version string implies the reference has not been verified at all. + return false; + } + + return DBRefSource.isPrimaryCandidate(ucversion); + } + + /** + * Mappings to chromosome are held with accessionId as "chromosome:id" + * + * @return + */ + public boolean isChromosome() + { + return accessionId != null && accessionId.startsWith(CHROMOSOME + ":"); + } + + /** + * stores the upper-case canonical name of the source for use in + * Sequence.getPrimaryDBRefs(). + * + * @author Bob Hanson + * + * @return + */ + public String getCanonicalSourceName() { + return (canonicalSourceName == null ? (canonicalSourceName = DBRefUtils.getCanonicalName(this.source)) : canonicalSourceName); + } + + }