src/jalview/datamodel/Sequence.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.datamodel;
  19
  20 import jalview.analysis.AlignSeq;
  21
  22 import java.util.Enumeration;
  23 import java.util.Vector;
  24
  25 /**
  26  *
  27  * Implements the SequenceI interface for a char[] based sequence object.
  28  *
  29  * @author $author$
  30  * @version $Revision$
  31  */
  32 public class Sequence implements SequenceI
  33 {
  34   SequenceI datasetSequence;
  35
  36   String name;
  37
  38   private char[] sequence;
  39
  40   String description;
  41
  42   int start;
  43
  44   int end;
  45
  46   Vector pdbIds;
  47
  48   String vamsasId;
  49
  50   DBRefEntry[] dbrefs;
  51
  52   /**
  53    * This annotation is displayed below the alignment but the positions are tied
  54    * to the residues of this sequence
  55    */
  56   Vector annotation;
  57
  58   /**
  59    * The index of the sequence in a MSA
  60    */
  61   int index = -1;
  62
  63   /** array of seuqence features - may not be null for a valid sequence object */
  64   public SequenceFeature[] sequenceFeatures;
  65
  66   /**
  67    * Creates a new Sequence object.
  68    *
  69    * @param name
  70    *          display name string
  71    * @param sequence
  72    *          string to form a possibly gapped sequence out of
  73    * @param start
  74    *          first position of non-gap residue in the sequence
  75    * @param end
  76    *          last position of ungapped residues (nearly always only used for
  77    *          display purposes)
  78    */
  79   public Sequence(String name, String sequence, int start, int end)
  80   {
  81     this.name = name;
  82     this.sequence = sequence.toCharArray();
  83     this.start = start;
  84     this.end = end;
  85     parseId();
  86     checkValidRange();
  87   }
  88
  89   public Sequence(String name, char[] sequence, int start, int end)
  90   {
  91     this.name = name;
  92     this.sequence = sequence;
  93     this.start = start;
  94     this.end = end;
  95     parseId();
  96     checkValidRange();
  97   }
  98
  99   com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
 100           "[/][0-9]{1,}[-][0-9]{1,}$");
 101
 102   com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex("[0-9]{1,}$");
 103
 104   void parseId()
 105   {
 106     if (name == null)
 107     {
 108       System.err
 109               .println("POSSIBLE IMPLEMENTATION ERROR: null sequence name passed to constructor.");
 110       name = "";
 111     }
 112     // Does sequence have the /start-end signiature?
 113     if (limitrx.search(name))
 114     {
 115       name = limitrx.left();
 116       endrx.search(limitrx.stringMatched());
 117       setStart(Integer.parseInt(limitrx.stringMatched().substring(1,
 118               endrx.matchedFrom() - 1)));
 119       setEnd(Integer.parseInt(endrx.stringMatched()));
 120     }
 121   }
 122
 123   void checkValidRange()
 124   {
 125     // Note: JAL-774 : http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
 126     {
 127       int endRes = 0;
 128       for (int j = 0; j < sequence.length; j++)
 129       {
 130         if (!jalview.util.Comparison.isGap(sequence[j]))
 131         {
 132           endRes++;
 133         }
 134       }
 135       if (endRes > 0)
 136       {
 137         endRes += start - 1;
 138       }
 139
 140       if (end<endRes) {
 141         end = endRes;
 142       }
 143     }
 144
 145   }
 146
 147   /**
 148    * Creates a new Sequence object.
 149    *
 150    * @param name
 151    *          DOCUMENT ME!
 152    * @param sequence
 153    *          DOCUMENT ME!
 154    */
 155   public Sequence(String name, String sequence)
 156   {
 157     this(name, sequence, 1, -1);
 158   }
 159
 160   /**
 161    * Creates a new Sequence object with new features, DBRefEntries,
 162    * AlignmentAnnotations, and PDBIds but inherits any existing dataset sequence
 163    * reference.
 164    *
 165    * @param seq
 166    *          DOCUMENT ME!
 167    */
 168   public Sequence(SequenceI seq)
 169   {
 170     this(seq, seq.getAnnotation());
 171   }
 172
 173   /**
 174    * Create a new sequence object with new features, DBRefEntries, and PDBIds
 175    * but inherits any existing dataset sequence reference, and duplicate of any
 176    * annotation that is present in the given annotation array.
 177    *
 178    * @param seq
 179    *          the sequence to be copied
 180    * @param alAnnotation
 181    *          an array of annotation including some associated with seq
 182    */
 183   public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation)
 184   {
 185     this(seq.getName(), seq.getSequence(), seq.getStart(), seq.getEnd());
 186     description = seq.getDescription();
 187     if (seq.getSequenceFeatures() != null)
 188     {
 189       SequenceFeature[] sf = seq.getSequenceFeatures();
 190       for (int i = 0; i < sf.length; i++)
 191       {
 192         addSequenceFeature(new SequenceFeature(sf[i]));
 193       }
 194     }
 195     setDatasetSequence(seq.getDatasetSequence());
 196     if (datasetSequence == null && seq.getDBRef() != null)
 197     {
 198       // only copy DBRefs if we really are a dataset sequence
 199       DBRefEntry[] dbr = seq.getDBRef();
 200       for (int i = 0; i < dbr.length; i++)
 201       {
 202         addDBRef(new DBRefEntry(dbr[i]));
 203       }
 204     }
 205     if (seq.getAnnotation() != null)
 206     {
 207       AlignmentAnnotation[] sqann = seq.getAnnotation();
 208       for (int i = 0; i < sqann.length; i++)
 209       {
 210         if (sqann[i] == null)
 211         {
 212           continue;
 213         }
 214         boolean found = (alAnnotation == null);
 215         if (!found)
 216         {
 217           for (int apos = 0; !found && apos < alAnnotation.length; apos++)
 218           {
 219             found = (alAnnotation[apos] == sqann[i]);
 220           }
 221         }
 222         if (found)
 223         {
 224           // only copy the given annotation
 225           AlignmentAnnotation newann = new AlignmentAnnotation(sqann[i]);
 226           addAlignmentAnnotation(newann);
 227         }
 228       }
 229     }
 230     if (seq.getPDBId() != null)
 231     {
 232       Vector ids = seq.getPDBId();
 233       Enumeration e = ids.elements();
 234       while (e.hasMoreElements())
 235       {
 236         this.addPDBId(new PDBEntry((PDBEntry) e.nextElement()));
 237       }
 238     }
 239   }
 240
 241   /**
 242    * DOCUMENT ME!
 243    *
 244    * @param v
 245    *          DOCUMENT ME!
 246    */
 247   public void setSequenceFeatures(SequenceFeature[] features)
 248   {
 249     sequenceFeatures = features;
 250   }
 251
 252   public synchronized void addSequenceFeature(SequenceFeature sf)
 253   {
 254     if (sequenceFeatures == null)
 255     {
 256       sequenceFeatures = new SequenceFeature[0];
 257     }
 258
 259     for (int i = 0; i < sequenceFeatures.length; i++)
 260     {
 261       if (sequenceFeatures[i].equals(sf))
 262       {
 263         return;
 264       }
 265     }
 266
 267     SequenceFeature[] temp = new SequenceFeature[sequenceFeatures.length + 1];
 268     System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);
 269     temp[sequenceFeatures.length] = sf;
 270
 271     sequenceFeatures = temp;
 272   }
 273
 274   public void deleteFeature(SequenceFeature sf)
 275   {
 276     if (sequenceFeatures == null)
 277     {
 278       return;
 279     }
 280
 281     int index = 0;
 282     for (index = 0; index < sequenceFeatures.length; index++)
 283     {
 284       if (sequenceFeatures[index].equals(sf))
 285       {
 286         break;
 287       }
 288     }
 289
 290     if (index == sequenceFeatures.length)
 291     {
 292       return;
 293     }
 294
 295     int sfLength = sequenceFeatures.length;
 296     if (sfLength < 2)
 297     {
 298       sequenceFeatures = null;
 299     }
 300     else
 301     {
 302       SequenceFeature[] temp = new SequenceFeature[sfLength - 1];
 303       System.arraycopy(sequenceFeatures, 0, temp, 0, index);
 304
 305       if (index < sfLength)
 306       {
 307         System.arraycopy(sequenceFeatures, index + 1, temp, index,
 308                 sequenceFeatures.length - index - 1);
 309       }
 310
 311       sequenceFeatures = temp;
 312     }
 313   }
 314
 315   /**
 316    * DOCUMENT ME!
 317    *
 318    * @return DOCUMENT ME!
 319    */
 320   public SequenceFeature[] getSequenceFeatures()
 321   {
 322     return sequenceFeatures;
 323   }
 324
 325   public void addPDBId(PDBEntry entry)
 326   {
 327     if (pdbIds == null)
 328     {
 329       pdbIds = new Vector();
 330     }
 331     if (!pdbIds.contains(entry))
 332     {
 333       pdbIds.addElement(entry);
 334     }
 335   }
 336
 337   /**
 338    * DOCUMENT ME!
 339    *
 340    * @param id
 341    *          DOCUMENT ME!
 342    */
 343   public void setPDBId(Vector id)
 344   {
 345     pdbIds = id;
 346   }
 347
 348   /**
 349    * DOCUMENT ME!
 350    *
 351    * @return DOCUMENT ME!
 352    */
 353   public Vector getPDBId()
 354   {
 355     return pdbIds;
 356   }
 357
 358   /**
 359    * DOCUMENT ME!
 360    *
 361    * @return DOCUMENT ME!
 362    */
 363   public String getDisplayId(boolean jvsuffix)
 364   {
 365     StringBuffer result = new StringBuffer(name);
 366     if (jvsuffix)
 367     {
 368       result.append("/" + start + "-" + end);
 369     }
 370
 371     return result.toString();
 372   }
 373
 374   /**
 375    * DOCUMENT ME!
 376    *
 377    * @param name
 378    *          DOCUMENT ME!
 379    */
 380   public void setName(String name)
 381   {
 382     this.name = name;
 383     this.parseId();
 384   }
 385
 386   /**
 387    * DOCUMENT ME!
 388    *
 389    * @return DOCUMENT ME!
 390    */
 391   public String getName()
 392   {
 393     return this.name;
 394   }
 395
 396   /**
 397    * DOCUMENT ME!
 398    *
 399    * @param start
 400    *          DOCUMENT ME!
 401    */
 402   public void setStart(int start)
 403   {
 404     this.start = start;
 405   }
 406
 407   /**
 408    * DOCUMENT ME!
 409    *
 410    * @return DOCUMENT ME!
 411    */
 412   public int getStart()
 413   {
 414     return this.start;
 415   }
 416
 417   /**
 418    * DOCUMENT ME!
 419    *
 420    * @param end
 421    *          DOCUMENT ME!
 422    */
 423   public void setEnd(int end)
 424   {
 425     this.end = end;
 426   }
 427
 428   /**
 429    * DOCUMENT ME!
 430    *
 431    * @return DOCUMENT ME!
 432    */
 433   public int getEnd()
 434   {
 435     return this.end;
 436   }
 437
 438   /**
 439    * DOCUMENT ME!
 440    *
 441    * @return DOCUMENT ME!
 442    */
 443   public int getLength()
 444   {
 445     return this.sequence.length;
 446   }
 447
 448   /**
 449    * DOCUMENT ME!
 450    *
 451    * @param seq
 452    *          DOCUMENT ME!
 453    */
 454   public void setSequence(String seq)
 455   {
 456     this.sequence = seq.toCharArray();
 457     checkValidRange();
 458   }
 459
 460   public String getSequenceAsString()
 461   {
 462     return new String(sequence);
 463   }
 464
 465   public String getSequenceAsString(int start, int end)
 466   {
 467     return new String(getSequence(start, end));
 468   }
 469
 470   public char[] getSequence()
 471   {
 472     return sequence;
 473   }
 474
 475   /*
 476    * (non-Javadoc)
 477    *
 478    * @see jalview.datamodel.SequenceI#getSequence(int, int)
 479    */
 480   public char[] getSequence(int start, int end)
 481   {
 482     if (start < 0)
 483       start = 0;
 484     // JBPNote - left to user to pad the result here (TODO:Decide on this
 485     // policy)
 486     if (start >= sequence.length)
 487     {
 488       return new char[0];
 489     }
 490
 491     if (end >= sequence.length)
 492     {
 493       end = sequence.length;
 494     }
 495
 496     char[] reply = new char[end - start];
 497     System.arraycopy(sequence, start, reply, 0, end - start);
 498
 499     return reply;
 500   }
 501
 502   /**
 503    * make a new Sequence object from start to end (including gaps) over this
 504    * seqeunce
 505    *
 506    * @param start
 507    *          int
 508    * @param end
 509    *          int
 510    * @return SequenceI
 511    */
 512   public SequenceI getSubSequence(int start, int end)
 513   {
 514     if (start < 0)
 515     {
 516       start = 0;
 517     }
 518     char[] seq = getSequence(start, end);
 519     if (seq.length == 0)
 520     {
 521       return null;
 522     }
 523     int nstart = findPosition(start);
 524     int nend = findPosition(end) - 1;
 525     // JBPNote - this is an incomplete copy.
 526     SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend);
 527     nseq.setDescription(description);
 528     if (datasetSequence != null)
 529     {
 530       nseq.setDatasetSequence(datasetSequence);
 531     }
 532     else
 533     {
 534       nseq.setDatasetSequence(this);
 535     }
 536     return nseq;
 537   }
 538
 539   /**
 540    * DOCUMENT ME!
 541    *
 542    * @param i
 543    *          DOCUMENT ME!
 544    *
 545    * @return DOCUMENT ME!
 546    */
 547   public char getCharAt(int i)
 548   {
 549     if (i < sequence.length)
 550     {
 551       return sequence[i];
 552     }
 553     else
 554     {
 555       return ' ';
 556     }
 557   }
 558
 559   /**
 560    * DOCUMENT ME!
 561    *
 562    * @param desc
 563    *          DOCUMENT ME!
 564    */
 565   public void setDescription(String desc)
 566   {
 567     this.description = desc;
 568   }
 569
 570   /**
 571    * DOCUMENT ME!
 572    *
 573    * @return DOCUMENT ME!
 574    */
 575   public String getDescription()
 576   {
 577     return this.description;
 578   }
 579
 580   /**
 581    * Return the alignment position for a sequence position
 582    *
 583    * @param pos
 584    *          lying from start to end
 585    *
 586    * @return aligned position of residue pos
 587    */
 588   public int findIndex(int pos)
 589   {
 590     // returns the alignment position for a residue
 591     int j = start;
 592     int i = 0;
 593     // Rely on end being at least as long as the length of the sequence.
 594     while ((i < sequence.length) && (j <= end) && (j <= pos))
 595     {
 596       if (!jalview.util.Comparison.isGap(sequence[i]))
 597       {
 598         j++;
 599       }
 600
 601       i++;
 602     }
 603
 604     if ((j == end) && (j < pos))
 605     {
 606       return end + 1;
 607     }
 608     else
 609     {
 610       return i;
 611     }
 612   }
 613
 614   /**
 615    * Returns the sequence position for an alignment position
 616    *
 617    * @param i
 618    *          column index in alignment (from 1)
 619    *
 620    * @return residue number for residue (left of and) nearest ith column
 621    */
 622   public int findPosition(int i)
 623   {
 624     int j = 0;
 625     int pos = start;
 626     int seqlen = sequence.length;
 627     while ((j < i) && (j < seqlen))
 628     {
 629       if (!jalview.util.Comparison.isGap(sequence[j]))
 630       {
 631         pos++;
 632       }
 633
 634       j++;
 635     }
 636
 637     return pos;
 638   }
 639
 640   /**
 641    * Returns an int array where indices correspond to each residue in the
 642    * sequence and the element value gives its position in the alignment
 643    *
 644    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 645    *         residues in SequenceI object
 646    */
 647   public int[] gapMap()
 648   {
 649     String seq = jalview.analysis.AlignSeq.extractGaps(
 650             jalview.util.Comparison.GapChars, new String(sequence));
 651     int[] map = new int[seq.length()];
 652     int j = 0;
 653     int p = 0;
 654
 655     while (j < sequence.length)
 656     {
 657       if (!jalview.util.Comparison.isGap(sequence[j]))
 658       {
 659         map[p++] = j;
 660       }
 661
 662       j++;
 663     }
 664
 665     return map;
 666   }
 667
 668   /*
 669    * (non-Javadoc)
 670    *
 671    * @see jalview.datamodel.SequenceI#findPositionMap()
 672    */
 673   public int[] findPositionMap()
 674   {
 675     int map[] = new int[sequence.length];
 676     int j = 0;
 677     int pos = start;
 678     int seqlen = sequence.length;
 679     while ((j < seqlen))
 680     {
 681       map[j] = pos;
 682       if (!jalview.util.Comparison.isGap(sequence[j]))
 683       {
 684         pos++;
 685       }
 686
 687       j++;
 688     }
 689     return map;
 690   }
 691
 692   /*
 693    * (non-Javadoc)
 694    *
 695    * @see jalview.datamodel.SequenceI#deleteChars(int, int)
 696    */
 697   public void deleteChars(int i, int j)
 698   {
 699     int newstart = start, newend = end;
 700     if (i >= sequence.length)
 701     {
 702       return;
 703     }
 704
 705     char[] tmp;
 706
 707     if (j >= sequence.length)
 708     {
 709       tmp = new char[i];
 710       System.arraycopy(sequence, 0, tmp, 0, i);
 711     }
 712     else
 713     {
 714       tmp = new char[sequence.length - j + i];
 715       System.arraycopy(sequence, 0, tmp, 0, i);
 716       System.arraycopy(sequence, j, tmp, i, sequence.length - j);
 717     }
 718     boolean createNewDs = false;
 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   public AlignmentAnnotation[] getAnnotation()
 883   {
 884     if (annotation == null)
 885     {
 886       return null;
 887     }
 888
 889     AlignmentAnnotation[] ret = new AlignmentAnnotation[annotation.size()];
 890     for (int r = 0; r < ret.length; r++)
 891     {
 892       ret[r] = (AlignmentAnnotation) annotation.elementAt(r);
 893     }
 894
 895     return ret;
 896   }
 897
 898   public void addAlignmentAnnotation(AlignmentAnnotation annotation)
 899   {
 900     if (this.annotation == null)
 901     {
 902       this.annotation = new Vector();
 903     }
 904
 905     this.annotation.addElement(annotation);
 906     annotation.setSequenceRef(this);
 907   }
 908
 909   public void removeAlignmentAnnotation(AlignmentAnnotation annotation)
 910   {
 911     if (this.annotation != null)
 912     {
 913       this.annotation.removeElement(annotation);
 914       if (this.annotation.size() == 0)
 915         this.annotation = null;
 916     }
 917   }
 918
 919   /**
 920    * test if this is a valid candidate for another sequence's dataset sequence.
 921    *
 922    */
 923   private boolean isValidDatasetSequence()
 924   {
 925     if (datasetSequence != null)
 926     {
 927       return false;
 928     }
 929     for (int i = 0; i < sequence.length; i++)
 930     {
 931       if (jalview.util.Comparison.isGap(sequence[i]))
 932       {
 933         return false;
 934       }
 935     }
 936     return true;
 937   }
 938
 939   /*
 940    * (non-Javadoc)
 941    *
 942    * @see jalview.datamodel.SequenceI#deriveSequence()
 943    */
 944   public SequenceI deriveSequence()
 945   {
 946     SequenceI seq = new Sequence(this);
 947     if (datasetSequence != null)
 948     {
 949       // duplicate current sequence with same dataset
 950       seq.setDatasetSequence(datasetSequence);
 951     }
 952     else
 953     {
 954       if (isValidDatasetSequence())
 955       {
 956         // Use this as dataset sequence
 957         seq.setDatasetSequence(this);
 958       }
 959       else
 960       {
 961         // Create a new, valid dataset sequence
 962         SequenceI ds = seq;
 963         ds.setSequence(AlignSeq.extractGaps(
 964                 jalview.util.Comparison.GapChars, new String(sequence)));
 965         setDatasetSequence(ds);
 966         ds.setSequenceFeatures(getSequenceFeatures());
 967         seq = this; // and return this sequence as the derived sequence.
 968       }
 969     }
 970     return seq;
 971   }
 972
 973   /*
 974    * (non-Javadoc)
 975    *
 976    * @see jalview.datamodel.SequenceI#createDatasetSequence()
 977    */
 978   public SequenceI createDatasetSequence()
 979   {
 980     if (datasetSequence == null)
 981     {
 982       datasetSequence = new Sequence(getName(), AlignSeq.extractGaps(
 983               jalview.util.Comparison.GapChars, getSequenceAsString()),
 984               getStart(), getEnd());
 985       datasetSequence.setSequenceFeatures(getSequenceFeatures());
 986       datasetSequence.setDescription(getDescription());
 987       setSequenceFeatures(null);
 988       // move database references onto dataset sequence
 989       datasetSequence.setDBRef(getDBRef());
 990       setDBRef(null);
 991       datasetSequence.setPDBId(getPDBId());
 992       setPDBId(null);
 993       datasetSequence.updatePDBIds();
 994     }
 995     return datasetSequence;
 996   }
 997
 998   /*
 999    * (non-Javadoc)
1000    *
1001    * @see
1002    * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[]
1003    * annotations)
1004    */
1005   public void setAlignmentAnnotation(AlignmentAnnotation[] annotations)
1006   {
1007     if (annotation != null)
1008     {
1009       annotation.removeAllElements();
1010     }
1011     if (annotations != null)
1012     {
1013       for (int i = 0; i < annotations.length; i++)
1014       {
1015         if (annotations[i] != null)
1016           addAlignmentAnnotation(annotations[i]);
1017       }
1018     }
1019   }
1020
1021   /*
1022    * (non-Javadoc)
1023    *
1024    * @see jalview.datamodel.SequenceI#getAnnotation(java.lang.String)
1025    */
1026   public AlignmentAnnotation[] getAnnotation(String label)
1027   {
1028     if (annotation == null || annotation.size() == 0)
1029     {
1030       return null;
1031     }
1032
1033     Vector subset = new Vector();
1034     Enumeration e = annotation.elements();
1035     while (e.hasMoreElements())
1036     {
1037       AlignmentAnnotation ann = (AlignmentAnnotation) e.nextElement();
1038       if (ann.label != null && ann.label.equals(label))
1039       {
1040         subset.addElement(ann);
1041       }
1042     }
1043     if (subset.size() == 0)
1044     {
1045       return null;
1046     }
1047     AlignmentAnnotation[] anns = new AlignmentAnnotation[subset.size()];
1048     int i = 0;
1049     e = subset.elements();
1050     while (e.hasMoreElements())
1051     {
1052       anns[i++] = (AlignmentAnnotation) e.nextElement();
1053     }
1054     subset.removeAllElements();
1055     return anns;
1056   }
1057
1058   public boolean updatePDBIds()
1059   {
1060     if (datasetSequence != null)
1061     {
1062       // TODO: could merge DBRefs
1063       return datasetSequence.updatePDBIds();
1064     }
1065     if (dbrefs == null || dbrefs.length == 0)
1066     {
1067       return false;
1068     }
1069     Vector newpdb = new Vector();
1070     for (int i = 0; i < dbrefs.length; i++)
1071     {
1072       if (DBRefSource.PDB.equals(dbrefs[i].getSource()))
1073       {
1074         PDBEntry pdbe = new PDBEntry();
1075         pdbe.setId(dbrefs[i].getAccessionId());
1076         if (pdbIds == null || pdbIds.size() == 0)
1077         {
1078           newpdb.addElement(pdbe);
1079         }
1080         else
1081         {
1082           Enumeration en = pdbIds.elements();
1083           boolean matched = false;
1084           while (!matched && en.hasMoreElements())
1085           {
1086             PDBEntry anentry = (PDBEntry) en.nextElement();
1087             if (anentry.getId().equals(pdbe.getId()))
1088             {
1089               matched = true;
1090             }
1091           }
1092           if (!matched)
1093           {
1094             newpdb.addElement(pdbe);
1095           }
1096         }
1097       }
1098     }
1099     if (newpdb.size() > 0)
1100     {
1101       Enumeration en = newpdb.elements();
1102       while (en.hasMoreElements())
1103       {
1104         addPDBId((PDBEntry) en.nextElement());
1105       }
1106       return true;
1107     }
1108     return false;
1109   }
1110
1111   /*
1112    * (non-Javadoc)
1113    *
1114    * @see
1115    * jalview.datamodel.SequenceI#transferAnnotation(jalview.datamodel.SequenceI,
1116    * jalview.datamodel.Mapping)
1117    */
1118   public void transferAnnotation(SequenceI entry, Mapping mp)
1119   {
1120     if (datasetSequence != null)
1121     {
1122       datasetSequence.transferAnnotation(entry, mp);
1123       return;
1124     }
1125     if (entry.getDatasetSequence() != null)
1126     {
1127       transferAnnotation(entry.getDatasetSequence(), mp);
1128       return;
1129     }
1130     // transfer any new features from entry onto sequence
1131     if (entry.getSequenceFeatures() != null)
1132     {
1133
1134       SequenceFeature[] sfs = entry.getSequenceFeatures();
1135       for (int si = 0; si < sfs.length; si++)
1136       {
1137         SequenceFeature sf[] = (mp != null) ? mp.locateFeature(sfs[si])
1138                 : new SequenceFeature[]
1139                 { new SequenceFeature(sfs[si]) };
1140         if (sf != null && sf.length > 0)
1141         {
1142           for (int sfi = 0; sfi < sf.length; sfi++)
1143           {
1144             addSequenceFeature(sf[sfi]);
1145           }
1146         }
1147       }
1148     }
1149
1150     // transfer PDB entries
1151     if (entry.getPDBId() != null)
1152     {
1153       Enumeration e = entry.getPDBId().elements();
1154       while (e.hasMoreElements())
1155       {
1156         PDBEntry pdb = (PDBEntry) e.nextElement();
1157         addPDBId(pdb);
1158       }
1159     }
1160     // transfer database references
1161     DBRefEntry[] entryRefs = entry.getDBRef();
1162     if (entryRefs != null)
1163     {
1164       for (int r = 0; r < entryRefs.length; r++)
1165       {
1166         DBRefEntry newref = new DBRefEntry(entryRefs[r]);
1167         if (newref.getMap() != null && mp != null)
1168         {
1169           // remap ref using our local mapping
1170         }
1171         // we also assume all version string setting is done by dbSourceProxy
1172         /*
1173          * if (!newref.getSource().equalsIgnoreCase(dbSource)) {
1174          * newref.setSource(dbSource); }
1175          */
1176         addDBRef(newref);
1177       }
1178     }
1179   }
1180
1181   /**
1182    * @return The index (zero-based) on this sequence in the MSA.
1183    * It returns {@code -1} if this information is not available.
1184    */
1185   public int getIndex() { return index; }
1186
1187   /**
1188    * Defines the position of this sequence in the MSA.
1189    * Use the value {@code -1} if this information is undefined.
1190    *
1191    * @param The position for this sequence. This value is zero-based (zero for this first sequence)
1192    */
1193   public void setIndex(int value) { index = value; }
1194 }