src/jalview/datamodel/DBRefEntry.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 import jalview.api.DBRefEntryI;
  24
  25 import java.util.Arrays;
  26 import java.util.List;
  27
  28 public class DBRefEntry implements DBRefEntryI
  29 {
  30   String source = "", version = "", accessionId = "";
  31
  32   /**
  33    * maps from associated sequence to the database sequence's coordinate system
  34    */
  35   Mapping map = null;
  36
  37   public DBRefEntry()
  38   {
  39
  40   }
  41
  42   public DBRefEntry(String source, String version, String accessionId)
  43   {
  44     this(source, version, accessionId, null);
  45   }
  46
  47   /**
  48    *
  49    * @param source
  50    *          canonical source (uppercase only)
  51    * @param version
  52    *          (source dependent version string)
  53    * @param accessionId
  54    *          (source dependent accession number string)
  55    * @param map
  56    *          (mapping from local sequence numbering to source accession
  57    *          numbering)
  58    */
  59   public DBRefEntry(String source, String version, String accessionId,
  60           Mapping map)
  61   {
  62     this.source = source.toUpperCase();
  63     this.version = version;
  64     this.accessionId = accessionId;
  65     this.map = map;
  66   }
  67
  68   public DBRefEntry(DBRefEntryI entry)
  69   {
  70     this((entry.getSource() == null ? "" : new String(entry.getSource())),
  71             (entry.getVersion() == null ? ""
  72                     : new String(entry.getVersion())),
  73             (entry.getAccessionId() == null ? ""
  74                     : new String(entry.getAccessionId())),
  75             (entry.getMap() == null ? null : new Mapping(entry.getMap())));
  76   }
  77
  78   @Override
  79   public boolean equals(Object o)
  80   {
  81     // TODO should also override hashCode to ensure equal objects have equal
  82     // hashcodes
  83     if (o == null || !(o instanceof DBRefEntry))
  84     {
  85       return false;
  86     }
  87     DBRefEntry entry = (DBRefEntry) o;
  88     if (entry == this)
  89     {
  90       return true;
  91     }
  92     if (equalRef(entry) && ((map == null && entry.map == null)
  93             || (map != null && entry.map != null && map.equals(entry.map))))
  94     {
  95       return true;
  96     }
  97     return false;
  98   }
  99
 100   /**
 101    * Answers true if this object is either equivalent to, or can be 'improved'
 102    * by, the given entry. Specifically, answers true if
 103    * <ul>
 104    * <li>source and accession are identical (ignoring case)</li>
 105    * <li>version is identical (ignoring case), or this version is of the format
 106    * "someSource:0", in which case the version for the other entry replaces
 107    * it</li>
 108    * <li>mappings are not compared but if this entry has no mapping, replace
 109    * with that for the other entry</li>
 110    * </ul>
 111    *
 112    * @param other
 113    * @return
 114    */
 115   @Override
 116   public boolean updateFrom(DBRefEntryI other)
 117   {
 118     if (other == null)
 119     {
 120       return false;
 121     }
 122     if (other == this)
 123     {
 124       return true;
 125     }
 126
 127     /*
 128      * source must either match or be both null
 129      */
 130     String otherSource = other.getSource();
 131     if ((source == null && otherSource != null)
 132             || (source != null && otherSource == null)
 133             || (source != null && !source.equalsIgnoreCase(otherSource)))
 134     {
 135       return false;
 136     }
 137
 138     /*
 139      * accession id must either match or be both null
 140      */
 141     String otherAccession = other.getAccessionId();
 142     if ((accessionId == null && otherAccession != null)
 143             || (accessionId != null && otherAccession == null)
 144             || (accessionId != null
 145                     && !accessionId.equalsIgnoreCase(otherAccession)))
 146     {
 147       return false;
 148     }
 149
 150     /*
 151      * if my version is null, "0" or "source:0" then replace with other version,
 152      * otherwise the versions have to match
 153      */
 154     String otherVersion = other.getVersion();
 155
 156     if ((version == null || version.equals("0") || version.endsWith(":0"))
 157             && otherVersion != null)
 158     {
 159       setVersion(otherVersion);
 160     }
 161     else
 162     {
 163       if (version != null && (otherVersion == null
 164               || !version.equalsIgnoreCase(otherVersion)))
 165       {
 166         return false;
 167       }
 168     }
 169
 170     /*
 171      * if I have no mapping, take that of the other dbref
 172      */
 173     if (map == null)
 174     {
 175       setMap(other.getMap());
 176     }
 177     return true;
 178   }
 179
 180   /**
 181    * test for similar DBRef attributes, except for the map object.
 182    *
 183    * @param entry
 184    * @return true if source, accession and version are equal with those of entry
 185    */
 186   @Override
 187   public boolean equalRef(DBRefEntryI entry)
 188   {
 189     // TODO is this method and equals() not needed?
 190     if (entry == null)
 191     {
 192       return false;
 193     }
 194     if (entry == this)
 195     {
 196       return true;
 197     }
 198     if (entry != null
 199             && (source != null && entry.getSource() != null
 200                     && source.equalsIgnoreCase(entry.getSource()))
 201             && (accessionId != null && entry.getAccessionId() != null
 202                     && accessionId.equalsIgnoreCase(entry.getAccessionId()))
 203             && (version != null && entry.getVersion() != null
 204                     && version.equalsIgnoreCase(entry.getVersion())))
 205     {
 206       return true;
 207     }
 208     return false;
 209   }
 210
 211   @Override
 212   public String getSource()
 213   {
 214     return source;
 215   }
 216
 217   @Override
 218   public String getVersion()
 219   {
 220     return version;
 221   }
 222
 223   @Override
 224   public String getAccessionId()
 225   {
 226     return accessionId;
 227   }
 228
 229   @Override
 230   public void setAccessionId(String accessionId)
 231   {
 232     this.accessionId = accessionId;
 233   }
 234
 235   @Override
 236   public void setSource(String source)
 237   {
 238     this.source = source;
 239   }
 240
 241   @Override
 242   public void setVersion(String version)
 243   {
 244     this.version = version;
 245   }
 246
 247   @Override
 248   public Mapping getMap()
 249   {
 250     return map;
 251   }
 252
 253   /**
 254    * @param map
 255    *          the map to set
 256    */
 257   public void setMap(Mapping map)
 258   {
 259     this.map = map;
 260   }
 261
 262   public boolean hasMap()
 263   {
 264     return map != null;
 265   }
 266
 267   /**
 268    *
 269    * @return source+":"+accessionId
 270    */
 271   public String getSrcAccString()
 272   {
 273     return ((source != null) ? source : "") + ":"
 274             + ((accessionId != null) ? accessionId : "");
 275   }
 276
 277   @Override
 278   public String toString()
 279   {
 280     return getSrcAccString();
 281   }
 282
 283   @Override
 284   public boolean isPrimaryCandidate()
 285   {
 286     /*
 287      * if a map is present, unless it is 1:1 and has no SequenceI mate, it cannot be a primary reference.
 288      */
 289     if (map != null)
 290     {
 291       if (map.getTo() != null)
 292       {
 293         return false;
 294       }
 295       if (map.getMap().getFromRatio() != map.getMap().getToRatio()
 296               || map.getMap().getFromRatio() != 1)
 297       {
 298         return false;
 299       }
 300       // check map is between identical single contiguous ranges
 301       List<int[]> fromRanges = map.getMap().getFromRanges();
 302       List<int[]> toRanges = map.getMap().getToRanges();
 303       if (fromRanges.size() != 1 || toRanges.size() != 1)
 304       {
 305         return false;
 306       }
 307       if (fromRanges.get(0)[0] != toRanges.get(0)[0]
 308               || fromRanges.get(0)[1] != toRanges.get(0)[1])
 309       {
 310         return false;
 311       }
 312     }
 313     if (version == null)
 314     {
 315       // no version string implies the reference has not been verified at all.
 316       return false;
 317     }
 318     // tricky - this test really needs to search the sequence's set of dbrefs to
 319     // see if there is a primary reference that derived this reference.
 320     String ucv = version.toUpperCase();
 321     for (String primsrc : Arrays.asList(DBRefSource.allSources()))
 322     {
 323       if (ucv.startsWith(primsrc.toUpperCase()))
 324       {
 325         // by convention, many secondary references inherit the primary
 326         // reference's
 327         // source string as a prefix for any version information from the
 328         // secondary reference.
 329         return false;
 330       }
 331     }
 332     return true;
 333   }
 334 }