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             if (oldds != sequence.getDatasetSequence())
 560             {
 561               oldds.getFeatures().deleteAll();
 562             }
 563
 564             if (cutPositions != null)
 565             {
 566               cutFeatures(command, sequence, cutPositions.getBegin(),
 567                               cutPositions.getEnd(), cutIsInternal);
 568             }
 569           }
 570         }
 571       }
 572
 573       if (sequence.getLength() < 1)
 574       {
 575         command.al.deleteSequence(sequence);
 576         seqDeleted = true;
 577       }
 578     }
 579
 580     adjustAnnotations(command, false, seqDeleted, views);
 581   }
 582
 583   /**
 584    * Perform the given Paste command. This may be to add cut or copied sequences
 585    * to an alignment, or to undo a 'Cut' action on a region of the alignment.
 586    *
 587    * @param command
 588    * @param views
 589    */
 590   static void paste(Edit command, AlignmentI[] views)
 591   {
 592     boolean seqWasDeleted = false;
 593
 594     for (int i = 0; i < command.seqs.length; i++)
 595     {
 596       int start = 0;
 597       int end = 0;
 598       boolean newDSNeeded = false;
 599       boolean newDSWasNeeded = command.oldds != null
 600               && command.oldds[i] != null;
 601       SequenceI sequence = command.seqs[i];
 602       if (sequence.getLength() < 1)
 603       {
 604         /*
 605          * sequence was deleted; re-add it to the alignment
 606          */
 607         if (command.alIndex[i] < command.al.getHeight())
 608         {
 609           List<SequenceI> sequences;
 610           synchronized (sequences = command.al.getSequences())
 611           {
 612             if (!(command.alIndex[i] < 0))
 613             {
 614               sequences.add(command.alIndex[i], sequence);
 615             }
 616           }
 617         }
 618         else
 619         {
 620           command.al.addSequence(sequence);
 621         }
 622         seqWasDeleted = true;
 623       }
 624       int newStart = sequence.getStart();
 625       int newEnd = sequence.getEnd();
 626
 627       StringBuilder tmp = new StringBuilder();
 628       tmp.append(sequence.getSequence());
 629       // Undo of a delete does not replace original dataset sequence on to
 630       // alignment sequence.
 631
 632       if (command.string != null && command.string[i] != null)
 633       {
 634         if (command.position >= tmp.length())
 635         {
 636           // This occurs if padding is on, and residues
 637           // are removed from end of alignment
 638           int length = command.position - tmp.length();
 639           while (length > 0)
 640           {
 641             tmp.append(command.gapChar);
 642             length--;
 643           }
 644         }
 645         tmp.insert(command.position, command.string[i]);
 646         for (int s = 0; s < command.string[i].length; s++)
 647         {
 648           if (!Comparison.isGap(command.string[i][s]))
 649           {
 650             if (!newDSNeeded)
 651             {
 652               newDSNeeded = true;
 653               start = sequence.findPosition(command.position);
 654               end = sequence.findPosition(command.position
 655                       + command.number);
 656             }
 657             if (sequence.getStart() == start)
 658             {
 659               newStart--;
 660             }
 661             else
 662             {
 663               newEnd++;
 664             }
 665           }
 666         }
 667         command.string[i] = null;
 668       }
 669
 670       sequence.setSequence(tmp.toString());
 671       sequence.setStart(newStart);
 672       sequence.setEnd(newEnd);
 673
 674       /*
 675        * command and Undo share the same dataset sequence if cut was
 676        * at start or end of sequence
 677        */
 678       boolean sameDatasetSequence = false;
 679       if (newDSNeeded)
 680       {
 681         if (sequence.getDatasetSequence() != null)
 682         {
 683           SequenceI ds;
 684           if (newDSWasNeeded)
 685           {
 686             ds = command.oldds[i];
 687           }
 688           else
 689           {
 690             // make a new DS sequence
 691             // use new ds mechanism here
 692             String ungapped = AlignSeq.extractGaps(Comparison.GapChars,
 693                     sequence.getSequenceAsString());
 694             ds = new Sequence(sequence.getName(), ungapped,
 695                     sequence.getStart(), sequence.getEnd());
 696             ds.setDescription(sequence.getDescription());
 697           }
 698           if (command.oldds == null)
 699           {
 700             command.oldds = new SequenceI[command.seqs.length];
 701           }
 702           command.oldds[i] = sequence.getDatasetSequence();
 703           sameDatasetSequence = ds == sequence.getDatasetSequence();
 704           ds.setSequenceFeatures(sequence.getSequenceFeatures());
 705           sequence.setDatasetSequence(ds);
 706         }
 707         undoCutFeatures(command, i, start, end, sameDatasetSequence);
 708       }
 709     }
 710     adjustAnnotations(command, true, seqWasDeleted, views);
 711
 712     command.string = null;
 713   }
 714
 715   static void replace(Edit command)
 716   {
 717     StringBuffer tmp;
 718     String oldstring;
 719     int start = command.position;
 720     int end = command.number;
 721     // TODO TUTORIAL - Fix for replacement with different length of sequence (or
 722     // whole sequence)
 723     // TODO Jalview 2.4 bugfix change to an aggregate command - original
 724     // sequence string is cut, new string is pasted in.
 725     command.number = start + command.string[0].length;
 726     for (int i = 0; i < command.seqs.length; i++)
 727     {
 728       boolean newDSWasNeeded = command.oldds != null
 729               && command.oldds[i] != null;
 730
 731       /**
 732        * cut addHistoryItem(new EditCommand("Cut Sequences", EditCommand.CUT,
 733        * cut, sg.getStartRes(), sg.getEndRes()-sg.getStartRes()+1,
 734        * viewport.alignment));
 735        *
 736        */
 737       /**
 738        * then addHistoryItem(new EditCommand( "Add sequences",
 739        * EditCommand.PASTE, sequences, 0, alignment.getWidth(), alignment) );
 740        *
 741        */
 742       oldstring = command.seqs[i].getSequenceAsString();
 743       tmp = new StringBuffer(oldstring.substring(0, start));
 744       tmp.append(command.string[i]);
 745       String nogaprep = jalview.analysis.AlignSeq.extractGaps(
 746               jalview.util.Comparison.GapChars,
 747               new String(command.string[i]));
 748       int ipos = command.seqs[i].findPosition(start)
 749               - command.seqs[i].getStart();
 750       tmp.append(oldstring.substring(end));
 751       command.seqs[i].setSequence(tmp.toString());
 752       command.string[i] = oldstring.substring(start, end).toCharArray();
 753       String nogapold = jalview.analysis.AlignSeq.extractGaps(
 754               jalview.util.Comparison.GapChars,
 755               new String(command.string[i]));
 756       if (!nogaprep.toLowerCase().equals(nogapold.toLowerCase()))
 757       {
 758         if (newDSWasNeeded)
 759         {
 760           SequenceI oldds = command.seqs[i].getDatasetSequence();
 761           command.seqs[i].setDatasetSequence(command.oldds[i]);
 762           command.oldds[i] = oldds;
 763         }
 764         else
 765         {
 766           if (command.oldds == null)
 767           {
 768             command.oldds = new SequenceI[command.seqs.length];
 769           }
 770           command.oldds[i] = command.seqs[i].getDatasetSequence();
 771           SequenceI newds = new Sequence(
 772                   command.seqs[i].getDatasetSequence());
 773           String fullseq, osp = newds.getSequenceAsString();
 774           fullseq = osp.substring(0, ipos) + nogaprep
 775                   + osp.substring(ipos + nogaprep.length());
 776           newds.setSequence(fullseq.toUpperCase());
 777           // TODO: JAL-1131 ensure newly created dataset sequence is added to
 778           // the set of
 779           // dataset sequences associated with the alignment.
 780           // TODO: JAL-1131 fix up any annotation associated with new dataset
 781           // sequence to ensure that original sequence/annotation relationships
 782           // are preserved.
 783           command.seqs[i].setDatasetSequence(newds);
 784
 785         }
 786       }
 787       tmp = null;
 788       oldstring = null;
 789     }
 790   }
 791
 792   final static void adjustAnnotations(Edit command, boolean insert,
 793           boolean modifyVisibility, AlignmentI[] views)
 794   {
 795     AlignmentAnnotation[] annotations = null;
 796
 797     if (modifyVisibility && !insert)
 798     {
 799       // only occurs if a sequence was added or deleted.
 800       command.deletedAnnotationRows = new Hashtable<SequenceI, AlignmentAnnotation[]>();
 801     }
 802     if (command.fullAlignmentHeight)
 803     {
 804       annotations = command.al.getAlignmentAnnotation();
 805     }
 806     else
 807     {
 808       int aSize = 0;
 809       AlignmentAnnotation[] tmp;
 810       for (int s = 0; s < command.seqs.length; s++)
 811       {
 812         command.seqs[s].sequenceChanged();
 813
 814         if (modifyVisibility)
 815         {
 816           // Rows are only removed or added to sequence object.
 817           if (!insert)
 818           {
 819             // remove rows
 820             tmp = command.seqs[s].getAnnotation();
 821             if (tmp != null)
 822             {
 823               int alen = tmp.length;
 824               for (int aa = 0; aa < tmp.length; aa++)
 825               {
 826                 if (!command.al.deleteAnnotation(tmp[aa]))
 827                 {
 828                   // strip out annotation not in the current al (will be put
 829                   // back on insert in all views)
 830                   tmp[aa] = null;
 831                   alen--;
 832                 }
 833               }
 834               command.seqs[s].setAlignmentAnnotation(null);
 835               if (alen != tmp.length)
 836               {
 837                 // save the non-null annotation references only
 838                 AlignmentAnnotation[] saved = new AlignmentAnnotation[alen];
 839                 for (int aa = 0, aapos = 0; aa < tmp.length; aa++)
 840                 {
 841                   if (tmp[aa] != null)
 842                   {
 843                     saved[aapos++] = tmp[aa];
 844                     tmp[aa] = null;
 845                   }
 846                 }
 847                 tmp = saved;
 848                 command.deletedAnnotationRows.put(command.seqs[s], saved);
 849                 // and then remove any annotation in the other views
 850                 for (int alview = 0; views != null
 851                         && alview < views.length; alview++)
 852                 {
 853                   if (views[alview] != command.al)
 854                   {
 855                     AlignmentAnnotation[] toremove = views[alview]
 856                             .getAlignmentAnnotation();
 857                     if (toremove == null || toremove.length == 0)
 858                     {
 859                       continue;
 860                     }
 861                     // remove any alignment annotation on this sequence that's
 862                     // on that alignment view.
 863                     for (int aa = 0; aa < toremove.length; aa++)
 864                     {
 865                       if (toremove[aa].sequenceRef == command.seqs[s])
 866                       {
 867                         views[alview].deleteAnnotation(toremove[aa]);
 868                       }
 869                     }
 870                   }
 871                 }
 872               }
 873               else
 874               {
 875                 // save all the annotation
 876                 command.deletedAnnotationRows.put(command.seqs[s], tmp);
 877               }
 878             }
 879           }
 880           else
 881           {
 882             // recover rows
 883             if (command.deletedAnnotationRows != null
 884                     && command.deletedAnnotationRows
 885                             .containsKey(command.seqs[s]))
 886             {
 887               AlignmentAnnotation[] revealed = command.deletedAnnotationRows
 888                       .get(command.seqs[s]);
 889               command.seqs[s].setAlignmentAnnotation(revealed);
 890               if (revealed != null)
 891               {
 892                 for (int aa = 0; aa < revealed.length; aa++)
 893                 {
 894                   // iterate through al adding original annotation
 895                   command.al.addAnnotation(revealed[aa]);
 896                 }
 897                 for (int aa = 0; aa < revealed.length; aa++)
 898                 {
 899                   command.al.setAnnotationIndex(revealed[aa], aa);
 900                 }
 901                 // and then duplicate added annotation on every other alignment
 902                 // view
 903                 for (int vnum = 0; views != null
 904                         && vnum < views.length; vnum++)
 905                 {
 906                   if (views[vnum] != command.al)
 907                   {
 908                     int avwidth = views[vnum].getWidth() + 1;
 909                     // duplicate in this view
 910                     for (int a = 0; a < revealed.length; a++)
 911                     {
 912                       AlignmentAnnotation newann = new AlignmentAnnotation(
 913                               revealed[a]);
 914                       command.seqs[s].addAlignmentAnnotation(newann);
 915                       newann.padAnnotation(avwidth);
 916                       views[vnum].addAnnotation(newann);
 917                       views[vnum].setAnnotationIndex(newann, a);
 918                     }
 919                   }
 920                 }
 921               }
 922             }
 923           }
 924           continue;
 925         }
 926
 927         if (command.seqs[s].getAnnotation() == null)
 928         {
 929           continue;
 930         }
 931
 932         if (aSize == 0)
 933         {
 934           annotations = command.seqs[s].getAnnotation();
 935         }
 936         else
 937         {
 938           tmp = new AlignmentAnnotation[aSize
 939                   + command.seqs[s].getAnnotation().length];
 940
 941           System.arraycopy(annotations, 0, tmp, 0, aSize);
 942
 943           System.arraycopy(command.seqs[s].getAnnotation(), 0, tmp, aSize,
 944                   command.seqs[s].getAnnotation().length);
 945
 946           annotations = tmp;
 947         }
 948         aSize = annotations.length;
 949       }
 950     }
 951
 952     if (annotations == null)
 953     {
 954       return;
 955     }
 956
 957     if (!insert)
 958     {
 959       command.deletedAnnotations = new Hashtable<String, Annotation[]>();
 960     }
 961
 962     int aSize;
 963     Annotation[] temp;
 964     for (int a = 0; a < annotations.length; a++)
 965     {
 966       if (annotations[a].autoCalculated
 967               || annotations[a].annotations == null)
 968       {
 969         continue;
 970       }
 971
 972       int tSize = 0;
 973
 974       aSize = annotations[a].annotations.length;
 975       if (insert)
 976       {
 977         temp = new Annotation[aSize + command.number];
 978         if (annotations[a].padGaps)
 979         {
 980           for (int aa = 0; aa < temp.length; aa++)
 981           {
 982             temp[aa] = new Annotation(command.gapChar + "", null, ' ', 0);
 983           }
 984         }
 985       }
 986       else
 987       {
 988         if (command.position < aSize)
 989         {
 990           if (command.position + command.number >= aSize)
 991           {
 992             tSize = aSize;
 993           }
 994           else
 995           {
 996             tSize = aSize - command.number;
 997           }
 998         }
 999         else
1000         {
1001           tSize = aSize;
1002         }
1003
1004         if (tSize < 0)
1005         {
1006           tSize = aSize;
1007         }
1008         temp = new Annotation[tSize];
1009       }
1010
1011       if (insert)
1012       {
1013         if (command.position < annotations[a].annotations.length)
1014         {
1015           System.arraycopy(annotations[a].annotations, 0, temp, 0,
1016                   command.position);
1017
1018           if (command.deletedAnnotations != null
1019                   && command.deletedAnnotations
1020                           .containsKey(annotations[a].annotationId))
1021           {
1022             Annotation[] restore = command.deletedAnnotations
1023                     .get(annotations[a].annotationId);
1024
1025             System.arraycopy(restore, 0, temp, command.position,
1026                     command.number);
1027
1028           }
1029
1030           System.arraycopy(annotations[a].annotations, command.position,
1031                   temp, command.position + command.number,
1032                   aSize - command.position);
1033         }
1034         else
1035         {
1036           if (command.deletedAnnotations != null
1037                   && command.deletedAnnotations
1038                           .containsKey(annotations[a].annotationId))
1039           {
1040             Annotation[] restore = command.deletedAnnotations
1041                     .get(annotations[a].annotationId);
1042
1043             temp = new Annotation[annotations[a].annotations.length
1044                     + restore.length];
1045             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1046                     annotations[a].annotations.length);
1047             System.arraycopy(restore, 0, temp,
1048                     annotations[a].annotations.length, restore.length);
1049           }
1050           else
1051           {
1052             temp = annotations[a].annotations;
1053           }
1054         }
1055       }
1056       else
1057       {
1058         if (tSize != aSize || command.position < 2)
1059         {
1060           int copylen = Math.min(command.position,
1061                   annotations[a].annotations.length);
1062           if (copylen > 0)
1063           {
1064             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1065                     copylen); // command.position);
1066           }
1067
1068           Annotation[] deleted = new Annotation[command.number];
1069           if (copylen >= command.position)
1070           {
1071             copylen = Math.min(command.number,
1072                     annotations[a].annotations.length - command.position);
1073             if (copylen > 0)
1074             {
1075               System.arraycopy(annotations[a].annotations, command.position,
1076                       deleted, 0, copylen); // command.number);
1077             }
1078           }
1079
1080           command.deletedAnnotations.put(annotations[a].annotationId,
1081                   deleted);
1082           if (annotations[a].annotations.length > command.position
1083                   + command.number)
1084           {
1085             System.arraycopy(annotations[a].annotations,
1086                     command.position + command.number, temp,
1087                     command.position, annotations[a].annotations.length
1088                             - command.position - command.number); // aSize
1089           }
1090         }
1091         else
1092         {
1093           int dSize = aSize - command.position;
1094
1095           if (dSize > 0)
1096           {
1097             Annotation[] deleted = new Annotation[command.number];
1098             System.arraycopy(annotations[a].annotations, command.position,
1099                     deleted, 0, dSize);
1100
1101             command.deletedAnnotations.put(annotations[a].annotationId,
1102                     deleted);
1103
1104             tSize = Math.min(annotations[a].annotations.length,
1105                     command.position);
1106             temp = new Annotation[tSize];
1107             System.arraycopy(annotations[a].annotations, 0, temp, 0, tSize);
1108           }
1109           else
1110           {
1111             temp = annotations[a].annotations;
1112           }
1113         }
1114       }
1115
1116       annotations[a].annotations = temp;
1117     }
1118   }
1119
1120   final static void undoCutFeatures(Edit command, int index, final int i,
1121           final int j, boolean sameDatasetSequence)
1122   {
1123     SequenceI seq = command.seqs[index];
1124     SequenceI sequence = seq.getDatasetSequence();
1125     if (sequence == null)
1126     {
1127       sequence = seq;
1128     }
1129
1130     /*
1131      * shift right features that lie to the right of the restored cut
1132      * (but not if dataset sequence unchanged - coordinates left unchanged by Cut)
1133      */
1134     if (!sameDatasetSequence)
1135     {
1136       seq.getFeatures().shiftFeatures(i + 1, j - i);
1137     }
1138
1139     /*
1140      * restore any features that were deleted or truncated
1141      */
1142     if (command.deletedFeatures != null
1143             && command.deletedFeatures.containsKey(seq))
1144     {
1145       for (SequenceFeature deleted : command.deletedFeatures.get(seq))
1146       {
1147         sequence.addSequenceFeature(deleted);
1148       }
1149     }
1150
1151     /*
1152      * delete any truncated features
1153      */
1154     if (command.truncatedFeatures != null
1155             && command.truncatedFeatures.containsKey(seq))
1156     {
1157       for (SequenceFeature amended : command.truncatedFeatures.get(seq))
1158       {
1159         sequence.deleteFeature(amended);
1160       }
1161     }
1162   }
1163
1164   /**
1165    * Returns the list of edit commands wrapped by this object.
1166    *
1167    * @return
1168    */
1169   public List<Edit> getEdits()
1170   {
1171     return this.edits;
1172   }
1173
1174   /**
1175    * Returns a map whose keys are the dataset sequences, and values their
1176    * aligned sequences before the command edit list was applied. The aligned
1177    * sequences are copies, which may be updated without affecting the originals.
1178    *
1179    * The command holds references to the aligned sequences (after editing). If
1180    * the command is an 'undo',then the prior state is simply the aligned state.
1181    * Otherwise, we have to derive the prior state by working backwards through
1182    * the edit list to infer the aligned sequences before editing.
1183    *
1184    * Note: an alternative solution would be to cache the 'before' state of each
1185    * edit, but this would be expensive in space in the common case that the
1186    * original is never needed (edits are not mirrored).
1187    *
1188    * @return
1189    * @throws IllegalStateException
1190    *           on detecting an edit command of a type that can't be unwound
1191    */
1192   public Map<SequenceI, SequenceI> priorState(boolean forUndo)
1193   {
1194     Map<SequenceI, SequenceI> result = new HashMap<SequenceI, SequenceI>();
1195     if (getEdits() == null)
1196     {
1197       return result;
1198     }
1199     if (forUndo)
1200     {
1201       for (Edit e : getEdits())
1202       {
1203         for (SequenceI seq : e.getSequences())
1204         {
1205           SequenceI ds = seq.getDatasetSequence();
1206           // SequenceI preEdit = result.get(ds);
1207           if (!result.containsKey(ds))
1208           {
1209             /*
1210              * copy sequence including start/end (but don't use copy constructor
1211              * as we don't need annotations)
1212              */
1213             SequenceI preEdit = new Sequence("", seq.getSequenceAsString(),
1214                     seq.getStart(), seq.getEnd());
1215             preEdit.setDatasetSequence(ds);
1216             result.put(ds, preEdit);
1217           }
1218         }
1219       }
1220       return result;
1221     }
1222
1223     /*
1224      * Work backwards through the edit list, deriving the sequences before each
1225      * was applied. The final result is the sequence set before any edits.
1226      */
1227     Iterator<Edit> editList = new ReverseListIterator<Edit>(getEdits());
1228     while (editList.hasNext())
1229     {
1230       Edit oldEdit = editList.next();
1231       Action action = oldEdit.getAction();
1232       int position = oldEdit.getPosition();
1233       int number = oldEdit.getNumber();
1234       final char gap = oldEdit.getGapCharacter();
1235       for (SequenceI seq : oldEdit.getSequences())
1236       {
1237         SequenceI ds = seq.getDatasetSequence();
1238         SequenceI preEdit = result.get(ds);
1239         if (preEdit == null)
1240         {
1241           preEdit = new Sequence("", seq.getSequenceAsString(),
1242                   seq.getStart(), seq.getEnd());
1243           preEdit.setDatasetSequence(ds);
1244           result.put(ds, preEdit);
1245         }
1246         /*
1247          * 'Undo' this edit action on the sequence (updating the value in the
1248          * map).
1249          */
1250         if (ds != null)
1251         {
1252           if (action == Action.DELETE_GAP)
1253           {
1254             preEdit.setSequence(new String(StringUtils.insertCharAt(
1255                     preEdit.getSequence(), position, number, gap)));
1256           }
1257           else if (action == Action.INSERT_GAP)
1258           {
1259             preEdit.setSequence(new String(StringUtils.deleteChars(
1260                     preEdit.getSequence(), position, position + number)));
1261           }
1262           else
1263           {
1264             System.err.println("Can't undo edit action " + action);
1265             // throw new IllegalStateException("Can't undo edit action " +
1266             // action);
1267           }
1268         }
1269       }
1270     }
1271     return result;
1272   }
1273
1274   public class Edit
1275   {
1276     public SequenceI[] oldds;
1277
1278     boolean fullAlignmentHeight = false;
1279
1280     Map<SequenceI, AlignmentAnnotation[]> deletedAnnotationRows;
1281
1282     Map<String, Annotation[]> deletedAnnotations;
1283
1284     /*
1285      * features deleted by the cut (re-add on Undo)
1286      * (including the original of any shortened features)
1287      */
1288     Map<SequenceI, List<SequenceFeature>> deletedFeatures;
1289
1290     /*
1291      * shortened features added by the cut (delete on Undo)
1292      */
1293     Map<SequenceI, List<SequenceFeature>> truncatedFeatures;
1294
1295     AlignmentI al;
1296
1297     Action command;
1298
1299     char[][] string;
1300
1301     SequenceI[] seqs;
1302
1303     int[] alIndex;
1304
1305     int position, number;
1306
1307     char gapChar;
1308
1309     public Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1310             char gap)
1311     {
1312       this.command = cmd;
1313       this.seqs = sqs;
1314       this.position = pos;
1315       this.number = count;
1316       this.gapChar = gap;
1317     }
1318
1319     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1320             AlignmentI align)
1321     {
1322       this(cmd, sqs, pos, count, align.getGapCharacter());
1323
1324       this.al = align;
1325
1326       alIndex = new int[sqs.length];
1327       for (int i = 0; i < sqs.length; i++)
1328       {
1329         alIndex[i] = align.findIndex(sqs[i]);
1330       }
1331
1332       fullAlignmentHeight = (align.getHeight() == sqs.length);
1333     }
1334
1335     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1336             AlignmentI align, String replace)
1337     {
1338       this(cmd, sqs, pos, count, align);
1339
1340       string = new char[sqs.length][];
1341       for (int i = 0; i < sqs.length; i++)
1342       {
1343         string[i] = replace.toCharArray();
1344       }
1345     }
1346
1347     public SequenceI[] getSequences()
1348     {
1349       return seqs;
1350     }
1351
1352     public int getPosition()
1353     {
1354       return position;
1355     }
1356
1357     public Action getAction()
1358     {
1359       return command;
1360     }
1361
1362     public int getNumber()
1363     {
1364       return number;
1365     }
1366
1367     public char getGapCharacter()
1368     {
1369       return gapChar;
1370     }
1371   }
1372
1373   /**
1374    * Returns an iterator over the list of edit commands which traverses the list
1375    * either forwards or backwards.
1376    *
1377    * @param forwards
1378    * @return
1379    */
1380   public Iterator<Edit> getEditIterator(boolean forwards)
1381   {
1382     if (forwards)
1383     {
1384       return getEdits().iterator();
1385     }
1386     else
1387     {
1388       return new ReverseListIterator<Edit>(getEdits());
1389     }
1390   }
1391
1392   /**
1393    * Adjusts features for Cut, and saves details of changes made to allow Undo
1394    * <ul>
1395    * <li>features left of the cut are unchanged</li>
1396    * <li>features right of the cut are shifted left</li>
1397    * <li>features internal to the cut region are deleted</li>
1398    * <li>features that overlap or span the cut are shortened</li>
1399    * <li>the originals of any deleted or shorted features are saved, to re-add
1400    * on Undo</li>
1401    * <li>any added (shortened) features are saved, to delete on Undo</li>
1402    * </ul>
1403    *
1404    * @param command
1405    * @param seq
1406    * @param fromPosition
1407    * @param toPosition
1408    * @param cutIsInternal
1409    */
1410   protected static void cutFeatures(Edit command, SequenceI seq,
1411           int fromPosition, int toPosition, boolean cutIsInternal)
1412   {
1413     List<SequenceFeature> added = new ArrayList<>();
1414     List<SequenceFeature> removed = new ArrayList<>();
1415
1416     SequenceFeaturesI featureStore = seq.getFeatures();
1417     if (toPosition < fromPosition || featureStore == null)
1418     {
1419       return;
1420     }
1421
1422     int cutStartPos = fromPosition;
1423     int cutEndPos = toPosition;
1424     int cutWidth = cutEndPos - cutStartPos + 1;
1425
1426     synchronized (featureStore)
1427     {
1428       /*
1429        * get features that overlap the cut region
1430        */
1431       List<SequenceFeature> toAmend = featureStore.findFeatures(
1432               cutStartPos, cutEndPos);
1433
1434       /*
1435        * add any contact features that span the cut region
1436        * (not returned by findFeatures)
1437        */
1438       for (SequenceFeature contact : featureStore.getContactFeatures())
1439       {
1440         if (contact.getBegin() < cutStartPos
1441                 && contact.getEnd() > cutEndPos)
1442         {
1443           toAmend.add(contact);
1444         }
1445       }
1446
1447       /*
1448        * adjust start-end of overlapping features;
1449        * delete features enclosed by the cut;
1450        * delete partially overlapping contact features
1451        */
1452       for (SequenceFeature sf : toAmend)
1453       {
1454         int sfBegin = sf.getBegin();
1455         int sfEnd = sf.getEnd();
1456         int newBegin = sfBegin;
1457         int newEnd = sfEnd;
1458         boolean toDelete = false;
1459         boolean follows = false;
1460
1461         if (sfBegin >= cutStartPos && sfEnd <= cutEndPos)
1462         {
1463           /*
1464            * feature lies within cut region - delete it
1465            */
1466           toDelete = true;
1467         }
1468         else if (sfBegin < cutStartPos && sfEnd > cutEndPos)
1469         {
1470           /*
1471            * feature spans cut region - left-shift the end
1472            */
1473           newEnd -= cutWidth;
1474         }
1475         else if (sfEnd <= cutEndPos)
1476         {
1477           /*
1478            * feature overlaps left of cut region - truncate right
1479            */
1480           newEnd = cutStartPos - 1;
1481           if (sf.isContactFeature())
1482           {
1483             toDelete = true;
1484           }
1485         }
1486         else if (sfBegin >= cutStartPos)
1487         {
1488           /*
1489            * remaining case - feature overlaps right
1490            * truncate left, adjust end of feature
1491            */
1492           newBegin = cutIsInternal ? cutStartPos : cutEndPos + 1;
1493           newEnd = newBegin + sfEnd - cutEndPos - 1;
1494           if (sf.isContactFeature())
1495           {
1496             toDelete = true;
1497           }
1498         }
1499
1500         seq.deleteFeature(sf);
1501         if (!follows)
1502         {
1503           removed.add(sf);
1504         }
1505         if (!toDelete)
1506         {
1507           SequenceFeature copy = new SequenceFeature(sf, newBegin, newEnd,
1508                   sf.getFeatureGroup(), sf.getScore());
1509           seq.addSequenceFeature(copy);
1510           if (!follows)
1511           {
1512             added.add(copy);
1513           }
1514         }
1515       }
1516
1517       /*
1518        * and left shift any features lying to the right of the cut region
1519        * (but not if the cut is at start or end of sequence)
1520        */
1521       if (cutIsInternal)
1522       {
1523         featureStore.shiftFeatures(cutEndPos + 1, -cutWidth);
1524       }
1525     }
1526
1527     /*
1528      * save deleted and amended features, so that Undo can
1529      * re-add or delete them respectively
1530      */
1531     if (command.deletedFeatures == null)
1532     {
1533       command.deletedFeatures = new HashMap<>();
1534     }
1535     if (command.truncatedFeatures == null)
1536     {
1537       command.truncatedFeatures = new HashMap<>();
1538     }
1539     command.deletedFeatures.put(seq, removed);
1540     command.truncatedFeatures.put(seq, added);
1541   }
1542 }