JAL-2418 source formatting
[jalview.git] / src / jalview / datamodel / HiddenSequences.java
index 0514fb8..c9dce08 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-\r
-package jalview.datamodel;\r
-\r
-import java.util.*;\r
-\r
-public class HiddenSequences\r
-{\r
-  public SequenceI[] hiddenSequences;\r
-  AlignmentI alignment;\r
-\r
-  public HiddenSequences(AlignmentI al)\r
-  {\r
-    alignment = al;\r
-  }\r
-\r
-  public int getSize()\r
-  {\r
-    if (hiddenSequences == null)\r
-    {\r
-      return 0;\r
-    }\r
-    int count = 0;\r
-    for (int i = 0; i < hiddenSequences.length; i++)\r
-    {\r
-      if (hiddenSequences[i] != null)\r
-      {\r
-        count++;\r
-      }\r
-    }\r
-\r
-    return count;\r
-  }\r
-\r
-  public int getWidth()\r
-  {\r
-    int width = 0;\r
-    for (int i = 0; i < hiddenSequences.length; i++)\r
-    {\r
-      if (hiddenSequences[i] != null && hiddenSequences[i].getLength() > width)\r
-      {\r
-        width = hiddenSequences[i].getLength();\r
-      }\r
-    }\r
-\r
-    return width;\r
-  }\r
-\r
-  /**\r
-   * Call this method if sequences are removed from the\r
-   * main alignment\r
-   */\r
-  public void adjustHeightSequenceDeleted(int seqIndex)\r
-  {\r
-    if (hiddenSequences == null)\r
-    {\r
-      return;\r
-    }\r
-\r
-    int alHeight = alignment.getHeight();\r
-\r
-    SequenceI[] tmp = new SequenceI[alHeight + getSize()];\r
-    int deletionIndex = adjustForHiddenSeqs(seqIndex);\r
-\r
-    for (int i = 0; i < hiddenSequences.length; i++)\r
-    {\r
-      if (hiddenSequences[i] == null)\r
-      {\r
-        continue;\r
-      }\r
-\r
-      if (i > deletionIndex)\r
-      {\r
-        tmp[i - 1] = hiddenSequences[i];\r
-      }\r
-      else\r
-      {\r
-        tmp[i] = hiddenSequences[i];\r
-      }\r
-    }\r
-\r
-    hiddenSequences = tmp;\r
-\r
-  }\r
-\r
-  /**\r
-   * Call this method if sequences are added to or removed from the\r
-   * main alignment\r
-   */\r
-  public void adjustHeightSequenceAdded()\r
-  {\r
-    if (hiddenSequences == null)\r
-    {\r
-      return;\r
-    }\r
-\r
-    int alHeight = alignment.getHeight();\r
-\r
-    SequenceI[] tmp = new SequenceI[alHeight + getSize()];\r
-    System.arraycopy(hiddenSequences, 0, tmp, 0, hiddenSequences.length);\r
-    hiddenSequences = tmp;\r
-  }\r
-\r
-  public void hideSequence(SequenceI sequence)\r
-  {\r
-    if (hiddenSequences == null)\r
-    {\r
-      hiddenSequences = new SequenceI[alignment.getHeight()];\r
-    }\r
-\r
-    int alignmentIndex = alignment.findIndex(sequence);\r
-    alignmentIndex = adjustForHiddenSeqs(alignmentIndex);\r
-\r
-    if (hiddenSequences[alignmentIndex] != null)\r
-    {\r
-      System.out.println("ERROR!!!!!!!!!!!");\r
-    }\r
-\r
-    hiddenSequences[alignmentIndex] = sequence;\r
-\r
-    alignment.deleteSequence(sequence);\r
-  }\r
-\r
-  public Vector showAll(Hashtable hiddenReps)\r
-  {\r
-    Vector revealedSeqs = new Vector();\r
-    for (int i = 0; i < hiddenSequences.length; i++)\r
-    {\r
-      if (hiddenSequences[i] != null)\r
-      {\r
-        Vector tmp = showSequence(i, hiddenReps);\r
-        for (int t = 0; t < tmp.size(); t++)\r
-        {\r
-          revealedSeqs.addElement(tmp.elementAt(t));\r
-        }\r
-      }\r
-    }\r
-    return revealedSeqs;\r
-  }\r
-\r
-  public Vector showSequence(int alignmentIndex, Hashtable hiddenReps)\r
-  {\r
-    Vector revealedSeqs = new Vector();\r
-    SequenceI repSequence = alignment.getSequenceAt(alignmentIndex);\r
-    if (repSequence != null &&\r
-        hiddenReps != null\r
-        && hiddenReps.containsKey(repSequence))\r
-    {\r
-      hiddenReps.remove(repSequence);\r
-      revealedSeqs.addElement(repSequence);\r
-    }\r
-\r
-    int start = adjustForHiddenSeqs(alignmentIndex - 1);\r
-    int end = adjustForHiddenSeqs(alignmentIndex);\r
-    if (end >= hiddenSequences.length)\r
-    {\r
-      end = hiddenSequences.length - 1;\r
-    }\r
-\r
-    for (int index = end; index > start; index--)\r
-    {\r
-      SequenceI seq = hiddenSequences[index];\r
-      hiddenSequences[index] = null;\r
-\r
-      if (seq != null)\r
-      {\r
-        if (seq.getLength() > 0)\r
-        {\r
-          revealedSeqs.addElement(seq);\r
-          alignment.getSequences().insertElementAt(seq, alignmentIndex);\r
-        }\r
-        else\r
-        {\r
-          System.out.println(seq.getName() + " has been deleted whilst hidden");\r
-        }\r
-      }\r
-\r
-    }\r
-\r
-    return revealedSeqs;\r
-  }\r
-\r
-  public SequenceI getHiddenSequence(int alignmentIndex)\r
-  {\r
-    return hiddenSequences[alignmentIndex];\r
-  }\r
-\r
-  public int findIndexWithoutHiddenSeqs(int alignmentIndex)\r
-  {\r
-    int index = 0;\r
-    int hiddenSeqs = 0;\r
-    if (hiddenSequences.length <= alignmentIndex)\r
-    {\r
-      alignmentIndex = hiddenSequences.length - 1;\r
-    }\r
-\r
-    while (index <= alignmentIndex)\r
-    {\r
-      if (hiddenSequences[index] != null)\r
-      {\r
-        hiddenSeqs++;\r
-      }\r
-      index++;\r
-    }\r
-    ;\r
-\r
-    return (alignmentIndex - hiddenSeqs);\r
-  }\r
-\r
-  public int adjustForHiddenSeqs(int alignmentIndex)\r
-  {\r
-    int index = 0;\r
-    int hSize = hiddenSequences.length;\r
-    while (index <= alignmentIndex && index < hSize)\r
-    {\r
-      if (hiddenSequences[index] != null)\r
-      {\r
-        alignmentIndex++;\r
-      }\r
-      index++;\r
-    }\r
-    ;\r
-\r
-    return alignmentIndex;\r
-  }\r
-\r
-  public AlignmentI getFullAlignment()\r
-  {\r
-    int isize = hiddenSequences.length;\r
-    SequenceI[] seq = new Sequence[isize];\r
-\r
-    int index = 0;\r
-    for (int i = 0; i < hiddenSequences.length; i++)\r
-    {\r
-      if (hiddenSequences[i] != null)\r
-      {\r
-        seq[i] = hiddenSequences[i];\r
-      }\r
-      else\r
-      {\r
-        seq[i] = alignment.getSequenceAt(index);\r
-        index++;\r
-      }\r
-    }\r
-\r
-    return new Alignment(seq);\r
-  }\r
-\r
-  public boolean isHidden(SequenceI seq)\r
-  {\r
-    for (int i = 0; i < hiddenSequences.length; i++)\r
-    {\r
-      if (hiddenSequences[i] != null && hiddenSequences[i] == seq)\r
-      {\r
-        return true;\r
-      }\r
-    }\r
-\r
-    return false;\r
-  }\r
-}\r
+/*
+ * 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 
+ * 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.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.datamodel;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public class HiddenSequences
+{
+  /**
+   * holds a list of hidden sequences associated with an alignment.
+   */
+  public SequenceI[] hiddenSequences;
+
+  AlignmentI alignment;
+
+  /**
+   * Constructor given a reference to an alignment (with no hidden sequences)
+   * 
+   * @param al
+   */
+  public HiddenSequences(AlignmentI al)
+  {
+    alignment = al;
+  }
+
+  /**
+   * Answers the number of hidden sequences
+   * 
+   * @return
+   */
+  public int getSize()
+  {
+    if (hiddenSequences == null)
+    {
+      return 0;
+    }
+    int count = 0;
+    for (SequenceI seq : hiddenSequences)
+    {
+      if (seq != null)
+      {
+        count++;
+      }
+    }
+
+    return count;
+  }
+
+  /**
+   * Answers the length of the longest hidden sequence
+   * 
+   * @return
+   */
+  public int getWidth()
+  {
+    if (hiddenSequences == null)
+    {
+      return 0;
+    }
+    int width = 0;
+    for (SequenceI seq : hiddenSequences)
+    {
+      if (seq != null && seq.getLength() > width)
+      {
+        width = seq.getLength();
+      }
+    }
+
+    return width;
+  }
+
+  /**
+   * Call this method after a sequence is removed from the main alignment
+   */
+  public void adjustHeightSequenceDeleted(int seqIndex)
+  {
+    if (hiddenSequences == null)
+    {
+      return;
+    }
+
+    int alHeight = alignment.getHeight();
+
+    SequenceI[] tmp = new SequenceI[alHeight + getSize()];
+    int deletionIndex = adjustForHiddenSeqs(seqIndex);
+
+    for (int i = 0; i < hiddenSequences.length; i++)
+    {
+      if (hiddenSequences[i] == null)
+      {
+        continue;
+      }
+
+      if (i > deletionIndex)
+      {
+        tmp[i - 1] = hiddenSequences[i];
+      }
+      else
+      {
+        tmp[i] = hiddenSequences[i];
+      }
+    }
+
+    hiddenSequences = tmp;
+
+  }
+
+  /**
+   * Call this method after a sequence is added to the main alignment
+   */
+  public void adjustHeightSequenceAdded()
+  {
+    if (hiddenSequences == null)
+    {
+      return;
+    }
+
+    int alHeight = alignment.getHeight();
+
+    SequenceI[] tmp = new SequenceI[alHeight + getSize()];
+    System.arraycopy(hiddenSequences, 0, tmp, 0, hiddenSequences.length);
+    hiddenSequences = tmp;
+  }
+
+  /**
+   * Mark the specified sequence as hidden
+   * 
+   * @param sequence
+   */
+  public void hideSequence(SequenceI sequence)
+  {
+    if (hiddenSequences == null)
+    {
+      hiddenSequences = new SequenceI[alignment.getHeight()];
+    }
+
+    int absAlignmentIndex = alignment.findIndex(sequence);
+    int alignmentIndex = adjustForHiddenSeqs(absAlignmentIndex);
+
+    if (alignmentIndex < 0 || hiddenSequences[alignmentIndex] != null)
+    {
+      System.out.println("ERROR!!!!!!!!!!!");
+      return;
+    }
+
+    hiddenSequences[alignmentIndex] = sequence;
+
+    alignment.deleteHiddenSequence(absAlignmentIndex);
+  }
+
+  public List<SequenceI> showAll(
+          Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
+  {
+    List<SequenceI> revealedSeqs = new ArrayList<>();
+
+    if (hiddenSequences == null)
+    {
+      return revealedSeqs;
+    }
+
+    for (int i = 0; i < hiddenSequences.length; i++)
+    {
+      if (hiddenSequences[i] != null)
+      {
+        List<SequenceI> tmp = showSequence(i, hiddenRepSequences);
+        for (SequenceI seq : tmp)
+        {
+          revealedSeqs.add(seq);
+        }
+      }
+    }
+    return revealedSeqs;
+  }
+
+  /**
+   * Reveals (unhides) consecutive hidden sequences just above the given
+   * alignment index. The revealed sequences are selected (including their
+   * visible representative sequence if there was one and 'reveal' is being
+   * performed on it).
+   * 
+   * @param alignmentIndex
+   * @param hiddenRepSequences
+   *          a map of representative sequences to the sequences they represent
+   * @return
+   */
+  public List<SequenceI> showSequence(int alignmentIndex,
+          Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
+  {
+    List<SequenceI> revealedSeqs = new ArrayList<>();
+    SequenceI repSequence = alignment.getSequenceAt(alignmentIndex);
+    if (repSequence != null && hiddenRepSequences != null
+            && hiddenRepSequences.containsKey(repSequence))
+    {
+      hiddenRepSequences.remove(repSequence);
+      revealedSeqs.add(repSequence);
+    }
+
+    int start = adjustForHiddenSeqs(alignmentIndex - 1);
+    int end = adjustForHiddenSeqs(alignmentIndex);
+    if (end >= hiddenSequences.length)
+    {
+      end = hiddenSequences.length - 1;
+    }
+
+    List<SequenceI> asequences;
+    synchronized (asequences = alignment.getSequences())
+    {
+      for (int index = end; index > start; index--)
+      {
+        SequenceI seq = hiddenSequences[index];
+        hiddenSequences[index] = null;
+
+        if (seq != null)
+        {
+          if (seq.getLength() > 0)
+          {
+            revealedSeqs.add(seq);
+            asequences.add(alignmentIndex, seq);
+          }
+          else
+          {
+            System.out.println(
+                    seq.getName() + " has been deleted whilst hidden");
+          }
+        }
+      }
+    }
+    return revealedSeqs;
+  }
+
+  public SequenceI getHiddenSequence(int alignmentIndex)
+  {
+    return hiddenSequences == null ? null : hiddenSequences[alignmentIndex];
+  }
+
+  /**
+   * Convert absolute alignment index to visible alignment index (or -1 if
+   * before the first visible sequence)
+   * 
+   * @param alignmentIndex
+   * @return
+   */
+  public int findIndexWithoutHiddenSeqs(int alignmentIndex)
+  {
+    if (hiddenSequences == null)
+    {
+      return alignmentIndex;
+    }
+    int index = 0;
+    int hiddenSeqs = 0;
+    int diff = 0;
+    if (hiddenSequences.length <= alignmentIndex)
+    {
+      // if the alignmentIndex runs past the end of hidden sequences
+      // and therefore actually past the end of the alignment
+      // store the difference to add back on at the end, so that behaviour
+      // is consistent with hidden columns behaviour (used by overview panel)
+      diff = alignmentIndex - hiddenSequences.length + 1;
+      alignmentIndex = hiddenSequences.length - 1;
+    }
+
+    while (index <= alignmentIndex)
+    {
+      if (hiddenSequences[index] != null)
+      {
+        hiddenSeqs++;
+      }
+      index++;
+    }
+
+    return (alignmentIndex - hiddenSeqs + diff);
+  }
+
+  /**
+   * Find the visible row which is a given visible number of rows above another
+   * visible row. i.e. for a startRow x, the row which is distance 1 away will
+   * be row x-1.
+   * 
+   * @param visibleDistance
+   *          the number of visible rows to offset by
+   * @param startRow
+   *          the row to start from
+   * @return the position of the row in the visible alignment
+   */
+  public int subtractVisibleRows(int visibleDistance, int startRow)
+  {
+    // walk upwards through the alignment
+    // count all the non-null sequences until we have visibleDistance counted
+    // then return the next visible sequence
+    if (hiddenSequences == null)
+    {
+      return startRow - visibleDistance;
+    }
+
+    int index = Math.min(startRow, hiddenSequences.length - 1);
+    int count = 0;
+    while ((index > -1) && (count < visibleDistance))
+    {
+      if (hiddenSequences[index] == null)
+      {
+        // count visible sequences
+        count++;
+      }
+      index--;
+    }
+    return index;
+  }
+
+  /**
+   * Convert alignment index from visible alignment to absolute alignment
+   * 
+   * @param alignmentIndex
+   * @return
+   */
+  public int adjustForHiddenSeqs(int alignmentIndex)
+  {
+    if (hiddenSequences == null)
+    {
+      return alignmentIndex;
+    }
+    int index = 0;
+    int hSize = hiddenSequences.length;
+    while (index <= alignmentIndex && index < hSize)
+    {
+      if (hiddenSequences[index] != null)
+      {
+        alignmentIndex++;
+      }
+      index++;
+    }
+    ;
+
+    return alignmentIndex;
+  }
+
+  /**
+   * makes a copy of the alignment with hidden sequences included. Using the
+   * copy for anything other than simple output is not recommended. Note - this
+   * method DOES NOT USE THE AlignmentI COPY CONSTRUCTOR!
+   * 
+   * @return
+   */
+  public AlignmentI getFullAlignment()
+  {
+    SequenceI[] seq;
+    if (hiddenSequences == null)
+    {
+      seq = alignment.getSequencesArray();
+    }
+    else
+    {
+      int isize = hiddenSequences.length;
+      seq = new Sequence[isize];
+
+      int index = 0;
+      for (int i = 0; i < hiddenSequences.length; i++)
+      {
+        if (hiddenSequences[i] != null)
+        {
+          seq[i] = hiddenSequences[i];
+        }
+        else
+        {
+          seq[i] = alignment.getSequenceAt(index);
+          index++;
+        }
+      }
+    }
+    Alignment fAlignmt = new Alignment(seq);
+    fAlignmt.annotations = alignment.getAlignmentAnnotation();
+    fAlignmt.alignmentProperties = alignment.getProperties();
+    fAlignmt.groups = alignment.getGroups();
+    fAlignmt.hasRNAStructure = alignment.hasRNAStructure();
+    fAlignmt.setSeqrep(alignment.getSeqrep());
+
+    return fAlignmt;
+  }
+
+  public boolean isHidden(SequenceI seq)
+  {
+    if (hiddenSequences != null)
+    {
+      for (int i = 0; i < hiddenSequences.length; i++)
+      {
+        if (hiddenSequences[i] != null && hiddenSequences[i] == seq)
+        {
+          return true;
+        }
+      }
+    }
+
+    return false;
+  }
+
+  /**
+   * Answers if a sequence is hidden
+   * 
+   * @param seq
+   *          (absolute) index to test
+   * @return true if sequence at index seq is hidden
+   */
+  public boolean isHidden(int seq)
+  {
+    if (hiddenSequences != null)
+    {
+      return (hiddenSequences[seq] != null);
+    }
+    return false;
+  }
+}