src/jalview/commands/EditCommand.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.commands;
  22
  23 import jalview.analysis.AlignSeq;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.Range;
  28 import jalview.datamodel.Sequence;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.datamodel.features.SequenceFeaturesI;
  32 import jalview.util.Comparison;
  33 import jalview.util.ReverseListIterator;
  34 import jalview.util.StringUtils;
  35
  36 import java.util.ArrayList;
  37 import java.util.HashMap;
  38 import java.util.Hashtable;
  39 import java.util.Iterator;
  40 import java.util.List;
  41 import java.util.ListIterator;
  42 import java.util.Map;
  43
  44 /**
  45  *
  46  * <p>
  47  * Title: EditCommmand
  48  * </p>
  49  *
  50  * <p>
  51  * Description: Essential information for performing undo and redo for cut/paste
  52  * insert/delete gap which can be stored in the HistoryList
  53  * </p>
  54  *
  55  * <p>
  56  * Copyright: Copyright (c) 2006
  57  * </p>
  58  *
  59  * <p>
  60  * Company: Dundee University
  61  * </p>
  62  *
  63  * @author not attributable
  64  * @version 1.0
  65  */
  66 public class EditCommand implements CommandI
  67 {
  68   public enum Action
  69   {
  70     INSERT_GAP
  71     {
  72       @Override
  73       public Action getUndoAction()
  74       {
  75         return DELETE_GAP;
  76       }
  77     },
  78     DELETE_GAP
  79     {
  80       @Override
  81       public Action getUndoAction()
  82       {
  83         return INSERT_GAP;
  84       }
  85     },
  86     CUT
  87     {
  88       @Override
  89       public Action getUndoAction()
  90       {
  91         return PASTE;
  92       }
  93     },
  94     PASTE
  95     {
  96       @Override
  97       public Action getUndoAction()
  98       {
  99         return CUT;
 100       }
 101     },
 102     REPLACE
 103     {
 104       @Override
 105       public Action getUndoAction()
 106       {
 107         return REPLACE;
 108       }
 109     },
 110     INSERT_NUC
 111     {
 112       @Override
 113       public Action getUndoAction()
 114       {
 115         return null;
 116       }
 117     };
 118     public abstract Action getUndoAction();
 119   };
 120
 121   private List<Edit> edits = new ArrayList<Edit>();
 122
 123   String description;
 124
 125   public EditCommand()
 126   {
 127   }
 128
 129   public EditCommand(String desc)
 130   {
 131     this.description = desc;
 132   }
 133
 134   public EditCommand(String desc, Action command, SequenceI[] seqs,
 135           int position, int number, AlignmentI al)
 136   {
 137     this.description = desc;
 138     if (command == Action.CUT || command == Action.PASTE)
 139     {
 140       setEdit(new Edit(command, seqs, position, number, al));
 141     }
 142
 143     performEdit(0, null);
 144   }
 145
 146   public EditCommand(String desc, Action command, String replace,
 147           SequenceI[] seqs, int position, int number, AlignmentI al)
 148   {
 149     this.description = desc;
 150     if (command == Action.REPLACE)
 151     {
 152       setEdit(new Edit(command, seqs, position, number, al, replace));
 153     }
 154
 155     performEdit(0, null);
 156   }
 157
 158   /**
 159    * Set the list of edits to the specified item (only).
 160    *
 161    * @param e
 162    */
 163   protected void setEdit(Edit e)
 164   {
 165     edits.clear();
 166     edits.add(e);
 167   }
 168
 169   /**
 170    * Add the given edit command to the stored list of commands. If simply
 171    * expanding the range of the last command added, then modify it instead of
 172    * adding a new command.
 173    *
 174    * @param e
 175    */
 176   public void addEdit(Edit e)
 177   {
 178     if (!expandEdit(edits, e))
 179     {
 180       edits.add(e);
 181     }
 182   }
 183
 184   /**
 185    * Returns true if the new edit is incorporated by updating (expanding the
 186    * range of) the last edit on the list, else false. We can 'expand' the last
 187    * edit if the new one is the same action, on the same sequences, and acts on
 188    * a contiguous range. This is the case where a mouse drag generates a series
 189    * of contiguous gap insertions or deletions.
 190    *
 191    * @param edits
 192    * @param e
 193    * @return
 194    */
 195   protected static boolean expandEdit(List<Edit> edits, Edit e)
 196   {
 197     if (edits == null || edits.isEmpty())
 198     {
 199       return false;
 200     }
 201     Edit lastEdit = edits.get(edits.size() - 1);
 202     Action action = e.command;
 203     if (lastEdit.command != action)
 204     {
 205       return false;
 206     }
 207
 208     /*
 209      * Both commands must act on the same sequences - compare the underlying
 210      * dataset sequences, rather than the aligned sequences, which change as
 211      * they are edited.
 212      */
 213     if (lastEdit.seqs.length != e.seqs.length)
 214     {
 215       return false;
 216     }
 217     for (int i = 0; i < e.seqs.length; i++)
 218     {
 219       if (lastEdit.seqs[i].getDatasetSequence() != e.seqs[i]
 220               .getDatasetSequence())
 221       {
 222         return false;
 223       }
 224     }
 225
 226     /**
 227      * Check a contiguous edit; either
 228      * <ul>
 229      * <li>a new Insert <n> positions to the right of the last <insert n>,
 230      * or</li>
 231      * <li>a new Delete <n> gaps which is <n> positions to the left of the last
 232      * delete.</li>
 233      * </ul>
 234      */
 235     boolean contiguous = (action == Action.INSERT_GAP
 236             && e.position == lastEdit.position + lastEdit.number)
 237             || (action == Action.DELETE_GAP
 238                     && e.position + e.number == lastEdit.position);
 239     if (contiguous)
 240     {
 241       /*
 242        * We are just expanding the range of the last edit. For delete gap, also
 243        * moving the start position left.
 244        */
 245       lastEdit.number += e.number;
 246       lastEdit.seqs = e.seqs;
 247       if (action == Action.DELETE_GAP)
 248       {
 249         lastEdit.position--;
 250       }
 251       return true;
 252     }
 253     return false;
 254   }
 255
 256   /**
 257    * Clear the list of stored edit commands.
 258    *
 259    */
 260   protected void clearEdits()
 261   {
 262     edits.clear();
 263   }
 264
 265   /**
 266    * Returns the i'th stored Edit command.
 267    *
 268    * @param i
 269    * @return
 270    */
 271   protected Edit getEdit(int i)
 272   {
 273     if (i >= 0 && i < edits.size())
 274     {
 275       return edits.get(i);
 276     }
 277     return null;
 278   }
 279
 280   @Override
 281   final public String getDescription()
 282   {
 283     return description;
 284   }
 285
 286   @Override
 287   public int getSize()
 288   {
 289     return edits.size();
 290   }
 291
 292   /**
 293    * Return the alignment for the first edit (or null if no edit).
 294    *
 295    * @return
 296    */
 297   final public AlignmentI getAlignment()
 298   {
 299     return (edits.isEmpty() ? null : edits.get(0).al);
 300   }
 301
 302   /**
 303    * append a new editCommand Note. this shouldn't be called if the edit is an
 304    * operation affects more alignment objects than the one referenced in al (for
 305    * example, cut or pasting whole sequences). Use the form with an additional
 306    * AlignmentI[] views parameter.
 307    *
 308    * @param command
 309    * @param seqs
 310    * @param position
 311    * @param number
 312    * @param al
 313    * @param performEdit
 314    */
 315   final public void appendEdit(Action command, SequenceI[] seqs,
 316           int position, int number, AlignmentI al, boolean performEdit)
 317   {
 318     appendEdit(command, seqs, position, number, al, performEdit, null);
 319   }
 320
 321   /**
 322    * append a new edit command with a set of alignment views that may be
 323    * operated on
 324    *
 325    * @param command
 326    * @param seqs
 327    * @param position
 328    * @param number
 329    * @param al
 330    * @param performEdit
 331    * @param views
 332    */
 333   final public void appendEdit(Action command, SequenceI[] seqs,
 334           int position, int number, AlignmentI al, boolean performEdit,
 335           AlignmentI[] views)
 336   {
 337     Edit edit = new Edit(command, seqs, position, number, al);
 338     appendEdit(edit, al, performEdit, views);
 339   }
 340
 341   /**
 342    * Overloaded method that accepts an Edit object with additional parameters.
 343    *
 344    * @param edit
 345    * @param al
 346    * @param performEdit
 347    * @param views
 348    */
 349   final public void appendEdit(Edit edit, AlignmentI al,
 350           boolean performEdit, AlignmentI[] views)
 351   {
 352     if (al.getHeight() == edit.seqs.length)
 353     {
 354       edit.al = al;
 355       edit.fullAlignmentHeight = true;
 356     }
 357
 358     addEdit(edit);
 359
 360     if (performEdit)
 361     {
 362       performEdit(edit, views);
 363     }
 364   }
 365
 366   /**
 367    * Execute all the edit commands, starting at the given commandIndex
 368    *
 369    * @param commandIndex
 370    * @param views
 371    */
 372   public final void performEdit(int commandIndex, AlignmentI[] views)
 373   {
 374     ListIterator<Edit> iterator = edits.listIterator(commandIndex);
 375     while (iterator.hasNext())
 376     {
 377       Edit edit = iterator.next();
 378       performEdit(edit, views);
 379     }
 380   }
 381
 382   /**
 383    * Execute one edit command in all the specified alignment views
 384    *
 385    * @param edit
 386    * @param views
 387    */
 388   protected static void performEdit(Edit edit, AlignmentI[] views)
 389   {
 390     switch (edit.command)
 391     {
 392     case INSERT_GAP:
 393       insertGap(edit);
 394       break;
 395     case DELETE_GAP:
 396       deleteGap(edit);
 397       break;
 398     case CUT:
 399       cut(edit, views);
 400       break;
 401     case PASTE:
 402       paste(edit, views);
 403       break;
 404     case REPLACE:
 405       replace(edit);
 406       break;
 407     case INSERT_NUC:
 408       // TODO:add deleteNuc for UNDO
 409       // case INSERT_NUC:
 410       // insertNuc(edits[e]);
 411       break;
 412     default:
 413       break;
 414     }
 415   }
 416
 417   @Override
 418   final public void doCommand(AlignmentI[] views)
 419   {
 420     performEdit(0, views);
 421   }
 422
 423   /**
 424    * Undo the stored list of commands, in reverse order.
 425    */
 426   @Override
 427   final public void undoCommand(AlignmentI[] views)
 428   {
 429     ListIterator<Edit> iterator = edits.listIterator(edits.size());
 430     while (iterator.hasPrevious())
 431     {
 432       Edit e = iterator.previous();
 433       switch (e.command)
 434       {
 435       case INSERT_GAP:
 436         deleteGap(e);
 437         break;
 438       case DELETE_GAP:
 439         insertGap(e);
 440         break;
 441       case CUT:
 442         paste(e, views);
 443         break;
 444       case PASTE:
 445         cut(e, views);
 446         break;
 447       case REPLACE:
 448         replace(e);
 449         break;
 450       case INSERT_NUC:
 451         // not implemented
 452         break;
 453       default:
 454         break;
 455       }
 456     }
 457   }
 458
 459   /**
 460    * Insert gap(s) in sequences as specified by the command, and adjust
 461    * annotations.
 462    *
 463    * @param command
 464    */
 465   final private static void insertGap(Edit command)
 466   {
 467
 468     for (int s = 0; s < command.seqs.length; s++)
 469     {
 470       command.seqs[s].insertCharAt(command.position, command.number,
 471               command.gapChar);
 472       // System.out.println("pos: "+command.position+" number:
 473       // "+command.number);
 474     }
 475
 476     adjustAnnotations(command, true, false, null);
 477   }
 478
 479   //
 480   // final void insertNuc(Edit command)
 481   // {
 482   //
 483   // for (int s = 0; s < command.seqs.length; s++)
 484   // {
 485   // System.out.println("pos: "+command.position+" number: "+command.number);
 486   // command.seqs[s].insertCharAt(command.position, command.number,'A');
 487   // }
 488   //
 489   // adjustAnnotations(command, true, false, null);
 490   // }
 491
 492   /**
 493    * Delete gap(s) in sequences as specified by the command, and adjust
 494    * annotations.
 495    *
 496    * @param command
 497    */
 498   final static private void deleteGap(Edit command)
 499   {
 500     for (int s = 0; s < command.seqs.length; s++)
 501     {
 502       command.seqs[s].deleteChars(command.position,
 503               command.position + command.number);
 504     }
 505
 506     adjustAnnotations(command, false, false, null);
 507   }
 508
 509   /**
 510    * Carry out a Cut action. The cut characters are saved in case Undo is
 511    * requested.
 512    *
 513    * @param command
 514    * @param views
 515    */
 516   static void cut(Edit command, AlignmentI[] views)
 517   {
 518     boolean seqDeleted = false;
 519     command.string = new char[command.seqs.length][];
 520
 521     for (int i = 0; i < command.seqs.length; i++)
 522     {
 523       final SequenceI sequence = command.seqs[i];
 524       if (sequence.getLength() > command.position)
 525       {
 526         command.string[i] = sequence.getSequence(command.position,
 527                 command.position + command.number);
 528         SequenceI oldds = sequence.getDatasetSequence();
 529         if (command.oldds != null && command.oldds[i] != null)
 530         {
 531           // we are redoing an undone cut.
 532           sequence.setDatasetSequence(null);
 533         }
 534         Range cutPositions = sequence.findPositions(command.position + 1,
 535                 command.position + command.number);
 536         boolean cutIsInternal = cutPositions != null
 537                 && sequence.getStart() != cutPositions
 538                 .getBegin() && sequence.getEnd() != cutPositions.getEnd();
 539         sequence.deleteChars(command.position, command.position
 540                 + command.number);
 541
 542         if (command.oldds != null && command.oldds[i] != null)
 543         {
 544           // oldds entry contains the cut dataset sequence.
 545           sequence.setDatasetSequence(command.oldds[i]);
 546           command.oldds[i] = oldds;
 547         }
 548         else
 549         {
 550           // modify the oldds if necessary
 551           if (oldds != sequence.getDatasetSequence()
 552                   || sequence.getFeatures().hasFeatures())
 553           {
 554             if (command.oldds == null)
 555             {
 556               command.oldds = new SequenceI[command.seqs.length];
 557             }
 558             command.oldds[i] = oldds;
 559
 560             if (cutPositions != null)
 561             {
 562               cutFeatures(command, sequence, cutPositions.getBegin(),
 563                               cutPositions.getEnd(), cutIsInternal);
 564             }
 565           }
 566         }
 567       }
 568
 569       if (sequence.getLength() < 1)
 570       {
 571         command.al.deleteSequence(sequence);
 572         seqDeleted = true;
 573       }
 574     }
 575
 576     adjustAnnotations(command, false, seqDeleted, views);
 577   }
 578
 579   /**
 580    * Perform the given Paste command. This may be to add cut or copied sequences
 581    * to an alignment, or to undo a 'Cut' action on a region of the alignment.
 582    *
 583    * @param command
 584    * @param views
 585    */
 586   static void paste(Edit command, AlignmentI[] views)
 587   {
 588     boolean seqWasDeleted = false;
 589
 590     for (int i = 0; i < command.seqs.length; i++)
 591     {
 592       boolean newDSNeeded = false;
 593       boolean newDSWasNeeded = command.oldds != null
 594               && command.oldds[i] != null;
 595       SequenceI sequence = command.seqs[i];
 596       if (sequence.getLength() < 1)
 597       {
 598         /*
 599          * sequence was deleted; re-add it to the alignment
 600          */
 601         if (command.alIndex[i] < command.al.getHeight())
 602         {
 603           List<SequenceI> sequences;
 604           synchronized (sequences = command.al.getSequences())
 605           {
 606             if (!(command.alIndex[i] < 0))
 607             {
 608               sequences.add(command.alIndex[i], sequence);
 609             }
 610           }
 611         }
 612         else
 613         {
 614           command.al.addSequence(sequence);
 615         }
 616         seqWasDeleted = true;
 617       }
 618       int newStart = sequence.getStart();
 619       int newEnd = sequence.getEnd();
 620
 621       StringBuilder tmp = new StringBuilder();
 622       tmp.append(sequence.getSequence());
 623       // Undo of a delete does not replace original dataset sequence on to
 624       // alignment sequence.
 625
 626       int start = 0;
 627       int length = 0;
 628
 629       if (command.string != null && command.string[i] != null)
 630       {
 631         if (command.position >= tmp.length())
 632         {
 633           // This occurs if padding is on, and residues
 634           // are removed from end of alignment
 635           int len = command.position - tmp.length();
 636           while (len > 0)
 637           {
 638             tmp.append(command.gapChar);
 639             len--;
 640           }
 641         }
 642         tmp.insert(command.position, command.string[i]);
 643         for (int s = 0; s < command.string[i].length; s++)
 644         {
 645           if (!Comparison.isGap(command.string[i][s]))
 646           {
 647             length++;
 648             if (!newDSNeeded)
 649             {
 650               newDSNeeded = true;
 651               start = sequence.findPosition(command.position);
 652               // end = sequence
 653               // .findPosition(command.position + command.number);
 654             }
 655             if (sequence.getStart() == start)
 656             {
 657               newStart--;
 658             }
 659             else
 660             {
 661               newEnd++;
 662             }
 663           }
 664         }
 665         command.string[i] = null;
 666       }
 667
 668       sequence.setSequence(tmp.toString());
 669       sequence.setStart(newStart);
 670       sequence.setEnd(newEnd);
 671
 672       /*
 673        * command and Undo share the same dataset sequence if cut was
 674        * at start or end of sequence
 675        */
 676       boolean sameDatasetSequence = false;
 677       if (newDSNeeded)
 678       {
 679         if (sequence.getDatasetSequence() != null)
 680         {
 681           SequenceI ds;
 682           if (newDSWasNeeded)
 683           {
 684             ds = command.oldds[i];
 685           }
 686           else
 687           {
 688             // make a new DS sequence
 689             // use new ds mechanism here
 690             String ungapped = AlignSeq.extractGaps(Comparison.GapChars,
 691                     sequence.getSequenceAsString());
 692             ds = new Sequence(sequence.getName(), ungapped,
 693                     sequence.getStart(), sequence.getEnd());
 694             ds.setDescription(sequence.getDescription());
 695           }
 696           if (command.oldds == null)
 697           {
 698             command.oldds = new SequenceI[command.seqs.length];
 699           }
 700           command.oldds[i] = sequence.getDatasetSequence();
 701           sameDatasetSequence = ds == sequence.getDatasetSequence();
 702           ds.setSequenceFeatures(sequence.getSequenceFeatures());
 703           sequence.setDatasetSequence(ds);
 704         }
 705         undoCutFeatures(command, command.seqs[i], start, length,
 706                 sameDatasetSequence);
 707       }
 708     }
 709     adjustAnnotations(command, true, seqWasDeleted, views);
 710
 711     command.string = null;
 712   }
 713
 714   static void replace(Edit command)
 715   {
 716     StringBuffer tmp;
 717     String oldstring;
 718     int start = command.position;
 719     int end = command.number;
 720     // TODO TUTORIAL - Fix for replacement with different length of sequence (or
 721     // whole sequence)
 722     // TODO Jalview 2.4 bugfix change to an aggregate command - original
 723     // sequence string is cut, new string is pasted in.
 724     command.number = start + command.string[0].length;
 725     for (int i = 0; i < command.seqs.length; i++)
 726     {
 727       boolean newDSWasNeeded = command.oldds != null
 728               && command.oldds[i] != null;
 729
 730       /**
 731        * cut addHistoryItem(new EditCommand("Cut Sequences", EditCommand.CUT,
 732        * cut, sg.getStartRes(), sg.getEndRes()-sg.getStartRes()+1,
 733        * viewport.alignment));
 734        *
 735        */
 736       /**
 737        * then addHistoryItem(new EditCommand( "Add sequences",
 738        * EditCommand.PASTE, sequences, 0, alignment.getWidth(), alignment) );
 739        *
 740        */
 741       oldstring = command.seqs[i].getSequenceAsString();
 742       tmp = new StringBuffer(oldstring.substring(0, start));
 743       tmp.append(command.string[i]);
 744       String nogaprep = jalview.analysis.AlignSeq.extractGaps(
 745               jalview.util.Comparison.GapChars,
 746               new String(command.string[i]));
 747       int ipos = command.seqs[i].findPosition(start)
 748               - command.seqs[i].getStart();
 749       tmp.append(oldstring.substring(end));
 750       command.seqs[i].setSequence(tmp.toString());
 751       command.string[i] = oldstring.substring(start, end).toCharArray();
 752       String nogapold = AlignSeq.extractGaps(Comparison.GapChars,
 753               new String(command.string[i]));
 754       if (!nogaprep.toLowerCase().equals(nogapold.toLowerCase()))
 755       {
 756         if (newDSWasNeeded)
 757         {
 758           SequenceI oldds = command.seqs[i].getDatasetSequence();
 759           command.seqs[i].setDatasetSequence(command.oldds[i]);
 760           command.oldds[i] = oldds;
 761         }
 762         else
 763         {
 764           if (command.oldds == null)
 765           {
 766             command.oldds = new SequenceI[command.seqs.length];
 767           }
 768           command.oldds[i] = command.seqs[i].getDatasetSequence();
 769           SequenceI newds = new Sequence(
 770                   command.seqs[i].getDatasetSequence());
 771           String fullseq, osp = newds.getSequenceAsString();
 772           fullseq = osp.substring(0, ipos) + nogaprep
 773                   + osp.substring(ipos + nogaprep.length());
 774           newds.setSequence(fullseq.toUpperCase());
 775           // TODO: JAL-1131 ensure newly created dataset sequence is added to
 776           // the set of
 777           // dataset sequences associated with the alignment.
 778           // TODO: JAL-1131 fix up any annotation associated with new dataset
 779           // sequence to ensure that original sequence/annotation relationships
 780           // are preserved.
 781           command.seqs[i].setDatasetSequence(newds);
 782
 783         }
 784       }
 785       tmp = null;
 786       oldstring = null;
 787     }
 788   }
 789
 790   final static void adjustAnnotations(Edit command, boolean insert,
 791           boolean modifyVisibility, AlignmentI[] views)
 792   {
 793     AlignmentAnnotation[] annotations = null;
 794
 795     if (modifyVisibility && !insert)
 796     {
 797       // only occurs if a sequence was added or deleted.
 798       command.deletedAnnotationRows = new Hashtable<SequenceI, AlignmentAnnotation[]>();
 799     }
 800     if (command.fullAlignmentHeight)
 801     {
 802       annotations = command.al.getAlignmentAnnotation();
 803     }
 804     else
 805     {
 806       int aSize = 0;
 807       AlignmentAnnotation[] tmp;
 808       for (int s = 0; s < command.seqs.length; s++)
 809       {
 810         command.seqs[s].sequenceChanged();
 811
 812         if (modifyVisibility)
 813         {
 814           // Rows are only removed or added to sequence object.
 815           if (!insert)
 816           {
 817             // remove rows
 818             tmp = command.seqs[s].getAnnotation();
 819             if (tmp != null)
 820             {
 821               int alen = tmp.length;
 822               for (int aa = 0; aa < tmp.length; aa++)
 823               {
 824                 if (!command.al.deleteAnnotation(tmp[aa]))
 825                 {
 826                   // strip out annotation not in the current al (will be put
 827                   // back on insert in all views)
 828                   tmp[aa] = null;
 829                   alen--;
 830                 }
 831               }
 832               command.seqs[s].setAlignmentAnnotation(null);
 833               if (alen != tmp.length)
 834               {
 835                 // save the non-null annotation references only
 836                 AlignmentAnnotation[] saved = new AlignmentAnnotation[alen];
 837                 for (int aa = 0, aapos = 0; aa < tmp.length; aa++)
 838                 {
 839                   if (tmp[aa] != null)
 840                   {
 841                     saved[aapos++] = tmp[aa];
 842                     tmp[aa] = null;
 843                   }
 844                 }
 845                 tmp = saved;
 846                 command.deletedAnnotationRows.put(command.seqs[s], saved);
 847                 // and then remove any annotation in the other views
 848                 for (int alview = 0; views != null
 849                         && alview < views.length; alview++)
 850                 {
 851                   if (views[alview] != command.al)
 852                   {
 853                     AlignmentAnnotation[] toremove = views[alview]
 854                             .getAlignmentAnnotation();
 855                     if (toremove == null || toremove.length == 0)
 856                     {
 857                       continue;
 858                     }
 859                     // remove any alignment annotation on this sequence that's
 860                     // on that alignment view.
 861                     for (int aa = 0; aa < toremove.length; aa++)
 862                     {
 863                       if (toremove[aa].sequenceRef == command.seqs[s])
 864                       {
 865                         views[alview].deleteAnnotation(toremove[aa]);
 866                       }
 867                     }
 868                   }
 869                 }
 870               }
 871               else
 872               {
 873                 // save all the annotation
 874                 command.deletedAnnotationRows.put(command.seqs[s], tmp);
 875               }
 876             }
 877           }
 878           else
 879           {
 880             // recover rows
 881             if (command.deletedAnnotationRows != null
 882                     && command.deletedAnnotationRows
 883                             .containsKey(command.seqs[s]))
 884             {
 885               AlignmentAnnotation[] revealed = command.deletedAnnotationRows
 886                       .get(command.seqs[s]);
 887               command.seqs[s].setAlignmentAnnotation(revealed);
 888               if (revealed != null)
 889               {
 890                 for (int aa = 0; aa < revealed.length; aa++)
 891                 {
 892                   // iterate through al adding original annotation
 893                   command.al.addAnnotation(revealed[aa]);
 894                 }
 895                 for (int aa = 0; aa < revealed.length; aa++)
 896                 {
 897                   command.al.setAnnotationIndex(revealed[aa], aa);
 898                 }
 899                 // and then duplicate added annotation on every other alignment
 900                 // view
 901                 for (int vnum = 0; views != null && vnum < views.length; vnum++)
 902                 {
 903                   if (views[vnum] != command.al)
 904                   {
 905                     int avwidth = views[vnum].getWidth() + 1;
 906                     // duplicate in this view
 907                     for (int a = 0; a < revealed.length; a++)
 908                     {
 909                       AlignmentAnnotation newann = new AlignmentAnnotation(
 910                               revealed[a]);
 911                       command.seqs[s].addAlignmentAnnotation(newann);
 912                       newann.padAnnotation(avwidth);
 913                       views[vnum].addAnnotation(newann);
 914                       views[vnum].setAnnotationIndex(newann, a);
 915                     }
 916                   }
 917                 }
 918               }
 919             }
 920           }
 921           continue;
 922         }
 923
 924         if (command.seqs[s].getAnnotation() == null)
 925         {
 926           continue;
 927         }
 928
 929         if (aSize == 0)
 930         {
 931           annotations = command.seqs[s].getAnnotation();
 932         }
 933         else
 934         {
 935           tmp = new AlignmentAnnotation[aSize
 936                   + command.seqs[s].getAnnotation().length];
 937
 938           System.arraycopy(annotations, 0, tmp, 0, aSize);
 939
 940           System.arraycopy(command.seqs[s].getAnnotation(), 0, tmp, aSize,
 941                   command.seqs[s].getAnnotation().length);
 942
 943           annotations = tmp;
 944         }
 945         aSize = annotations.length;
 946       }
 947     }
 948
 949     if (annotations == null)
 950     {
 951       return;
 952     }
 953
 954     if (!insert)
 955     {
 956       command.deletedAnnotations = new Hashtable<String, Annotation[]>();
 957     }
 958
 959     int aSize;
 960     Annotation[] temp;
 961     for (int a = 0; a < annotations.length; a++)
 962     {
 963       if (annotations[a].autoCalculated
 964               || annotations[a].annotations == null)
 965       {
 966         continue;
 967       }
 968
 969       int tSize = 0;
 970
 971       aSize = annotations[a].annotations.length;
 972       if (insert)
 973       {
 974         temp = new Annotation[aSize + command.number];
 975         if (annotations[a].padGaps)
 976         {
 977           for (int aa = 0; aa < temp.length; aa++)
 978           {
 979             temp[aa] = new Annotation(command.gapChar + "", null, ' ', 0);
 980           }
 981         }
 982       }
 983       else
 984       {
 985         if (command.position < aSize)
 986         {
 987           if (command.position + command.number >= aSize)
 988           {
 989             tSize = aSize;
 990           }
 991           else
 992           {
 993             tSize = aSize - command.number;
 994           }
 995         }
 996         else
 997         {
 998           tSize = aSize;
 999         }
1000
1001         if (tSize < 0)
1002         {
1003           tSize = aSize;
1004         }
1005         temp = new Annotation[tSize];
1006       }
1007
1008       if (insert)
1009       {
1010         if (command.position < annotations[a].annotations.length)
1011         {
1012           System.arraycopy(annotations[a].annotations, 0, temp, 0,
1013                   command.position);
1014
1015           if (command.deletedAnnotations != null
1016                   && command.deletedAnnotations
1017                           .containsKey(annotations[a].annotationId))
1018           {
1019             Annotation[] restore = command.deletedAnnotations
1020                     .get(annotations[a].annotationId);
1021
1022             System.arraycopy(restore, 0, temp, command.position,
1023                     command.number);
1024
1025           }
1026
1027           System.arraycopy(annotations[a].annotations, command.position,
1028                   temp, command.position + command.number,
1029                   aSize - command.position);
1030         }
1031         else
1032         {
1033           if (command.deletedAnnotations != null
1034                   && command.deletedAnnotations
1035                           .containsKey(annotations[a].annotationId))
1036           {
1037             Annotation[] restore = command.deletedAnnotations
1038                     .get(annotations[a].annotationId);
1039
1040             temp = new Annotation[annotations[a].annotations.length
1041                     + restore.length];
1042             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1043                     annotations[a].annotations.length);
1044             System.arraycopy(restore, 0, temp,
1045                     annotations[a].annotations.length, restore.length);
1046           }
1047           else
1048           {
1049             temp = annotations[a].annotations;
1050           }
1051         }
1052       }
1053       else
1054       {
1055         if (tSize != aSize || command.position < 2)
1056         {
1057           int copylen = Math.min(command.position,
1058                   annotations[a].annotations.length);
1059           if (copylen > 0)
1060           {
1061             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1062                     copylen); // command.position);
1063           }
1064
1065           Annotation[] deleted = new Annotation[command.number];
1066           if (copylen >= command.position)
1067           {
1068             copylen = Math.min(command.number,
1069                     annotations[a].annotations.length - command.position);
1070             if (copylen > 0)
1071             {
1072               System.arraycopy(annotations[a].annotations, command.position,
1073                       deleted, 0, copylen); // command.number);
1074             }
1075           }
1076
1077           command.deletedAnnotations.put(annotations[a].annotationId,
1078                   deleted);
1079           if (annotations[a].annotations.length > command.position
1080                   + command.number)
1081           {
1082             System.arraycopy(annotations[a].annotations,
1083                     command.position + command.number, temp,
1084                     command.position, annotations[a].annotations.length
1085                             - command.position - command.number); // aSize
1086           }
1087         }
1088         else
1089         {
1090           int dSize = aSize - command.position;
1091
1092           if (dSize > 0)
1093           {
1094             Annotation[] deleted = new Annotation[command.number];
1095             System.arraycopy(annotations[a].annotations, command.position,
1096                     deleted, 0, dSize);
1097
1098             command.deletedAnnotations.put(annotations[a].annotationId,
1099                     deleted);
1100
1101             tSize = Math.min(annotations[a].annotations.length,
1102                     command.position);
1103             temp = new Annotation[tSize];
1104             System.arraycopy(annotations[a].annotations, 0, temp, 0, tSize);
1105           }
1106           else
1107           {
1108             temp = annotations[a].annotations;
1109           }
1110         }
1111       }
1112
1113       annotations[a].annotations = temp;
1114     }
1115   }
1116
1117   /**
1118    * Restores features to the state before a Cut.
1119    * <ul>
1120    * <li>re-add any features deleted by the cut</li>
1121    * <li>remove any truncated features created by the cut</li>
1122    * <li>shift right any features to the right of the cut</li>
1123    * </ul>
1124    *
1125    * @param command
1126    *          the Cut command
1127    * @param seq
1128    *          the sequence the Cut applied to
1129    * @param start
1130    *          the start residue position of the cut
1131    * @param length
1132    *          the number of residues cut
1133    * @param sameDatasetSequence
1134    *          true if dataset sequence and frame of reference were left
1135    *          unchanged by the Cut
1136    */
1137   final static void undoCutFeatures(Edit command, SequenceI seq,
1138           final int start, final int length, boolean sameDatasetSequence)
1139   {
1140     SequenceI sequence = seq.getDatasetSequence();
1141     if (sequence == null)
1142     {
1143       sequence = seq;
1144     }
1145
1146     /*
1147      * shift right features that lie to the right of the restored cut (but not
1148      * if dataset sequence unchanged - so coordinates were changed by Cut)
1149      */
1150     if (!sameDatasetSequence)
1151     {
1152       /*
1153        * shift right all features right of and not
1154        * contiguous with the cut position
1155        */
1156       seq.getFeatures().shiftFeatures(start + 1, length);
1157
1158       /*
1159        * shift right any features that start at the cut position,
1160        * unless they were truncated
1161        */
1162       List<SequenceFeature> sfs = seq.getFeatures().findFeatures(start,
1163               start);
1164       for (SequenceFeature sf : sfs)
1165       {
1166         if (sf.getBegin() == start)
1167         {
1168           if (!command.truncatedFeatures.containsKey(seq)
1169                   || !command.truncatedFeatures.get(seq).contains(sf))
1170           {
1171             /*
1172              * feature was shifted left to cut position (not truncated),
1173              * so shift it back right
1174              */
1175             SequenceFeature shifted = new SequenceFeature(sf, sf.getBegin()
1176                     + length, sf.getEnd() + length, sf.getFeatureGroup(),
1177                     sf.getScore());
1178             seq.addSequenceFeature(shifted);
1179             seq.deleteFeature(sf);
1180           }
1181         }
1182       }
1183     }
1184
1185     /*
1186      * restore any features that were deleted or truncated
1187      */
1188     if (command.deletedFeatures != null
1189             && command.deletedFeatures.containsKey(seq))
1190     {
1191       for (SequenceFeature deleted : command.deletedFeatures.get(seq))
1192       {
1193         sequence.addSequenceFeature(deleted);
1194       }
1195     }
1196
1197     /*
1198      * delete any truncated features
1199      */
1200     if (command.truncatedFeatures != null
1201             && command.truncatedFeatures.containsKey(seq))
1202     {
1203       for (SequenceFeature amended : command.truncatedFeatures.get(seq))
1204       {
1205         sequence.deleteFeature(amended);
1206       }
1207     }
1208   }
1209
1210   /**
1211    * Returns the list of edit commands wrapped by this object.
1212    *
1213    * @return
1214    */
1215   public List<Edit> getEdits()
1216   {
1217     return this.edits;
1218   }
1219
1220   /**
1221    * Returns a map whose keys are the dataset sequences, and values their
1222    * aligned sequences before the command edit list was applied. The aligned
1223    * sequences are copies, which may be updated without affecting the originals.
1224    *
1225    * The command holds references to the aligned sequences (after editing). If
1226    * the command is an 'undo',then the prior state is simply the aligned state.
1227    * Otherwise, we have to derive the prior state by working backwards through
1228    * the edit list to infer the aligned sequences before editing.
1229    *
1230    * Note: an alternative solution would be to cache the 'before' state of each
1231    * edit, but this would be expensive in space in the common case that the
1232    * original is never needed (edits are not mirrored).
1233    *
1234    * @return
1235    * @throws IllegalStateException
1236    *           on detecting an edit command of a type that can't be unwound
1237    */
1238   public Map<SequenceI, SequenceI> priorState(boolean forUndo)
1239   {
1240     Map<SequenceI, SequenceI> result = new HashMap<SequenceI, SequenceI>();
1241     if (getEdits() == null)
1242     {
1243       return result;
1244     }
1245     if (forUndo)
1246     {
1247       for (Edit e : getEdits())
1248       {
1249         for (SequenceI seq : e.getSequences())
1250         {
1251           SequenceI ds = seq.getDatasetSequence();
1252           // SequenceI preEdit = result.get(ds);
1253           if (!result.containsKey(ds))
1254           {
1255             /*
1256              * copy sequence including start/end (but don't use copy constructor
1257              * as we don't need annotations)
1258              */
1259             SequenceI preEdit = new Sequence("", seq.getSequenceAsString(),
1260                     seq.getStart(), seq.getEnd());
1261             preEdit.setDatasetSequence(ds);
1262             result.put(ds, preEdit);
1263           }
1264         }
1265       }
1266       return result;
1267     }
1268
1269     /*
1270      * Work backwards through the edit list, deriving the sequences before each
1271      * was applied. The final result is the sequence set before any edits.
1272      */
1273     Iterator<Edit> editList = new ReverseListIterator<Edit>(getEdits());
1274     while (editList.hasNext())
1275     {
1276       Edit oldEdit = editList.next();
1277       Action action = oldEdit.getAction();
1278       int position = oldEdit.getPosition();
1279       int number = oldEdit.getNumber();
1280       final char gap = oldEdit.getGapCharacter();
1281       for (SequenceI seq : oldEdit.getSequences())
1282       {
1283         SequenceI ds = seq.getDatasetSequence();
1284         SequenceI preEdit = result.get(ds);
1285         if (preEdit == null)
1286         {
1287           preEdit = new Sequence("", seq.getSequenceAsString(),
1288                   seq.getStart(), seq.getEnd());
1289           preEdit.setDatasetSequence(ds);
1290           result.put(ds, preEdit);
1291         }
1292         /*
1293          * 'Undo' this edit action on the sequence (updating the value in the
1294          * map).
1295          */
1296         if (ds != null)
1297         {
1298           if (action == Action.DELETE_GAP)
1299           {
1300             preEdit.setSequence(new String(StringUtils.insertCharAt(
1301                     preEdit.getSequence(), position, number, gap)));
1302           }
1303           else if (action == Action.INSERT_GAP)
1304           {
1305             preEdit.setSequence(new String(StringUtils.deleteChars(
1306                     preEdit.getSequence(), position, position + number)));
1307           }
1308           else
1309           {
1310             System.err.println("Can't undo edit action " + action);
1311             // throw new IllegalStateException("Can't undo edit action " +
1312             // action);
1313           }
1314         }
1315       }
1316     }
1317     return result;
1318   }
1319
1320   public class Edit
1321   {
1322     public SequenceI[] oldds;
1323
1324     boolean fullAlignmentHeight = false;
1325
1326     Map<SequenceI, AlignmentAnnotation[]> deletedAnnotationRows;
1327
1328     Map<String, Annotation[]> deletedAnnotations;
1329
1330     /*
1331      * features deleted by the cut (re-add on Undo)
1332      * (including the original of any shortened features)
1333      */
1334     Map<SequenceI, List<SequenceFeature>> deletedFeatures;
1335
1336     /*
1337      * shortened features added by the cut (delete on Undo)
1338      */
1339     Map<SequenceI, List<SequenceFeature>> truncatedFeatures;
1340
1341     AlignmentI al;
1342
1343     Action command;
1344
1345     char[][] string;
1346
1347     SequenceI[] seqs;
1348
1349     int[] alIndex;
1350
1351     int position, number;
1352
1353     char gapChar;
1354
1355     public Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1356             char gap)
1357     {
1358       this.command = cmd;
1359       this.seqs = sqs;
1360       this.position = pos;
1361       this.number = count;
1362       this.gapChar = gap;
1363     }
1364
1365     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1366             AlignmentI align)
1367     {
1368       this(cmd, sqs, pos, count, align.getGapCharacter());
1369
1370       this.al = align;
1371
1372       alIndex = new int[sqs.length];
1373       for (int i = 0; i < sqs.length; i++)
1374       {
1375         alIndex[i] = align.findIndex(sqs[i]);
1376       }
1377
1378       fullAlignmentHeight = (align.getHeight() == sqs.length);
1379     }
1380
1381     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1382             AlignmentI align, String replace)
1383     {
1384       this(cmd, sqs, pos, count, align);
1385
1386       string = new char[sqs.length][];
1387       for (int i = 0; i < sqs.length; i++)
1388       {
1389         string[i] = replace.toCharArray();
1390       }
1391     }
1392
1393     public SequenceI[] getSequences()
1394     {
1395       return seqs;
1396     }
1397
1398     public int getPosition()
1399     {
1400       return position;
1401     }
1402
1403     public Action getAction()
1404     {
1405       return command;
1406     }
1407
1408     public int getNumber()
1409     {
1410       return number;
1411     }
1412
1413     public char getGapCharacter()
1414     {
1415       return gapChar;
1416     }
1417   }
1418
1419   /**
1420    * Returns an iterator over the list of edit commands which traverses the list
1421    * either forwards or backwards.
1422    *
1423    * @param forwards
1424    * @return
1425    */
1426   public Iterator<Edit> getEditIterator(boolean forwards)
1427   {
1428     if (forwards)
1429     {
1430       return getEdits().iterator();
1431     }
1432     else
1433     {
1434       return new ReverseListIterator<Edit>(getEdits());
1435     }
1436   }
1437
1438   /**
1439    * Adjusts features for Cut, and saves details of changes made to allow Undo
1440    * <ul>
1441    * <li>features left of the cut are unchanged</li>
1442    * <li>features right of the cut are shifted left</li>
1443    * <li>features internal to the cut region are deleted</li>
1444    * <li>features that overlap or span the cut are shortened</li>
1445    * <li>the originals of any deleted or shorted features are saved, to re-add
1446    * on Undo</li>
1447    * <li>any added (shortened) features are saved, to delete on Undo</li>
1448    * </ul>
1449    *
1450    * @param command
1451    * @param seq
1452    * @param fromPosition
1453    * @param toPosition
1454    * @param cutIsInternal
1455    */
1456   protected static void cutFeatures(Edit command, SequenceI seq,
1457           int fromPosition, int toPosition, boolean cutIsInternal)
1458   {
1459     if (!cutIsInternal)
1460     {
1461       return;
1462     }
1463     List<SequenceFeature> added = new ArrayList<>();
1464     List<SequenceFeature> removed = new ArrayList<>();
1465
1466     SequenceFeaturesI featureStore = seq.getFeatures();
1467     if (toPosition < fromPosition || featureStore == null)
1468     {
1469       return;
1470     }
1471
1472     int cutStartPos = fromPosition;
1473     int cutEndPos = toPosition;
1474     int cutWidth = cutEndPos - cutStartPos + 1;
1475
1476     synchronized (featureStore)
1477     {
1478       /*
1479        * get features that overlap the cut region
1480        */
1481       List<SequenceFeature> toAmend = featureStore.findFeatures(
1482               cutStartPos, cutEndPos);
1483
1484       /*
1485        * add any contact features that span the cut region
1486        * (not returned by findFeatures)
1487        */
1488       for (SequenceFeature contact : featureStore.getContactFeatures())
1489       {
1490         if (contact.getBegin() < cutStartPos
1491                 && contact.getEnd() > cutEndPos)
1492         {
1493           toAmend.add(contact);
1494         }
1495       }
1496
1497       /*
1498        * adjust start-end of overlapping features;
1499        * delete features enclosed by the cut;
1500        * delete partially overlapping contact features
1501        */
1502       for (SequenceFeature sf : toAmend)
1503       {
1504         int sfBegin = sf.getBegin();
1505         int sfEnd = sf.getEnd();
1506         int newBegin = sfBegin;
1507         int newEnd = sfEnd;
1508         boolean toDelete = false;
1509         boolean follows = false;
1510
1511         if (sfBegin >= cutStartPos && sfEnd <= cutEndPos)
1512         {
1513           /*
1514            * feature lies within cut region - delete it
1515            */
1516           toDelete = true;
1517         }
1518         else if (sfBegin < cutStartPos && sfEnd > cutEndPos)
1519         {
1520           /*
1521            * feature spans cut region - left-shift the end
1522            */
1523           newEnd -= cutWidth;
1524         }
1525         else if (sfEnd <= cutEndPos)
1526         {
1527           /*
1528            * feature overlaps left of cut region - truncate right
1529            */
1530           newEnd = cutStartPos - 1;
1531           if (sf.isContactFeature())
1532           {
1533             toDelete = true;
1534           }
1535         }
1536         else if (sfBegin >= cutStartPos)
1537         {
1538           /*
1539            * remaining case - feature overlaps right
1540            * truncate left, adjust end of feature
1541            */
1542           newBegin = cutIsInternal ? cutStartPos : cutEndPos + 1;
1543           newEnd = newBegin + sfEnd - cutEndPos - 1;
1544           if (sf.isContactFeature())
1545           {
1546             toDelete = true;
1547           }
1548         }
1549
1550         seq.deleteFeature(sf);
1551         if (!follows)
1552         {
1553           removed.add(sf);
1554         }
1555         if (!toDelete)
1556         {
1557           SequenceFeature copy = new SequenceFeature(sf, newBegin, newEnd,
1558                   sf.getFeatureGroup(), sf.getScore());
1559           seq.addSequenceFeature(copy);
1560           if (!follows)
1561           {
1562             added.add(copy);
1563           }
1564         }
1565       }
1566
1567       /*
1568        * and left shift any features lying to the right of the cut region
1569        * (but not if the cut is at start or end of sequence)
1570        */
1571       if (cutIsInternal)
1572       {
1573         featureStore.shiftFeatures(cutEndPos + 1, -cutWidth);
1574       }
1575     }
1576
1577     /*
1578      * save deleted and amended features, so that Undo can
1579      * re-add or delete them respectively
1580      */
1581     if (command.deletedFeatures == null)
1582     {
1583       command.deletedFeatures = new HashMap<>();
1584     }
1585     if (command.truncatedFeatures == null)
1586     {
1587       command.truncatedFeatures = new HashMap<>();
1588     }
1589     command.deletedFeatures.put(seq, removed);
1590     command.truncatedFeatures.put(seq, added);
1591   }
1592 }