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
 154     if ((version == null || version.equals("0") || version.endsWith(":0"))
 155             && otherVersion != null)
 156     {
 157       setVersion(otherVersion);
 158     }
 159     else
 160     {
 161       if (version != null
 162               && (otherVersion == null || !version
 163                       .equalsIgnoreCase(otherVersion)))
 164       {
 165         return false;
 166       }
 167     }
 168
 169     /*
 170      * if I have no mapping, take that of the other dbref
 171      */
 172     if (map == null)
 173     {
 174       setMap(other.getMap());
 175     }
 176     return true;
 177   }
 178
 179   /**
 180    * test for similar DBRef attributes, except for the map object.
 181    *
 182    * @param entry
 183    * @return true if source, accession and version are equal with those of entry
 184    */
 185   @Override
 186   public boolean equalRef(DBRefEntryI entry)
 187   {
 188     // TODO is this method and equals() not needed?
 189     if (entry == null)
 190     {
 191       return false;
 192     }
 193     if (entry == this)
 194     {
 195       return true;
 196     }
 197     if (entry != null
 198             && (source != null && entry.getSource() != null && source
 199                     .equalsIgnoreCase(entry.getSource()))
 200             && (accessionId != null && entry.getAccessionId() != null && accessionId
 201                     .equalsIgnoreCase(entry.getAccessionId()))
 202             && (version != null && entry.getVersion() != null && version
 203                     .equalsIgnoreCase(entry.getVersion())))
 204     {
 205       return true;
 206     }
 207     return false;
 208   }
 209
 210   @Override
 211   public String getSource()
 212   {
 213     return source;
 214   }
 215
 216   @Override
 217   public String getVersion()
 218   {
 219     return version;
 220   }
 221
 222   @Override
 223   public String getAccessionId()
 224   {
 225     return accessionId;
 226   }
 227
 228
 229   @Override
 230   public void setAccessionId(String accessionId)
 231   {
 232     this.accessionId = accessionId;
 233   }
 234
 235
 236   @Override
 237   public void setSource(String source)
 238   {
 239     this.source = source;
 240   }
 241
 242
 243   @Override
 244   public void setVersion(String version)
 245   {
 246     this.version = version;
 247   }
 248
 249
 250   @Override
 251   public Mapping getMap()
 252   {
 253     return map;
 254   }
 255
 256   /**
 257    * @param map
 258    *          the map to set
 259    */
 260   public void setMap(Mapping map)
 261   {
 262     this.map = map;
 263   }
 264
 265   public boolean hasMap()
 266   {
 267     return map != null;
 268   }
 269
 270   /**
 271    *
 272    * @return source+":"+accessionId
 273    */
 274   public String getSrcAccString()
 275   {
 276     return ((source != null) ? source : "") + ":"
 277             + ((accessionId != null) ? accessionId : "");
 278   }
 279
 280   @Override
 281   public String toString()
 282   {
 283     return getSrcAccString();
 284   }
 285
 286   @Override
 287   public int getStartRes()
 288   {
 289     return startRes;
 290   }
 291
 292   @Override
 293   public void setStartRes(int startRes)
 294   {
 295     this.startRes = startRes;
 296   }
 297
 298   @Override
 299   public int getEndRes()
 300   {
 301     return endRes;
 302   }
 303
 304   @Override
 305   public void setEndRes(int endRes)
 306   {
 307     this.endRes = endRes;
 308   }
 309 }