src/jalview/datamodel/Sequence.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
   3  * Copyright (C) 2014 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.analysis.AlignSeq;
  24
  25 import java.util.ArrayList;
  26 import java.util.Enumeration;
  27 import java.util.List;
  28 import java.util.Vector;
  29
  30 import fr.orsay.lri.varna.models.rna.RNA;
  31
  32 /**
  33  *
  34  * Implements the SequenceI interface for a char[] based sequence object.
  35  *
  36  * @author $author$
  37  * @version $Revision$
  38  */
  39 public class Sequence implements SequenceI
  40 {
  41   SequenceI datasetSequence;
  42
  43   String name;
  44
  45   private char[] sequence;
  46
  47   String description;
  48
  49   int start;
  50
  51   int end;
  52
  53   Vector pdbIds;
  54
  55   String vamsasId;
  56
  57   DBRefEntry[] dbrefs;
  58
  59   RNA rna;
  60
  61   /**
  62    * This annotation is displayed below the alignment but the positions are tied
  63    * to the residues of this sequence
  64    *
  65    * TODO: change to List<>
  66    */
  67   Vector<AlignmentAnnotation> annotation;
  68
  69   /**
  70    * The index of the sequence in a MSA
  71    */
  72   int index = -1;
  73
  74   /** array of sequence features - may not be null for a valid sequence object */
  75   public SequenceFeature[] sequenceFeatures;
  76
  77   /**
  78    * Creates a new Sequence object.
  79    *
  80    * @param name
  81    *          display name string
  82    * @param sequence
  83    *          string to form a possibly gapped sequence out of
  84    * @param start
  85    *          first position of non-gap residue in the sequence
  86    * @param end
  87    *          last position of ungapped residues (nearly always only used for
  88    *          display purposes)
  89    */
  90   public Sequence(String name, String sequence, int start, int end)
  91   {
  92     this.name = name;
  93     this.sequence = sequence.toCharArray();
  94     this.start = start;
  95     this.end = end;
  96     parseId();
  97     checkValidRange();
  98   }
  99
 100   public Sequence(String name, char[] sequence, int start, int end)
 101   {
 102     this.name = name;
 103     this.sequence = sequence;
 104     this.start = start;
 105     this.end = end;
 106     parseId();
 107     checkValidRange();
 108   }
 109
 110   com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
 111           "[/][0-9]{1,}[-][0-9]{1,}$");
 112
 113   com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex("[0-9]{1,}$");
 114
 115   void parseId()
 116   {
 117     if (name == null)
 118     {
 119       System.err
 120               .println("POSSIBLE IMPLEMENTATION ERROR: null sequence name passed to constructor.");
 121       name = "";
 122     }
 123     // Does sequence have the /start-end signiature?
 124     if (limitrx.search(name))
 125     {
 126       name = limitrx.left();
 127       endrx.search(limitrx.stringMatched());
 128       setStart(Integer.parseInt(limitrx.stringMatched().substring(1,
 129               endrx.matchedFrom() - 1)));
 130       setEnd(Integer.parseInt(endrx.stringMatched()));
 131     }
 132   }
 133
 134   void checkValidRange()
 135   {
 136     // Note: JAL-774 :
 137     // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
 138     {
 139       int endRes = 0;
 140       for (int j = 0; j < sequence.length; j++)
 141       {
 142         if (!jalview.util.Comparison.isGap(sequence[j]))
 143         {
 144           endRes++;
 145         }
 146       }
 147       if (endRes > 0)
 148       {
 149         endRes += start - 1;
 150       }
 151
 152       if (end < endRes)
 153       {
 154         end = endRes;
 155       }
 156     }
 157
 158   }
 159
 160   /**
 161    * Creates a new Sequence object.
 162    *
 163    * @param name
 164    *          DOCUMENT ME!
 165    * @param sequence
 166    *          DOCUMENT ME!
 167    */
 168   public Sequence(String name, String sequence)
 169   {
 170     this(name, sequence, 1, -1);
 171   }
 172
 173   /**
 174    * Creates a new Sequence object with new features, DBRefEntries,
 175    * AlignmentAnnotations, and PDBIds but inherits any existing dataset sequence
 176    * reference.
 177    *
 178    * @param seq
 179    *          DOCUMENT ME!
 180    */
 181   public Sequence(SequenceI seq)
 182   {
 183     this(seq, seq.getAnnotation());
 184   }
 185
 186   /**
 187    * Create a new sequence object with new features, DBRefEntries, and PDBIds
 188    * but inherits any existing dataset sequence reference, and duplicate of any
 189    * annotation that is present in the given annotation array.
 190    *
 191    * @param seq
 192    *          the sequence to be copied
 193    * @param alAnnotation
 194    *          an array of annotation including some associated with seq
 195    */
 196   public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation)
 197   {
 198     this(seq.getName(), seq.getSequence(), seq.getStart(), seq.getEnd());
 199     description = seq.getDescription();
 200     if (seq.getSequenceFeatures() != null)
 201     {
 202       SequenceFeature[] sf = seq.getSequenceFeatures();
 203       for (int i = 0; i < sf.length; i++)
 204       {
 205         addSequenceFeature(new SequenceFeature(sf[i]));
 206       }
 207     }
 208     setDatasetSequence(seq.getDatasetSequence());
 209     if (datasetSequence == null && seq.getDBRef() != null)
 210     {
 211       // only copy DBRefs if we really are a dataset sequence
 212       DBRefEntry[] dbr = seq.getDBRef();
 213       for (int i = 0; i < dbr.length; i++)
 214       {
 215         addDBRef(new DBRefEntry(dbr[i]));
 216       }
 217     }
 218     if (seq.getAnnotation() != null)
 219     {
 220       AlignmentAnnotation[] sqann = seq.getAnnotation();
 221       for (int i = 0; i < sqann.length; i++)
 222       {
 223         if (sqann[i] == null)
 224         {
 225           continue;
 226         }
 227         boolean found = (alAnnotation == null);
 228         if (!found)
 229         {
 230           for (int apos = 0; !found && apos < alAnnotation.length; apos++)
 231           {
 232             found = (alAnnotation[apos] == sqann[i]);
 233           }
 234         }
 235         if (found)
 236         {
 237           // only copy the given annotation
 238           AlignmentAnnotation newann = new AlignmentAnnotation(sqann[i]);
 239           addAlignmentAnnotation(newann);
 240         }
 241       }
 242     }
 243     if (seq.getPDBId() != null)
 244     {
 245       Vector ids = seq.getPDBId();
 246       Enumeration e = ids.elements();
 247       while (e.hasMoreElements())
 248       {
 249         this.addPDBId(new PDBEntry((PDBEntry) e.nextElement()));
 250       }
 251     }
 252   }
 253
 254   /**
 255    * DOCUMENT ME!
 256    *
 257    * @param v
 258    *          DOCUMENT ME!
 259    */
 260   public void setSequenceFeatures(SequenceFeature[] features)
 261   {
 262     sequenceFeatures = features;
 263   }
 264
 265   public synchronized void addSequenceFeature(SequenceFeature sf)
 266   {
 267     if (sequenceFeatures == null)
 268     {
 269       sequenceFeatures = new SequenceFeature[0];
 270     }
 271
 272     for (int i = 0; i < sequenceFeatures.length; i++)
 273     {
 274       if (sequenceFeatures[i].equals(sf))
 275       {
 276         return;
 277       }
 278     }
 279
 280     SequenceFeature[] temp = new SequenceFeature[sequenceFeatures.length + 1];
 281     System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);
 282     temp[sequenceFeatures.length] = sf;
 283
 284     sequenceFeatures = temp;
 285   }
 286
 287   public void deleteFeature(SequenceFeature sf)
 288   {
 289     if (sequenceFeatures == null)
 290     {
 291       return;
 292     }
 293
 294     int index = 0;
 295     for (index = 0; index < sequenceFeatures.length; index++)
 296     {
 297       if (sequenceFeatures[index].equals(sf))
 298       {
 299         break;
 300       }
 301     }
 302
 303     if (index == sequenceFeatures.length)
 304     {
 305       return;
 306     }
 307
 308     int sfLength = sequenceFeatures.length;
 309     if (sfLength < 2)
 310     {
 311       sequenceFeatures = null;
 312     }
 313     else
 314     {
 315       SequenceFeature[] temp = new SequenceFeature[sfLength - 1];
 316       System.arraycopy(sequenceFeatures, 0, temp, 0, index);
 317
 318       if (index < sfLength)
 319       {
 320         System.arraycopy(sequenceFeatures, index + 1, temp, index,
 321                 sequenceFeatures.length - index - 1);
 322       }
 323
 324       sequenceFeatures = temp;
 325     }
 326   }
 327
 328   /**
 329    * DOCUMENT ME!
 330    *
 331    * @return DOCUMENT ME!
 332    */
 333   public SequenceFeature[] getSequenceFeatures()
 334   {
 335     return sequenceFeatures;
 336   }
 337
 338   public void addPDBId(PDBEntry entry)
 339   {
 340     if (pdbIds == null)
 341     {
 342       pdbIds = new Vector();
 343     }
 344     if (!pdbIds.contains(entry))
 345     {
 346       pdbIds.addElement(entry);
 347     }
 348   }
 349
 350   /**
 351    * DOCUMENT ME!
 352    *
 353    * @param id
 354    *          DOCUMENT ME!
 355    */
 356   public void setPDBId(Vector id)
 357   {
 358     pdbIds = id;
 359   }
 360
 361   /**
 362    * DOCUMENT ME!
 363    *
 364    * @return DOCUMENT ME!
 365    */
 366   public Vector getPDBId()
 367   {
 368     return pdbIds;
 369   }
 370
 371   /**
 372    * DOCUMENT ME!
 373    *
 374    * @return DOCUMENT ME!
 375    */
 376   public String getDisplayId(boolean jvsuffix)
 377   {
 378     StringBuffer result = new StringBuffer(name);
 379     if (jvsuffix)
 380     {
 381       result.append("/" + start + "-" + end);
 382     }
 383
 384     return result.toString();
 385   }
 386
 387   /**
 388    * DOCUMENT ME!
 389    *
 390    * @param name
 391    *          DOCUMENT ME!
 392    */
 393   public void setName(String name)
 394   {
 395     this.name = name;
 396     this.parseId();
 397   }
 398
 399   /**
 400    * DOCUMENT ME!
 401    *
 402    * @return DOCUMENT ME!
 403    */
 404   public String getName()
 405   {
 406     return this.name;
 407   }
 408
 409   /**
 410    * DOCUMENT ME!
 411    *
 412    * @param start
 413    *          DOCUMENT ME!
 414    */
 415   public void setStart(int start)
 416   {
 417     this.start = start;
 418   }
 419
 420   /**
 421    * DOCUMENT ME!
 422    *
 423    * @return DOCUMENT ME!
 424    */
 425   public int getStart()
 426   {
 427     return this.start;
 428   }
 429
 430   /**
 431    * DOCUMENT ME!
 432    *
 433    * @param end
 434    *          DOCUMENT ME!
 435    */
 436   public void setEnd(int end)
 437   {
 438     this.end = end;
 439   }
 440
 441   /**
 442    * DOCUMENT ME!
 443    *
 444    * @return DOCUMENT ME!
 445    */
 446   public int getEnd()
 447   {
 448     return this.end;
 449   }
 450
 451   /**
 452    * DOCUMENT ME!
 453    *
 454    * @return DOCUMENT ME!
 455    */
 456   public int getLength()
 457   {
 458     return this.sequence.length;
 459   }
 460
 461   /**
 462    * DOCUMENT ME!
 463    *
 464    * @param seq
 465    *          DOCUMENT ME!
 466    */
 467   public void setSequence(String seq)
 468   {
 469     this.sequence = seq.toCharArray();
 470     checkValidRange();
 471   }
 472
 473   public String getSequenceAsString()
 474   {
 475     return new String(sequence);
 476   }
 477
 478   public String getSequenceAsString(int start, int end)
 479   {
 480     return new String(getSequence(start, end));
 481   }
 482
 483   public char[] getSequence()
 484   {
 485     return sequence;
 486   }
 487
 488   /*
 489    * (non-Javadoc)
 490    *
 491    * @see jalview.datamodel.SequenceI#getSequence(int, int)
 492    */
 493   public char[] getSequence(int start, int end)
 494   {
 495     if (start < 0)
 496     {
 497       start = 0;
 498     }
 499     // JBPNote - left to user to pad the result here (TODO:Decide on this
 500     // policy)
 501     if (start >= sequence.length)
 502     {
 503       return new char[0];
 504     }
 505
 506     if (end >= sequence.length)
 507     {
 508       end = sequence.length;
 509     }
 510
 511     char[] reply = new char[end - start];
 512     System.arraycopy(sequence, start, reply, 0, end - start);
 513
 514     return reply;
 515   }
 516
 517   @Override
 518   public SequenceI getSubSequence(int start, int end)
 519   {
 520     if (start < 0)
 521     {
 522       start = 0;
 523     }
 524     char[] seq = getSequence(start, end);
 525     if (seq.length == 0)
 526     {
 527       return null;
 528     }
 529     int nstart = findPosition(start);
 530     int nend = findPosition(end) - 1;
 531     // JBPNote - this is an incomplete copy.
 532     SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend);
 533     nseq.setDescription(description);
 534     if (datasetSequence != null)
 535     {
 536       nseq.setDatasetSequence(datasetSequence);
 537     }
 538     else
 539     {
 540       nseq.setDatasetSequence(this);
 541     }
 542     return nseq;
 543   }
 544
 545   /**
 546    * DOCUMENT ME!
 547    *
 548    * @param i
 549    *          DOCUMENT ME!
 550    *
 551    * @return DOCUMENT ME!
 552    */
 553   public char getCharAt(int i)
 554   {
 555     if (i < sequence.length)
 556     {
 557       return sequence[i];
 558     }
 559     else
 560     {
 561       return ' ';
 562     }
 563   }
 564
 565   /**
 566    * DOCUMENT ME!
 567    *
 568    * @param desc
 569    *          DOCUMENT ME!
 570    */
 571   public void setDescription(String desc)
 572   {
 573     this.description = desc;
 574   }
 575
 576   /**
 577    * DOCUMENT ME!
 578    *
 579    * @return DOCUMENT ME!
 580    */
 581   public String getDescription()
 582   {
 583     return this.description;
 584   }
 585
 586   /*
 587    * (non-Javadoc)
 588    *
 589    * @see jalview.datamodel.SequenceI#findIndex(int)
 590    */
 591   public int findIndex(int pos)
 592   {
 593     // returns the alignment position for a residue
 594     int j = start;
 595     int i = 0;
 596     // Rely on end being at least as long as the length of the sequence.
 597     while ((i < sequence.length) && (j <= end) && (j <= pos))
 598     {
 599       if (!jalview.util.Comparison.isGap(sequence[i]))
 600       {
 601         j++;
 602       }
 603
 604       i++;
 605     }
 606
 607     if ((j == end) && (j < pos))
 608     {
 609       return end + 1;
 610     }
 611     else
 612     {
 613       return i;
 614     }
 615   }
 616
 617   @Override
 618   public int findPosition(int i)
 619   {
 620     int j = 0;
 621     int pos = start;
 622     int seqlen = sequence.length;
 623     while ((j < i) && (j < seqlen))
 624     {
 625       if (!jalview.util.Comparison.isGap(sequence[j]))
 626       {
 627         pos++;
 628       }
 629
 630       j++;
 631     }
 632
 633     return pos;
 634   }
 635
 636   /**
 637    * Returns an int array where indices correspond to each residue in the
 638    * sequence and the element value gives its position in the alignment
 639    *
 640    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 641    *         residues in SequenceI object
 642    */
 643   public int[] gapMap()
 644   {
 645     String seq = jalview.analysis.AlignSeq.extractGaps(
 646             jalview.util.Comparison.GapChars, new String(sequence));
 647     int[] map = new int[seq.length()];
 648     int j = 0;
 649     int p = 0;
 650
 651     while (j < sequence.length)
 652     {
 653       if (!jalview.util.Comparison.isGap(sequence[j]))
 654       {
 655         map[p++] = j;
 656       }
 657
 658       j++;
 659     }
 660
 661     return map;
 662   }
 663
 664   /*
 665    * (non-Javadoc)
 666    *
 667    * @see jalview.datamodel.SequenceI#findPositionMap()
 668    */
 669   public int[] findPositionMap()
 670   {
 671     int map[] = new int[sequence.length];
 672     int j = 0;
 673     int pos = start;
 674     int seqlen = sequence.length;
 675     while ((j < seqlen))
 676     {
 677       map[j] = pos;
 678       if (!jalview.util.Comparison.isGap(sequence[j]))
 679       {
 680         pos++;
 681       }
 682
 683       j++;
 684     }
 685     return map;
 686   }
 687
 688   /*
 689    * (non-Javadoc)
 690    *
 691    * @see jalview.datamodel.SequenceI#deleteChars(int, int)
 692    */
 693   public void deleteChars(int i, int j)
 694   {
 695     int newstart = start, newend = end;
 696     if (i >= sequence.length)
 697     {
 698       return;
 699     }
 700
 701     char[] tmp;
 702
 703     if (j >= sequence.length)
 704     {
 705       tmp = new char[i];
 706       System.arraycopy(sequence, 0, tmp, 0, i);
 707       j = sequence.length;
 708     }
 709     else
 710     {
 711       tmp = new char[sequence.length - j + i];
 712       System.arraycopy(sequence, 0, tmp, 0, i);
 713       System.arraycopy(sequence, j, tmp, i, sequence.length - j);
 714     }
 715     boolean createNewDs = false;
 716     // TODO: take a look at the new dataset creation validation method below -
 717     // this could become time comsuming for large sequences - consider making it
 718     // more efficient
 719     for (int s = i; s < j; s++)
 720     {
 721       if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23)
 722       {
 723         if (createNewDs)
 724         {
 725           newend--;
 726         }
 727         else
 728         {
 729           int sindex = findIndex(start) - 1;
 730           if (sindex == s)
 731           {
 732             // delete characters including start of sequence
 733             newstart = findPosition(j);
 734             break; // don't need to search for any more residue characters.
 735           }
 736           else
 737           {
 738             // delete characters after start.
 739             int eindex = findIndex(end) - 1;
 740             if (eindex < j)
 741             {
 742               // delete characters at end of sequence
 743               newend = findPosition(i - 1);
 744               break; // don't need to search for any more residue characters.
 745             }
 746             else
 747             {
 748               createNewDs = true;
 749               newend--; // decrease end position by one for the deleted residue
 750               // and search further
 751             }
 752           }
 753         }
 754       }
 755     }
 756     // deletion occured in the middle of the sequence
 757     if (createNewDs && this.datasetSequence != null)
 758     {
 759       // construct a new sequence
 760       Sequence ds = new Sequence(datasetSequence);
 761       // TODO: remove any non-inheritable properties ?
 762       // TODO: create a sequence mapping (since there is a relation here ?)
 763       ds.deleteChars(i, j);
 764       datasetSequence = ds;
 765     }
 766     start = newstart;
 767     end = newend;
 768     sequence = tmp;
 769   }
 770
 771   /**
 772    * DOCUMENT ME!
 773    *
 774    * @param i
 775    *          DOCUMENT ME!
 776    * @param c
 777    *          DOCUMENT ME!
 778    * @param chop
 779    *          DOCUMENT ME!
 780    */
 781   public void insertCharAt(int i, int length, char c)
 782   {
 783     char[] tmp = new char[sequence.length + length];
 784
 785     if (i >= sequence.length)
 786     {
 787       System.arraycopy(sequence, 0, tmp, 0, sequence.length);
 788       i = sequence.length;
 789     }
 790     else
 791     {
 792       System.arraycopy(sequence, 0, tmp, 0, i);
 793     }
 794
 795     int index = i;
 796     while (length > 0)
 797     {
 798       tmp[index++] = c;
 799       length--;
 800     }
 801
 802     if (i < sequence.length)
 803     {
 804       System.arraycopy(sequence, i, tmp, index, sequence.length - i);
 805     }
 806
 807     sequence = tmp;
 808   }
 809
 810   public void insertCharAt(int i, char c)
 811   {
 812     insertCharAt(i, 1, c);
 813   }
 814
 815   public String getVamsasId()
 816   {
 817     return vamsasId;
 818   }
 819
 820   public void setVamsasId(String id)
 821   {
 822     vamsasId = id;
 823   }
 824
 825   public void setDBRef(DBRefEntry[] dbref)
 826   {
 827     dbrefs = dbref;
 828   }
 829
 830   public DBRefEntry[] getDBRef()
 831   {
 832     if (dbrefs == null && datasetSequence != null
 833             && this != datasetSequence)
 834     {
 835       return datasetSequence.getDBRef();
 836     }
 837     return dbrefs;
 838   }
 839
 840   public void addDBRef(DBRefEntry entry)
 841   {
 842     if (dbrefs == null)
 843     {
 844       dbrefs = new DBRefEntry[0];
 845     }
 846
 847     int i, iSize = dbrefs.length;
 848
 849     for (i = 0; i < iSize; i++)
 850     {
 851       if (dbrefs[i].equalRef(entry))
 852       {
 853         if (entry.getMap() != null)
 854         {
 855           if (dbrefs[i].getMap() == null)
 856           {
 857             // overwrite with 'superior' entry that contains a mapping.
 858             dbrefs[i] = entry;
 859           }
 860         }
 861         return;
 862       }
 863     }
 864
 865     DBRefEntry[] temp = new DBRefEntry[iSize + 1];
 866     System.arraycopy(dbrefs, 0, temp, 0, iSize);
 867     temp[temp.length - 1] = entry;
 868
 869     dbrefs = temp;
 870   }
 871
 872   public void setDatasetSequence(SequenceI seq)
 873   {
 874     datasetSequence = seq;
 875   }
 876
 877   public SequenceI getDatasetSequence()
 878   {
 879     return datasetSequence;
 880   }
 881
 882   /**
 883    * Returns a new array containing this sequence's annotations, or null.
 884    */
 885   public AlignmentAnnotation[] getAnnotation()
 886   {
 887     return annotation == null ? null : annotation
 888             .toArray(new AlignmentAnnotation[annotation.size()]);
 889   }
 890
 891   /**
 892    * Returns true if this sequence has the given annotation (by object
 893    * identity).
 894    */
 895   @Override
 896   public boolean hasAnnotation(AlignmentAnnotation ann)
 897   {
 898     return annotation == null ? false : annotation.contains(ann);
 899   }
 900
 901   /**
 902    * Add the given annotation, if not already added, and set its sequence ref to
 903    * be this sequence. Does nothing if this sequence's annotations already
 904    * include this annotation (by identical object reference).
 905    */
 906   public void addAlignmentAnnotation(AlignmentAnnotation annotation)
 907   {
 908     if (this.annotation == null)
 909     {
 910       this.annotation = new Vector();
 911     }
 912     if (!this.annotation.contains(annotation))
 913     {
 914       this.annotation.addElement(annotation);
 915     }
 916     annotation.setSequenceRef(this);
 917   }
 918
 919   public void removeAlignmentAnnotation(AlignmentAnnotation annotation)
 920   {
 921     if (this.annotation != null)
 922     {
 923       this.annotation.removeElement(annotation);
 924       if (this.annotation.size() == 0)
 925       {
 926         this.annotation = null;
 927       }
 928     }
 929   }
 930
 931   /**
 932    * test if this is a valid candidate for another sequence's dataset sequence.
 933    *
 934    */
 935   private boolean isValidDatasetSequence()
 936   {
 937     if (datasetSequence != null)
 938     {
 939       return false;
 940     }
 941     for (int i = 0; i < sequence.length; i++)
 942     {
 943       if (jalview.util.Comparison.isGap(sequence[i]))
 944       {
 945         return false;
 946       }
 947     }
 948     return true;
 949   }
 950
 951   /*
 952    * (non-Javadoc)
 953    *
 954    * @see jalview.datamodel.SequenceI#deriveSequence()
 955    */
 956   public SequenceI deriveSequence()
 957   {
 958     SequenceI seq = new Sequence(this);
 959     if (datasetSequence != null)
 960     {
 961       // duplicate current sequence with same dataset
 962       seq.setDatasetSequence(datasetSequence);
 963     }
 964     else
 965     {
 966       if (isValidDatasetSequence())
 967       {
 968         // Use this as dataset sequence
 969         seq.setDatasetSequence(this);
 970       }
 971       else
 972       {
 973         // Create a new, valid dataset sequence
 974         SequenceI ds = seq;
 975         ds.setSequence(AlignSeq.extractGaps(
 976                 jalview.util.Comparison.GapChars, new String(sequence)));
 977         setDatasetSequence(ds);
 978         ds.setSequenceFeatures(getSequenceFeatures());
 979         seq = this; // and return this sequence as the derived sequence.
 980       }
 981     }
 982     return seq;
 983   }
 984
 985   /*
 986    * (non-Javadoc)
 987    *
 988    * @see jalview.datamodel.SequenceI#createDatasetSequence()
 989    */
 990   public SequenceI createDatasetSequence()
 991   {
 992     if (datasetSequence == null)
 993     {
 994       datasetSequence = new Sequence(getName(), AlignSeq.extractGaps(
 995               jalview.util.Comparison.GapChars, getSequenceAsString()),
 996               getStart(), getEnd());
 997       datasetSequence.setSequenceFeatures(getSequenceFeatures());
 998       datasetSequence.setDescription(getDescription());
 999       setSequenceFeatures(null);
1000       // move database references onto dataset sequence
1001       datasetSequence.setDBRef(getDBRef());
1002       setDBRef(null);
1003       datasetSequence.setPDBId(getPDBId());
1004       setPDBId(null);
1005       datasetSequence.updatePDBIds();
1006       if (annotation != null)
1007       {
1008         for (AlignmentAnnotation aa : annotation)
1009         {
1010           AlignmentAnnotation _aa = new AlignmentAnnotation(aa);
1011           _aa.sequenceRef = datasetSequence;
1012           _aa.adjustForAlignment(); // uses annotation's own record of
1013                                    // sequence-column mapping
1014           datasetSequence.addAlignmentAnnotation(_aa);
1015         }
1016       }
1017     }
1018     return datasetSequence;
1019   }
1020
1021   /*
1022    * (non-Javadoc)
1023    *
1024    * @see
1025    * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[]
1026    * annotations)
1027    */
1028   public void setAlignmentAnnotation(AlignmentAnnotation[] annotations)
1029   {
1030     if (annotation != null)
1031     {
1032       annotation.removeAllElements();
1033     }
1034     if (annotations != null)
1035     {
1036       for (int i = 0; i < annotations.length; i++)
1037       {
1038         if (annotations[i] != null)
1039         {
1040           addAlignmentAnnotation(annotations[i]);
1041         }
1042       }
1043     }
1044   }
1045
1046   /*
1047    * (non-Javadoc)
1048    *
1049    * @see jalview.datamodel.SequenceI#getAnnotation(java.lang.String)
1050    */
1051   public AlignmentAnnotation[] getAnnotation(String label)
1052   {
1053     if (annotation == null || annotation.size() == 0)
1054     {
1055       return null;
1056     }
1057
1058     Vector subset = new Vector();
1059     Enumeration e = annotation.elements();
1060     while (e.hasMoreElements())
1061     {
1062       AlignmentAnnotation ann = (AlignmentAnnotation) e.nextElement();
1063       if (ann.label != null && ann.label.equals(label))
1064       {
1065         subset.addElement(ann);
1066       }
1067     }
1068     if (subset.size() == 0)
1069     {
1070       return null;
1071     }
1072     AlignmentAnnotation[] anns = new AlignmentAnnotation[subset.size()];
1073     int i = 0;
1074     e = subset.elements();
1075     while (e.hasMoreElements())
1076     {
1077       anns[i++] = (AlignmentAnnotation) e.nextElement();
1078     }
1079     subset.removeAllElements();
1080     return anns;
1081   }
1082
1083   public boolean updatePDBIds()
1084   {
1085     if (datasetSequence != null)
1086     {
1087       // TODO: could merge DBRefs
1088       return datasetSequence.updatePDBIds();
1089     }
1090     if (dbrefs == null || dbrefs.length == 0)
1091     {
1092       return false;
1093     }
1094     Vector newpdb = new Vector();
1095     for (int i = 0; i < dbrefs.length; i++)
1096     {
1097       if (DBRefSource.PDB.equals(dbrefs[i].getSource()))
1098       {
1099         PDBEntry pdbe = new PDBEntry();
1100         pdbe.setId(dbrefs[i].getAccessionId());
1101         if (pdbIds == null || pdbIds.size() == 0)
1102         {
1103           newpdb.addElement(pdbe);
1104         }
1105         else
1106         {
1107           Enumeration en = pdbIds.elements();
1108           boolean matched = false;
1109           while (!matched && en.hasMoreElements())
1110           {
1111             PDBEntry anentry = (PDBEntry) en.nextElement();
1112             if (anentry.getId().equals(pdbe.getId()))
1113             {
1114               matched = true;
1115             }
1116           }
1117           if (!matched)
1118           {
1119             newpdb.addElement(pdbe);
1120           }
1121         }
1122       }
1123     }
1124     if (newpdb.size() > 0)
1125     {
1126       Enumeration en = newpdb.elements();
1127       while (en.hasMoreElements())
1128       {
1129         addPDBId((PDBEntry) en.nextElement());
1130       }
1131       return true;
1132     }
1133     return false;
1134   }
1135
1136   /*
1137    * (non-Javadoc)
1138    *
1139    * @see
1140    * jalview.datamodel.SequenceI#transferAnnotation(jalview.datamodel.SequenceI,
1141    * jalview.datamodel.Mapping)
1142    */
1143   public void transferAnnotation(SequenceI entry, Mapping mp)
1144   {
1145     if (datasetSequence != null)
1146     {
1147       datasetSequence.transferAnnotation(entry, mp);
1148       return;
1149     }
1150     if (entry.getDatasetSequence() != null)
1151     {
1152       transferAnnotation(entry.getDatasetSequence(), mp);
1153       return;
1154     }
1155     // transfer any new features from entry onto sequence
1156     if (entry.getSequenceFeatures() != null)
1157     {
1158
1159       SequenceFeature[] sfs = entry.getSequenceFeatures();
1160       for (int si = 0; si < sfs.length; si++)
1161       {
1162         SequenceFeature sf[] = (mp != null) ? mp.locateFeature(sfs[si])
1163                 : new SequenceFeature[]
1164                 { new SequenceFeature(sfs[si]) };
1165         if (sf != null && sf.length > 0)
1166         {
1167           for (int sfi = 0; sfi < sf.length; sfi++)
1168           {
1169             addSequenceFeature(sf[sfi]);
1170           }
1171         }
1172       }
1173     }
1174
1175     // transfer PDB entries
1176     if (entry.getPDBId() != null)
1177     {
1178       Enumeration e = entry.getPDBId().elements();
1179       while (e.hasMoreElements())
1180       {
1181         PDBEntry pdb = (PDBEntry) e.nextElement();
1182         addPDBId(pdb);
1183       }
1184     }
1185     // transfer database references
1186     DBRefEntry[] entryRefs = entry.getDBRef();
1187     if (entryRefs != null)
1188     {
1189       for (int r = 0; r < entryRefs.length; r++)
1190       {
1191         DBRefEntry newref = new DBRefEntry(entryRefs[r]);
1192         if (newref.getMap() != null && mp != null)
1193         {
1194           // remap ref using our local mapping
1195         }
1196         // we also assume all version string setting is done by dbSourceProxy
1197         /*
1198          * if (!newref.getSource().equalsIgnoreCase(dbSource)) {
1199          * newref.setSource(dbSource); }
1200          */
1201         addDBRef(newref);
1202       }
1203     }
1204   }
1205
1206   /**
1207    * @return The index (zero-based) on this sequence in the MSA. It returns
1208    *         {@code -1} if this information is not available.
1209    */
1210   public int getIndex()
1211   {
1212     return index;
1213   }
1214
1215   /**
1216    * Defines the position of this sequence in the MSA. Use the value {@code -1}
1217    * if this information is undefined.
1218    *
1219    * @param The
1220    *          position for this sequence. This value is zero-based (zero for
1221    *          this first sequence)
1222    */
1223   public void setIndex(int value)
1224   {
1225     index = value;
1226   }
1227
1228   public void setRNA(RNA r)
1229   {
1230     rna = r;
1231   }
1232
1233   public RNA getRNA()
1234   {
1235     return rna;
1236   }
1237
1238   /**
1239    * Returns a (possibly empty) list of any annotations that match on given
1240    * calcId (source) and label (type). Null values do not match.
1241    *
1242    * @param calcId
1243    * @param label
1244    */
1245   @Override
1246   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
1247           String label)
1248   {
1249     List<AlignmentAnnotation> result = new ArrayList<AlignmentAnnotation>();
1250     if (this.annotation != null) {
1251       for (AlignmentAnnotation ann : annotation) {
1252         if (ann.calcId != null && ann.calcId.equals(calcId)
1253                 && ann.label != null && ann.label.equals(label))
1254         {
1255           result.add(ann);
1256         }
1257       }
1258     }
1259     return result;
1260   }
1261
1262 }