JAL-2235 raise exceptions if self reference or reference to non-ds sequence is passed...
[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.DBRefUtils;
26 import jalview.util.MapList;
27 import jalview.util.StringUtils;
28
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.Collections;
32 import java.util.Enumeration;
33 import java.util.List;
34 import java.util.Vector;
35
36 import fr.orsay.lri.varna.models.rna.RNA;
37
38 /**
39  * 
40  * Implements the SequenceI interface for a char[] based sequence object.
41  * 
42  * @author $author$
43  * @version $Revision$
44  */
45 public class Sequence extends ASequence implements SequenceI
46 {
47   SequenceI datasetSequence;
48
49   String name;
50
51   private char[] sequence;
52
53   String description;
54
55   int start;
56
57   int end;
58
59   Vector<PDBEntry> pdbIds;
60
61   String vamsasId;
62
63   DBRefEntry[] dbrefs;
64
65   RNA rna;
66
67   /**
68    * This annotation is displayed below the alignment but the positions are tied
69    * to the residues of this sequence
70    *
71    * TODO: change to List<>
72    */
73   Vector<AlignmentAnnotation> annotation;
74
75   /**
76    * The index of the sequence in a MSA
77    */
78   int index = -1;
79
80   /** array of sequence features - may not be null for a valid sequence object */
81   public SequenceFeature[] sequenceFeatures;
82
83   /**
84    * Creates a new Sequence object.
85    * 
86    * @param name
87    *          display name string
88    * @param sequence
89    *          string to form a possibly gapped sequence out of
90    * @param start
91    *          first position of non-gap residue in the sequence
92    * @param end
93    *          last position of ungapped residues (nearly always only used for
94    *          display purposes)
95    */
96   public Sequence(String name, String sequence, int start, int end)
97   {
98     initSeqAndName(name, sequence.toCharArray(), start, end);
99   }
100
101   public Sequence(String name, char[] sequence, int start, int end)
102   {
103     initSeqAndName(name, sequence, start, end);
104   }
105
106   /**
107    * Stage 1 constructor - assign name, sequence, and set start and end fields.
108    * start and end are updated values from name2 if it ends with /start-end
109    * 
110    * @param name2
111    * @param sequence2
112    * @param start2
113    * @param end2
114    */
115   protected void initSeqAndName(String name2, char[] sequence2, int start2,
116           int end2)
117   {
118     this.name = name2;
119     this.sequence = sequence2;
120     this.start = start2;
121     this.end = end2;
122     parseId();
123     checkValidRange();
124   }
125
126   com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
127           "[/][0-9]{1,}[-][0-9]{1,}$");
128
129   com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex("[0-9]{1,}$");
130
131   void parseId()
132   {
133     if (name == null)
134     {
135       System.err
136               .println("POSSIBLE IMPLEMENTATION ERROR: null sequence name passed to constructor.");
137       name = "";
138     }
139     // Does sequence have the /start-end signature?
140     if (limitrx.search(name))
141     {
142       name = limitrx.left();
143       endrx.search(limitrx.stringMatched());
144       setStart(Integer.parseInt(limitrx.stringMatched().substring(1,
145               endrx.matchedFrom() - 1)));
146       setEnd(Integer.parseInt(endrx.stringMatched()));
147     }
148   }
149
150   void checkValidRange()
151   {
152     // Note: JAL-774 :
153     // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
154     {
155       int endRes = 0;
156       for (int j = 0; j < sequence.length; j++)
157       {
158         if (!jalview.util.Comparison.isGap(sequence[j]))
159         {
160           endRes++;
161         }
162       }
163       if (endRes > 0)
164       {
165         endRes += start - 1;
166       }
167
168       if (end < endRes)
169       {
170         end = endRes;
171       }
172     }
173
174   }
175
176   /**
177    * Creates a new Sequence object.
178    * 
179    * @param name
180    *          DOCUMENT ME!
181    * @param sequence
182    *          DOCUMENT ME!
183    */
184   public Sequence(String name, String sequence)
185   {
186     this(name, sequence, 1, -1);
187   }
188
189   /**
190    * Creates a new Sequence object with new AlignmentAnnotations but inherits
191    * any existing dataset sequence reference. If non exists, everything is
192    * copied.
193    * 
194    * @param seq
195    *          if seq is a dataset sequence, behaves like a plain old copy
196    *          constructor
197    */
198   public Sequence(SequenceI seq)
199   {
200     this(seq, seq.getAnnotation());
201   }
202
203   /**
204    * Create a new sequence object with new features, DBRefEntries, and PDBIds
205    * but inherits any existing dataset sequence reference, and duplicate of any
206    * annotation that is present in the given annotation array.
207    * 
208    * @param seq
209    *          the sequence to be copied
210    * @param alAnnotation
211    *          an array of annotation including some associated with seq
212    */
213   public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation)
214   {
215     initSeqFrom(seq, alAnnotation);
216
217   }
218
219   /**
220    * does the heavy lifting when cloning a dataset sequence, or coping data from
221    * dataset to a new derived sequence.
222    * 
223    * @param seq
224    *          - source of attributes.
225    * @param alAnnotation
226    *          - alignment annotation present on seq that should be copied onto
227    *          this sequence
228    */
229   protected void initSeqFrom(SequenceI seq,
230           AlignmentAnnotation[] alAnnotation)
231   {
232     {
233       char[] oseq = seq.getSequence();
234       initSeqAndName(seq.getName(), Arrays.copyOf(oseq, oseq.length),
235               seq.getStart(),
236             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
296   @Override
297   public void setSequenceFeatures(SequenceFeature[] features)
298   {
299     if (datasetSequence == null)
300     {
301       sequenceFeatures = features;
302     }
303     else
304     {
305       if (datasetSequence.getSequenceFeatures() != features
306               && datasetSequence.getSequenceFeatures() != null
307               && datasetSequence.getSequenceFeatures().length > 0)
308       {
309         new Exception(
310                 "Warning: JAL-2046 side effect ? Possible implementation error: overwriting dataset sequence features by setting sequence features on alignment")
311                 .printStackTrace();
312       }
313       datasetSequence.setSequenceFeatures(features);
314     }
315   }
316
317   @Override
318   public synchronized void addSequenceFeature(SequenceFeature sf)
319   {
320     if (sequenceFeatures==null && datasetSequence != null)
321     {
322       datasetSequence.addSequenceFeature(sf);
323       return;
324     }
325     if (sequenceFeatures == null)
326     {
327       sequenceFeatures = new SequenceFeature[0];
328     }
329
330     for (int i = 0; i < sequenceFeatures.length; i++)
331     {
332       if (sequenceFeatures[i].equals(sf))
333       {
334         return;
335       }
336     }
337
338     SequenceFeature[] temp = new SequenceFeature[sequenceFeatures.length + 1];
339     System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);
340     temp[sequenceFeatures.length] = sf;
341
342     sequenceFeatures = temp;
343   }
344
345   @Override
346   public void deleteFeature(SequenceFeature sf)
347   {
348     if (sequenceFeatures == null)
349     {
350       if (datasetSequence!=null) {
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 Error(
1017               "Implementation Error: self reference passed to SequenceI.setDatasetSequence");
1018     }
1019     if (seq != null && seq.getDatasetSequence() != null)
1020     {
1021       throw new Error(
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   @Override
1121   public boolean isProtein()
1122   {
1123     if (datasetSequence != null)
1124     {
1125       return datasetSequence.isProtein();
1126     }
1127     if (_seqhash != sequence.hashCode())
1128     {
1129       _seqhash = sequence.hashCode();
1130       _isNa=jalview.util.Comparison.isNucleotide(new SequenceI[] { this });
1131     }
1132     return !_isNa;
1133   };
1134
1135   /*
1136    * (non-Javadoc)
1137    * 
1138    * @see jalview.datamodel.SequenceI#createDatasetSequence()
1139    */
1140   @Override
1141   public SequenceI createDatasetSequence()
1142   {
1143     if (datasetSequence == null)
1144     {
1145       Sequence dsseq = new Sequence(getName(), AlignSeq.extractGaps(
1146               jalview.util.Comparison.GapChars, getSequenceAsString()),
1147               getStart(), getEnd());
1148
1149       datasetSequence = dsseq;
1150
1151       dsseq.setDescription(description);
1152       // move features and database references onto dataset sequence
1153       dsseq.sequenceFeatures = sequenceFeatures;
1154       sequenceFeatures=null;
1155       dsseq.dbrefs = dbrefs;
1156       dbrefs=null;
1157       // TODO: search and replace any references to this sequence with
1158       // references to the dataset sequence in Mappings on dbref
1159       dsseq.pdbIds = pdbIds;
1160       pdbIds = null;
1161       datasetSequence.updatePDBIds();
1162       if (annotation != null)
1163       {
1164         // annotation is cloned rather than moved, to preserve what's currently
1165         // on the alignment
1166         for (AlignmentAnnotation aa : annotation)
1167         {
1168           AlignmentAnnotation _aa = new AlignmentAnnotation(aa);
1169           _aa.sequenceRef = datasetSequence;
1170           _aa.adjustForAlignment(); // uses annotation's own record of
1171                                     // sequence-column mapping
1172           datasetSequence.addAlignmentAnnotation(_aa);
1173         }
1174       }
1175     }
1176     return datasetSequence;
1177   }
1178
1179   /*
1180    * (non-Javadoc)
1181    * 
1182    * @see
1183    * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[]
1184    * annotations)
1185    */
1186   @Override
1187   public void setAlignmentAnnotation(AlignmentAnnotation[] annotations)
1188   {
1189     if (annotation != null)
1190     {
1191       annotation.removeAllElements();
1192     }
1193     if (annotations != null)
1194     {
1195       for (int i = 0; i < annotations.length; i++)
1196       {
1197         if (annotations[i] != null)
1198         {
1199           addAlignmentAnnotation(annotations[i]);
1200         }
1201       }
1202     }
1203   }
1204
1205   @Override
1206   public AlignmentAnnotation[] getAnnotation(String label)
1207   {
1208     if (annotation == null || annotation.size() == 0)
1209     {
1210       return null;
1211     }
1212
1213     Vector subset = new Vector();
1214     Enumeration e = annotation.elements();
1215     while (e.hasMoreElements())
1216     {
1217       AlignmentAnnotation ann = (AlignmentAnnotation) e.nextElement();
1218       if (ann.label != null && ann.label.equals(label))
1219       {
1220         subset.addElement(ann);
1221       }
1222     }
1223     if (subset.size() == 0)
1224     {
1225       return null;
1226     }
1227     AlignmentAnnotation[] anns = new AlignmentAnnotation[subset.size()];
1228     int i = 0;
1229     e = subset.elements();
1230     while (e.hasMoreElements())
1231     {
1232       anns[i++] = (AlignmentAnnotation) e.nextElement();
1233     }
1234     subset.removeAllElements();
1235     return anns;
1236   }
1237
1238   @Override
1239   public boolean updatePDBIds()
1240   {
1241     if (datasetSequence != null)
1242     {
1243       // TODO: could merge DBRefs
1244       return datasetSequence.updatePDBIds();
1245     }
1246     if (dbrefs == null || dbrefs.length == 0)
1247     {
1248       return false;
1249     }
1250     boolean added = false;
1251     for (DBRefEntry dbr : dbrefs)
1252     {
1253       if (DBRefSource.PDB.equals(dbr.getSource()))
1254       {
1255         /*
1256          * 'Add' any PDB dbrefs as a PDBEntry - add is only performed if the
1257          * PDB id is not already present in a 'matching' PDBEntry
1258          * Constructor parses out a chain code if appended to the accession id
1259          * (a fudge used to 'store' the chain code in the DBRef)
1260          */
1261         PDBEntry pdbe = new PDBEntry(dbr);
1262         added |= addPDBId(pdbe);
1263       }
1264     }
1265     return added;
1266   }
1267
1268   @Override
1269   public void transferAnnotation(SequenceI entry, Mapping mp)
1270   {
1271     if (datasetSequence != null)
1272     {
1273       datasetSequence.transferAnnotation(entry, mp);
1274       return;
1275     }
1276     if (entry.getDatasetSequence() != null)
1277     {
1278       transferAnnotation(entry.getDatasetSequence(), mp);
1279       return;
1280     }
1281     // transfer any new features from entry onto sequence
1282     if (entry.getSequenceFeatures() != null)
1283     {
1284
1285       SequenceFeature[] sfs = entry.getSequenceFeatures();
1286       for (int si = 0; si < sfs.length; si++)
1287       {
1288         SequenceFeature sf[] = (mp != null) ? mp.locateFeature(sfs[si])
1289                 : new SequenceFeature[] { new SequenceFeature(sfs[si]) };
1290         if (sf != null && sf.length > 0)
1291         {
1292           for (int sfi = 0; sfi < sf.length; sfi++)
1293           {
1294             addSequenceFeature(sf[sfi]);
1295           }
1296         }
1297       }
1298     }
1299
1300     // transfer PDB entries
1301     if (entry.getAllPDBEntries() != null)
1302     {
1303       Enumeration e = entry.getAllPDBEntries().elements();
1304       while (e.hasMoreElements())
1305       {
1306         PDBEntry pdb = (PDBEntry) e.nextElement();
1307         addPDBId(pdb);
1308       }
1309     }
1310     // transfer database references
1311     DBRefEntry[] entryRefs = entry.getDBRefs();
1312     if (entryRefs != null)
1313     {
1314       for (int r = 0; r < entryRefs.length; r++)
1315       {
1316         DBRefEntry newref = new DBRefEntry(entryRefs[r]);
1317         if (newref.getMap() != null && mp != null)
1318         {
1319           // remap ref using our local mapping
1320         }
1321         // we also assume all version string setting is done by dbSourceProxy
1322         /*
1323          * if (!newref.getSource().equalsIgnoreCase(dbSource)) {
1324          * newref.setSource(dbSource); }
1325          */
1326         addDBRef(newref);
1327       }
1328     }
1329   }
1330
1331   /**
1332    * @return The index (zero-based) on this sequence in the MSA. It returns
1333    *         {@code -1} if this information is not available.
1334    */
1335   @Override
1336   public int getIndex()
1337   {
1338     return index;
1339   }
1340
1341   /**
1342    * Defines the position of this sequence in the MSA. Use the value {@code -1}
1343    * if this information is undefined.
1344    * 
1345    * @param The
1346    *          position for this sequence. This value is zero-based (zero for
1347    *          this first sequence)
1348    */
1349   @Override
1350   public void setIndex(int value)
1351   {
1352     index = value;
1353   }
1354
1355   @Override
1356   public void setRNA(RNA r)
1357   {
1358     rna = r;
1359   }
1360
1361   @Override
1362   public RNA getRNA()
1363   {
1364     return rna;
1365   }
1366
1367   @Override
1368   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
1369           String label)
1370   {
1371     List<AlignmentAnnotation> result = new ArrayList<AlignmentAnnotation>();
1372     if (this.annotation != null)
1373     {
1374       for (AlignmentAnnotation ann : annotation)
1375       {
1376         if (ann.calcId != null && ann.calcId.equals(calcId)
1377                 && ann.label != null && ann.label.equals(label))
1378         {
1379           result.add(ann);
1380         }
1381       }
1382     }
1383     return result;
1384   }
1385
1386   @Override
1387   public String toString()
1388   {
1389     return getDisplayId(false);
1390   }
1391
1392   @Override
1393   public PDBEntry getPDBEntry(String pdbIdStr)
1394   {
1395     if (getDatasetSequence() != null)
1396     {
1397       return getDatasetSequence().getPDBEntry(pdbIdStr);
1398     }
1399     if (pdbIds == null)
1400     {
1401       return null;
1402     }
1403     List<PDBEntry> entries = getAllPDBEntries();
1404     for (PDBEntry entry : entries)
1405     {
1406       if (entry.getId().equalsIgnoreCase(pdbIdStr))
1407       {
1408         return entry;
1409       }
1410     }
1411     return null;
1412   }
1413
1414
1415   @Override
1416   public List<DBRefEntry> getPrimaryDBRefs()
1417   {
1418     if (datasetSequence!=null)
1419     {
1420       return datasetSequence.getPrimaryDBRefs();
1421     }
1422     if (dbrefs==null || dbrefs.length==0)
1423     {
1424       return Collections.emptyList();
1425     }
1426     synchronized (dbrefs)
1427     {
1428       List<DBRefEntry> primaries = new ArrayList<DBRefEntry>();
1429       DBRefEntry[] tmp = new DBRefEntry[1];
1430       for (DBRefEntry ref : dbrefs)
1431       {
1432         if (!ref.isPrimaryCandidate())
1433         {
1434           continue;
1435         }
1436         if (ref.hasMap())
1437         {
1438           MapList mp = ref.getMap().getMap();
1439           if (mp.getFromLowest() > start || mp.getFromHighest() < end)
1440           {
1441             // map only involves a subsequence, so cannot be primary
1442             continue;
1443           }
1444         }
1445         // whilst it looks like it is a primary ref, we also sanity check type
1446         if (DBRefUtils.getCanonicalName(DBRefSource.PDB).equals(
1447                 DBRefUtils.getCanonicalName(ref.getSource())))
1448         {
1449           // PDB dbrefs imply there should be a PDBEntry associated
1450           // TODO: tighten PDB dbrefs
1451           // formally imply Jalview has actually downloaded and
1452           // parsed the pdb file. That means there should be a cached file
1453           // handle on the PDBEntry, and a real mapping between sequence and
1454           // extracted sequence from PDB file
1455           PDBEntry pdbentry = getPDBEntry(ref.getAccessionId());
1456           if (pdbentry != null && pdbentry.getFile() != null)
1457           {
1458             primaries.add(ref);
1459           }
1460           continue;
1461         }
1462         // check standard protein or dna sources
1463         tmp[0] = ref;
1464         DBRefEntry[] res = DBRefUtils.selectDbRefs(!isProtein(), tmp);
1465         if (res != null && res[0] == tmp[0])
1466         {
1467           primaries.add(ref);
1468           continue;
1469         }
1470       }
1471       return primaries;
1472     }
1473   }
1474
1475 }