X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FAlignmentI.java;h=2e61f9d6001a9dd17529baae7d6bbf5ef6a09c94;hb=136c0793b90b72b928c4d77dc109dd5c644e00d3;hp=5bfd8788af78350542e42d38ef79b209eaa0fa07;hpb=ab43013b7e357b84b4abade0dba949668dfb2a0e;p=jalview.git

diff --git a/src/jalview/datamodel/AlignmentI.java b/src/jalview/datamodel/AlignmentI.java
index 5bfd878..2e61f9d 100755
--- a/src/jalview/datamodel/AlignmentI.java
+++ b/src/jalview/datamodel/AlignmentI.java
@@ -1,20 +1,20 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
- * modify it under the terms of the GNU General Public License 
+ * modify it under the terms of the GNU General License 
  * as published by the Free Software Foundation, either version 3
  * of the License, or (at your option) any later version.
  *  
  * Jalview 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.
+ * PURPOSE.  See the GNU General License for more details.
  * 
- * You should have received a copy of the GNU General Public License
+ * You should have received a copy of the GNU General License
  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
@@ -23,6 +23,7 @@ package jalview.datamodel;
 import java.util.Hashtable;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * Data structure to hold and manipulate a multiple sequence alignment
@@ -30,19 +31,30 @@ import java.util.Map;
 public interface AlignmentI extends AnnotatedCollectionI
 {
   /**
-   * Calculates the number of sequences in an alignment
+   * Calculates the number of sequences in an alignment, excluding hidden
+   * sequences
    * 
    * @return Number of sequences in alignment
    */
-  public int getHeight();
+  int getHeight();
 
   /**
+   * Calculates the number of sequences in an alignment, including hidden
+   * sequences
+   * 
+   * @return Number of sequences in alignment
+   */
+  int getAbsoluteHeight();
+
+  /**
+   * 
    * Calculates the maximum width of the alignment, including gaps.
    * 
-   * @return Greatest sequence length within alignment.
+   * @return Greatest sequence length within alignment, or -1 if no sequences
+   *         present
    */
   @Override
-  public int getWidth();
+  int getWidth();
 
   /**
    * Calculates if this set of sequences (visible and invisible) are all the
@@ -50,7 +62,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @return true if all sequences in alignment are the same length
    */
-  public boolean isAligned();
+  boolean isAligned();
 
   /**
    * Calculates if this set of sequences is all the same length
@@ -59,7 +71,16 @@ public interface AlignmentI extends AnnotatedCollectionI
    *          optionally exclude hidden sequences from test
    * @return true if all (or just visible) sequences are the same length
    */
-  public boolean isAligned(boolean includeHidden);
+  boolean isAligned(boolean includeHidden);
+
+  /**
+   * Answers if the sequence at alignmentIndex is hidden
+   * 
+   * @param alignmentIndex
+   *          the index to check
+   * @return true if the sequence is hidden
+   */
+  boolean isHidden(int alignmentIndex);
 
   /**
    * Gets sequences as a Synchronized collection
@@ -67,14 +88,14 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @return All sequences in alignment.
    */
   @Override
-  public List<SequenceI> getSequences();
+  List<SequenceI> getSequences();
 
   /**
    * Gets sequences as a SequenceI[]
    * 
    * @return All sequences in alignment.
    */
-  public SequenceI[] getSequencesArray();
+  SequenceI[] getSequencesArray();
 
   /**
    * Find a specific sequence in this alignment.
@@ -84,7 +105,25 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @return SequenceI at given index.
    */
-  public SequenceI getSequenceAt(int i);
+  SequenceI getSequenceAt(int i);
+
+  /**
+   * Find a specific sequence in this alignment.
+   * 
+   * @param i
+   *          Index of required sequence in full alignment, i.e. if all columns
+   *          were visible
+   * 
+   * @return SequenceI at given index.
+   */
+  SequenceI getSequenceAtAbsoluteIndex(int i);
+
+  /**
+   * Returns a map of lists of sequences keyed by sequence name.
+   * 
+   * @return
+   */
+  Map<String, List<SequenceI>> getSequencesByName();
 
   /**
    * Add a new sequence to this alignment.
@@ -92,33 +131,48 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param seq
    *          New sequence will be added at end of alignment.
    */
-  public void addSequence(SequenceI seq);
+  void addSequence(SequenceI seq);
 
   /**
    * Used to set a particular index of the alignment with the given sequence.
    * 
    * @param i
-   *          Index of sequence to be updated.
+   *          Index of sequence to be updated. if i>length, sequence will be
+   *          added to end, with no intervening positions.
    * @param seq
-   *          New sequence to be inserted.
+   *          New sequence to be inserted. The existing sequence at position i
+   *          will be replaced.
+   * @return existing sequence (or null if i>current length)
    */
-  public void setSequenceAt(int i, SequenceI seq);
+  SequenceI replaceSequenceAt(int i, SequenceI seq);
 
   /**
-   * Deletes a sequence from the alignment
+   * Deletes a sequence from the alignment. Updates hidden sequences to account
+   * for the removed sequence. Do NOT use this method to delete sequences which
+   * are just hidden.
    * 
    * @param s
    *          Sequence to be deleted.
    */
-  public void deleteSequence(SequenceI s);
+  void deleteSequence(SequenceI s);
 
   /**
-   * Deletes a sequence from the alignment.
+   * Deletes a sequence from the alignment. Updates hidden sequences to account
+   * for the removed sequence. Do NOT use this method to delete sequences which
+   * are just hidden.
    * 
    * @param i
    *          Index of sequence to be deleted.
    */
-  public void deleteSequence(int i);
+  void deleteSequence(int i);
+
+  /**
+   * Deletes a sequence in the alignment which has been hidden.
+   * 
+   * @param i
+   *          Index of sequence to be deleted
+   */
+  void deleteHiddenSequence(int i);
 
   /**
    * Finds sequence in alignment using sequence name as query.
@@ -128,9 +182,9 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @return Sequence matching query, if found. If not found returns null.
    */
-  public SequenceI findName(String name);
+  SequenceI findName(String name);
 
-  public SequenceI[] findSequenceMatch(String name);
+  SequenceI[] findSequenceMatch(String name);
 
   /**
    * Finds index of a given sequence in the alignment.
@@ -140,18 +194,20 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @return Index of sequence within the alignment or -1 if not found
    */
-  public int findIndex(SequenceI s);
+  int findIndex(SequenceI s);
 
   /**
-   * Finds group that given sequence is part of.
+   * Returns the first group (in the order in which groups were added) that
+   * includes the given sequence instance and aligned position (base 0), or null
+   * if none found
    * 
-   * @param s
-   *          Sequence in alignment.
+   * @param seq
+   *          - must be contained in the alignment (not a dataset sequence)
+   * @param position
    * 
-   * @return First group found for sequence. WARNING : Sequences may be members
-   *         of several groups. This method is incomplete.
+   * @return
    */
-  public SequenceGroup findGroup(SequenceI s);
+  SequenceGroup findGroup(SequenceI seq, int position);
 
   /**
    * Finds all groups that a given sequence is part of.
@@ -161,7 +217,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @return All groups containing given sequence.
    */
-  public SequenceGroup[] findAllGroups(SequenceI s);
+  SequenceGroup[] findAllGroups(SequenceI s);
 
   /**
    * Adds a new SequenceGroup to this alignment.
@@ -169,7 +225,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param sg
    *          New group to be added.
    */
-  public void addGroup(SequenceGroup sg);
+  void addGroup(SequenceGroup sg);
 
   /**
    * Deletes a specific SequenceGroup
@@ -177,19 +233,19 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param g
    *          Group will be deleted from alignment.
    */
-  public void deleteGroup(SequenceGroup g);
+  void deleteGroup(SequenceGroup g);
 
   /**
    * Get all the groups associated with this alignment.
    * 
    * @return All groups as a list.
    */
-  public List<SequenceGroup> getGroups();
+  List<SequenceGroup> getGroups();
 
   /**
    * Deletes all groups from this alignment.
    */
-  public void deleteAllGroups();
+  void deleteAllGroups();
 
   /**
    * Adds a new AlignmentAnnotation to this alignment
@@ -197,7 +253,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @note Care should be taken to ensure that annotation is at least as wide as
    *       the longest sequence in the alignment for rendering purposes.
    */
-  public void addAnnotation(AlignmentAnnotation aa);
+  void addAnnotation(AlignmentAnnotation aa);
 
   /**
    * moves annotation to a specified index in alignment annotation display stack
@@ -207,7 +263,16 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param index
    *          the destination position
    */
-  public void setAnnotationIndex(AlignmentAnnotation aa, int index);
+  void setAnnotationIndex(AlignmentAnnotation aa, int index);
+
+  /**
+   * Delete all annotations, including auto-calculated if the flag is set true.
+   * Returns true if at least one annotation was deleted, else false.
+   * 
+   * @param includingAutoCalculated
+   * @return
+   */
+  boolean deleteAllAnnotations(boolean includingAutoCalculated);
 
   /**
    * Deletes a specific AlignmentAnnotation from the alignment, and removes its
@@ -219,7 +284,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    *          the annotation to delete
    * @return true if annotation was deleted from this alignment.
    */
-  public boolean deleteAnnotation(AlignmentAnnotation aa);
+  boolean deleteAnnotation(AlignmentAnnotation aa);
 
   /**
    * Deletes a specific AlignmentAnnotation from the alignment, and optionally
@@ -235,7 +300,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    *          into the alignment
    * @return true if annotation was deleted from this alignment.
    */
-  public boolean deleteAnnotation(AlignmentAnnotation aa, boolean unhook);
+  boolean deleteAnnotation(AlignmentAnnotation aa, boolean unhook);
 
   /**
    * Get the annotation associated with this alignment (this can be null if no
@@ -244,7 +309,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @return array of AlignmentAnnotation objects
    */
   @Override
-  public AlignmentAnnotation[] getAlignmentAnnotation();
+  AlignmentAnnotation[] getAlignmentAnnotation();
 
   /**
    * Change the gap character used in this alignment to 'gc'
@@ -252,34 +317,21 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param gc
    *          the new gap character.
    */
-  public void setGapCharacter(char gc);
+  void setGapCharacter(char gc);
 
   /**
    * Get the gap character used in this alignment
    * 
    * @return gap character
    */
-  public char getGapCharacter();
-
-  /**
-   * Test for all nucleotide alignment
-   * 
-   * @return true if alignment is nucleotide sequence
-   */
-  public boolean isNucleotide();
+  char getGapCharacter();
 
   /**
    * Test if alignment contains RNA structure
    * 
    * @return true if RNA structure AligmnentAnnotation was added to alignment
    */
-  public boolean hasRNAStructure();
-
-  /**
-   * Set alignment to be a nucleotide sequence
-   * 
-   */
-  public void setNucleotide(boolean b);
+  boolean hasRNAStructure();
 
   /**
    * Get the associated dataset for the alignment.
@@ -287,7 +339,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @return Alignment containing dataset sequences or null of this is a
    *         dataset.
    */
-  public Alignment getDataset();
+  AlignmentI getDataset();
 
   /**
    * Set the associated dataset for the alignment, or create one.
@@ -295,23 +347,25 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param dataset
    *          The dataset alignment or null to construct one.
    */
-  public void setDataset(Alignment dataset);
+  void setDataset(AlignmentI dataset);
 
   /**
    * pads sequences with gaps (to ensure the set looks like an alignment)
    * 
    * @return boolean true if alignment was modified
    */
-  public boolean padGaps();
+  boolean padGaps();
+
+  HiddenSequences getHiddenSequences();
 
-  public HiddenSequences getHiddenSequences();
+  HiddenColumns getHiddenColumns();
 
   /**
    * Compact representation of alignment
    * 
    * @return CigarArray
    */
-  public CigarArray getCompactAlignment();
+  CigarArray getCompactAlignment();
 
   /**
    * Set an arbitrary key value pair for an alignment. Note: both key and value
@@ -320,7 +374,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param key
    * @param value
    */
-  public void setProperty(Object key, Object value);
+  void setProperty(Object key, Object value);
 
   /**
    * Get a named property from the alignment.
@@ -328,21 +382,21 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param key
    * @return value of property
    */
-  public Object getProperty(Object key);
+  Object getProperty(Object key);
 
   /**
    * Get the property hashtable.
    * 
    * @return hashtable of alignment properties (or null if none are defined)
    */
-  public Hashtable getProperties();
+  Hashtable getProperties();
 
   /**
    * add a reference to a frame of aligned codons for this alignment
    * 
    * @param codons
    */
-  public void addCodonFrame(AlignedCodonFrame codons);
+  void addCodonFrame(AlignedCodonFrame codons);
 
   /**
    * remove a particular codon frame reference from this alignment
@@ -350,27 +404,24 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param codons
    * @return true if codon frame was removed.
    */
-  public boolean removeCodonFrame(AlignedCodonFrame codons);
+  boolean removeCodonFrame(AlignedCodonFrame codons);
 
   /**
    * get all codon frames associated with this alignment
    * 
    * @return
    */
-  public AlignedCodonFrame[] getCodonFrames();
+  List<AlignedCodonFrame> getCodonFrames();
 
   /**
-   * get a particular codon frame
-   * 
-   * @param index
-   * @return
+   * Set the codon frame mappings (replacing any existing list).
    */
-  public AlignedCodonFrame getCodonFrame(int index);
+  void setCodonFrames(List<AlignedCodonFrame> acfs);
 
   /**
    * get codon frames involving sequenceI
    */
-  public AlignedCodonFrame[] getCodonFrame(SequenceI seq);
+  List<AlignedCodonFrame> getCodonFrame(SequenceI seq);
 
   /**
    * find sequence with given name in alignment
@@ -382,7 +433,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    *          tried
    * @return matched sequence or null
    */
-  public SequenceI findName(String token, boolean b);
+  SequenceI findName(String token, boolean b);
 
   /**
    * find next sequence with given name in alignment starting after a given
@@ -398,7 +449,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    *          tried
    * @return matched sequence or null
    */
-  public SequenceI findName(SequenceI startAfter, String token, boolean b);
+  SequenceI findName(SequenceI startAfter, String token, boolean b);
 
   /**
    * find first sequence in alignment which is involved in the given search
@@ -407,7 +458,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param results
    * @return -1 or index of sequence in alignment
    */
-  public int findIndex(SearchResults results);
+  int findIndex(SearchResultsI results);
 
   /**
    * append sequences and annotation from another alignment object to this one.
@@ -420,7 +471,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param toappend
    *          - the alignment to be appended.
    */
-  public void append(AlignmentI toappend);
+  void append(AlignmentI toappend);
 
   /**
    * Justify the sequences to the left or right by deleting and inserting gaps
@@ -430,7 +481,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    *          true if alignment padded to right, false to justify to left
    * @return true if alignment was changed TODO: return undo object
    */
-  public boolean justify(boolean right);
+  boolean justify(boolean right);
 
   /**
    * add given annotation row at given position (0 is start, -1 is end)
@@ -438,7 +489,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param consensus
    * @param i
    */
-  public void addAnnotation(AlignmentAnnotation consensus, int i);
+  void addAnnotation(AlignmentAnnotation consensus, int i);
 
   /**
    * search for or create a specific annotation row on the alignment
@@ -458,9 +509,8 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @return existing annotation matching the given attributes
    */
-  public AlignmentAnnotation findOrCreateAnnotation(String name,
-          String calcId, boolean autoCalc, SequenceI seqRef,
-          SequenceGroup groupRef);
+  AlignmentAnnotation findOrCreateAnnotation(String name, String calcId,
+          boolean autoCalc, SequenceI seqRef, SequenceGroup groupRef);
 
   /**
    * move the given group up or down in the alignment by the given number of
@@ -472,7 +522,7 @@ public interface AlignmentI extends AnnotatedCollectionI
    * @param up
    * @param i
    */
-  public void moveSelectedSequencesByOne(SequenceGroup sg,
+  void moveSelectedSequencesByOne(SequenceGroup sg,
           Map<SequenceI, SequenceCollectionI> map, boolean up);
 
   /**
@@ -481,5 +531,64 @@ public interface AlignmentI extends AnnotatedCollectionI
    * 
    * @param alignmentAnnotation
    */
-  public void validateAnnotation(AlignmentAnnotation alignmentAnnotation);
+  void validateAnnotation(AlignmentAnnotation alignmentAnnotation);
+
+  /**
+   * Align this alignment the same as the given one. If both of the same type
+   * (nucleotide/protein) then align both identically. If this is nucleotide and
+   * the other is protein, make 3 gaps for each gap in the protein sequences. If
+   * this is protein and the other is nucleotide, insert a gap for each 3 gaps
+   * (or part thereof) between nucleotide bases. Returns the number of mapped
+   * sequences that were realigned .
+   * 
+   * @param al
+   * @return
+   */
+  int alignAs(AlignmentI al);
+
+  /**
+   * Returns the set of distinct sequence names in the alignment.
+   * 
+   * @return
+   */
+  Set<String> getSequenceNames();
+
+  /**
+   * Checks if the alignment has at least one sequence with one non-gaped
+   * residue
+   * 
+   * @return
+   */
+  public boolean hasValidSequence();
+
+  /**
+   * Update any mappings to 'virtual' sequences to compatible real ones, if
+   * present in the added sequences. Returns a count of mappings updated.
+   * 
+   * @param seqs
+   * @return
+   */
+  int realiseMappings(List<SequenceI> seqs);
+
+  /**
+   * Returns the first AlignedCodonFrame that has a mapping between the given
+   * dataset sequences
+   * 
+   * @param mapFrom
+   * @param mapTo
+   * @return
+   */
+  AlignedCodonFrame getMapping(SequenceI mapFrom, SequenceI mapTo);
+
+  /**
+   * Calculate the visible start and end index of an alignment. The result is
+   * returned an int array where: int[0] = startIndex, and int[1] = endIndex.
+   * 
+   * @param hiddenCols
+   * @return
+   */
+  public int[] getVisibleStartAndEndIndex(List<int[]> hiddenCols);
+
+  public void setHiddenColumns(HiddenColumns cols);
+
 }