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 public class DBRefEntry implements DBRefEntryI
  26 {
  27   String source = "", version = "", accessionId = "";
  28
  29   private int startRes, endRes;
  30   /**
  31    * maps from associated sequence to the database sequence's coordinate system
  32    */
  33   Mapping map = null;
  34
  35   public DBRefEntry()
  36   {
  37
  38   }
  39
  40
  41   public DBRefEntry(String source, String version, String accessionId)
  42   {
  43     this(source, version, accessionId, null);
  44   }
  45
  46   /**
  47    *
  48    * @param source
  49    *          canonical source (uppercase only)
  50    * @param version
  51    *          (source dependent version string)
  52    * @param accessionId
  53    *          (source dependent accession number string)
  54    * @param map
  55    *          (mapping from local sequence numbering to source accession
  56    *          numbering)
  57    */
  58   public DBRefEntry(String source, String version, String accessionId,
  59           Mapping map)
  60   {
  61     this.source = source.toUpperCase();
  62     this.version = version;
  63     this.accessionId = accessionId;
  64     this.map = map;
  65   }
  66
  67   public DBRefEntry(DBRefEntryI entry)
  68   {
  69     this((entry.getSource() == null ? "" : new String(entry.getSource())),
  70             (entry.getVersion() == null ? "" : new String(
  71                     entry.getVersion())),
  72             (entry.getAccessionId() == null ? "" : new String(
  73                     entry.getAccessionId())),
  74             (entry.getMap() == null ? null : new Mapping(entry.getMap())));
  75   }
  76
  77   @Override
  78   public boolean equals(Object o)
  79   {
  80     // TODO should also override hashCode to ensure equal objects have equal
  81     // hashcodes
  82     if (o == null || !(o instanceof DBRefEntry))
  83     {
  84       return false;
  85     }
  86     DBRefEntry entry = (DBRefEntry) o;
  87     if (entry == this)
  88     {
  89       return true;
  90     }
  91     if (equalRef(entry)
  92             && ((map == null && entry.map == null) || (map != null
  93                     && 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 it</li>
 107    * <li>mappings are not compared but if this entry has no mapping, replace
 108    * with that for the other entry</li>
 109    * </ul>
 110    *
 111    * @param other
 112    * @return
 113    */
 114   @Override
 115   public boolean updateFrom(DBRefEntryI other)
 116   {
 117     if (other == null)
 118     {
 119       return false;
 120     }
 121     if (other == this)
 122     {
 123       return true;
 124     }
 125
 126     /*
 127      * source must either match or be both null
 128      */
 129     String otherSource = other.getSource();
 130     if ((source == null && otherSource != null)
 131             || (source != null && otherSource == null)
 132             || (source != null && !source.equalsIgnoreCase(otherSource)))
 133     {
 134       return false;
 135     }
 136
 137     /*
 138      * accession id must either match or be both null
 139      */
 140     String otherAccession = other.getAccessionId();
 141     if ((accessionId == null && otherAccession != null)
 142             || (accessionId != null && otherAccession == null)
 143             || (accessionId != null && !accessionId.equalsIgnoreCase(otherAccession)))
 144     {
 145       return false;
 146     }
 147
 148     /*
 149      * if my version is null, "0" or "source:0" then replace with other version,
 150      * otherwise the versions have to match
 151      */
 152     String otherVersion = other.getVersion();
 153     if ((version == null || version.equals("0") || version.endsWith(":0"))
 154             && otherVersion != null)
 155     {
 156       setVersion(otherVersion);
 157     }
 158     else
 159     {
 160       if (!version.equalsIgnoreCase(otherVersion))
 161       {
 162         return false;
 163       }
 164     }
 165
 166     /*
 167      * if I have no mapping, take that of the other dbref
 168      */
 169     if (map == null)
 170     {
 171       setMap(other.getMap());
 172     }
 173     return true;
 174   }
 175
 176   /**
 177    * test for similar DBRef attributes, except for the map object.
 178    *
 179    * @param entry
 180    * @return true if source, accession and version are equal with those of entry
 181    */
 182   @Override
 183   public boolean equalRef(DBRefEntryI entry)
 184   {
 185     // TODO is this method and equals() not needed?
 186     if (entry == null)
 187     {
 188       return false;
 189     }
 190     if (entry == this)
 191     {
 192       return true;
 193     }
 194     if (entry != null
 195             && (source != null && entry.getSource() != null && source
 196                     .equalsIgnoreCase(entry.getSource()))
 197             && (accessionId != null && entry.getAccessionId() != null && accessionId
 198                     .equalsIgnoreCase(entry.getAccessionId()))
 199             && (version != null && entry.getVersion() != null && version
 200                     .equalsIgnoreCase(entry.getVersion())))
 201     {
 202       return true;
 203     }
 204     return false;
 205   }
 206
 207   @Override
 208   public String getSource()
 209   {
 210     return source;
 211   }
 212
 213   @Override
 214   public String getVersion()
 215   {
 216     return version;
 217   }
 218
 219   @Override
 220   public String getAccessionId()
 221   {
 222     return accessionId;
 223   }
 224
 225
 226   @Override
 227   public void setAccessionId(String accessionId)
 228   {
 229     this.accessionId = accessionId;
 230   }
 231
 232
 233   @Override
 234   public void setSource(String source)
 235   {
 236     this.source = source;
 237   }
 238
 239
 240   @Override
 241   public void setVersion(String version)
 242   {
 243     this.version = version;
 244   }
 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 int getStartRes()
 285   {
 286     return startRes;
 287   }
 288
 289   @Override
 290   public void setStartRes(int startRes)
 291   {
 292     this.startRes = startRes;
 293   }
 294
 295   @Override
 296   public int getEndRes()
 297   {
 298     return endRes;
 299   }
 300
 301   @Override
 302   public void setEndRes(int endRes)
 303   {
 304     this.endRes = endRes;
 305   }
 306 }