From: gmungoc Date: Fri, 27 May 2016 14:21:54 +0000 (+0100) Subject: JAL-1989 added hashCode and equals, renamed field to avoid name conflict X-Git-Tag: Release_2_10_0~207 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=c2484e319127d8c57182a156138ef50de3740c64;p=jalview.git JAL-1989 added hashCode and equals, renamed field to avoid name conflict --- diff --git a/src/jalview/datamodel/ColumnSelection.java b/src/jalview/datamodel/ColumnSelection.java index 6fd76b2..74c58b7 100644 --- a/src/jalview/datamodel/ColumnSelection.java +++ b/src/jalview/datamodel/ColumnSelection.java @@ -32,10 +32,14 @@ import java.util.List; import java.util.Vector; /** - * NOTE: Columns are zero based. + * Data class holding the selected columns and hidden column ranges for a view. + * Ranges are base 1. */ public class ColumnSelection { + /** + * A class to hold an efficient representation of selected columns + */ private class IntList { /* @@ -205,9 +209,26 @@ public class ColumnSelection } return rlist; } + + @Override + public int hashCode() + { + // TODO Auto-generated method stub + return selected.hashCode(); + } + + @Override + public boolean equals(Object obj) + { + if (obj instanceof IntList) + { + return ((IntList) obj).selected.equals(selected); + } + return false; + } } - IntList selected = new IntList(); + IntList selection = new IntList(); /* * list of hidden column [start, end] ranges; the list is maintained in @@ -223,7 +244,7 @@ public class ColumnSelection */ public void addElement(int col) { - selected.add(col); + selection.add(col); } /** @@ -231,7 +252,7 @@ public class ColumnSelection */ public void clear() { - selected.clear(); + selection.clear(); } /** @@ -242,7 +263,7 @@ public class ColumnSelection */ public void removeElement(int col) { - selected.remove(col); + selection.remove(col); } /** @@ -259,9 +280,9 @@ public class ColumnSelection for (int i = start; i < end; i++) { colInt = new Integer(i); - if (selected.contains(colInt)) + if (selection.contains(colInt)) { - selected.remove(colInt); + selection.remove(colInt); } } } @@ -273,7 +294,7 @@ public class ColumnSelection */ public List getSelected() { - return selected.getList(); + return selection.getList(); } /** @@ -282,7 +303,7 @@ public class ColumnSelection */ public List getSelectedRanges() { - return selected.getRanges(); + return selection.getRanges(); } /** @@ -294,7 +315,7 @@ public class ColumnSelection */ public boolean contains(int col) { - return (col > -1) ? selected.isSelected(col) : false; + return (col > -1) ? selection.isSelected(col) : false; } /** @@ -302,7 +323,7 @@ public class ColumnSelection */ public boolean isEmpty() { - return selected == null || selected.isEmpty(); + return selection == null || selection.isEmpty(); } /** @@ -312,11 +333,11 @@ public class ColumnSelection */ public int getMax() { - if (selected.isEmpty()) + if (selection.isEmpty()) { return -1; } - return selected.getMaxColumn(); + return selection.getMaxColumn(); } /** @@ -326,11 +347,11 @@ public class ColumnSelection */ public int getMin() { - if (selected.isEmpty()) + if (selection.isEmpty()) { return 1000000000; } - return selected.getMinColumn(); + return selection.getMinColumn(); } /** @@ -344,7 +365,7 @@ public class ColumnSelection public List compensateForEdit(int start, int change) { List deletedHiddenColumns = null; - selected.compensateForEdits(start, change); + selection.compensateForEdits(start, change); if (hiddenColumns != null) { @@ -394,7 +415,7 @@ public class ColumnSelection private void compensateForDelEdits(int start, int change) { - selected.compensateForEdits(start, change); + selection.compensateForEdits(start, change); if (hiddenColumns != null) { @@ -571,12 +592,12 @@ public class ColumnSelection hiddenColumns = null; } } - if (selected != null && selected.size() > 0) + if (selection != null && selection.size() > 0) { - selected.pruneColumnList(shifts); - if (selected != null && selected.size() == 0) + selection.pruneColumnList(shifts); + if (selection != null && selection.size() == 0) { - selected = null; + selection = null; } } // and shift the rest. @@ -743,13 +764,13 @@ public class ColumnSelection public void hideSelectedColumns() { - synchronized (selected) + synchronized (selection) { - for (int[] selregions : selected.getRanges()) + for (int[] selregions : selection.getRanges()) { hideColumns(selregions[0], selregions[1]); } - selected.clear(); + selection.clear(); } } @@ -927,12 +948,12 @@ public class ColumnSelection { if (copy != null) { - if (copy.selected != null) + if (copy.selection != null) { - selected = new IntList(); - for (int i = 0, j = copy.selected.size(); i < j; i++) + selection = new IntList(); + for (int i = 0, j = copy.selection.size(); i < j; i++) { - selected.add(copy.selected.elementAt(i)); + selection.add(copy.selection.elementAt(i)); } } if (copy.hiddenColumns != null) @@ -1307,7 +1328,7 @@ public class ColumnSelection { if (hiddenColumns != null && isVisible(col.intValue())) { - selected.add(col); + selection.add(col); } } } @@ -1321,8 +1342,8 @@ public class ColumnSelection */ public void setElementsFrom(ColumnSelection colsel) { - selected = new IntList(); - if (colsel.selected != null && colsel.selected.size() > 0) + selection = new IntList(); + if (colsel.selection != null && colsel.selection.size() > 0) { if (hiddenColumns != null && hiddenColumns.size() > 0) { @@ -1489,7 +1510,7 @@ public class ColumnSelection */ public boolean hasSelectedColumns() { - return (selected != null && selected.size() > 0); + return (selection != null && selection.size() > 0); } /** @@ -1612,4 +1633,32 @@ public class ColumnSelection return false; } + /** + * Returns a hashCode built from selected columns and hidden column ranges + */ + @Override + public int hashCode() + { + int hashCode = selection.hashCode(); + if (hiddenColumns != null) + { + for (int[] hidden : hiddenColumns) + { + hashCode = 31 * hashCode + hidden[0]; + hashCode = 31 * hashCode + hidden[1]; + } + } + return hashCode; + } + + @Override + public boolean equals(Object obj) + { + if (obj instanceof ColumnSelection) + { + return hashCode() == obj.hashCode(); + } + return false; + } + } diff --git a/test/jalview/datamodel/ColumnSelectionTest.java b/test/jalview/datamodel/ColumnSelectionTest.java index 86e7949..e1d04eb 100644 --- a/test/jalview/datamodel/ColumnSelectionTest.java +++ b/test/jalview/datamodel/ColumnSelectionTest.java @@ -478,4 +478,47 @@ public class ColumnSelectionTest cs.addElement(0); assertEquals(0, cs.getMin()); } + + @Test(groups = { "Functional" }) + public void testEquals() + { + ColumnSelection cs = new ColumnSelection(); + cs.addElement(0); + cs.addElement(513); + cs.addElement(1); + cs.hideColumns(3); + cs.hideColumns(7); + cs.hideColumns(5,9); + + // same selections added in a different order + ColumnSelection cs2 = new ColumnSelection(); + cs2.addElement(1); + cs2.addElement(513); + cs2.addElement(0); + cs2.hideColumns(6, 9); + cs2.hideColumns(5, 8); + cs2.hideColumns(3); + + assertTrue(cs.equals(cs2)); + assertTrue(cs.equals(cs)); + assertTrue(cs2.equals(cs)); + assertTrue(cs2.equals(cs2)); + + cs2.addElement(12); + assertFalse(cs.equals(cs2)); + assertFalse(cs2.equals(cs)); + + cs2.removeElement(12); + assertTrue(cs.equals(cs2)); + + cs2.hideColumns(88); + assertFalse(cs.equals(cs2)); + /* + * unhiding a column adds it to selection! + */ + cs2.revealHiddenColumns(88); + assertFalse(cs.equals(cs2)); + cs.addElement(88); + assertTrue(cs.equals(cs2)); + } }