Coverage Report

 /**
  * Copyright 2008 WebPhotos
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package net.sf.webphotos.gui.util;
 
 import java.awt.*;
 import java.awt.event.*;
 import java.util.*;
 import java.util.List;
 import javax.swing.*;
 import javax.swing.event.TableModelEvent;
 import javax.swing.event.TableModelListener;
 import javax.swing.table.*;
 
 /**
  * TableSorter is a decorator for TableModels; adding sorting
  * functionality to a supplied TableModel. TableSorter does
  * not store or copy the data in its TableModel; instead it maintains
  * a map from the row indexes of the view to the row indexes of the
  * model. As requests are made of the sorter (like getValueAt(row, col))
  * they are passed to the underlying model after the row numbers
  * have been translated via the internal mapping array. This way,
  * the TableSorter appears to hold another copy of the table
  * with the rows in a different order.
  * <p/>
  * TableSorter registers itself as a listener to the underlying model,
  * just as the JTable itself would. Events recieved from the model
  * are examined, sometimes manipulated (typically widened), and then
  * passed on to the TableSorter's listeners (typically the JTable).
  * If a change to the model has invalidated the order of TableSorter's
  * rows, a note of this is made and the sorter will resort the
  * rows the next time a value is requested.
  * <p/>
  * When the tableHeader property is set, either by using the
  * setTableHeader() method or the two argument constructor, the
  * table header may be used as a complete UI for TableSorter.
  * The default renderer of the tableHeader is decorated with a renderer
  * that indicates the sorting status of each column. In addition,
  * a mouse listener is installed with the following behavior:
  * <ul>
  * <li>
  * Mouse-click: Clears the sorting status of all other columns
  * and advances the sorting status of that column through three
  * values: {NOT_SORTED, ASCENDING, DESCENDING} (then back to
  * NOT_SORTED again).
  * <li>
  * SHIFT-mouse-click: Clears the sorting status of all other columns
  * and cycles the sorting status of the column through the same
  * three values, in the opposite order: {NOT_SORTED, DESCENDING, ASCENDING}.
  * <li>
  * CONTROL-mouse-click and CONTROL-SHIFT-mouse-click: as above except
  * that the changes to the column do not cancel the statuses of columns
  * that are already sorting - giving a way to initiate a compound
  * sort.
  * </ul>
  * <p/>
  * This is a long overdue rewrite of a class of the same name that
  * first appeared in the swing table demos in 1997.
  * 
  * @author Philip Milne
  * @author Brendon McLean 
  * @author Dan van Enckevort
  * @author Parwinder Sekhon
  * @version 2.0 02/27/04
  */
 public final class TableSorter extends AbstractTableModel {
 
     private static final long serialVersionUID = -5572044930561418466L;
     /**
      *
      */
     protected TableModel tableModel;
     /**
      *
      */
     public static final int DESCENDING = -1;
     /**
      *
      */
     public static final int NOT_SORTED = 0;
     /**
      *
      */
     public static final int ASCENDING = 1;
     private static Directive EMPTY_DIRECTIVE = new Directive(-1, NOT_SORTED);
     /**
      *
      */
     public static final Comparator<Comparable<Object>> COMPARABLE_COMPARATOR = new Comparator<Comparable<Object>>() {
 
         @Override
         public int compare(Comparable<Object> o1, Comparable<Object> o2) {
             return o1.compareTo(o2);
         }
     };
     /**
      *
      */
     public static final Comparator<Comparable<Object>> LEXICAL_COMPARATOR = new Comparator<Comparable<Object>>() {
 
         @Override
         public int compare(Comparable<Object> o1, Comparable<Object> o2) {
             return o1.toString().compareTo(o2.toString());
         }
     };
     private Row[] viewToModel;
     private int[] modelToView;
     private JTableHeader tableHeader;
     private MouseListener mouseListener;
     private TableModelListener tableModelListener;
     private Map<Class<?>, Comparator<?>> columnComparators = new HashMap<Class<?>, Comparator<?>>();
     private List<Directive> sortingColumns = new ArrayList<Directive>();
 
     /**
      *
      */
     public TableSorter() {
         this.mouseListener = new MouseHandler();
         this.tableModelListener = new TableModelHandler();
     }
 
     /**
      *
      * @param tableModel
      */
     public TableSorter(TableModel tableModel) {
         this();
         setTableModel(tableModel);
     }
 
     /**
      *
      * @param tableModel
      * @param tableHeader
      */
     public TableSorter(TableModel tableModel, JTableHeader tableHeader) {
         this();
         setTableHeader(tableHeader);
         setTableModel(tableModel);
     }
 
     private void clearSortingState() {
         viewToModel = null;
         modelToView = null;
     }
 
     /**
      *
      * @return
      */
     public TableModel getTableModel() {
         return tableModel;
     }
 
     /**
      *
      * @param tableModel
      */
     public void setTableModel(TableModel tableModel) {
         if (this.tableModel != null) {
             this.tableModel.removeTableModelListener(tableModelListener);
         }
 
         this.tableModel = tableModel;
         if (this.tableModel != null) {
             this.tableModel.addTableModelListener(tableModelListener);
         }
 
         clearSortingState();
         fireTableStructureChanged();
     }
 
     /**
      *
      * @return
      */
     public JTableHeader getTableHeader() {
         return tableHeader;
     }
 
     /**
      *
      * @param tableHeader
      */
     public void setTableHeader(JTableHeader tableHeader) {
         if (this.tableHeader != null) {
             this.tableHeader.removeMouseListener(mouseListener);
             TableCellRenderer defaultRenderer = this.tableHeader.getDefaultRenderer();
             if (defaultRenderer instanceof SortableHeaderRenderer) {
                 this.tableHeader.setDefaultRenderer(((SortableHeaderRenderer) defaultRenderer).tableCellRenderer);
             }
         }
         this.tableHeader = tableHeader;
         if (this.tableHeader != null) {
             this.tableHeader.addMouseListener(mouseListener);
             this.tableHeader.setDefaultRenderer(
                     new SortableHeaderRenderer(this.tableHeader.getDefaultRenderer()));
         }
     }
 
     /**
      *
      * @return
      */
     public boolean isSorting() {
         return !sortingColumns.isEmpty();
     }
 
     private Directive getDirective(int column) {
         for (int i = 0; i < sortingColumns.size(); i++) {
             Directive directive = (Directive) sortingColumns.get(i);
             if (directive.column == column) {
                 return directive;
             }
         }
         return EMPTY_DIRECTIVE;
     }
 
     /**
      *
      * @param column
      * @return
      */
     public int getSortingStatus(int column) {
         return getDirective(column).direction;
     }
 
     private void sortingStatusChanged() {
         clearSortingState();
         fireTableDataChanged();
         if (tableHeader != null) {
             tableHeader.repaint();
         }
     }
 
     /**
      *
      * @param column
      * @param status
      */
     public void setSortingStatus(int column, int status) {
         Directive directive = getDirective(column);
         if (directive != EMPTY_DIRECTIVE) {
             sortingColumns.remove(directive);
         }
         if (status != NOT_SORTED) {
             sortingColumns.add(new Directive(column, status));
         }
         sortingStatusChanged();
     }
 
     /**
      *
      * @param column
      * @param size
      * @return
      */
     protected Icon getHeaderRendererIcon(int column, int size) {
         Directive directive = getDirective(column);
         if (directive == EMPTY_DIRECTIVE) {
             return null;
         }
         return new Arrow(directive.direction == DESCENDING, size, sortingColumns.indexOf(directive));
     }
 
     private void cancelSorting() {
         sortingColumns.clear();
         sortingStatusChanged();
     }
 
     /**
      *
      * @param type
      * @param comparator
      */
     public void setColumnComparator(Class<?> type, Comparator<?> comparator) {
         if (comparator == null) {
             columnComparators.remove(type);
         } else {
             columnComparators.put(type, comparator);
         }
     }
 
     /**
      *
      * @param column
      * @return
      */
     @SuppressWarnings("unchecked")
     protected Comparator<Comparable<Object>> getComparator(int column) {
         Class<?> columnType = tableModel.getColumnClass(column);
         Comparator<Comparable<Object>> comparator = (Comparator<Comparable<Object>>) columnComparators.get(columnType);
         if (comparator != null) {
             return comparator;
         }
         if (Comparable.class.isAssignableFrom(columnType)) {
             return COMPARABLE_COMPARATOR;
         }
         return LEXICAL_COMPARATOR;
     }
 
     private Row[] getViewToModel() {
         if (viewToModel == null) {
             int tableModelRowCount = tableModel.getRowCount();
             viewToModel = new Row[tableModelRowCount];
             for (int row = 0; row < tableModelRowCount; row++) {
                 viewToModel[row] = new Row(row);
             }
 
             if (isSorting()) {
                 Arrays.sort(viewToModel);
             }
         }
         return viewToModel;
     }
 
     /**
      *
      * @param viewIndex
      * @return
      */
     public int modelIndex(int viewIndex) {
         return getViewToModel()[viewIndex].modelIndex;
     }
 
     private int[] getModelToView() {
         if (modelToView == null) {
             int n = getViewToModel().length;
             modelToView = new int[n];
             for (int i = 0; i < n; i++) {
                 modelToView[modelIndex(i)] = i;
             }
         }
         return modelToView;
     }
 
     // TableModel interface methods 
     @Override
     public int getRowCount() {
         return (tableModel == null) ? 0 : tableModel.getRowCount();
     }
 
     @Override
     public int getColumnCount() {
         return (tableModel == null) ? 0 : tableModel.getColumnCount();
     }
 
     @Override
     public String getColumnName(int column) {
         return tableModel.getColumnName(column);
     }
 
     @Override
     public Class<?> getColumnClass(int column) {
         return tableModel.getColumnClass(column);
     }
 
     @Override
     public boolean isCellEditable(int row, int column) {
         return tableModel.isCellEditable(modelIndex(row), column);
     }
 
     @Override
     public Object getValueAt(int row, int column) {
         return tableModel.getValueAt(modelIndex(row), column);
     }
 
     @Override
     public void setValueAt(Object aValue, int row, int column) {
         tableModel.setValueAt(aValue, modelIndex(row), column);
     }
 
     // Helper classes
     private class Row implements Comparable<Row> {
 
         private int modelIndex;
 
         public Row(int index) {
             this.modelIndex = index;
         }
 
         @SuppressWarnings("unchecked")
         @Override
         public int compareTo(Row o) {
             int row1 = modelIndex;
             int row2 = o.modelIndex;
 
             for (Iterator<Directive> it = sortingColumns.iterator(); it.hasNext();) {
                 Directive directive = (Directive) it.next();
                 int column = directive.column;
                 Object o1 = tableModel.getValueAt(row1, column);
                 Object o2 = tableModel.getValueAt(row2, column);
 
                 int comparison = 0;
                 // Define null less than everything, except null.
                 if (o1 == null && o2 == null) {
                     comparison = 0;
                 } else if (o1 == null) {
                     comparison = -1;
                 } else if (o2 == null) {
                     comparison = 1;
                 } else {
                     comparison = getComparator(column).compare((Comparable<Object>) o1, (Comparable<Object>) o2);
                 }
                 if (comparison != 0) {
                     return directive.direction == DESCENDING ? -comparison : comparison;
                 }
             }
             return 0;
         }
     }
 
     private class TableModelHandler implements TableModelListener {
 
         @Override
         public void tableChanged(TableModelEvent e) {
             // If we're not sorting by anything, just pass the event along.             
             if (!isSorting()) {
                 clearSortingState();
                 fireTableChanged(e);
                 return;
             }
 
             // If the table structure has changed, cancel the sorting; the             
             // sorting columns may have been either moved or deleted from             
             // the model. 
             if (e.getFirstRow() == TableModelEvent.HEADER_ROW) {
                 cancelSorting();
                 fireTableChanged(e);
                 return;
             }
 
             // We can map a cell event through to the view without widening             
             // when the following conditions apply: 
             // 
             // a) all the changes are on one row (e.getFirstRow() == e.getLastRow()) and, 
             // b) all the changes are in one column (column != TableModelEvent.ALL_COLUMNS) and,
             // c) we are not sorting on that column (getSortingStatus(column) == NOT_SORTED) and, 
             // d) a reverse lookup will not trigger a sort (modelToView != null)
             //
             // Note: INSERT and DELETE events fail this test as they have column == ALL_COLUMNS.
             // 
             // The last check, for (modelToView != null) is to see if modelToView 
             // is already allocated. If we don't do this check; sorting can become 
             // a performance bottleneck for applications where cells  
             // change rapidly in different parts of the table. If cells 
             // change alternately in the sorting column and then outside of             
             // it this class can end up re-sorting on alternate cell updates - 
             // which can be a performance problem for large tables. The last 
             // clause avoids this problem. 
             int column = e.getColumn();
             if (e.getFirstRow() == e.getLastRow()
                     && column != TableModelEvent.ALL_COLUMNS
                     && getSortingStatus(column) == NOT_SORTED
                     && modelToView != null) {
                 int viewIndex = getModelToView()[e.getFirstRow()];
                 fireTableChanged(new TableModelEvent(TableSorter.this,
                         viewIndex, viewIndex,
                         column, e.getType()));
                 return;
             }
 
             // Something has happened to the data that may have invalidated the row order. 
             clearSortingState();
             fireTableDataChanged();
         }
     }
 
     private class MouseHandler extends MouseAdapter {
 
         @Override
         public void mouseClicked(MouseEvent e) {
             JTableHeader h = (JTableHeader) e.getSource();
             TableColumnModel columnModel = h.getColumnModel();
             int viewColumn = columnModel.getColumnIndexAtX(e.getX());
             int column = columnModel.getColumn(viewColumn).getModelIndex();
             if (column != -1) {
                 int status = getSortingStatus(column);
                 if (!e.isControlDown()) {
                     cancelSorting();
                 }
                 // Cycle the sorting states through {NOT_SORTED, ASCENDING, DESCENDING} or 
                 // {NOT_SORTED, DESCENDING, ASCENDING} depending on whether shift is pressed. 
                 status = status + (e.isShiftDown() ? -1 : 1);
                 status = (status + 4) % 3 - 1; // signed mod, returning {-1, 0, 1}
                 setSortingStatus(column, status);
             }
         }
     }
 
     private static class Arrow implements Icon {
 
         private boolean descending;
         private int size;
         private int priority;
 
         public Arrow(boolean descending, int size, int priority) {
             this.descending = descending;
             this.size = size;
             this.priority = priority;
         }
 
         @Override
         public void paintIcon(Component c, Graphics g, int x, int y) {
             Color color = c == null ? Color.GRAY : c.getBackground();
             // In a compound sort, make each succesive triangle 20% 
             // smaller than the previous one. 
             int dx = (int) (size / 2 * Math.pow(0.8, priority));
             int dy = descending ? dx : -dx;
             // Align icon (roughly) with font baseline. 
             y = y + 5 * size / 6 + (descending ? -dy : 0);
             int shift = descending ? 1 : -1;
             g.translate(x, y);
 
             // Right diagonal. 
             g.setColor(color.darker());
             g.drawLine(dx / 2, dy, 0, 0);
             g.drawLine(dx / 2, dy + shift, 0, shift);
 
             // Left diagonal. 
             g.setColor(color.brighter());
             g.drawLine(dx / 2, dy, dx, 0);
             g.drawLine(dx / 2, dy + shift, dx, shift);
 
             // Horizontal line. 
             if (descending) {
                 g.setColor(color.darker().darker());
             } else {
                 g.setColor(color.brighter().brighter());
             }
             g.drawLine(dx, 0, 0, 0);
 
             g.setColor(color);
             g.translate(-x, -y);
         }
 
         @Override
         public int getIconWidth() {
             return size;
         }
 
         @Override
         public int getIconHeight() {
             return size;
         }
     }
 
     private class SortableHeaderRenderer implements TableCellRenderer {
 
         private TableCellRenderer tableCellRenderer;
 
         public SortableHeaderRenderer(TableCellRenderer tableCellRenderer) {
             this.tableCellRenderer = tableCellRenderer;
         }
 
         @Override
         public Component getTableCellRendererComponent(JTable table,
                 Object value,
                 boolean isSelected,
                 boolean hasFocus,
                 int row,
                 int column) {
             Component c = tableCellRenderer.getTableCellRendererComponent(table,
                     value, isSelected, hasFocus, row, column);
             if (c instanceof JLabel) {
                 JLabel l = (JLabel) c;
                 l.setHorizontalTextPosition(JLabel.LEFT);
                 int modelColumn = table.convertColumnIndexToModel(column);
                 l.setIcon(getHeaderRendererIcon(modelColumn, l.getFont().getSize()));
             }
             return c;
         }
     }
 
     private static class Directive {
 
         private int column;
         private int direction;
 
         public Directive(int column, int direction) {
             this.column = column;
             this.direction = direction;
         }
     }
 }

1		/**
2		* Copyright 2008 WebPhotos
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package net.sf.webphotos.gui.util;
17
18		import java.awt.*;
19		import java.awt.event.*;
20		import java.util.*;
21		import java.util.List;
22		import javax.swing.*;
23		import javax.swing.event.TableModelEvent;
24		import javax.swing.event.TableModelListener;
25		import javax.swing.table.*;
26
27		/**
28		* TableSorter is a decorator for TableModels; adding sorting
29		* functionality to a supplied TableModel. TableSorter does
30		* not store or copy the data in its TableModel; instead it maintains
31		* a map from the row indexes of the view to the row indexes of the
32		* model. As requests are made of the sorter (like getValueAt(row, col))
33		* they are passed to the underlying model after the row numbers
34		* have been translated via the internal mapping array. This way,
35		* the TableSorter appears to hold another copy of the table
36		* with the rows in a different order.
37		* <p/>
38		* TableSorter registers itself as a listener to the underlying model,
39		* just as the JTable itself would. Events recieved from the model
40		* are examined, sometimes manipulated (typically widened), and then
41		* passed on to the TableSorter's listeners (typically the JTable).
42		* If a change to the model has invalidated the order of TableSorter's
43		* rows, a note of this is made and the sorter will resort the
44		* rows the next time a value is requested.
45		* <p/>
46		* When the tableHeader property is set, either by using the
47		* setTableHeader() method or the two argument constructor, the
48		* table header may be used as a complete UI for TableSorter.
49		* The default renderer of the tableHeader is decorated with a renderer
50		* that indicates the sorting status of each column. In addition,
51		* a mouse listener is installed with the following behavior:
52		* <ul>
53		* <li>
54		* Mouse-click: Clears the sorting status of all other columns
55		* and advances the sorting status of that column through three
56		* values: {NOT_SORTED, ASCENDING, DESCENDING} (then back to
57		* NOT_SORTED again).
58		* <li>
59		* SHIFT-mouse-click: Clears the sorting status of all other columns
60		* and cycles the sorting status of the column through the same
61		* three values, in the opposite order: {NOT_SORTED, DESCENDING, ASCENDING}.
62		* <li>
63		* CONTROL-mouse-click and CONTROL-SHIFT-mouse-click: as above except
64		* that the changes to the column do not cancel the statuses of columns
65		* that are already sorting - giving a way to initiate a compound
66		* sort.
67		* </ul>
68		* <p/>
69		* This is a long overdue rewrite of a class of the same name that
70		* first appeared in the swing table demos in 1997.
71		*
72		* @author Philip Milne
73		* @author Brendon McLean
74		* @author Dan van Enckevort
75		* @author Parwinder Sekhon
76		* @version 2.0 02/27/04
77		*/
78	0	public final class TableSorter extends AbstractTableModel {
79
80		private static final long serialVersionUID = -5572044930561418466L;
81		/**
82		*
83		*/
84		protected TableModel tableModel;
85		/**
86		*
87		*/
88		public static final int DESCENDING = -1;
89		/**
90		*
91		*/
92		public static final int NOT_SORTED = 0;
93		/**
94		*
95		*/
96		public static final int ASCENDING = 1;
97	0	private static Directive EMPTY_DIRECTIVE = new Directive(-1, NOT_SORTED);
98		/**
99		*
100		*/
101	0	public static final Comparator<Comparable<Object>> COMPARABLE_COMPARATOR = new Comparator<Comparable<Object>>() {
102
103		@Override
104		public int compare(Comparable<Object> o1, Comparable<Object> o2) {
105	0	return o1.compareTo(o2);
106		}
107		};
108		/**
109		*
110		*/
111	0	public static final Comparator<Comparable<Object>> LEXICAL_COMPARATOR = new Comparator<Comparable<Object>>() {
112
113		@Override
114		public int compare(Comparable<Object> o1, Comparable<Object> o2) {
115	0	return o1.toString().compareTo(o2.toString());
116		}
117		};
118		private Row[] viewToModel;
119		private int[] modelToView;
120		private JTableHeader tableHeader;
121		private MouseListener mouseListener;
122		private TableModelListener tableModelListener;
123	0	private Map<Class<?>, Comparator<?>> columnComparators = new HashMap<Class<?>, Comparator<?>>();
124	0	private List<Directive> sortingColumns = new ArrayList<Directive>();
125
126		/**
127		*
128		*/
129	0	public TableSorter() {
130	0	this.mouseListener = new MouseHandler();
131	0	this.tableModelListener = new TableModelHandler();
132	0	}
133
134		/**
135		*
136		* @param tableModel
137		*/
138		public TableSorter(TableModel tableModel) {
139	0	this();
140	0	setTableModel(tableModel);
141	0	}
142
143		/**
144		*
145		* @param tableModel
146		* @param tableHeader
147		*/
148		public TableSorter(TableModel tableModel, JTableHeader tableHeader) {
149	0	this();
150	0	setTableHeader(tableHeader);
151	0	setTableModel(tableModel);
152	0	}
153
154		private void clearSortingState() {
155	0	viewToModel = null;
156	0	modelToView = null;
157	0	}
158
159		/**
160		*
161		* @return
162		*/
163		public TableModel getTableModel() {
164	0	return tableModel;
165		}
166
167		/**
168		*
169		* @param tableModel
170		*/
171		public void setTableModel(TableModel tableModel) {
172	0	if (this.tableModel != null) {
173	0	this.tableModel.removeTableModelListener(tableModelListener);
174		}
175
176	0	this.tableModel = tableModel;
177	0	if (this.tableModel != null) {
178	0	this.tableModel.addTableModelListener(tableModelListener);
179		}
180
181	0	clearSortingState();
182	0	fireTableStructureChanged();
183	0	}
184
185		/**
186		*
187		* @return
188		*/
189		public JTableHeader getTableHeader() {
190	0	return tableHeader;
191		}
192
193		/**
194		*
195		* @param tableHeader
196		*/
197		public void setTableHeader(JTableHeader tableHeader) {
198	0	if (this.tableHeader != null) {
199	0	this.tableHeader.removeMouseListener(mouseListener);
200	0	TableCellRenderer defaultRenderer = this.tableHeader.getDefaultRenderer();
201	0	if (defaultRenderer instanceof SortableHeaderRenderer) {
202	0	this.tableHeader.setDefaultRenderer(((SortableHeaderRenderer) defaultRenderer).tableCellRenderer);
203		}
204		}
205	0	this.tableHeader = tableHeader;
206	0	if (this.tableHeader != null) {
207	0	this.tableHeader.addMouseListener(mouseListener);
208	0	this.tableHeader.setDefaultRenderer(
209		new SortableHeaderRenderer(this.tableHeader.getDefaultRenderer()));
210		}
211	0	}
212
213		/**
214		*
215		* @return
216		*/
217		public boolean isSorting() {
218	0	return !sortingColumns.isEmpty();
219		}
220
221		private Directive getDirective(int column) {
222	0	for (int i = 0; i < sortingColumns.size(); i++) {
223	0	Directive directive = (Directive) sortingColumns.get(i);
224	0	if (directive.column == column) {
225	0	return directive;
226		}
227		}
228	0	return EMPTY_DIRECTIVE;
229		}
230
231		/**
232		*
233		* @param column
234		* @return
235		*/
236		public int getSortingStatus(int column) {
237	0	return getDirective(column).direction;
238		}
239
240		private void sortingStatusChanged() {
241	0	clearSortingState();
242	0	fireTableDataChanged();
243	0	if (tableHeader != null) {
244	0	tableHeader.repaint();
245		}
246	0	}
247
248		/**
249		*
250		* @param column
251		* @param status
252		*/
253		public void setSortingStatus(int column, int status) {
254	0	Directive directive = getDirective(column);
255	0	if (directive != EMPTY_DIRECTIVE) {
256	0	sortingColumns.remove(directive);
257		}
258	0	if (status != NOT_SORTED) {
259	0	sortingColumns.add(new Directive(column, status));
260		}
261	0	sortingStatusChanged();
262	0	}
263
264		/**
265		*
266		* @param column
267		* @param size
268		* @return
269		*/
270		protected Icon getHeaderRendererIcon(int column, int size) {
271	0	Directive directive = getDirective(column);
272	0	if (directive == EMPTY_DIRECTIVE) {
273	0	return null;
274		}
275	0	return new Arrow(directive.direction == DESCENDING, size, sortingColumns.indexOf(directive));
276		}
277
278		private void cancelSorting() {
279	0	sortingColumns.clear();
280	0	sortingStatusChanged();
281	0	}
282
283		/**
284		*
285		* @param type
286		* @param comparator
287		*/
288		public void setColumnComparator(Class<?> type, Comparator<?> comparator) {
289	0	if (comparator == null) {
290	0	columnComparators.remove(type);
291		} else {
292	0	columnComparators.put(type, comparator);
293		}
294	0	}
295
296		/**
297		*
298		* @param column
299		* @return
300		*/
301		@SuppressWarnings("unchecked")
302		protected Comparator<Comparable<Object>> getComparator(int column) {
303	0	Class<?> columnType = tableModel.getColumnClass(column);
304	0	Comparator<Comparable<Object>> comparator = (Comparator<Comparable<Object>>) columnComparators.get(columnType);
305	0	if (comparator != null) {
306	0	return comparator;
307		}
308	0	if (Comparable.class.isAssignableFrom(columnType)) {
309	0	return COMPARABLE_COMPARATOR;
310		}
311	0	return LEXICAL_COMPARATOR;
312		}
313
314		private Row[] getViewToModel() {
315	0	if (viewToModel == null) {
316	0	int tableModelRowCount = tableModel.getRowCount();
317	0	viewToModel = new Row[tableModelRowCount];
318	0	for (int row = 0; row < tableModelRowCount; row++) {
319	0	viewToModel[row] = new Row(row);
320		}
321
322	0	if (isSorting()) {
323	0	Arrays.sort(viewToModel);
324		}
325		}
326	0	return viewToModel;
327		}
328
329		/**
330		*
331		* @param viewIndex
332		* @return
333		*/
334		public int modelIndex(int viewIndex) {
335	0	return getViewToModel()[viewIndex].modelIndex;
336		}
337
338		private int[] getModelToView() {
339	0	if (modelToView == null) {
340	0	int n = getViewToModel().length;
341	0	modelToView = new int[n];
342	0	for (int i = 0; i < n; i++) {
343	0	modelToView[modelIndex(i)] = i;
344		}
345		}
346	0	return modelToView;
347		}
348
349		// TableModel interface methods
350		@Override
351		public int getRowCount() {
352	0	return (tableModel == null) ? 0 : tableModel.getRowCount();
353		}
354
355		@Override
356		public int getColumnCount() {
357	0	return (tableModel == null) ? 0 : tableModel.getColumnCount();
358		}
359
360		@Override
361		public String getColumnName(int column) {
362	0	return tableModel.getColumnName(column);
363		}
364
365		@Override
366		public Class<?> getColumnClass(int column) {
367	0	return tableModel.getColumnClass(column);
368		}
369
370		@Override
371		public boolean isCellEditable(int row, int column) {
372	0	return tableModel.isCellEditable(modelIndex(row), column);
373		}
374
375		@Override
376		public Object getValueAt(int row, int column) {
377	0	return tableModel.getValueAt(modelIndex(row), column);
378		}
379
380		@Override
381		public void setValueAt(Object aValue, int row, int column) {
382	0	tableModel.setValueAt(aValue, modelIndex(row), column);
383	0	}
384
385		// Helper classes
386	0	private class Row implements Comparable<Row> {
387
388		private int modelIndex;
389
390	0	public Row(int index) {
391	0	this.modelIndex = index;
392	0	}
393
394		@SuppressWarnings("unchecked")
395		@Override
396		public int compareTo(Row o) {
397	0	int row1 = modelIndex;
398	0	int row2 = o.modelIndex;
399
400	0	for (Iterator<Directive> it = sortingColumns.iterator(); it.hasNext();) {
401	0	Directive directive = (Directive) it.next();
402	0	int column = directive.column;
403	0	Object o1 = tableModel.getValueAt(row1, column);
404	0	Object o2 = tableModel.getValueAt(row2, column);
405
406	0	int comparison = 0;
407		// Define null less than everything, except null.
408	0	if (o1 == null && o2 == null) {
409	0	comparison = 0;
410	0	} else if (o1 == null) {
411	0	comparison = -1;
412	0	} else if (o2 == null) {
413	0	comparison = 1;
414		} else {
415	0	comparison = getComparator(column).compare((Comparable<Object>) o1, (Comparable<Object>) o2);
416		}
417	0	if (comparison != 0) {
418	0	return directive.direction == DESCENDING ? -comparison : comparison;
419		}
420	0	}
421	0	return 0;
422		}
423		}
424
425	0	private class TableModelHandler implements TableModelListener {
426
427		@Override
428		public void tableChanged(TableModelEvent e) {
429		// If we're not sorting by anything, just pass the event along.
430	0	if (!isSorting()) {
431	0	clearSortingState();
432	0	fireTableChanged(e);
433	0	return;
434		}
435
436		// If the table structure has changed, cancel the sorting; the
437		// sorting columns may have been either moved or deleted from
438		// the model.
439	0	if (e.getFirstRow() == TableModelEvent.HEADER_ROW) {
440	0	cancelSorting();
441	0	fireTableChanged(e);
442	0	return;
443		}
444
445		// We can map a cell event through to the view without widening
446		// when the following conditions apply:
447		//
448		// a) all the changes are on one row (e.getFirstRow() == e.getLastRow()) and,
449		// b) all the changes are in one column (column != TableModelEvent.ALL_COLUMNS) and,
450		// c) we are not sorting on that column (getSortingStatus(column) == NOT_SORTED) and,
451		// d) a reverse lookup will not trigger a sort (modelToView != null)
452		//
453		// Note: INSERT and DELETE events fail this test as they have column == ALL_COLUMNS.
454		//
455		// The last check, for (modelToView != null) is to see if modelToView
456		// is already allocated. If we don't do this check; sorting can become
457		// a performance bottleneck for applications where cells
458		// change rapidly in different parts of the table. If cells
459		// change alternately in the sorting column and then outside of
460		// it this class can end up re-sorting on alternate cell updates -
461		// which can be a performance problem for large tables. The last
462		// clause avoids this problem.
463	0	int column = e.getColumn();
464	0	if (e.getFirstRow() == e.getLastRow()
465		&& column != TableModelEvent.ALL_COLUMNS
466		&& getSortingStatus(column) == NOT_SORTED
467		&& modelToView != null) {
468	0	int viewIndex = getModelToView()[e.getFirstRow()];
469	0	fireTableChanged(new TableModelEvent(TableSorter.this,
470		viewIndex, viewIndex,
471		column, e.getType()));
472	0	return;
473		}
474
475		// Something has happened to the data that may have invalidated the row order.
476	0	clearSortingState();
477	0	fireTableDataChanged();
478	0	}
479		}
480
481	0	private class MouseHandler extends MouseAdapter {
482
483		@Override
484		public void mouseClicked(MouseEvent e) {
485	0	JTableHeader h = (JTableHeader) e.getSource();
486	0	TableColumnModel columnModel = h.getColumnModel();
487	0	int viewColumn = columnModel.getColumnIndexAtX(e.getX());
488	0	int column = columnModel.getColumn(viewColumn).getModelIndex();
489	0	if (column != -1) {
490	0	int status = getSortingStatus(column);
491	0	if (!e.isControlDown()) {
492	0	cancelSorting();
493		}
494		// Cycle the sorting states through {NOT_SORTED, ASCENDING, DESCENDING} or
495		// {NOT_SORTED, DESCENDING, ASCENDING} depending on whether shift is pressed.
496	0	status = status + (e.isShiftDown() ? -1 : 1);
497	0	status = (status + 4) % 3 - 1; // signed mod, returning {-1, 0, 1}
498	0	setSortingStatus(column, status);
499		}
500	0	}
501		}
502
503		private static class Arrow implements Icon {
504
505		private boolean descending;
506		private int size;
507		private int priority;
508
509	0	public Arrow(boolean descending, int size, int priority) {
510	0	this.descending = descending;
511	0	this.size = size;
512	0	this.priority = priority;
513	0	}
514
515		@Override
516		public void paintIcon(Component c, Graphics g, int x, int y) {
517	0	Color color = c == null ? Color.GRAY : c.getBackground();
518		// In a compound sort, make each succesive triangle 20%
519		// smaller than the previous one.
520	0	int dx = (int) (size / 2 * Math.pow(0.8, priority));
521	0	int dy = descending ? dx : -dx;
522		// Align icon (roughly) with font baseline.
523	0	y = y + 5 * size / 6 + (descending ? -dy : 0);
524	0	int shift = descending ? 1 : -1;
525	0	g.translate(x, y);
526
527		// Right diagonal.
528	0	g.setColor(color.darker());
529	0	g.drawLine(dx / 2, dy, 0, 0);
530	0	g.drawLine(dx / 2, dy + shift, 0, shift);
531
532		// Left diagonal.
533	0	g.setColor(color.brighter());
534	0	g.drawLine(dx / 2, dy, dx, 0);
535	0	g.drawLine(dx / 2, dy + shift, dx, shift);
536
537		// Horizontal line.
538	0	if (descending) {
539	0	g.setColor(color.darker().darker());
540		} else {
541	0	g.setColor(color.brighter().brighter());
542		}
543	0	g.drawLine(dx, 0, 0, 0);
544
545	0	g.setColor(color);
546	0	g.translate(-x, -y);
547	0	}
548
549		@Override
550		public int getIconWidth() {
551	0	return size;
552		}
553
554		@Override
555		public int getIconHeight() {
556	0	return size;
557		}
558		}
559
560	0	private class SortableHeaderRenderer implements TableCellRenderer {
561
562		private TableCellRenderer tableCellRenderer;
563
564	0	public SortableHeaderRenderer(TableCellRenderer tableCellRenderer) {
565	0	this.tableCellRenderer = tableCellRenderer;
566	0	}
567
568		@Override
569		public Component getTableCellRendererComponent(JTable table,
570		Object value,
571		boolean isSelected,
572		boolean hasFocus,
573		int row,
574		int column) {
575	0	Component c = tableCellRenderer.getTableCellRendererComponent(table,
576		value, isSelected, hasFocus, row, column);
577	0	if (c instanceof JLabel) {
578	0	JLabel l = (JLabel) c;
579	0	l.setHorizontalTextPosition(JLabel.LEFT);
580	0	int modelColumn = table.convertColumnIndexToModel(column);
581	0	l.setIcon(getHeaderRendererIcon(modelColumn, l.getFont().getSize()));
582		}
583	0	return c;
584		}
585		}
586
587	0	private static class Directive {
588
589		private int column;
590		private int direction;
591
592	0	public Directive(int column, int direction) {
593	0	this.column = column;
594	0	this.direction = direction;
595	0	}
596		}
597		}