Merge branch 'features/JAL-1152annotationSorting' of https://source.jalview.org/git...

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

diff --git a/src/jalview/analysis/AnnotationSorter.java b/src/jalview/analysis/AnnotationSorter.java
index 4ee2b86..28fa1f8 100644 (file)
--- a/src/jalview/analysis/AnnotationSorter.java
+++ b/src/jalview/analysis/AnnotationSorter.java
@@ -17,11 +17,61 @@ import java.util.Comparator;
 public class AnnotationSorter
 {
 
+  /**
+   * enum for annotation sort options. The text description is used in the
+   * Preferences drop-down options. The enum name is saved in the preferences
+   * file.
+   * 
+   * @author gmcarstairs
+   *
+   */
+  public enum SequenceAnnotationOrder
+  {
+    // Text descriptions surface in the Preferences Sort by... options
+    SEQUENCE_AND_LABEL("Sequence"), LABEL_AND_SEQUENCE("Label"), NONE(
+            "No sort");
+
+    private String description;
+
+    private SequenceAnnotationOrder(String s)
+    {
+      description = s;
+    }
+
+    @Override
+    public String toString()
+    {
+      return description;
+    }
+
+    public static SequenceAnnotationOrder forDescription(String d) {
+      for (SequenceAnnotationOrder order : values())
+      {
+        if (order.toString().equals(d))
+        {
+          return order;
+        }
+      }
+      return null;
+    }
+  }
+
   private final AlignmentI alignment;
 
-  public AnnotationSorter(AlignmentI alignmentI)
+  private boolean showAutocalcAbove;
+
+  /**
+   * Constructor given an alignment and the location (top or bottom) of
+   * Consensus and similar.
+   * 
+   * @param alignmentI
+   * @param showAutocalculatedAbove
+   */
+  public AnnotationSorter(AlignmentI alignmentI,
+          boolean showAutocalculatedAbove)
   {
     this.alignment = alignmentI;
+    this.showAutocalcAbove = showAutocalculatedAbove;
   }
 
   /**
@@ -34,7 +84,7 @@ public class AnnotationSorter
    * <li>within the same sequence ref, sort by label (non-case-sensitive)</li>
    * </ul>
    */
-  private final Comparator<? super AlignmentAnnotation> bySequenceAndType = new Comparator<AlignmentAnnotation>()
+  private final Comparator<? super AlignmentAnnotation> bySequenceAndLabel = new Comparator<AlignmentAnnotation>()
   {
     @Override
     public int compare(AlignmentAnnotation o1, AlignmentAnnotation o2)
@@ -74,7 +124,7 @@ public class AnnotationSorter
    * <li>within the same label, sort by order of the related sequences</li>
    * </ul>
    */
-  private final Comparator<? super AlignmentAnnotation> byTypeAndSequence = new Comparator<AlignmentAnnotation>()
+  private final Comparator<? super AlignmentAnnotation> byLabelAndSequence = new Comparator<AlignmentAnnotation>()
   {
     @Override
     public int compare(AlignmentAnnotation o1, AlignmentAnnotation o2)
@@ -102,15 +152,15 @@ public class AnnotationSorter
       }
 
       /*
-       * Sort non-sequence-related after sequence-related.
+       * Sort non-sequence-related before or after sequence-related.
        */
       if (o1.sequenceRef == null)
       {
-        return 1;
+        return showAutocalcAbove ? -1 : 1;
       }
       if (o2.sequenceRef == null)
       {
-        return -1;
+        return showAutocalcAbove ? 1 : -1;
       }
       int labelOrder = compareLabels(o1, o2);
       return labelOrder == 0 ? compareSequences(o1, o2) : labelOrder;
@@ -118,42 +168,78 @@ public class AnnotationSorter
   };
 
   /**
-   * Sort by annotation type (label), within sequence order.
-   * Non-sequence-related annotations sort to the end.
-   * 
-   * @param alignmentAnnotations
+   * noSort leaves sort order unchanged, within sequence- and
+   * non-sequence-related annotations, but may switch the ordering of these
+   * groups. Note this is guaranteed (at least in Java 7) as Arrays.sort() is
+   * guaranteed to be 'stable' (not change ordering of equal items).
    */
-  public void sortBySequenceAndType(
-          AlignmentAnnotation[] alignmentAnnotations)
+  private Comparator<? super AlignmentAnnotation> noSort = new Comparator<AlignmentAnnotation>()
   {
-    if (alignmentAnnotations != null)
+    @Override
+    public int compare(AlignmentAnnotation o1, AlignmentAnnotation o2)
     {
-      synchronized (alignmentAnnotations)
+      if (o1 != null && o2 != null)
       {
-        Arrays.sort(alignmentAnnotations, bySequenceAndType);
+        if (o1.sequenceRef == null && o2.sequenceRef != null)
+        {
+          return showAutocalcAbove ? -1 : 1;
+        }
+        if (o1.sequenceRef != null && o2.sequenceRef == null)
+        {
+          return showAutocalcAbove ? 1 : -1;
+        }
       }
+      return 0;
     }
-  }
+  };
 
   /**
-   * Sort by sequence order within annotation type (label). Non-sequence-related
-   * annotations sort to the end.
+   * Sort by the specified ordering of sequence-specific annotations.
    * 
    * @param alignmentAnnotations
+   * @param order
    */
-  public void sortByTypeAndSequence(
-          AlignmentAnnotation[] alignmentAnnotations)
+  public void sort(AlignmentAnnotation[] alignmentAnnotations,
+          SequenceAnnotationOrder order)
   {
+    Comparator<? super AlignmentAnnotation> comparator = getComparator(order);
+
     if (alignmentAnnotations != null)
     {
       synchronized (alignmentAnnotations)
       {
-        Arrays.sort(alignmentAnnotations, byTypeAndSequence);
+        Arrays.sort(alignmentAnnotations, comparator);
       }
     }
   }
 
   /**
+   * Get the comparator for the specified sort order.
+   * 
+   * @param order
+   * @return
+   */
+  private Comparator<? super AlignmentAnnotation> getComparator(
+          SequenceAnnotationOrder order)
+  {
+    if (order == null)
+    {
+      return noSort;
+    }
+    switch (order)
+    {
+    case NONE:
+      return this.noSort;
+    case SEQUENCE_AND_LABEL:
+      return this.bySequenceAndLabel;
+    case LABEL_AND_SEQUENCE:
+      return this.byLabelAndSequence;
+    default:
+      throw new UnsupportedOperationException(order.toString());
+    }
+  }
+
+  /**
    * Non-case-sensitive comparison of annotation labels. Returns zero if either
    * argument is null.
    * 
@@ -201,13 +287,16 @@ public class AnnotationSorter
     {
       return 0;
     }
+    /*
+     * Sort non-sequence-related before or after sequence-related.
+     */
     if (seq1 == null)
     {
-      return 1;
+      return showAutocalcAbove ? -1 : 1;
     }
     if (seq2 == null)
     {
-      return -1;
+      return showAutocalcAbove ? 1 : -1;
     }
     // get sequence index - but note -1 means 'at end' so needs special handling
     int index1 = AlignmentUtils.getSequenceIndex(alignment, seq1);