JAL-1632 add score model params to PCAModel and PCA constructors
[jalview.git] / src / jalview / datamodel / Sequence.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.datamodel;
22
23 import jalview.analysis.AlignSeq;
24 import jalview.api.DBRefEntryI;
25 import jalview.util.Comparison;
26 import jalview.util.DBRefUtils;
27 import jalview.util.MapList;
28 import jalview.util.StringUtils;
29
30 import java.util.ArrayList;
31 import java.util.Arrays;
32 import java.util.Collections;
33 import java.util.Enumeration;
34 import java.util.List;
35 import java.util.Vector;
36
37 import fr.orsay.lri.varna.models.rna.RNA;
38
39 /**
40  * 
41  * Implements the SequenceI interface for a char[] based sequence object.
42  * 
43  * @author $author$
44  * @version $Revision$
45  */
46 public class Sequence extends ASequence implements SequenceI
47 {
48   SequenceI datasetSequence;
49
50   String name;
51
52   private char[] sequence;
53
54   String description;
55
56   int start;
57
58   int end;
59
60   Vector<PDBEntry> pdbIds;
61
62   String vamsasId;
63
64   DBRefEntry[] dbrefs;
65
66   RNA rna;
67
68   /**
69    * This annotation is displayed below the alignment but the positions are tied
70    * to the residues of this sequence
71    *
72    * TODO: change to List<>
73    */
74   Vector<AlignmentAnnotation> annotation;
75
76   /**
77    * The index of the sequence in a MSA
78    */
79   int index = -1;
80
81   /** array of sequence features - may not be null for a valid sequence object */
82   public SequenceFeature[] sequenceFeatures;
83
84   /**
85    * Creates a new Sequence object.
86    * 
87    * @param name
88    *          display name string
89    * @param sequence
90    *          string to form a possibly gapped sequence out of
91    * @param start
92    *          first position of non-gap residue in the sequence
93    * @param end
94    *          last position of ungapped residues (nearly always only used for
95    *          display purposes)
96    */
97   public Sequence(String name, String sequence, int start, int end)
98   {
99     initSeqAndName(name, sequence.toCharArray(), start, end);
100   }
101
102   public Sequence(String name, char[] sequence, int start, int end)
103   {
104     initSeqAndName(name, sequence, start, end);
105   }
106
107   /**
108    * Stage 1 constructor - assign name, sequence, and set start and end fields.
109    * start and end are updated values from name2 if it ends with /start-end
110    * 
111    * @param name2
112    * @param sequence2
113    * @param start2
114    * @param end2
115    */
116   protected void initSeqAndName(String name2, char[] sequence2, int start2,
117           int end2)
118   {
119     this.name = name2;
120     this.sequence = sequence2;
121     this.start = start2;
122     this.end = end2;
123     parseId();
124     checkValidRange();
125   }
126
127   com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
128           "[/][0-9]{1,}[-][0-9]{1,}$");
129
130   com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex("[0-9]{1,}$");
131
132   void parseId()
133   {
134     if (name == null)
135     {
136       System.err
137               .println("POSSIBLE IMPLEMENTATION ERROR: null sequence name passed to constructor.");
138       name = "";
139     }
140     // Does sequence have the /start-end signature?
141     if (limitrx.search(name))
142     {
143       name = limitrx.left();
144       endrx.search(limitrx.stringMatched());
145       setStart(Integer.parseInt(limitrx.stringMatched().substring(1,
146               endrx.matchedFrom() - 1)));
147       setEnd(Integer.parseInt(endrx.stringMatched()));
148     }
149   }
150
151   void checkValidRange()
152   {
153     // Note: JAL-774 :
154     // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
155     {
156       int endRes = 0;
157       for (int j = 0; j < sequence.length; j++)
158       {
159         if (!jalview.util.Comparison.isGap(sequence[j]))
160         {
161           endRes++;
162         }
163       }
164       if (endRes > 0)
165       {
166         endRes += start - 1;
167       }
168
169       if (end < endRes)
170       {
171         end = endRes;
172       }
173     }
174
175   }
176
177   /**
178    * Creates a new Sequence object.
179    * 
180    * @param name
181    *          DOCUMENT ME!
182    * @param sequence
183    *          DOCUMENT ME!
184    */
185   public Sequence(String name, String sequence)
186   {
187     this(name, sequence, 1, -1);
188   }
189
190   /**
191    * Creates a new Sequence object with new AlignmentAnnotations but inherits
192    * any existing dataset sequence reference. If non exists, everything is
193    * copied.
194    * 
195    * @param seq
196    *          if seq is a dataset sequence, behaves like a plain old copy
197    *          constructor
198    */
199   public Sequence(SequenceI seq)
200   {
201     this(seq, seq.getAnnotation());
202   }
203
204   /**
205    * Create a new sequence object with new features, DBRefEntries, and PDBIds
206    * but inherits any existing dataset sequence reference, and duplicate of any
207    * annotation that is present in the given annotation array.
208    * 
209    * @param seq
210    *          the sequence to be copied
211    * @param alAnnotation
212    *          an array of annotation including some associated with seq
213    */
214   public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation)
215   {
216     initSeqFrom(seq, alAnnotation);
217
218   }
219
220   /**
221    * does the heavy lifting when cloning a dataset sequence, or coping data from
222    * dataset to a new derived sequence.
223    * 
224    * @param seq
225    *          - source of attributes.
226    * @param alAnnotation
227    *          - alignment annotation present on seq that should be copied onto
228    *          this sequence
229    */
230   protected void initSeqFrom(SequenceI seq,
231           AlignmentAnnotation[] alAnnotation)
232   {
233     {
234       char[] oseq = seq.getSequence();
235       initSeqAndName(seq.getName(), Arrays.copyOf(oseq, oseq.length),
236               seq.getStart(), seq.getEnd());
237     }
238     description = seq.getDescription();
239     if (seq != datasetSequence)
240     {
241       setDatasetSequence(seq.getDatasetSequence());
242     }
243     if (datasetSequence == null && seq.getDBRefs() != null)
244     {
245       // only copy DBRefs and seqfeatures if we really are a dataset sequence
246       DBRefEntry[] dbr = seq.getDBRefs();
247       for (int i = 0; i < dbr.length; i++)
248       {
249         addDBRef(new DBRefEntry(dbr[i]));
250       }
251       if (seq.getSequenceFeatures() != null)
252       {
253         SequenceFeature[] sf = seq.getSequenceFeatures();
254         for (int i = 0; i < sf.length; i++)
255         {
256           addSequenceFeature(new SequenceFeature(sf[i]));
257         }
258       }
259     }
260     if (seq.getAnnotation() != null)
261     {
262       AlignmentAnnotation[] sqann = seq.getAnnotation();
263       for (int i = 0; i < sqann.length; i++)
264       {
265         if (sqann[i] == null)
266         {
267           continue;
268         }
269         boolean found = (alAnnotation == null);
270         if (!found)
271         {
272           for (int apos = 0; !found && apos < alAnnotation.length; apos++)
273           {
274             found = (alAnnotation[apos] == sqann[i]);
275           }
276         }
277         if (found)
278         {
279           // only copy the given annotation
280           AlignmentAnnotation newann = new AlignmentAnnotation(sqann[i]);
281           addAlignmentAnnotation(newann);
282         }
283       }
284     }
285     if (seq.getAllPDBEntries() != null)
286     {
287       Vector<PDBEntry> ids = seq.getAllPDBEntries();
288       for (PDBEntry pdb : ids)
289       {
290         this.addPDBId(new PDBEntry(pdb));
291       }
292     }
293   }
294
295   @Override
296   public void setSequenceFeatures(SequenceFeature[] features)
297   {
298     if (datasetSequence == null)
299     {
300       sequenceFeatures = features;
301     }
302     else
303     {
304       if (datasetSequence.getSequenceFeatures() != features
305               && datasetSequence.getSequenceFeatures() != null
306               && datasetSequence.getSequenceFeatures().length > 0)
307       {
308         new Exception(
309                 "Warning: JAL-2046 side effect ? Possible implementation error: overwriting dataset sequence features by setting sequence features on alignment")
310                 .printStackTrace();
311       }
312       datasetSequence.setSequenceFeatures(features);
313     }
314   }
315
316   @Override
317   public synchronized void addSequenceFeature(SequenceFeature sf)
318   {
319     if (sequenceFeatures == null && datasetSequence != null)
320     {
321       datasetSequence.addSequenceFeature(sf);
322       return;
323     }
324     if (sequenceFeatures == null)
325     {
326       sequenceFeatures = new SequenceFeature[0];
327     }
328
329     for (int i = 0; i < sequenceFeatures.length; i++)
330     {
331       if (sequenceFeatures[i].equals(sf))
332       {
333         return;
334       }
335     }
336
337     SequenceFeature[] temp = new SequenceFeature[sequenceFeatures.length + 1];
338     System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);
339     temp[sequenceFeatures.length] = sf;
340
341     sequenceFeatures = temp;
342   }
343
344   @Override
345   public void deleteFeature(SequenceFeature sf)
346   {
347     if (sequenceFeatures == null)
348     {
349       if (datasetSequence != null)
350       {
351         datasetSequence.deleteFeature(sf);
352       }
353       return;
354     }
355
356     int index = 0;
357     for (index = 0; index < sequenceFeatures.length; index++)
358     {
359       if (sequenceFeatures[index].equals(sf))
360       {
361         break;
362       }
363     }
364
365     if (index == sequenceFeatures.length)
366     {
367       return;
368     }
369
370     int sfLength = sequenceFeatures.length;
371     if (sfLength < 2)
372     {
373       sequenceFeatures = null;
374     }
375     else
376     {
377       SequenceFeature[] temp = new SequenceFeature[sfLength - 1];
378       System.arraycopy(sequenceFeatures, 0, temp, 0, index);
379
380       if (index < sfLength)
381       {
382         System.arraycopy(sequenceFeatures, index + 1, temp, index,
383                 sequenceFeatures.length - index - 1);
384       }
385
386       sequenceFeatures = temp;
387     }
388   }
389
390   /**
391    * Returns the sequence features (if any), looking first on the sequence, then
392    * on its dataset sequence, and so on until a non-null value is found (or
393    * none). This supports retrieval of sequence features stored on the sequence
394    * (as in the applet) or on the dataset sequence (as in the Desktop version).
395    * 
396    * @return
397    */
398   @Override
399   public SequenceFeature[] getSequenceFeatures()
400   {
401     SequenceFeature[] features = sequenceFeatures;
402
403     SequenceI seq = this;
404     int count = 0; // failsafe against loop in sequence.datasetsequence...
405     while (features == null && seq.getDatasetSequence() != null
406             && count++ < 10)
407     {
408       seq = seq.getDatasetSequence();
409       features = ((Sequence) seq).sequenceFeatures;
410     }
411     return features;
412   }
413
414   @Override
415   public boolean addPDBId(PDBEntry entry)
416   {
417     if (pdbIds == null)
418     {
419       pdbIds = new Vector<PDBEntry>();
420       pdbIds.add(entry);
421       return true;
422     }
423
424     for (PDBEntry pdbe : pdbIds)
425     {
426       if (pdbe.updateFrom(entry))
427       {
428         return false;
429       }
430     }
431     pdbIds.addElement(entry);
432     return true;
433   }
434
435   /**
436    * DOCUMENT ME!
437    * 
438    * @param id
439    *          DOCUMENT ME!
440    */
441   @Override
442   public void setPDBId(Vector<PDBEntry> id)
443   {
444     pdbIds = id;
445   }
446
447   /**
448    * DOCUMENT ME!
449    * 
450    * @return DOCUMENT ME!
451    */
452   @Override
453   public Vector<PDBEntry> getAllPDBEntries()
454   {
455     return pdbIds == null ? new Vector<PDBEntry>() : pdbIds;
456   }
457
458   /**
459    * DOCUMENT ME!
460    * 
461    * @return DOCUMENT ME!
462    */
463   @Override
464   public String getDisplayId(boolean jvsuffix)
465   {
466     StringBuffer result = new StringBuffer(name);
467     if (jvsuffix)
468     {
469       result.append("/" + start + "-" + end);
470     }
471
472     return result.toString();
473   }
474
475   /**
476    * DOCUMENT ME!
477    * 
478    * @param name
479    *          DOCUMENT ME!
480    */
481   @Override
482   public void setName(String name)
483   {
484     this.name = name;
485     this.parseId();
486   }
487
488   /**
489    * DOCUMENT ME!
490    * 
491    * @return DOCUMENT ME!
492    */
493   @Override
494   public String getName()
495   {
496     return this.name;
497   }
498
499   /**
500    * DOCUMENT ME!
501    * 
502    * @param start
503    *          DOCUMENT ME!
504    */
505   @Override
506   public void setStart(int start)
507   {
508     this.start = start;
509   }
510
511   /**
512    * DOCUMENT ME!
513    * 
514    * @return DOCUMENT ME!
515    */
516   @Override
517   public int getStart()
518   {
519     return this.start;
520   }
521
522   /**
523    * DOCUMENT ME!
524    * 
525    * @param end
526    *          DOCUMENT ME!
527    */
528   @Override
529   public void setEnd(int end)
530   {
531     this.end = end;
532   }
533
534   /**
535    * DOCUMENT ME!
536    * 
537    * @return DOCUMENT ME!
538    */
539   @Override
540   public int getEnd()
541   {
542     return this.end;
543   }
544
545   /**
546    * DOCUMENT ME!
547    * 
548    * @return DOCUMENT ME!
549    */
550   @Override
551   public int getLength()
552   {
553     return this.sequence.length;
554   }
555
556   /**
557    * DOCUMENT ME!
558    * 
559    * @param seq
560    *          DOCUMENT ME!
561    */
562   @Override
563   public void setSequence(String seq)
564   {
565     this.sequence = seq.toCharArray();
566     checkValidRange();
567   }
568
569   @Override
570   public String getSequenceAsString()
571   {
572     return new String(sequence);
573   }
574
575   @Override
576   public String getSequenceAsString(int start, int end)
577   {
578     return new String(getSequence(start, end));
579   }
580
581   @Override
582   public char[] getSequence()
583   {
584     return sequence;
585   }
586
587   /*
588    * (non-Javadoc)
589    * 
590    * @see jalview.datamodel.SequenceI#getSequence(int, int)
591    */
592   @Override
593   public char[] getSequence(int start, int end)
594   {
595     if (start < 0)
596     {
597       start = 0;
598     }
599     // JBPNote - left to user to pad the result here (TODO:Decide on this
600     // policy)
601     if (start >= sequence.length)
602     {
603       return new char[0];
604     }
605
606     if (end >= sequence.length)
607     {
608       end = sequence.length;
609     }
610
611     char[] reply = new char[end - start];
612     System.arraycopy(sequence, start, reply, 0, end - start);
613
614     return reply;
615   }
616
617   @Override
618   public SequenceI getSubSequence(int start, int end)
619   {
620     if (start < 0)
621     {
622       start = 0;
623     }
624     char[] seq = getSequence(start, end);
625     if (seq.length == 0)
626     {
627       return null;
628     }
629     int nstart = findPosition(start);
630     int nend = findPosition(end) - 1;
631     // JBPNote - this is an incomplete copy.
632     SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend);
633     nseq.setDescription(description);
634     if (datasetSequence != null)
635     {
636       nseq.setDatasetSequence(datasetSequence);
637     }
638     else
639     {
640       nseq.setDatasetSequence(this);
641     }
642     return nseq;
643   }
644
645   /**
646    * Returns the character of the aligned sequence at the given position (base
647    * zero), or space if the position is not within the sequence's bounds
648    * 
649    * @return
650    */
651   @Override
652   public char getCharAt(int i)
653   {
654     if (i >= 0 && i < sequence.length)
655     {
656       return sequence[i];
657     }
658     else
659     {
660       return ' ';
661     }
662   }
663
664   /**
665    * DOCUMENT ME!
666    * 
667    * @param desc
668    *          DOCUMENT ME!
669    */
670   @Override
671   public void setDescription(String desc)
672   {
673     this.description = desc;
674   }
675
676   /**
677    * DOCUMENT ME!
678    * 
679    * @return DOCUMENT ME!
680    */
681   @Override
682   public String getDescription()
683   {
684     return this.description;
685   }
686
687   /*
688    * (non-Javadoc)
689    * 
690    * @see jalview.datamodel.SequenceI#findIndex(int)
691    */
692   @Override
693   public int findIndex(int pos)
694   {
695     // returns the alignment position for a residue
696     int j = start;
697     int i = 0;
698     // Rely on end being at least as long as the length of the sequence.
699     while ((i < sequence.length) && (j <= end) && (j <= pos))
700     {
701       if (!jalview.util.Comparison.isGap(sequence[i]))
702       {
703         j++;
704       }
705
706       i++;
707     }
708
709     if ((j == end) && (j < pos))
710     {
711       return end + 1;
712     }
713     else
714     {
715       return i;
716     }
717   }
718
719   @Override
720   public int findPosition(int i)
721   {
722     int j = 0;
723     int pos = start;
724     int seqlen = sequence.length;
725     while ((j < i) && (j < seqlen))
726     {
727       if (!jalview.util.Comparison.isGap(sequence[j]))
728       {
729         pos++;
730       }
731
732       j++;
733     }
734
735     return pos;
736   }
737
738   /**
739    * Returns an int array where indices correspond to each residue in the
740    * sequence and the element value gives its position in the alignment
741    * 
742    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
743    *         residues in SequenceI object
744    */
745   @Override
746   public int[] gapMap()
747   {
748     String seq = jalview.analysis.AlignSeq.extractGaps(
749             jalview.util.Comparison.GapChars, new String(sequence));
750     int[] map = new int[seq.length()];
751     int j = 0;
752     int p = 0;
753
754     while (j < sequence.length)
755     {
756       if (!jalview.util.Comparison.isGap(sequence[j]))
757       {
758         map[p++] = j;
759       }
760
761       j++;
762     }
763
764     return map;
765   }
766
767   @Override
768   public int[] findPositionMap()
769   {
770     int map[] = new int[sequence.length];
771     int j = 0;
772     int pos = start;
773     int seqlen = sequence.length;
774     while ((j < seqlen))
775     {
776       map[j] = pos;
777       if (!jalview.util.Comparison.isGap(sequence[j]))
778       {
779         pos++;
780       }
781
782       j++;
783     }
784     return map;
785   }
786
787   @Override
788   public List<int[]> getInsertions()
789   {
790     ArrayList<int[]> map = new ArrayList<int[]>();
791     int lastj = -1, j = 0;
792     int pos = start;
793     int seqlen = sequence.length;
794     while ((j < seqlen))
795     {
796       if (jalview.util.Comparison.isGap(sequence[j]))
797       {
798         if (lastj == -1)
799         {
800           lastj = j;
801         }
802       }
803       else
804       {
805         if (lastj != -1)
806         {
807           map.add(new int[] { lastj, j - 1 });
808           lastj = -1;
809         }
810       }
811       j++;
812     }
813     if (lastj != -1)
814     {
815       map.add(new int[] { lastj, j - 1 });
816       lastj = -1;
817     }
818     return map;
819   }
820
821   @Override
822   public void deleteChars(int i, int j)
823   {
824     int newstart = start, newend = end;
825     if (i >= sequence.length || i < 0)
826     {
827       return;
828     }
829
830     char[] tmp = StringUtils.deleteChars(sequence, i, j);
831     boolean createNewDs = false;
832     // TODO: take a (second look) at the dataset creation validation method for
833     // the very large sequence case
834     int eindex = -1, sindex = -1;
835     boolean ecalc = false, scalc = false;
836     for (int s = i; s < j; s++)
837     {
838       if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23)
839       {
840         if (createNewDs)
841         {
842           newend--;
843         }
844         else
845         {
846           if (!scalc)
847           {
848             sindex = findIndex(start) - 1;
849             scalc = true;
850           }
851           if (sindex == s)
852           {
853             // delete characters including start of sequence
854             newstart = findPosition(j);
855             break; // don't need to search for any more residue characters.
856           }
857           else
858           {
859             // delete characters after start.
860             if (!ecalc)
861             {
862               eindex = findIndex(end) - 1;
863               ecalc = true;
864             }
865             if (eindex < j)
866             {
867               // delete characters at end of sequence
868               newend = findPosition(i - 1);
869               break; // don't need to search for any more residue characters.
870             }
871             else
872             {
873               createNewDs = true;
874               newend--; // decrease end position by one for the deleted residue
875               // and search further
876             }
877           }
878         }
879       }
880     }
881     // deletion occured in the middle of the sequence
882     if (createNewDs && this.datasetSequence != null)
883     {
884       // construct a new sequence
885       Sequence ds = new Sequence(datasetSequence);
886       // TODO: remove any non-inheritable properties ?
887       // TODO: create a sequence mapping (since there is a relation here ?)
888       ds.deleteChars(i, j);
889       datasetSequence = ds;
890     }
891     start = newstart;
892     end = newend;
893     sequence = tmp;
894   }
895
896   @Override
897   public void insertCharAt(int i, int length, char c)
898   {
899     char[] tmp = new char[sequence.length + length];
900
901     if (i >= sequence.length)
902     {
903       System.arraycopy(sequence, 0, tmp, 0, sequence.length);
904       i = sequence.length;
905     }
906     else
907     {
908       System.arraycopy(sequence, 0, tmp, 0, i);
909     }
910
911     int index = i;
912     while (length > 0)
913     {
914       tmp[index++] = c;
915       length--;
916     }
917
918     if (i < sequence.length)
919     {
920       System.arraycopy(sequence, i, tmp, index, sequence.length - i);
921     }
922
923     sequence = tmp;
924   }
925
926   @Override
927   public void insertCharAt(int i, char c)
928   {
929     insertCharAt(i, 1, c);
930   }
931
932   @Override
933   public String getVamsasId()
934   {
935     return vamsasId;
936   }
937
938   @Override
939   public void setVamsasId(String id)
940   {
941     vamsasId = id;
942   }
943
944   @Override
945   public void setDBRefs(DBRefEntry[] dbref)
946   {
947     if (dbrefs == null && datasetSequence != null
948             && this != datasetSequence)
949     {
950       datasetSequence.setDBRefs(dbref);
951       return;
952     }
953     dbrefs = dbref;
954     if (dbrefs != null)
955     {
956       DBRefUtils.ensurePrimaries(this);
957     }
958   }
959
960   @Override
961   public DBRefEntry[] getDBRefs()
962   {
963     if (dbrefs == null && datasetSequence != null
964             && this != datasetSequence)
965     {
966       return datasetSequence.getDBRefs();
967     }
968     return dbrefs;
969   }
970
971   @Override
972   public void addDBRef(DBRefEntry entry)
973   {
974     if (datasetSequence != null)
975     {
976       datasetSequence.addDBRef(entry);
977       return;
978     }
979
980     if (dbrefs == null)
981     {
982       dbrefs = new DBRefEntry[0];
983     }
984
985     for (DBRefEntryI dbr : dbrefs)
986     {
987       if (dbr.updateFrom(entry))
988       {
989         /*
990          * found a dbref that either matched, or could be
991          * updated from, the new entry - no need to add it
992          */
993         return;
994       }
995     }
996
997     /*
998      * extend the array to make room for one more
999      */
1000     // TODO use an ArrayList instead
1001     int j = dbrefs.length;
1002     DBRefEntry[] temp = new DBRefEntry[j + 1];
1003     System.arraycopy(dbrefs, 0, temp, 0, j);
1004     temp[temp.length - 1] = entry;
1005
1006     dbrefs = temp;
1007
1008     DBRefUtils.ensurePrimaries(this);
1009   }
1010
1011   @Override
1012   public void setDatasetSequence(SequenceI seq)
1013   {
1014     if (seq == this)
1015     {
1016       throw new IllegalArgumentException(
1017               "Implementation Error: self reference passed to SequenceI.setDatasetSequence");
1018     }
1019     if (seq != null && seq.getDatasetSequence() != null)
1020     {
1021       throw new IllegalArgumentException(
1022               "Implementation error: cascading dataset sequences are not allowed.");
1023     }
1024     datasetSequence = seq;
1025   }
1026
1027   @Override
1028   public SequenceI getDatasetSequence()
1029   {
1030     return datasetSequence;
1031   }
1032
1033   @Override
1034   public AlignmentAnnotation[] getAnnotation()
1035   {
1036     return annotation == null ? null : annotation
1037             .toArray(new AlignmentAnnotation[annotation.size()]);
1038   }
1039
1040   @Override
1041   public boolean hasAnnotation(AlignmentAnnotation ann)
1042   {
1043     return annotation == null ? false : annotation.contains(ann);
1044   }
1045
1046   @Override
1047   public void addAlignmentAnnotation(AlignmentAnnotation annotation)
1048   {
1049     if (this.annotation == null)
1050     {
1051       this.annotation = new Vector<AlignmentAnnotation>();
1052     }
1053     if (!this.annotation.contains(annotation))
1054     {
1055       this.annotation.addElement(annotation);
1056     }
1057     annotation.setSequenceRef(this);
1058   }
1059
1060   @Override
1061   public void removeAlignmentAnnotation(AlignmentAnnotation annotation)
1062   {
1063     if (this.annotation != null)
1064     {
1065       this.annotation.removeElement(annotation);
1066       if (this.annotation.size() == 0)
1067       {
1068         this.annotation = null;
1069       }
1070     }
1071   }
1072
1073   /**
1074    * test if this is a valid candidate for another sequence's dataset sequence.
1075    * 
1076    */
1077   private boolean isValidDatasetSequence()
1078   {
1079     if (datasetSequence != null)
1080     {
1081       return false;
1082     }
1083     for (int i = 0; i < sequence.length; i++)
1084     {
1085       if (jalview.util.Comparison.isGap(sequence[i]))
1086       {
1087         return false;
1088       }
1089     }
1090     return true;
1091   }
1092
1093   @Override
1094   public SequenceI deriveSequence()
1095   {
1096     Sequence seq = null;
1097     if (datasetSequence == null)
1098     {
1099       if (isValidDatasetSequence())
1100       {
1101         // Use this as dataset sequence
1102         seq = new Sequence(getName(), "", 1, -1);
1103         seq.setDatasetSequence(this);
1104         seq.initSeqFrom(this, getAnnotation());
1105         return seq;
1106       }
1107       else
1108       {
1109         // Create a new, valid dataset sequence
1110         createDatasetSequence();
1111       }
1112     }
1113     return new Sequence(this);
1114   }
1115
1116   private boolean _isNa;
1117
1118   private long _seqhash = 0;
1119
1120   /**
1121    * Answers false if the sequence is more than 85% nucleotide (ACGTU), else
1122    * true
1123    */
1124   @Override
1125   public boolean isProtein()
1126   {
1127     if (datasetSequence != null)
1128     {
1129       return datasetSequence.isProtein();
1130     }
1131     if (_seqhash != sequence.hashCode())
1132     {
1133       _seqhash = sequence.hashCode();
1134       _isNa = Comparison.isNucleotide(this);
1135     }
1136     return !_isNa;
1137   };
1138
1139   /*
1140    * (non-Javadoc)
1141    * 
1142    * @see jalview.datamodel.SequenceI#createDatasetSequence()
1143    */
1144   @Override
1145   public SequenceI createDatasetSequence()
1146   {
1147     if (datasetSequence == null)
1148     {
1149       Sequence dsseq = new Sequence(getName(), AlignSeq.extractGaps(
1150               jalview.util.Comparison.GapChars, getSequenceAsString()),
1151               getStart(), getEnd());
1152
1153       datasetSequence = dsseq;
1154
1155       dsseq.setDescription(description);
1156       // move features and database references onto dataset sequence
1157       dsseq.sequenceFeatures = sequenceFeatures;
1158       sequenceFeatures = null;
1159       dsseq.dbrefs = dbrefs;
1160       dbrefs = null;
1161       // TODO: search and replace any references to this sequence with
1162       // references to the dataset sequence in Mappings on dbref
1163       dsseq.pdbIds = pdbIds;
1164       pdbIds = null;
1165       datasetSequence.updatePDBIds();
1166       if (annotation != null)
1167       {
1168         // annotation is cloned rather than moved, to preserve what's currently
1169         // on the alignment
1170         for (AlignmentAnnotation aa : annotation)
1171         {
1172           AlignmentAnnotation _aa = new AlignmentAnnotation(aa);
1173           _aa.sequenceRef = datasetSequence;
1174           _aa.adjustForAlignment(); // uses annotation's own record of
1175                                     // sequence-column mapping
1176           datasetSequence.addAlignmentAnnotation(_aa);
1177         }
1178       }
1179     }
1180     return datasetSequence;
1181   }
1182
1183   /*
1184    * (non-Javadoc)
1185    * 
1186    * @see
1187    * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[]
1188    * annotations)
1189    */
1190   @Override
1191   public void setAlignmentAnnotation(AlignmentAnnotation[] annotations)
1192   {
1193     if (annotation != null)
1194     {
1195       annotation.removeAllElements();
1196     }
1197     if (annotations != null)
1198     {
1199       for (int i = 0; i < annotations.length; i++)
1200       {
1201         if (annotations[i] != null)
1202         {
1203           addAlignmentAnnotation(annotations[i]);
1204         }
1205       }
1206     }
1207   }
1208
1209   @Override
1210   public AlignmentAnnotation[] getAnnotation(String label)
1211   {
1212     if (annotation == null || annotation.size() == 0)
1213     {
1214       return null;
1215     }
1216
1217     Vector subset = new Vector();
1218     Enumeration e = annotation.elements();
1219     while (e.hasMoreElements())
1220     {
1221       AlignmentAnnotation ann = (AlignmentAnnotation) e.nextElement();
1222       if (ann.label != null && ann.label.equals(label))
1223       {
1224         subset.addElement(ann);
1225       }
1226     }
1227     if (subset.size() == 0)
1228     {
1229       return null;
1230     }
1231     AlignmentAnnotation[] anns = new AlignmentAnnotation[subset.size()];
1232     int i = 0;
1233     e = subset.elements();
1234     while (e.hasMoreElements())
1235     {
1236       anns[i++] = (AlignmentAnnotation) e.nextElement();
1237     }
1238     subset.removeAllElements();
1239     return anns;
1240   }
1241
1242   @Override
1243   public boolean updatePDBIds()
1244   {
1245     if (datasetSequence != null)
1246     {
1247       // TODO: could merge DBRefs
1248       return datasetSequence.updatePDBIds();
1249     }
1250     if (dbrefs == null || dbrefs.length == 0)
1251     {
1252       return false;
1253     }
1254     boolean added = false;
1255     for (DBRefEntry dbr : dbrefs)
1256     {
1257       if (DBRefSource.PDB.equals(dbr.getSource()))
1258       {
1259         /*
1260          * 'Add' any PDB dbrefs as a PDBEntry - add is only performed if the
1261          * PDB id is not already present in a 'matching' PDBEntry
1262          * Constructor parses out a chain code if appended to the accession id
1263          * (a fudge used to 'store' the chain code in the DBRef)
1264          */
1265         PDBEntry pdbe = new PDBEntry(dbr);
1266         added |= addPDBId(pdbe);
1267       }
1268     }
1269     return added;
1270   }
1271
1272   @Override
1273   public void transferAnnotation(SequenceI entry, Mapping mp)
1274   {
1275     if (datasetSequence != null)
1276     {
1277       datasetSequence.transferAnnotation(entry, mp);
1278       return;
1279     }
1280     if (entry.getDatasetSequence() != null)
1281     {
1282       transferAnnotation(entry.getDatasetSequence(), mp);
1283       return;
1284     }
1285     // transfer any new features from entry onto sequence
1286     if (entry.getSequenceFeatures() != null)
1287     {
1288
1289       SequenceFeature[] sfs = entry.getSequenceFeatures();
1290       for (int si = 0; si < sfs.length; si++)
1291       {
1292         SequenceFeature sf[] = (mp != null) ? mp.locateFeature(sfs[si])
1293                 : new SequenceFeature[] { new SequenceFeature(sfs[si]) };
1294         if (sf != null && sf.length > 0)
1295         {
1296           for (int sfi = 0; sfi < sf.length; sfi++)
1297           {
1298             addSequenceFeature(sf[sfi]);
1299           }
1300         }
1301       }
1302     }
1303
1304     // transfer PDB entries
1305     if (entry.getAllPDBEntries() != null)
1306     {
1307       Enumeration e = entry.getAllPDBEntries().elements();
1308       while (e.hasMoreElements())
1309       {
1310         PDBEntry pdb = (PDBEntry) e.nextElement();
1311         addPDBId(pdb);
1312       }
1313     }
1314     // transfer database references
1315     DBRefEntry[] entryRefs = entry.getDBRefs();
1316     if (entryRefs != null)
1317     {
1318       for (int r = 0; r < entryRefs.length; r++)
1319       {
1320         DBRefEntry newref = new DBRefEntry(entryRefs[r]);
1321         if (newref.getMap() != null && mp != null)
1322         {
1323           // remap ref using our local mapping
1324         }
1325         // we also assume all version string setting is done by dbSourceProxy
1326         /*
1327          * if (!newref.getSource().equalsIgnoreCase(dbSource)) {
1328          * newref.setSource(dbSource); }
1329          */
1330         addDBRef(newref);
1331       }
1332     }
1333   }
1334
1335   /**
1336    * @return The index (zero-based) on this sequence in the MSA. It returns
1337    *         {@code -1} if this information is not available.
1338    */
1339   @Override
1340   public int getIndex()
1341   {
1342     return index;
1343   }
1344
1345   /**
1346    * Defines the position of this sequence in the MSA. Use the value {@code -1}
1347    * if this information is undefined.
1348    * 
1349    * @param The
1350    *          position for this sequence. This value is zero-based (zero for
1351    *          this first sequence)
1352    */
1353   @Override
1354   public void setIndex(int value)
1355   {
1356     index = value;
1357   }
1358
1359   @Override
1360   public void setRNA(RNA r)
1361   {
1362     rna = r;
1363   }
1364
1365   @Override
1366   public RNA getRNA()
1367   {
1368     return rna;
1369   }
1370
1371   @Override
1372   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
1373           String label)
1374   {
1375     List<AlignmentAnnotation> result = new ArrayList<AlignmentAnnotation>();
1376     if (this.annotation != null)
1377     {
1378       for (AlignmentAnnotation ann : annotation)
1379       {
1380         if (ann.calcId != null && ann.calcId.equals(calcId)
1381                 && ann.label != null && ann.label.equals(label))
1382         {
1383           result.add(ann);
1384         }
1385       }
1386     }
1387     return result;
1388   }
1389
1390   @Override
1391   public String toString()
1392   {
1393     return getDisplayId(false);
1394   }
1395
1396   @Override
1397   public PDBEntry getPDBEntry(String pdbIdStr)
1398   {
1399     if (getDatasetSequence() != null)
1400     {
1401       return getDatasetSequence().getPDBEntry(pdbIdStr);
1402     }
1403     if (pdbIds == null)
1404     {
1405       return null;
1406     }
1407     List<PDBEntry> entries = getAllPDBEntries();
1408     for (PDBEntry entry : entries)
1409     {
1410       if (entry.getId().equalsIgnoreCase(pdbIdStr))
1411       {
1412         return entry;
1413       }
1414     }
1415     return null;
1416   }
1417
1418   @Override
1419   public List<DBRefEntry> getPrimaryDBRefs()
1420   {
1421     if (datasetSequence != null)
1422     {
1423       return datasetSequence.getPrimaryDBRefs();
1424     }
1425     if (dbrefs == null || dbrefs.length == 0)
1426     {
1427       return Collections.emptyList();
1428     }
1429     synchronized (dbrefs)
1430     {
1431       List<DBRefEntry> primaries = new ArrayList<DBRefEntry>();
1432       DBRefEntry[] tmp = new DBRefEntry[1];
1433       for (DBRefEntry ref : dbrefs)
1434       {
1435         if (!ref.isPrimaryCandidate())
1436         {
1437           continue;
1438         }
1439         if (ref.hasMap())
1440         {
1441           MapList mp = ref.getMap().getMap();
1442           if (mp.getFromLowest() > start || mp.getFromHighest() < end)
1443           {
1444             // map only involves a subsequence, so cannot be primary
1445             continue;
1446           }
1447         }
1448         // whilst it looks like it is a primary ref, we also sanity check type
1449         if (DBRefUtils.getCanonicalName(DBRefSource.PDB).equals(
1450                 DBRefUtils.getCanonicalName(ref.getSource())))
1451         {
1452           // PDB dbrefs imply there should be a PDBEntry associated
1453           // TODO: tighten PDB dbrefs
1454           // formally imply Jalview has actually downloaded and
1455           // parsed the pdb file. That means there should be a cached file
1456           // handle on the PDBEntry, and a real mapping between sequence and
1457           // extracted sequence from PDB file
1458           PDBEntry pdbentry = getPDBEntry(ref.getAccessionId());
1459           if (pdbentry != null && pdbentry.getFile() != null)
1460           {
1461             primaries.add(ref);
1462           }
1463           continue;
1464         }
1465         // check standard protein or dna sources
1466         tmp[0] = ref;
1467         DBRefEntry[] res = DBRefUtils.selectDbRefs(!isProtein(), tmp);
1468         if (res != null && res[0] == tmp[0])
1469         {
1470           primaries.add(ref);
1471           continue;
1472         }
1473       }
1474       return primaries;
1475     }
1476   }
1477
1478 }