net.sf.kdgcommons.util

Class DataTable

java.lang.Object

net.sf.kdgcommons.util.DataTable

public class DataTable
extends Object

This class maintains data in a tabular form: rows and columns, with a name for each column. It's useful for returning results from a JDBC query, or as a model for a JTable.

Note for JDBC: column indexes in DataTable are numbered from 0, not 1.

Constructor Summary

Constructors

Constructor and Description
DataTable(String[] colNames) Convenience constructor that just takes column names, creates an empty table that doesn't check data class.
DataTable(String[] colNames, Class<?>[] colClasses, Object[][] data) Base constructor.

Method Summary

Modifier and Type	Method and Description
void	addRow() Adds a new empty row to the end of the table.
void	addRow(Object[] rowData) Adds a new row to the end of the table, with specified data.
Class<?>	getColumnClass(int col) Returns the class of a column, null if the column can hold values of any class.
int	getColumnCount() Returns the number of columns in this table.
String	getColumnName(int col) Returns the name of a column.
Object	getValue(int row, int col) Returns the value at an existing row/column location.
Object	setValue(int row, int col, Object val) Sets the value at an existing row/column location.
int	size() Returns the number of rows in this table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataTable

public DataTable(String[] colNames,
                 Class<?>[] colClasses,
                 Object[][] data)

Base constructor.

Parameters:

colNames - The names for each column. This defines the width of the table; attempting to add rows with more or fewer columns causes an exception. Names in this array should be unique; if not, you will be unable to retrieve column values by name.

colClasses - The class of each column. Attempting to add values of the wrong class causes a ClassCastException . May be null or contain null elements to disable class checking for the entire table or particular column respectively.

data - Initial data for the table. May be null to create an empty table. If not null, this data is checked for number of columns and value class.

DataTable

public DataTable(String[] colNames)

Convenience constructor that just takes column names, creates an empty table that doesn't check data class.

Method Detail

size

public int size()

Returns the number of rows in this table.

getColumnCount

public int getColumnCount()

Returns the number of columns in this table.

getColumnName

public String getColumnName(int col)

Returns the name of a column.

getColumnClass

public Class<?> getColumnClass(int col)

Returns the class of a column, null if the column can hold values of any class.

getValue

public Object getValue(int row,
                       int col)

Returns the value at an existing row/column location.

Throws:

IndexOutOfBoundsException - if the specified row or column is not within the bounds of the table.

setValue

public Object setValue(int row,
                       int col,
                       Object val)

Sets the value at an existing row/column location.

Returns:

The object previously at that location.

Throws:

ClassCastException - if the passed value is an incorrect class for the column.

IndexOutOfBoundsException - if the specified row or column is not within the bounds of the table.

addRow

public void addRow()

Adds a new empty row to the end of the table.

addRow

public void addRow(Object[] rowData)

Adds a new row to the end of the table, with specified data.

Throws:

IllegalArgumentException - if the passed row is an incorrect size for the table.

ClassCastException - if an element within the row does not have the correct class for its column.