JAL-1152 annotation sort algorithm optimisation

[jalview.git] / src / jalview / analysis / AnnotationSorter.java

diff --git a/src/jalview/analysis/AnnotationSorter.java b/src/jalview/analysis/AnnotationSorter.java
index 28fa1f8..a5d2164 100644 (file)
--- a/src/jalview/analysis/AnnotationSorter.java
+++ b/src/jalview/analysis/AnnotationSorter.java
@@ -6,6 +6,8 @@ import jalview.datamodel.SequenceI;
 
 import java.util.Arrays;
 import java.util.Comparator;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * A helper class to sort all annotations associated with an alignment in
@@ -56,10 +58,15 @@ public class AnnotationSorter
     }
   }
 
+  // the alignment with respect to which annotations are sorted
   private final AlignmentI alignment;
 
+  // user preference for placement of non-sequence annotations
   private boolean showAutocalcAbove;
 
+  // working map of sequence index in alignment
+  private final Map<SequenceI, Integer> sequenceIndices = new HashMap<SequenceI, Integer>();
+
   /**
    * Constructor given an alignment and the location (top or bottom) of
    * Consensus and similar.
@@ -202,6 +209,9 @@ public class AnnotationSorter
   public void sort(AlignmentAnnotation[] alignmentAnnotations,
           SequenceAnnotationOrder order)
   {
+    // cache 'alignment sequence position' for the annotations
+    saveSequenceIndices(alignmentAnnotations);
+
     Comparator<? super AlignmentAnnotation> comparator = getComparator(order);
 
     if (alignmentAnnotations != null)
@@ -214,6 +224,26 @@ public class AnnotationSorter
   }
 
   /**
+   * Calculate and save in a temporary map the position of each annotation's
+   * sequence (if it has one) in the alignment. Faster to do this once than for
+   * every annotation comparison.
+   * 
+   * @param alignmentAnnotations
+   */
+  private void saveSequenceIndices(
+          AlignmentAnnotation[] alignmentAnnotations)
+  {
+    sequenceIndices.clear();
+    for (AlignmentAnnotation ann : alignmentAnnotations) {
+      SequenceI seq = ann.sequenceRef;
+      if (seq != null) {
+        int index = AlignmentUtils.getSequenceIndex(alignment, seq);
+        sequenceIndices.put(seq, index);
+      }
+    }
+  }
+
+  /**
    * Get the comparator for the specified sort order.
    * 
    * @param order
@@ -299,8 +329,8 @@ public class AnnotationSorter
       return showAutocalcAbove ? 1 : -1;
     }
     // get sequence index - but note -1 means 'at end' so needs special handling
-    int index1 = AlignmentUtils.getSequenceIndex(alignment, seq1);
-    int index2 = AlignmentUtils.getSequenceIndex(alignment, seq2);
+    int index1 = sequenceIndices.get(seq1);
+    int index2 = sequenceIndices.get(seq2);
     if (index1 == index2)
     {
       return 0;