1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
/* * @(#)TableRowSorter.java 1.8 06/03/31 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.table; import java.text.Collator; import java.util.*; import javax.swing.DefaultRowSorter; import javax.swing.RowFilter; import javax.swing.SortOrder; /** * An implementation of <code>RowSorter</code> that provides sorting * and filtering using a <code>TableModel</code>. * The following example shows adding sorting to a <code>JTable</code>: * <pre> * TableModel myModel = createMyTableModel(); * JTable table = new JTable(myModel); * table.setRowSorter(new TableRowSorter(myModel)); * </pre> * This will do all the wiring such that when the user does the appropriate * gesture, such as clicking on the column header, the table will * visually sort. * <p> * <code>JTable</code>'s row-based methods and <code>JTable</code>'s * selection model refer to the view and not the underlying * model. Therefore, it is necessary to convert between the two. For * example, to get the selection in terms of <code>myModel</code> * you need to convert the indices: * <pre> * int[] selection = table.getSelectedRows(); * for (int i = 0; i < selection.length; i++) { * selection[i] = table.convertRowIndexToModel(selection[i]); * } * </pre> * Similarly to select a row in <code>JTable</code> based on * a coordinate from the underlying model do the inverse: * <pre> * table.setRowSelectionInterval(table.convertRowIndexToView(row), * table.convertRowIndexToView(row)); * </pre> * <p> * The previous example assumes you have not enabled filtering. If you * have enabled filtering <code>convertRowIndexToView</code> will return * -1 for locations that are not visible in the view. * <p> * <code>TableRowSorter</code> uses <code>Comparator</code>s for doing * comparisons. The following defines how a <code>Comparator</code> is * chosen for a column: * <ol> * <li>If a <code>Comparator</code> has been specified for the column by the * <code>setComparator</code> method, use it. * <li>If the column class as returned by <code>getColumnClass</code> is * <code>String</code>, use the <code>Comparator</code> returned by * <code>Collator.getInstance()</code>. * <li>If the column class implements <code>Comparable</code>, use a * <code>Comparator</code> that invokes the <code>compareTo</code> * method. * <li>If a <code>TableStringConverter</code> has been specified, use it * to convert the values to <code>String</code>s and then use the * <code>Comparator</code> returned by <code>Collator.getInstance()</code>. * <li>Otherwise use the <code>Comparator</code> returned by * <code>Collator.getInstance()</code> on the results from * calling <code>toString</code> on the objects. * </ol> * <p> * In addition to sorting <code>TableRowSorter</code> provides the ability * to filter. A filter is specified using the <code>setFilter</code> * method. The following example will only show rows containing the string * "foo": * <pre> * TableModel myModel = createMyTableModel(); * TableRowSorter sorter = new TableRowSorter(myModel); * sorter.setRowFilter(RowFilter.regexFilter(".*foo.*")); * JTable table = new JTable(myModel); * table.setRowSorter(sorter); * </pre> * <p> * If the underlying model structure changes (the * <code>modelStructureChanged</code> method is invoked) the following * are reset to their default values: <code>Comparator</code>s by * column, current sort order, and whether each column is sortable. The default * sort order is natural (the same as the model), and columns are * sortable by default. * <p> * <code>TableRowSorter</code> has one formal type parameter: the type * of the model. Passing in a type that corresponds exactly to your * model allows you to filter based on your model without casting. * Refer to the documentation of <code>RowFilter</code> for an example * of this. * <p> * <b>WARNING:</b> <code>DefaultTableModel</code> returns a column * class of <code>Object</code>. As such all comparisons will * be done using <code>toString</code>. This may be unnecessarily * expensive. If the column only contains one type of value, such as * an <code>Integer</code>, you should override <code>getColumnClass</code> and * return the appropriate <code>Class</code>. This will dramatically * increase the performance of this class. * * @param <M> the type of the model, which must be an implementation of * <code>TableModel</code> * @version 1.8 03/31/06 * @see javax.swing.JTable * @see javax.swing.RowFilter * @see javax.swing.table.DefaultTableModel * @see java.text.Collator * @see java.util.Comparator * @since 1.6 */ public class TableRowSorter<M extends TableModel> extends DefaultRowSorter<M, Integer> { /** * Comparator that uses compareTo on the contents. */ private static final Comparator COMPARABLE_COMPARATOR = new ComparableComparator(); /** * Underlying model. */ private M tableModel; /** * For toString conversions. */ private TableStringConverter stringConverter; /** * Creates a <code>TableRowSorter</code> with an empty model. */ public TableRowSorter() { this(null); } /** * Creates a <code>TableRowSorter</code> using <code>model</code> * as the underlying <code>TableModel</code>. * * @param model the underlying <code>TableModel</code> to use, * <code>null</code> is treated as an empty model */ public TableRowSorter(M model) { setModel(model); } /** * Sets the <code>TableModel</code> to use as the underlying model * for this <code>TableRowSorter</code>. A value of <code>null</code> * can be used to set an empty model. * * @param model the underlying model to use, or <code>null</code> */ public void setModel(M model) { tableModel = model; setModelWrapper(new TableRowSorterModelWrapper()); } /** * Sets the object responsible for converting values from the * model to strings. If non-<code>null</code> this * is used to convert any object values, that do not have a * registered <code>Comparator</code>, to strings. * * @param stringConverter the object responsible for converting values * from the model to strings */ public void setStringConverter(TableStringConverter stringConverter) { this.stringConverter = stringConverter; } /** * Returns the object responsible for converting values from the * model to strings. * * @return object responsible for converting values to strings. */ public TableStringConverter getStringConverter() { return stringConverter; } /** * Returns the <code>Comparator</code> for the specified * column. If a <code>Comparator</code> has not been specified using * the <code>setComparator</code> method a <code>Comparator</code> * will be returned based on the column class * (<code>TableModel.getColumnClass</code>) of the specified column. * If the column class is <code>String</code>, * <code>Collator.getInstance</code> is returned. If the * column class implements <code>Comparable</code> a private * <code>Comparator</code> is returned that invokes the * <code>compareTo</code> method. Otherwise * <code>Collator.getInstance</code> is returned. * * @throws IndexOutOfBoundsException {@inheritDoc} */ public Comparator<?> getComparator(int column) { Comparator comparator = super.getComparator(column); if (comparator != null) { return comparator; } Class columnClass = getModel().getColumnClass(column); if (columnClass == String.class) { return Collator.getInstance(); } if (Comparable.class.isAssignableFrom(columnClass)) { return COMPARABLE_COMPARATOR; } return Collator.getInstance(); } /** * {@inheritDoc} * * @throws IndexOutOfBoundsException {@inheritDoc} */ protected boolean useToString(int column) { Comparator comparator = super.getComparator(column); if (comparator != null) { return false; } Class columnClass = getModel().getColumnClass(column); if (columnClass == String.class) { return false; } if (Comparable.class.isAssignableFrom(columnClass)) { return false; } return true; } /** * Implementation of DefaultRowSorter.ModelWrapper that delegates to a * TableModel. */ private class TableRowSorterModelWrapper extends ModelWrapper<M,Integer> { public M getModel() { return tableModel; } public int getColumnCount() { return (tableModel == null) ? 0 : tableModel.getColumnCount(); } public int getRowCount() { return (tableModel == null) ? 0 : tableModel.getRowCount(); } public Object getValueAt(int row, int column) { return tableModel.getValueAt(row, column); } public String getStringValueAt(int row, int column) { TableStringConverter converter = getStringConverter(); if (converter != null) { // Use the converter String value = converter.toString( tableModel, row, column); if (value != null) { return value; } return ""; } // No converter, use getValueAt followed by toString Object o = getValueAt(row, column); if (o == null) { return ""; } String string = o.toString(); if (string == null) { return ""; } return string; } public Integer getIdentifier(int index) { return index; } } private static class ComparableComparator implements Comparator { @SuppressWarnings(__JOT_PIECE_24__) public int compare(Object o1, Object o2) { return ((Comparable)o1).compareTo(o2); } } }