X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FAlignment.java;h=64b79b7416d1381b1cb921bcef718354f36f41c7;hb=482e093c4670a813c9eec254990178b209e32dbc;hp=713cb0d04c918103753e01b5ae73f43f83d0d16a;hpb=52f42d57f0f08942ce54e3a739f1c9936cc5f293;p=jalview.git

diff --git a/src/jalview/datamodel/Alignment.java b/src/jalview/datamodel/Alignment.java
index 713cb0d..64b79b7 100755
--- a/src/jalview/datamodel/Alignment.java
+++ b/src/jalview/datamodel/Alignment.java
@@ -1,689 +1,1129 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
+ * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * 
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- *
+ * 
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *
+ * 
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 package jalview.datamodel;
 
-import jalview.analysis.*;
-
-import jalview.util.*;
-
 import java.util.*;
 
-/** Data structure to hold and manipulate a multiple sequence alignment
+import jalview.analysis.*;
+
+/**
+ * Data structure to hold and manipulate a multiple sequence alignment
  */
 public class Alignment implements AlignmentI
 {
-    protected Alignment dataset;
-    protected Vector sequences;
-    protected Vector groups = new Vector();
-    protected char gapCharacter = '-';
-    protected int type = NUCLEOTIDE;
-    public static final int PROTEIN = 0;
-    public static final int NUCLEOTIDE = 1;
+  protected Alignment dataset;
 
-    /** DOCUMENT ME!! */
-    public AlignmentAnnotation[] annotations;
+  protected Vector sequences;
 
-    HiddenSequences hiddenSequences = new HiddenSequences(this);
+  protected Vector groups = new Vector();
 
-    private void initAlignment(SequenceI[] seqs) {
-      int i=0;
+  protected char gapCharacter = '-';
 
-      if( jalview.util.Comparison.isNucleotide(seqs))
-        type = NUCLEOTIDE;
-      else
-        type = PROTEIN;
+  protected int type = NUCLEOTIDE;
 
-      sequences = new Vector();
+  public static final int PROTEIN = 0;
 
-      for (i = 0; i < seqs.length; i++)
-      {
-        sequences.addElement(seqs[i]);
-      }
+  public static final int NUCLEOTIDE = 1;
 
-    }
-    /** Make an alignment from an array of Sequences.
-     *
-     * @param sequences
-     */
-    public Alignment(SequenceI[] seqs)
+  /** DOCUMENT ME!! */
+  public AlignmentAnnotation[] annotations;
+
+  HiddenSequences hiddenSequences = new HiddenSequences(this);
+
+  public Hashtable alignmentProperties;
+
+  private void initAlignment(SequenceI[] seqs)
+  {
+    int i = 0;
+
+    if (jalview.util.Comparison.isNucleotide(seqs))
     {
-      initAlignment(seqs);
-    }
-    /**
-     * Make a new alignment from an array of SeqCigars
-     * @param seqs SeqCigar[]
-     */
-    public Alignment(SeqCigar[] alseqs) {
-      SequenceI[] seqs = SeqCigar.createAlignmentSequences(alseqs, gapCharacter, new ColumnSelection(), null);
-      initAlignment(seqs);
+      type = NUCLEOTIDE;
     }
-    /**
-     * Make a new alignment from an CigarArray
-     * JBPNote - can only do this when compactAlignment does not contain hidden regions.
-     * JBPNote - must also check that compactAlignment resolves to a set of SeqCigars - or construct them appropriately.
-     * @param compactAlignment CigarArray
-     */
-    public static AlignmentI createAlignment(CigarArray compactAlignment) {
-      throw new Error("Alignment(CigarArray) not yet implemented");
-      // this(compactAlignment.refCigars);
+    else
+    {
+      type = PROTEIN;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public Vector getSequences()
+    sequences = new Vector();
+
+    for (i = 0; i < seqs.length; i++)
     {
-        return sequences;
+      sequences.addElement(seqs[i]);
     }
 
-    public SequenceI [] getSequencesArray()
+  }
+
+  /**
+   * Make an alignment from an array of Sequences.
+   * 
+   * @param sequences
+   */
+  public Alignment(SequenceI[] seqs)
+  {
+    initAlignment(seqs);
+  }
+
+  /**
+   * Make a new alignment from an array of SeqCigars
+   * 
+   * @param seqs
+   *                SeqCigar[]
+   */
+  public Alignment(SeqCigar[] alseqs)
+  {
+    SequenceI[] seqs = SeqCigar.createAlignmentSequences(alseqs,
+            gapCharacter, new ColumnSelection(), null);
+    initAlignment(seqs);
+  }
+
+  /**
+   * Make a new alignment from an CigarArray JBPNote - can only do this when
+   * compactAlignment does not contain hidden regions. JBPNote - must also check
+   * that compactAlignment resolves to a set of SeqCigars - or construct them
+   * appropriately.
+   * 
+   * @param compactAlignment
+   *                CigarArray
+   */
+  public static AlignmentI createAlignment(CigarArray compactAlignment)
+  {
+    throw new Error("Alignment(CigarArray) not yet implemented");
+    // this(compactAlignment.refCigars);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public Vector getSequences()
+  {
+    return sequences;
+  }
+
+  public SequenceI[] getSequencesArray()
+  {
+    if (sequences == null)
+      return null;
+    SequenceI[] reply = new SequenceI[sequences.size()];
+    for (int i = 0; i < sequences.size(); i++)
     {
-      SequenceI [] reply = new SequenceI[sequences.size()];
-      for(int i=0; i<sequences.size(); i++)
-      {
-        reply[i] = (SequenceI)sequences.elementAt(i);
-      }
-      return reply;
+      reply[i] = (SequenceI) sequences.elementAt(i);
     }
+    return reply;
+  }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param i DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public SequenceI getSequenceAt(int i)
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param i
+   *                DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public SequenceI getSequenceAt(int i)
+  {
+    if (i < sequences.size())
     {
-        if (i < sequences.size())
-        {
-            return (SequenceI) sequences.elementAt(i);
-        }
-
-        return null;
+      return (SequenceI) sequences.elementAt(i);
     }
 
-    /** Adds a sequence to the alignment.  Recalculates maxLength and size.
-     *
-     * @param snew
-     */
-    public void addSequence(SequenceI snew)
+    return null;
+  }
+
+  /**
+   * Adds a sequence to the alignment. Recalculates maxLength and size.
+   * 
+   * @param snew
+   */
+  public void addSequence(SequenceI snew)
+  {
+    if (dataset != null)
     {
-      if(dataset!=null)
+      // maintain dataset integrity
+      if (snew.getDatasetSequence() != null)
       {
-        if(snew.getDatasetSequence()!=null)
-        {
-          getDataset().addSequence(snew.getDatasetSequence());
-        }
-        else
-        {
-          Sequence ds = new Sequence(snew.getName(),
-                                     AlignSeq.extractGaps("-. ",
-              snew.getSequence()),
-                                     snew.getStart(),
-                                     snew.getEnd());
-
-          snew.setDatasetSequence(ds);
-          getDataset().addSequence(ds);
-        }
+        getDataset().addSequence(snew.getDatasetSequence());
+      }
+      else
+      {
+        // derive new sequence
+        SequenceI adding = snew.deriveSequence();
+        getDataset().addSequence(adding.getDatasetSequence());
+        snew = adding;
       }
+    }
+    if (sequences == null)
+    {
+      initAlignment(new SequenceI[]
+      { snew });
+    }
+    else
+    {
       sequences.addElement(snew);
-
-      hiddenSequences.adjustHeightSequenceAdded();
     }
+    if (hiddenSequences != null)
+      hiddenSequences.adjustHeightSequenceAdded();
+  }
 
+  /**
+   * Adds a sequence to the alignment. Recalculates maxLength and size.
+   * 
+   * @param snew
+   */
+  public void setSequenceAt(int i, SequenceI snew)
+  {
+    SequenceI oldseq = getSequenceAt(i);
+    deleteSequence(oldseq);
 
-    /** Adds a sequence to the alignment.  Recalculates maxLength and size.
-     *
-     * @param snew
-     */
-    public void setSequenceAt(int i, SequenceI snew)
-    {
-        SequenceI oldseq = getSequenceAt(i);
-        deleteSequence(oldseq);
+    sequences.setElementAt(snew, i);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public Vector getGroups()
+  {
+    return groups;
+  }
+
+  public void finalize()
+  {
+    if (getDataset() != null)
+      getDataset().removeAlignmentRef();
+
+    dataset = null;
+    sequences = null;
+    groups = null;
+    annotations = null;
+    hiddenSequences = null;
+  }
 
-        sequences.setElementAt(snew, i);
+  /**
+   * decrement the alignmentRefs counter by one and call finalize if it goes to
+   * zero.
+   */
+  private void removeAlignmentRef()
+  {
+    if (--alignmentRefs == 0)
+    {
+      finalize();
     }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param s
+   *                DOCUMENT ME!
+   */
+  public void deleteSequence(SequenceI s)
+  {
+    deleteSequence(findIndex(s));
+  }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public Vector getGroups()
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param i
+   *                DOCUMENT ME!
+   */
+  public void deleteSequence(int i)
+  {
+    if (i > -1 && i < getHeight())
     {
-        return groups;
+      sequences.removeElementAt(i);
+      hiddenSequences.adjustHeightSequenceDeleted(i);
     }
+  }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param s DOCUMENT ME!
-     */
-    public void deleteSequence(SequenceI s)
+  /**    */
+  public SequenceGroup findGroup(SequenceI s)
+  {
+    for (int i = 0; i < this.groups.size(); i++)
     {
-      deleteSequence(findIndex(s));
+      SequenceGroup sg = (SequenceGroup) groups.elementAt(i);
+
+      if (sg.getSequences(null).contains(s))
+      {
+        return sg;
+      }
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param i DOCUMENT ME!
-     */
-    public void deleteSequence(int i)
+    return null;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param s
+   *                DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public SequenceGroup[] findAllGroups(SequenceI s)
+  {
+    Vector temp = new Vector();
+
+    int gSize = groups.size();
+    for (int i = 0; i < gSize; i++)
     {
-      if(i>-1 && i<getHeight())
+      SequenceGroup sg = (SequenceGroup) groups.elementAt(i);
+      if (sg == null || sg.getSequences(null) == null)
+      {
+        this.deleteGroup(sg);
+        gSize--;
+        continue;
+      }
+
+      if (sg.getSequences(null).contains(s))
       {
-        sequences.removeElementAt(i);
-        hiddenSequences.adjustHeightSequenceDeleted(i);
+        temp.addElement(sg);
       }
     }
 
+    SequenceGroup[] ret = new SequenceGroup[temp.size()];
+
+    for (int i = 0; i < temp.size(); i++)
+    {
+      ret[i] = (SequenceGroup) temp.elementAt(i);
+    }
+
+    return ret;
+  }
 
-    /**    */
-    public SequenceGroup findGroup(SequenceI s)
+  /**    */
+  public void addGroup(SequenceGroup sg)
+  {
+    if (!groups.contains(sg))
     {
-        for (int i = 0; i < this.groups.size(); i++)
+      if (hiddenSequences.getSize() > 0)
+      {
+        int i, iSize = sg.getSize();
+        for (i = 0; i < iSize; i++)
         {
-            SequenceGroup sg = (SequenceGroup) groups.elementAt(i);
+          if (!sequences.contains(sg.getSequenceAt(i)))
+          {
+            sg.deleteSequence(sg.getSequenceAt(i), false);
+            iSize--;
+            i--;
+          }
+        }
 
-            if (sg.getSequences(false).contains(s))
-            {
-                return sg;
-            }
+        if (sg.getSize() < 1)
+        {
+          return;
         }
+      }
 
-        return null;
+      groups.addElement(sg);
     }
+  }
+
+  /**
+   * DOCUMENT ME!
+   */
+  public void deleteAllGroups()
+  {
+    groups.removeAllElements();
+  }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param s DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public SequenceGroup[] findAllGroups(SequenceI s)
+  /**    */
+  public void deleteGroup(SequenceGroup g)
+  {
+    if (groups.contains(g))
     {
-        Vector temp = new Vector();
+      groups.removeElement(g);
+    }
+  }
 
-        int gSize = groups.size();
-        for (int i = 0; i < gSize; i++)
-        {
-            SequenceGroup sg = (SequenceGroup) groups.elementAt(i);
-            if(sg==null || sg.getSequences(false)==null)
-            {
-              this.deleteGroup(sg);
-              gSize--;
-              continue;
-            }
+  /**    */
+  public SequenceI findName(String name)
+  {
+    return findName(name, false);
+  }
 
-            if (sg.getSequences(false).contains(s))
-            {
-                temp.addElement(sg);
-            }
-        }
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#findName(java.lang.String, boolean)
+   */
+  public SequenceI findName(String token, boolean b)
+  {
+    return findName(null, token, b);
+  }
 
-        SequenceGroup[] ret = new SequenceGroup[temp.size()];
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#findName(SequenceI, java.lang.String,
+   *      boolean)
+   */
+  public SequenceI findName(SequenceI startAfter, String token, boolean b)
+  {
 
-        for (int i = 0; i < temp.size(); i++)
+    int i = 0;
+    SequenceI sq = null;
+    String sqname = null;
+    if (startAfter != null)
+    {
+      // try to find the sequence in the alignment
+      boolean matched = false;
+      while (i < sequences.size())
+      {
+        if (getSequenceAt(i++) == startAfter)
         {
-            ret[i] = (SequenceGroup) temp.elementAt(i);
+          matched = true;
+          break;
         }
+      }
+      if (!matched)
+      {
+        i = 0;
+      }
+    }
+    while (i < sequences.size())
+    {
+      sq = getSequenceAt(i);
+      sqname = sq.getName();
+      if (sqname.equals(token) // exact match
+              || (b && // allow imperfect matches - case varies
+              (sqname.equalsIgnoreCase(token))))
+      {
+        return getSequenceAt(i);
+      }
 
-        return ret;
+      i++;
     }
 
+    return null;
+  }
 
+  public SequenceI[] findSequenceMatch(String name)
+  {
+    Vector matches = new Vector();
+    int i = 0;
 
-    /**    */
-    public void addGroup(SequenceGroup sg)
+    while (i < sequences.size())
     {
-        if (!groups.contains(sg))
-        {
-            groups.addElement(sg);
-        }
+      if (getSequenceAt(i).getName().equals(name))
+      {
+        matches.addElement(getSequenceAt(i));
+      }
+      i++;
     }
 
-    /**
-     * DOCUMENT ME!
-     */
-    public void deleteAllGroups()
+    SequenceI[] result = new SequenceI[matches.size()];
+    for (i = 0; i < result.length; i++)
     {
-        groups.removeAllElements();
+      result[i] = (SequenceI) matches.elementAt(i);
+    }
 
-        int i = 0;
+    return result;
 
-        while (i < sequences.size())
-        {
-            SequenceI s = getSequenceAt(i);
-            s.setColor(java.awt.Color.white);
-            i++;
-        }
-    }
+  }
+
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#findIndex(jalview.datamodel.SequenceI)
+   */
+  public int findIndex(SequenceI s)
+  {
+    int i = 0;
 
-    /**    */
-    public void deleteGroup(SequenceGroup g)
+    while (i < sequences.size())
     {
-        if (groups.contains(g))
-        {
-            groups.removeElement(g);
-        }
+      if (s == getSequenceAt(i))
+      {
+        return i;
+      }
+
+      i++;
     }
 
-    /**    */
-    public SequenceI findName(String name)
+    return -1;
+  }
+
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#findIndex(jalview.datamodel.SearchResults)
+   */
+  public int findIndex(SearchResults results)
+  {
+    int i = 0;
+
+    while (i < sequences.size())
     {
-        int i = 0;
+      if (results.involvesSequence(getSequenceAt(i)))
+      {
+        return i;
+      }
+      i++;
+    }
+    return -1;
+  }
 
-        while (i < sequences.size())
-        {
-            if (getSequenceAt(i).getName().equals(name))
-            {
-                return getSequenceAt(i);
-            }
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public int getHeight()
+  {
+    return sequences.size();
+  }
 
-            i++;
-        }
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public int getWidth()
+  {
+    int maxLength = -1;
 
-        return null;
+    for (int i = 0; i < sequences.size(); i++)
+    {
+      if (getSequenceAt(i).getLength() > maxLength)
+      {
+        maxLength = getSequenceAt(i).getLength();
+      }
     }
 
-    public SequenceI [] findSequenceMatch(String name)
+    return maxLength;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param gc
+   *                DOCUMENT ME!
+   */
+  public void setGapCharacter(char gc)
+  {
+    gapCharacter = gc;
+
+    for (int i = 0; i < sequences.size(); i++)
     {
-      Vector matches = new Vector();
-      int i = 0;
+      Sequence seq = (Sequence) sequences.elementAt(i);
+      seq.setSequence(seq.getSequenceAsString().replace('.', gc).replace(
+              '-', gc).replace(' ', gc));
+    }
+  }
 
-      while (i < sequences.size())
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public char getGapCharacter()
+  {
+    return gapCharacter;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public boolean isAligned()
+  {
+    int width = getWidth();
+
+    for (int i = 0; i < sequences.size(); i++)
+    {
+      if (getSequenceAt(i).getLength() != width)
       {
-          if (getSequenceAt(i).getName().equals(name))
-          {
-              matches.addElement(getSequenceAt(i));
-          }
-          i++;
+        return false;
       }
+    }
 
-      SequenceI [] result = new SequenceI[matches.size()];
-      for(i=0; i<result.length; i++)
-        result[i] = (SequenceI)matches.elementAt(i);
+    return true;
+  }
 
-      return result;
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#deleteAnnotation(jalview.datamodel.AlignmentAnnotation)
+   */
+  public boolean deleteAnnotation(AlignmentAnnotation aa)
+  {
+    int aSize = 1;
 
+    if (annotations != null)
+    {
+      aSize = annotations.length;
     }
 
-
-    /**    */
-    public int findIndex(SequenceI s)
+    if (aSize < 1)
     {
-        int i = 0;
+      return false;
+    }
 
-        while (i < sequences.size())
-        {
-            if (s == getSequenceAt(i))
-            {
-                return i;
-            }
+    AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize - 1];
 
-            i++;
-        }
+    boolean swap = false;
+    int tIndex = 0;
+
+    for (int i = 0; i < aSize; i++)
+    {
+      if (annotations[i] == aa)
+      {
+        swap = true;
+        continue;
+      }
+      if (tIndex < temp.length)
+        temp[tIndex++] = annotations[i];
+    }
 
-        return -1;
+    if (swap)
+    {
+      annotations = temp;
+      if (aa.sequenceRef != null)
+        aa.sequenceRef.removeAlignmentAnnotation(aa);
     }
+    return swap;
+  }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public int getHeight()
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param aa
+   *                DOCUMENT ME!
+   */
+  public void addAnnotation(AlignmentAnnotation aa)
+  {
+    int aSize = 1;
+    if (annotations != null)
     {
-        return sequences.size();
+      aSize = annotations.length + 1;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public int getWidth()
+    AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize];
+
+    temp[aSize - 1] = aa;
+
+    int i = 0;
+
+    if (aSize > 1)
     {
-        int maxLength = -1;
+      for (i = 0; i < (aSize - 1); i++)
+      {
+        temp[i] = annotations[i];
+      }
+    }
 
-        for (int i = 0; i < sequences.size(); i++)
-        {
-            if (getSequenceAt(i).getLength() > maxLength)
-            {
-                maxLength = getSequenceAt(i).getLength();
-            }
-        }
+    annotations = temp;
+  }
 
-        return maxLength;
+  public void setAnnotationIndex(AlignmentAnnotation aa, int index)
+  {
+    if (aa == null || annotations == null || annotations.length - 1 < index)
+    {
+      return;
     }
 
+    int aSize = annotations.length;
+    AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize];
+
+    temp[index] = aa;
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param gc DOCUMENT ME!
-     */
-    public void setGapCharacter(char gc)
+    for (int i = 0; i < aSize; i++)
     {
-        gapCharacter = gc;
+      if (i == index)
+      {
+        continue;
+      }
 
-        for (int i = 0; i < sequences.size(); i++)
-        {
-            Sequence seq = (Sequence) sequences.elementAt(i);
-            seq.setSequence( seq.getSequence().replace('.', gc) );
-            seq.setSequence( seq.getSequence().replace('-', gc) );
-            seq.setSequence( seq.getSequence().replace(' ', gc) );
-        }
+      if (i < index)
+      {
+        temp[i] = annotations[i];
+      }
+      else
+      {
+        temp[i] = annotations[i - 1];
+      }
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public char getGapCharacter()
+    annotations = temp;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public AlignmentAnnotation[] getAlignmentAnnotation()
+  {
+    return annotations;
+  }
+
+  public void setNucleotide(boolean b)
+  {
+    if (b)
     {
-        return gapCharacter;
+      type = NUCLEOTIDE;
     }
+    else
+    {
+      type = PROTEIN;
+    }
+  }
 
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public boolean isAligned()
+  public boolean isNucleotide()
+  {
+    if (type == NUCLEOTIDE)
+    {
+      return true;
+    }
+    else
     {
-        int width = getWidth();
+      return false;
+    }
+  }
 
-        for (int i = 0; i < sequences.size(); i++)
+  public void setDataset(Alignment data)
+  {
+    if (dataset == null && data == null)
+    {
+      // Create a new dataset for this alignment.
+      // Can only be done once, if dataset is not null
+      // This will not be performed
+      SequenceI[] seqs = new SequenceI[getHeight()];
+      SequenceI currentSeq;
+      for (int i = 0; i < getHeight(); i++)
+      {
+        currentSeq = getSequenceAt(i);
+        if (currentSeq.getDatasetSequence() != null)
         {
-            if (getSequenceAt(i).getLength() != width)
-            {
-                return false;
-            }
+          seqs[i] = (Sequence) currentSeq.getDatasetSequence();
+        }
+        else
+        {
+          seqs[i] = currentSeq.createDatasetSequence();
         }
+      }
 
-        return true;
+      dataset = new Alignment(seqs);
     }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aa DOCUMENT ME!
-     */
-    public void deleteAnnotation(AlignmentAnnotation aa)
+    else if (dataset == null && data != null)
     {
-        int aSize = 1;
+      dataset = data;
+    }
+    dataset.addAlignmentRef();
+  }
 
-        if (annotations != null)
-        {
-            aSize = annotations.length;
-        }
+  /**
+   * reference count for number of alignments referencing this one.
+   */
+  int alignmentRefs = 0;
+
+  /**
+   * increase reference count to this alignment.
+   */
+  private void addAlignmentRef()
+  {
+    alignmentRefs++;
+  }
 
-        AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize - 1];
+  public Alignment getDataset()
+  {
+    return dataset;
+  }
 
-        int tIndex = 0;
+  public boolean padGaps()
+  {
+    boolean modified = false;
 
-        for (int i = 0; i < aSize; i++)
-        {
-            if (annotations[i] == aa)
-            {
-                continue;
-            }
+    // Remove excess gaps from the end of alignment
+    int maxLength = -1;
 
-            temp[tIndex] = annotations[i];
-            tIndex++;
+    SequenceI current;
+    for (int i = 0; i < sequences.size(); i++)
+    {
+      current = getSequenceAt(i);
+      for (int j = current.getLength(); j > maxLength; j--)
+      {
+        if (j > maxLength
+                && !jalview.util.Comparison.isGap(current.getCharAt(j)))
+        {
+          maxLength = j;
+          break;
         }
-
-        annotations = temp;
+      }
     }
 
+    maxLength++;
+
+    int cLength;
+    for (int i = 0; i < sequences.size(); i++)
+    {
+      current = getSequenceAt(i);
+      cLength = current.getLength();
+
+      if (cLength < maxLength)
+      {
+        current.insertCharAt(cLength, maxLength - cLength, gapCharacter);
+        modified = true;
+      }
+      else if (current.getLength() > maxLength)
+      {
+        current.deleteChars(maxLength, current.getLength());
+      }
+    }
+    return modified;
+  }
+  /**
+   * Justify the sequences to the left or right by deleting and inserting gaps before the initial residue or after the terminal residue
+   * @param right true if alignment padded to right, false to justify to left
+   * @return true if alignment was changed
+   */
+  public boolean justify(boolean right)
+  {
+    boolean modified = false;
 
-    public void adjustSequenceAnnotations()
+    // Remove excess gaps from the end of alignment
+    int maxLength = -1;
+    int ends[] = new int[sequences.size()*2];
+    SequenceI current;
+    for (int i = 0; i < sequences.size(); i++)
     {
-      if(annotations!=null)
+      current = getSequenceAt(i);
+      // This should really be a sequence method
+      ends[i*2] = current.findIndex(current.getStart());
+      ends[i*2+1] = current.findIndex(current.getStart()+current.getLength());
+      boolean hitres=false;
+      for (int j = 0,rs=0,ssiz=current.getLength(); j<ssiz; j++)
       {
-        for (int a = 0; a < annotations.length; a++)
+        if (!jalview.util.Comparison.isGap(current.getCharAt(j)))
         {
-          if (annotations[a].sequenceRef != null)
+          if (!hitres)
           {
-            annotations[a].adjustForAlignment();
+            ends[i*2] = j;
+            hitres=true;
+          } else {
+            ends[i*2+1] = j;
+            if (j-ends[i*2]>maxLength)
+            {
+              maxLength = j-ends[i*2];
+            }
           }
         }
       }
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aa DOCUMENT ME!
-     */
-    public void addAnnotation(AlignmentAnnotation aa)
+    maxLength++;
+    // now edit the flanking gaps to justify to either left or right
+    int cLength,extent,diff;
+    for (int i = 0; i < sequences.size(); i++)
     {
-        int aSize = 1;
-        if (annotations != null)
+      current = getSequenceAt(i);
+      
+      cLength = 1+ends[i*2+1]-ends[i*2];
+      diff = maxLength-cLength; // number of gaps to indent
+      extent = current.getLength();
+      if (right)
+      {
+        // right justify
+        if (extent>ends[i*2+1])
         {
-            aSize = annotations.length + 1;
+          current.deleteChars(ends[i*2+1]+1, extent);
+          modified = true;
         }
-
-        AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize];
-
-        temp[aSize-1] = aa;
-
-        int i = 0;
-
-        if (aSize > 1)
+        if (ends[i*2]>diff)
         {
-            for (i = 0; i < (aSize-1); i++)
-            {
-                temp[i] = annotations[i];
-            }
+          current.deleteChars(0, ends[i*2]-diff);
+          modified = true;
+        } else {
+          if (ends[i*2]<diff)
+          {
+            current.insertCharAt(0, diff-ends[i*2],gapCharacter);
+            modified = true;
+          }
         }
-
-        annotations = temp;
+      } else {
+        // left justify
+        if (ends[i*2]>0)
+        {
+          current.deleteChars(0, ends[i*2]);
+          modified = true;
+          ends[i*2+1]-=ends[i*2];
+          extent-=ends[i*2];
+        }
+        if (extent>maxLength)
+        {
+          current.deleteChars(maxLength+1, extent);
+          modified = true;
+        } else {
+          if (extent<maxLength)
+          {
+            current.insertCharAt(extent, maxLength-extent,gapCharacter);
+            modified = true;
+          }
+        }
+      }
     }
+    return modified;
+  }
+
+  public HiddenSequences getHiddenSequences()
+  {
+    return hiddenSequences;
+  }
 
-    public void setAnnotationIndex(AlignmentAnnotation aa, int index)
+  public CigarArray getCompactAlignment()
+  {
+    SeqCigar alseqs[] = new SeqCigar[sequences.size()];
+    for (int i = 0; i < sequences.size(); i++)
     {
-      if(aa==null || annotations==null || annotations.length-1<index)
-        return;
+      alseqs[i] = new SeqCigar((SequenceI) sequences.elementAt(i));
+    }
+    CigarArray cal = new CigarArray(alseqs);
+    cal.addOperation(CigarArray.M, getWidth());
+    return cal;
+  }
 
-      int aSize = annotations.length;
-      AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize];
+  public void setProperty(Object key, Object value)
+  {
+    if (alignmentProperties == null)
+      alignmentProperties = new Hashtable();
 
-      temp[index] = aa;
+    alignmentProperties.put(key, value);
+  }
 
-      for (int i = 0; i < aSize; i++)
-      {
-        if(i==index)
-          continue;
+  public Object getProperty(Object key)
+  {
+    if (alignmentProperties != null)
+      return alignmentProperties.get(key);
+    else
+      return null;
+  }
 
-        if(i<index)
-          temp[i] = annotations[i];
-        else
-          temp[i] = annotations[i-1];
-      }
+  public Hashtable getProperties()
+  {
+    return alignmentProperties;
+  }
 
-        annotations = temp;
-    }
+  AlignedCodonFrame[] codonFrameList = null;
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public AlignmentAnnotation[] getAlignmentAnnotation()
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#addCodonFrame(jalview.datamodel.AlignedCodonFrame)
+   */
+  public void addCodonFrame(AlignedCodonFrame codons)
+  {
+    if (codons == null)
+      return;
+    if (codonFrameList == null)
     {
-        return annotations;
+      codonFrameList = new AlignedCodonFrame[]
+      { codons };
+      return;
     }
+    AlignedCodonFrame[] t = new AlignedCodonFrame[codonFrameList.length + 1];
+    System.arraycopy(codonFrameList, 0, t, 0, codonFrameList.length);
+    t[codonFrameList.length] = codons;
+    codonFrameList = t;
+  }
 
-    public void setNucleotide(boolean b)
-    {
-      if(b)
-        type = NUCLEOTIDE;
-      else
-        type = PROTEIN;
-    }
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#getCodonFrame(int)
+   */
+  public AlignedCodonFrame getCodonFrame(int index)
+  {
+    return codonFrameList[index];
+  }
 
-    public boolean isNucleotide()
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#getCodonFrame(jalview.datamodel.SequenceI)
+   */
+  public AlignedCodonFrame[] getCodonFrame(SequenceI seq)
+  {
+    if (seq == null || codonFrameList == null)
+      return null;
+    Vector cframes = new Vector();
+    for (int f = 0; f < codonFrameList.length; f++)
     {
-      if(type==NUCLEOTIDE)
-        return true;
-      else
-        return false;
+      if (codonFrameList[f].involvesSequence(seq))
+        cframes.addElement(codonFrameList[f]);
     }
+    if (cframes.size() == 0)
+      return null;
+    AlignedCodonFrame[] cfr = new AlignedCodonFrame[cframes.size()];
+    cframes.copyInto(cfr);
+    return cfr;
+  }
+
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#getCodonFrames()
+   */
+  public AlignedCodonFrame[] getCodonFrames()
+  {
+    return codonFrameList;
+  }
 
-    public void setDataset(Alignment data)
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AlignmentI#removeCodonFrame(jalview.datamodel.AlignedCodonFrame)
+   */
+  public boolean removeCodonFrame(AlignedCodonFrame codons)
+  {
+    if (codons == null || codonFrameList == null)
+      return false;
+    boolean removed = false;
+    int i = 0, iSize = codonFrameList.length;
+    while (i < iSize)
     {
-      if(dataset==null && data==null)
+      if (codonFrameList[i] == codons)
       {
-        // Create a new dataset for this alignment.
-        // Can only be done once, if dataset is not null
-        // This will not be performed
-        Sequence[] seqs = new Sequence[getHeight()];
-        for (int i = 0; i < getHeight(); i++)
+        removed = true;
+        if (i + 1 < iSize)
         {
-          if(getSequenceAt(i).getDatasetSequence()!=null)
-          {
-            seqs[i] = (Sequence)getSequenceAt(i).getDatasetSequence();
-          }
-          else
-          {
-            seqs[i] = new Sequence(getSequenceAt(i).getName(),
-                                   AlignSeq.extractGaps(
-                                       jalview.util.Comparison.GapChars,
-                                       getSequenceAt(i).getSequence()
-                                   ),
-                                   getSequenceAt(i).getStart(),
-                                   getSequenceAt(i).getEnd());
-            seqs[i].sequenceFeatures = getSequenceAt(i).getSequenceFeatures();
-            getSequenceAt(i).setSequenceFeatures(null);
-            getSequenceAt(i).setDatasetSequence(seqs[i]);
-          }
+          System.arraycopy(codonFrameList, i + 1, codonFrameList, i, iSize
+                  - i - 1);
         }
-
-        dataset = new Alignment(seqs);
+        iSize--;
       }
-      else if(dataset==null && data!=null)
+      else
       {
-        dataset = data;
+        i++;
       }
     }
+    return removed;
+  }
 
-    public Alignment getDataset()
-    {
-      return dataset;
-    }
-
-    public boolean padGaps()
+  public void append(AlignmentI toappend)
+  {
+    // TODO test this method for a future 2.5 release
+    // currently tested for use in jalview.gui.SequenceFetcher
+    boolean samegap = toappend.getGapCharacter()==getGapCharacter();
+    char oldc = toappend.getGapCharacter();
+    boolean hashidden = toappend.getHiddenSequences()!=null && toappend.getHiddenSequences().hiddenSequences!=null;
+    // get all sequences including any hidden ones
+    Vector sqs = (hashidden) ? toappend.getHiddenSequences().getFullAlignment().getSequences() : toappend.getSequences();
+    if (sqs != null)
     {
-      boolean modified=false;
-
-      //Remove excess gaps from the end of alignment
-      int maxLength = -1;
-
-      SequenceI current;
-      for (int i = 0; i < sequences.size(); i++)
+      Enumeration sq = sqs.elements();
+      while (sq.hasMoreElements())
       {
-        current = getSequenceAt(i);
-        for (int j = current.getLength(); j > maxLength; j--)
+        SequenceI addedsq=(SequenceI) sq.nextElement();
+        if (!samegap)
         {
-          if (j > maxLength && !jalview.util.Comparison.isGap(
-              current.getCharAt(j)))
+          char[] oldseq = addedsq.getSequence();
+          for (int c=0;c<oldseq.length;c++)
           {
-            maxLength = j;
-            break;
+            if (oldseq[c]==oldc)
+            {
+              oldseq[c] = gapCharacter;
+            }
           }
         }
+        addSequence(addedsq);
       }
-
-      maxLength++;
-
-      int cLength;
-      for (int i = 0; i < sequences.size();
-           i++)
+    }
+    AlignmentAnnotation[] alan = toappend.getAlignmentAnnotation();
+    for (int a = 0; alan != null && a < alan.length; a++)
+    {
+      addAnnotation(alan[a]);
+    }
+    AlignedCodonFrame[] acod = toappend.getCodonFrames();
+    for (int a = 0; acod != null && a < acod.length; a++)
+    {
+      this.addCodonFrame(acod[a]);
+    }
+    Vector sg = toappend.getGroups();
+    if (sg != null)
+    {
+      Enumeration el = sg.elements();
+      while (el.hasMoreElements())
       {
-        current = getSequenceAt(i);
-        cLength = current.getLength();
-
-        if (cLength < maxLength)
-        {
-          current.insertCharAt(cLength,
-                              maxLength-cLength, gapCharacter);
-          modified=true;
-        }
-        else if(current.getLength() > maxLength)
-        {
-          current.deleteChars(maxLength, current.getLength());
-        }
+        addGroup((SequenceGroup) el.nextElement());
       }
-      return modified;
     }
-
-    public HiddenSequences getHiddenSequences()
+    if (toappend.getHiddenSequences()!=null)
     {
-      return hiddenSequences;
+      HiddenSequences hs = toappend.getHiddenSequences();
+      if (hiddenSequences==null)
+      {
+        hiddenSequences = new HiddenSequences(this);
+      }
+      if (hs.hiddenSequences!=null)
+      {
+        for (int s=0;s<hs.hiddenSequences.length; s++)
+        {
+          // hide the newly appended sequence in the alignment
+          if (hs.hiddenSequences[s]!=null)
+          {
+            hiddenSequences.hideSequence(hs.hiddenSequences[s]);
+          }
+        }
+      }
     }
-    SequenceI [] getVisibleAndRepresentedSeqs()
+    if (toappend.getProperties()!=null)
     {
-      if(hiddenSequences==null || hiddenSequences.getSize()<1)
-        return getSequencesArray();
-
-      Vector seqs = new Vector();
-      SequenceI seq;
-      SequenceGroup hidden;
-      for (int i = 0; i < sequences.size(); i++)
+      // we really can't do very much here - just try to concatenate strings where property collisions occur.
+      Enumeration key = toappend.getProperties().keys();
+      while (key.hasMoreElements())
       {
-        seq = (SequenceI) sequences.elementAt(i);
-        seqs.addElement(seq);
-        hidden = seq.getHiddenSequences();
-        if(hidden!=null)
+        Object k = key.nextElement();
+        Object ourval = this.getProperty(k);
+        Object toapprop = toappend.getProperty(k);
+        if (ourval!=null)
         {
-          for(int j=0; j<hidden.getSize(false); j++)
+          if (ourval.getClass().equals(toapprop.getClass()) && !ourval.equals(toapprop))
           {
-            seqs.addElement(hidden.getSequenceAt(j));
+            if (ourval instanceof String)
+            {
+              // append strings
+              this.setProperty(k, ((String) ourval)+"; "+((String) toapprop));
+            } else {
+              if (ourval instanceof Vector)
+              {
+                // append vectors
+                Enumeration theirv = ((Vector) toapprop).elements();
+                while (theirv.hasMoreElements())
+                {
+                  ((Vector)ourval).addElement(theirv);
+                }
+              }
+            }
           }
+        } else {
+          // just add new property directly
+          setProperty(k, toapprop);
         }
+       
       }
-      SequenceI [] result = new SequenceI[seqs.size()];
-      for(int i=0; i<seqs.size(); i++)
-        result[i] = (SequenceI)seqs.elementAt(i);
-
-      return result;
-
     }
-
-  public CigarArray getCompactAlignment()
-  {
-    SeqCigar alseqs[] = new SeqCigar[sequences.size()];
-    for (int i=0; i<sequences.size(); i++) {
-      alseqs[i] = new SeqCigar((SequenceI) sequences.elementAt(i));
-    }
-    CigarArray cal = new CigarArray(alseqs);
-    cal.addOperation(CigarArray.M, getWidth());
-    return cal;
   }
 
 }