src/jalview/datamodel/Sequence.java

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