All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.guise.framework.model.DefaultTableModel Maven / Gradle / Ivy

Go to download

Guise™ Internet application framework.

There is a newer version: 0.5.3
Show newest version
/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * 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 io.guise.framework.model;

import java.util.*;
import static java.util.Collections.*;

import static com.globalmentor.java.Arrays.*;

import com.globalmentor.collections.SynchronizedListDecorator;

/**
 * The default implementation of a table model. The model is thread-safe, synchronized on itself. Any iteration over values should include synchronization on
 * the instance of this class.
 * @author Garret Wilson
 */
public class DefaultTableModel extends AbstractTableModel {

	/** The list of value lists for rows. */
	private final List> valueRowLists;

	@Override
	public int getRowCount() {
		return valueRowLists.size();
	}

	/**
	 * Constructs a default table model indicating the type of values it can hold, using default column models.
	 * @param  The type of values in all the cells in the table.
	 * @param valueClass The class indicating the type of values held in the model.
	 * @param columnNames The names to serve as label headers for the columns.
	 * @throws NullPointerException if the given class object is null.
	 */
	public  DefaultTableModel(final Class valueClass, final String... columnNames) {
		this(valueClass, null, columnNames); //construct the class with no values
	}

	/**
	 * Constructs a default table model indicating the type of values it can hold along with column definitions.
	 * @param columns The models representing the table columns.
	 * @throws NullPointerException if the given class object is null.
	 */
	public DefaultTableModel(final TableColumnModel... columns) {
		this(null, columns); //construct the class with no values
	}

	/**
	 * Constructs a default table model indicating the type of values it can hold and column names.
	 * @param  The type of values in all the cells in the table.
	 * @param valueClass The class indicating the type of values held in the model.
	 * @param rowValues The two-dimensional list of values, where the first index represents the row and the second represents the column, or null if
	 *          no default values should be given.
	 * @param columnNames The names to serve as label headers for the columns.
	 * @throws NullPointerException if the given class object is null.
	 * @throws IllegalArgumentException if the given number of columns does not equal the number of columns in any given data row.
	 */
	public  DefaultTableModel(final Class valueClass, final C[][] rowValues, final String... columnNames) {
		this(rowValues, (TableColumnModel[])createDefaultColumns(valueClass, columnNames)); //create default columns for the column names
	}

	/**
	 * Constructs a default table model indicating the type of values it can hold.
	 * @param rowValues The two-dimensional list of values, where the first index represents the row and the second represents the column, or null if
	 *          no default values should be given.
	 * @param columns The models representing the table columns.
	 * @throws IllegalArgumentException if the given number of columns does not equal the number of columns in any given data row.
	 * @throws ClassCastException if one of the values in a row is not compatible with the type of its column.
	 */
	public DefaultTableModel(final Object[][] rowValues, final TableColumnModel... columns) {
		super(columns); //construct the parent class
		valueRowLists = new SynchronizedListDecorator>(new ArrayList>(), this); //create a list of value lists, synchronizing all access on this object
		if(rowValues != null) { //if table data was given
			synchronized(this) { //synchronize on this object out of consistency (even though it is highly unlikely another thread could have access to our data as the class is not yet constructed)
				for(final Object[] values : rowValues) { //for each row of given data
					if(values.length != columns.length) { //if the number of columns doesn't match the columns of data that were supplied
						throw new IllegalArgumentException("Received " + columns.length + " columns but encountered row with " + values.length + " values.");
					}
					for(int columnIndex = columns.length - 1; columnIndex >= 0; --columnIndex) { //for each column, make sure the given value is of an allowed type
						columns[columnIndex].getValueClass().cast(values[columnIndex]); //make sure this value can be cast to the column type
					}
					final List valueList = new SynchronizedListDecorator(new ArrayList(values.length), this); //create a list of value, synchronizing all access on this object
					addAll(valueList, values); //add all this row's values to the list
					valueRowLists.add(valueList); //add this row to the list of row lists
				}
			}
		}
	}

	/**
	 * Creates default columns with the given column names.
	 * @param  The type of values contained in the columns.
	 * @param valueClass The class representing the values contained in the columns.
	 * @param columnNames The names to serve as label headers for the columns.
	 * @return An array of default columns.
	 */
	@SuppressWarnings("unchecked")
	//as generics are only one-deep for class objects, we must cast the generic type of the default table column model class
	public static  TableColumnModel[] createDefaultColumns(final Class valueClass, final String... columnNames) {
		final DefaultTableColumnModel[] columns = createArray((Class>)(Object)DefaultTableColumnModel.class, columnNames.length); //create an array of default table columns TODO find out why we need the double-cast
		for(int i = columns.length - 1; i >= 0; --i) { //for each column
			final DefaultTableColumnModel column = new DefaultTableColumnModel(valueClass); //create a new default table column
			column.setLabel(columnNames[i]); //set the column label
			columns[i] = column; //store the column
		}
		return columns; //return the columns we created
	}

	@Override
	public  C getCellValue(final int rowIndex, final TableColumnModel column) {
		final int columnIndex = getColumnIndex(column); //get the index of this column
		if(columnIndex < 0) { //if this column isn't in this table
			throw new IllegalArgumentException("Table column " + column + " not in table.");
		}
		synchronized(this) { //don't allow others to change the table data while we access the values
			return column.getValueClass().cast(valueRowLists.get(rowIndex).get(columnIndex)); //get the value in the given row and column, cast to the appropriate type
		}
	}

	@Override
	public  void setCellValue(final int rowIndex, final TableColumnModel column, final C newCellValue) {
		final int columnIndex = getColumnIndex(column); //get the index of this column
		if(columnIndex < 0) { //if this column isn't in this table
			throw new IllegalArgumentException("Table column " + column + " not in table.");
		}
		synchronized(this) { //don't allow others to change the table data while we access the values
			valueRowLists.get(rowIndex).set(columnIndex, newCellValue); //set the value in the given row and column
		}
	}

}
    

    

    
            
    
            







    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy