ExtensibleTableModel.java

/***********************************************************************
 *
 * $CVSHeader$
 *
 * This file is part of WebScarab, an Open Web Application Security
 * Project utility. For details, please see http://www.owasp.org/
 *
 * Copyright (c) 2002 - 2004 Rogan Dawes
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Getting Source
 * ==============
 *
 * Source for this application is maintained at Sourceforge.net, a
 * repository for free software projects.
 * 
 * For details, please see http://www.sourceforge.net/projects/owasp
 *
 */

/*
 * ExtensibleTableModel.java
 *
 * Created on September 24, 2004, 8:10 AM
 */

package org.owasp.webscarab.util.swing;

import javax.swing.table.AbstractTableModel;

import java.util.List;
import java.util.ArrayList;

/**
 *
 * @author  knoppix
 */
public abstract class ExtensibleTableModel<T> extends AbstractTableModel {
    
    /**
	 * 
	 */
	private static final long serialVersionUID = -2783690695443856742L;
	private List<ColumnDataModel<T>> _columns = new ArrayList<ColumnDataModel<T>>();
    private ColumnDataListener<T> _columnListener;
    
    /** Creates a new instance of ExtensibleTableModel */
    public ExtensibleTableModel() {
        _columnListener = new ColumnDataListener<T>() {
            public void dataChanged(ColumnDataEvent<T> cde) {
                Object column = cde.getSource();
                int col = _columns.indexOf(column);
                if (col < 0) return;
                T key = cde.getKey();
                if (key == null) {
                    fireTableStructureChanged();
                } else {
                    int row = indexOfKey(key);
                    if (row > -1) {
                        fireTableCellUpdated(row, col);
                    }
                }
            }
        };
    }
    
    public abstract int getRowCount();
    
    public abstract T getKeyAt(int row);
    
    public abstract int indexOfKey(T key);
    
    public void addColumn(ColumnDataModel<T> column) {
        _columns.add(column);
        column.addColumnDataListener(_columnListener);
        fireTableStructureChanged();
    }
    
    public void removeColumn(ColumnDataModel<T> column) {
        int index = _columns.indexOf(column);
        if (index < 0) return;
        column.removeColumnDataListener(_columnListener);
        _columns.remove(index);
        fireTableStructureChanged();
    }
    
    public int getColumnCount() {
        return _columns.size();
    }
    
    /**
     * Returns the name of the column at <code>columnIndex</code>.  This is used
     * to initialize the table's column header name.  Note: this name does
     * not need to be unique; two columns in a table can have the same name.
     *
     * @param	column	the index of the column
     * @return  the name of the column
     */
    public String getColumnName(int column) {
        return _columns.get(column).getColumnName();
    }
    
    /**
     * Returns the most specific superclass for all the cell values
     * in the column.  This is used by the <code>JTable</code> to set up a
     * default renderer and editor for the column.
     *
     * @param column  the index of the column
     * @return the common ancestor class of the object values in the model.
     */
    public Class<?> getColumnClass(int column) {
        return _columns.get(column).getColumnClass();
    }
    
    protected Object getValueAt(T key, int column) {
        return _columns.get(column).getValue(key);
    }
    
    public Object getValueAt(int row, int column) {
        T key = getKeyAt(row);
        return getValueAt(key, column);
    }
    
    protected boolean isCellEditable(T key, int column) {
    	return _columns.get(column).isEditable(key);
    }
    
    public boolean isCellEditable(int row, int column) {
        T key = getKeyAt(row);
        return isCellEditable(key, column);
    }
    
    protected void setValueAt(Object aValue, T key, int column) {
        _columns.get(column).setValue(aValue, key);
    }
    
    public void setValueAt(Object aValue, int row, int column) {
        T key = getKeyAt(row);
        setValueAt(aValue, key, column);
    }
    
}