com.darwinsys.swingui.ArrayListTableModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of darwinsys-api Show documentation
Ian Darwin's assorted Java stuff, assembled as an API.
There is a newer version: 1.8.0
package com.darwinsys.swingui;

import java.util.List;

import javax.swing.table.AbstractTableModel;

/** JTable model for List of heterogeneous objects.
 * Subclasses must set String columnNames[] and
 * Class columnClasses[], which MUST be in the same order.
 * Subclasses need only implement these AbstractTableModel methods:
 *  * public int getColumnCount() {
 * public Object getValueAt(int row, int col)  {
 * public void setValueAt(Object val, int row, int col)  {
 * 
 */
public abstract class ArrayListTableModel extends AbstractTableModel {

	/** List of column names, must be provided by subclass. */
	protected String columnNames[];
	/** List of column names, must be provided by subclass. */
	protected Class columnClasses[];

	/** The list of Method object */
	protected List methods = null;

	/** for caching. */
	private int ROW_INVALID = -1;
	/** for caching, shared by get/set ValueAt */
	private int prevRow = ROW_INVALID;
	/** for caching, shared by get/set ValueAt */
	private Object current  = null;

	/** Constructor 
 	 * @param m the list of objects
 	 */
	public ArrayListTableModel(List m) {
		methods = m;
	}

	/** Allow the model to load the ArrayList all at once, as when
	 * loading a file.
	 * @param m the list of objects
	 */
	void setListData(List m) {
		methods = m;
		invalidateCache();
	}

	/** Get the name of a given column, from the list provided by subclass
	 * @param n The number of the column to get
	 */
	public String getColumnName(int n) {
		if (columnNames == null)
			throw new IllegalStateException("columnNames not set");
		int max = columnNames.length;
		if (n>=max)
			throw new ArrayIndexOutOfBoundsException(
			"columnNames has " + max + " elements; you asked for " + max);
		return columnNames[n];
	}

	/** Get the class of a given column, from the list provided by subclass
	 * @param n The number of the column to get
	 */
	public Class getColumnClass(int n) {
		if (columnClasses == null)
			throw new IllegalStateException("columnClasses not set");
		int max = columnClasses.length;
		if (n>=max)
			throw new ArrayIndexOutOfBoundsException(
			"columnClasses has " + max + " elements; you asked for " + max);
		return columnClasses[n];
	}

	/** @return the number of objects in the list. */
	public int getRowCount()  {
		return methods.size();
	}

	/** @inheritDoc */
	public boolean isCellEditable(int rowIndex, int columnIndex) {
		return true;
	}

	/** Cache one most-recently-used item. This is a convenience
	 * routine that subclasses are invited but not required to use.
	 * Normal use would be, in get/setValueAt():
	 * 	 *		public void setValueAt(int row, ...) {
	 *			MyDataType current = (MyDataType) getCached(row);
	 *			...
	 *		}
	 * 
	 * @param row The number of the column to get
	 */
	public Object getCached(int row) {
		if (row != prevRow) {
			current = methods.get(row);
			prevRow = row;
		}
		return current;
	}

	/** Invalidate the cache. Called automatically by setListData();
	 * must be called if you otherwise change the ArrayList.
	 */
	public void invalidateCache() {
		prevRow = ROW_INVALID;
	}
}