/*
* codjo.net
*
* Common Apache License 2.0
*/
package net.codjo.utils;
import java.awt.Component;
import java.awt.Toolkit;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.Date;
import java.util.Vector;
import javax.swing.ImageIcon;
import javax.swing.JLabel;
import javax.swing.JTable;
import javax.swing.SwingConstants;
import javax.swing.event.TableModelEvent;
import javax.swing.table.JTableHeader;
import javax.swing.table.TableCellRenderer;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import javax.swing.table.TableModel;
/**
* Overview.
*
* @author $Author: marcona $
* @version $Revision: 1.4 $
*
*/
public class TableSorter extends TableMap implements TableCellRenderer {
int[] indexes;
Vector sortingColumns = new Vector();
boolean ascending = true;
int columnSorted;
int compares;
//-----------------------------------------------------------
//-----------------------------------------------------------
//------------------------------------- CustomHeaderRenderer
//-----------------------------------------------------------
//-----------------------------------------------------------
JLabel Renderer;
ImageIcon AscendingIcon;
ImageIcon DescendingIcon;
/**
* Constructor for the TableSorter object
*/
public TableSorter() {
indexes = new int[0];
// For consistency.
initCustomHeaderRenderer();
}
/**
* Constructor for the TableSorter object
*
* @param model Description of Parameter
*/
public TableSorter(TableModel model) {
setModel(model);
initCustomHeaderRenderer();
}
/**
* Sets the Model attribute of the TableSorter object
*
* @param model The new Model value
*/
public void setModel(TableModel model) {
super.setModel(model);
reallocateIndexes();
}
/**
* Sets the ValueAt attribute of the TableSorter object
*
* @param aValue The new ValueAt value
* @param aRow The new ValueAt value
* @param aColumn The new ValueAt value
*/
public void setValueAt(Object aValue, int aRow, int aColumn) {
checkModel();
model.setValueAt(aValue, indexes[aRow], aColumn);
}
/**
* Converti l'index tri� en index du model origine.
*
* @param row l'index trie.
*
* @return l'index converti du model origine.
*/
public int getConvertedIndex(int row) {
return indexes[row];
}
// The mapping only affects the contents of the data rows.
// Pass all requests to these rows through the mapping array: "indexes".
/**
* Gets the ValueAt attribute of the TableSorter object
*
* @param aRow Description of Parameter
* @param aColumn Description of Parameter
*
* @return The ValueAt value
*/
public Object getValueAt(int aRow, int aColumn) {
checkModel();
return model.getValueAt(indexes[aRow], aColumn);
}
/**
* Gets the TableCellRendererComponent attribute of the TableSorter object
*
* @param Table Description of Parameter
* @param Value Description of Parameter
* @param Selected Description of Parameter
* @param HasFocus Description of Parameter
* @param Row Description of Parameter
* @param Col Description of Parameter
*
* @return The TableCellRendererComponent value
*/
public Component getTableCellRendererComponent(JTable Table, Object Value,
boolean Selected, boolean HasFocus, int Row, int Col) {
// Assign the column's name
Renderer.setText(Value.toString());
if (Table.convertColumnIndexToModel(Col) == columnSorted) {
Renderer.setIcon(ascending ? AscendingIcon : DescendingIcon);
}
else {
Renderer.setIcon(null);
}
return Renderer;
}
/**
* Overview.
*
* @param row1 Description of Parameter
* @param row2 Description of Parameter
* @param column Description of Parameter
*
* @return Description of the Returned Value
*/
public int compareRowsByColumn(int row1, int row2, int column) {
Class type = model.getColumnClass(column);
TableModel data = model;
// Check for nulls
Object o1 = data.getValueAt(row1, column);
Object o2 = data.getValueAt(row2, column);
// If both values are null return 0
if (o1 == null && o2 == null) {
return 0;
}
else if (o1 == null) {
// Define null less than everything.
return -1;
}
else if (o2 == null) {
return 1;
}
/*
* We copy all returned values from the getValue call in case
* an optimised model is reusing one object to return many values.
* The Number subclasses in the JDK are immutable and so will not be used in
* this way but other subclasses of Number might want to do this to save
* space and avoid unnecessary heap allocation.
*/
if (type.getSuperclass() == java.lang.Number.class) {
Number n1 = (Number)data.getValueAt(row1, column);
double d1 = n1.doubleValue();
Number n2 = (Number)data.getValueAt(row2, column);
double d2 = n2.doubleValue();
if (d1 < d2) {
return -1;
}
else if (d1 > d2) {
return 1;
}
else {
return 0;
}
}
else if (type == java.util.Date.class) {
Date d1 = (Date)data.getValueAt(row1, column);
long n1 = d1.getTime();
Date d2 = (Date)data.getValueAt(row2, column);
long n2 = d2.getTime();
if (n1 < n2) {
return -1;
}
else if (n1 > n2) {
return 1;
}
else {
return 0;
}
}
else if (type == String.class) {
String s1 = (String)data.getValueAt(row1, column);
String s2 = (String)data.getValueAt(row2, column);
int result = s1.compareTo(s2);
if (result < 0) {
return -1;
}
else if (result > 0) {
return 1;
}
else {
return 0;
}
}
else if (type == Boolean.class) {
Boolean bool1 = (Boolean)data.getValueAt(row1, column);
boolean b1 = bool1.booleanValue();
Boolean bool2 = (Boolean)data.getValueAt(row2, column);
boolean b2 = bool2.booleanValue();
if (b1 == b2) {
return 0;
}
else if (b1) {
// Define false < true
return 1;
}
else {
return -1;
}
}
else {
Object v1 = data.getValueAt(row1, column);
String s1 = v1.toString();
Object v2 = data.getValueAt(row2, column);
String s2 = v2.toString();
int result = s1.compareTo(s2);
if (result < 0) {
return -1;
}
else if (result > 0) {
return 1;
}
else {
return 0;
}
}
}
/**
* Overview.
*
* @param row1 Description of Parameter
* @param row2 Description of Parameter
*
* @return Description of the Returned Value
*/
public int compare(int row1, int row2) {
compares++;
for (int level = 0; level < sortingColumns.size(); level++) {
Integer column = (Integer)sortingColumns.elementAt(level);
int result = compareRowsByColumn(row1, row2, column.intValue());
if (result != 0) {
return ascending ? result : -result;
}
}
return 0;
}
/**
* Overview.
*/
public void reallocateIndexes() {
int rowCount = model.getRowCount();
// Set up a new array of indexes with the right number of elements
// for the new data model.
indexes = new int[rowCount];
// Initialise with the identity mapping.
for (int row = 0; row < rowCount; row++) {
indexes[row] = row;
}
checkModel();
}
/**
* Overview.
*
* @param evt Description of Parameter
*/
public void tableChanged(TableModelEvent evt) {
reallocateIndexes();
super.tableChanged(evt);
}
/**
* Overview.
*/
public void checkModel() {
if (indexes.length != model.getRowCount()) {
System.err.println("Sorter not informed of a change in model. : "
+ indexes.length + " != " + model.getRowCount());
}
}
/**
* Overview.
*
* @param sender Description of Parameter
*/
public void sort(Object sender) {
checkModel();
compares = 0;
// n2sort();
// qsort(0, indexes.length-1);
shuttlesort((int[])indexes.clone(), indexes, 0, indexes.length);
}
/**
* Overview.
*/
public void n2sort() {
for (int i = 0; i < getRowCount(); i++) {
for (int j = i + 1; j < getRowCount(); j++) {
if (compare(indexes[i], indexes[j]) == -1) {
swap(i, j);
}
}
}
}
// This is a home-grown implementation which we have not had time
// to research - it may perform poorly in some circumstances. It
// requires twice the space of an in-place algorithm and makes
// NlogN assigments shuttling the values between the two
// arrays. The number of compares appears to vary between N-1 and
// NlogN depending on the initial order but the main reason for
// using it here is that, unlike qsort, it is stable.
/**
* Overview.
*
* @param from Description of Parameter
* @param to Description of Parameter
* @param low Description of Parameter
* @param high Description of Parameter
*/
public void shuttlesort(int[] from, int[] to, int low, int high) {
if (high - low < 2) {
return;
}
int middle = (low + high) / 2;
shuttlesort(to, from, low, middle);
shuttlesort(to, from, middle, high);
int p = low;
int q = middle;
/*
* This is an optional short-cut; at each recursive call,
* check to see if the elements in this subset are already
* ordered. If so, no further comparisons are needed; the
* sub-array can just be copied. The array must be copied rather
* than assigned otherwise sister calls in the recursion might
* get out of sinc. When the number of elements is three they
* are partitioned so that the first set, [low, mid), has one
* element and and the second, [mid, high), has two. We skip the
* optimisation when the number of elements is three or less as
* the first compare in the normal merge will produce the same
* sequence of steps. This optimisation seems to be worthwhile
* for partially ordered lists but some analysis is needed to
* find out how the performance drops to Nlog(N) as the initial
* order diminishes - it may drop very quickly.
*/
if (high - low >= 4 && compare(from[middle - 1], from[middle]) <= 0) {
for (int i = low; i < high; i++) {
to[i] = from[i];
}
return;
}
// A normal merge.
for (int i = low; i < high; i++) {
if (q >= high || (p < middle && compare(from[p], from[q]) <= 0)) {
to[i] = from[p++];
}
else {
to[i] = from[q++];
}
}
}
/**
* Overview.
*
* @param i Description of Parameter
* @param j Description of Parameter
*/
public void swap(int i, int j) {
int tmp = indexes[i];
indexes[i] = indexes[j];
indexes[j] = tmp;
}
/**
* Overview.
*
* @param column Description of Parameter
*/
public void sortByColumn(int column) {
// sortByColumn(column, true);
sortByColumn(column, !ascending);
}
/**
* Overview.
*
* @param column Description of Parameter
* @param ascending Description of Parameter
*/
public void sortByColumn(int column, boolean ascending) {
this.ascending = ascending;
columnSorted = column;
sortingColumns.removeAllElements();
sortingColumns.addElement(new Integer(column));
sort(this);
super.tableChanged(new TableModelEvent(this));
}
// There is no-where else to put this.
// Add a mouse listener to the Table to trigger a table sort
// when a column heading is clicked in the JTable.
/**
* Adds a feature to the MouseListenerToHeaderInTable attribute of the TableSorter
* object
*
* @param table The feature to be added to the MouseListenerToHeaderInTable attribute
*/
public void addMouseListenerToHeaderInTable(JTable table) {
final TableSorter sorter = this;
final JTable tableView = table;
tableView.setColumnSelectionAllowed(false);
MouseAdapter listMouseListener =
new MouseAdapter() {
/**
* Overview.
*
* @param e Description of Parameter
*/
public void mousePressed(MouseEvent e) {
TableColumnModel columnModel = tableView.getColumnModel();
int viewColumn = columnModel.getColumnIndexAtX(e.getX());
int column = tableView.convertColumnIndexToModel(viewColumn);
if (e.getClickCount() > 1 && column != -1) {
//int shiftPressed = e.getModifiers()&InputEvent.SHIFT_MASK;
//boolean ascending = (shiftPressed == 0);
sorter.sortByColumn(column);
//, ascending);
//tableView.repaint();
}
}
};
// Add the mouse listener
JTableHeader th = tableView.getTableHeader();
th.addMouseListener(listMouseListener);
}
/**
* Overview.
*
* @param table Description of Parameter
*/
public void changeHeaderRenderer(JTable table) {
columnSorted = -1;
TableColumn aCol;
int nbColumn = getColumnCount();
for (int i = 0; i < nbColumn; i++) {
aCol = table.getColumn(getColumnName(i));
aCol.setHeaderRenderer(this);
}
}
/**
* Overview.
*/
private final void initCustomHeaderRenderer() {
// -----------------------------------------------------
// 1. Load the images that represent the widget
java.net.URL url;
// 1.1 Load AscendingIcon
url = getClass().getResource("Ascending.gif");
if (url != null) {
AscendingIcon = new ImageIcon(Toolkit.getDefaultToolkit().createImage(url));
//new ImageIcon(Toolkit.getDefaultToolkit().getImage(url));
}
else {
AscendingIcon = null;
}
// 1.2 Load DescendingIcon
url = getClass().getResource("Descending.gif");
if (url != null) {
DescendingIcon = new ImageIcon(Toolkit.getDefaultToolkit().createImage(url));
// new ImageIcon(Toolkit.getDefaultToolkit().getImage(url));
}
else {
DescendingIcon = null;
}
// -----------------------------------------------------
// 2. Set up the Renderer
Renderer = new JLabel();
Renderer.setOpaque(true);
Renderer.setHorizontalAlignment(SwingConstants.CENTER);
Renderer.setHorizontalTextPosition(SwingConstants.RIGHT);
Renderer.setVerticalTextPosition(SwingConstants.CENTER);
Renderer.setBorder(new javax.swing.border.EtchedBorder(
javax.swing.border.EtchedBorder.LOWERED));
}
}