org.simbrain.util.table

Class SimbrainDataTable<T>

java.lang.Object

javax.swing.table.AbstractTableModel

org.simbrain.util.table.SimbrainDataTable<T>

Type Parameters:

T - the type of the data to be displayed.

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel

Direct Known Subclasses:

MutableTable

public abstract class SimbrainDataTable<T>
extends javax.swing.table.AbstractTableModel

Superclass for tables that can be viewed by a SimbrainJTable, and saved in a reasonable, readable way with XStream. All data are backed to a list of lists. This data structure can then be converted to other data structures (e.g. a 2d array of doubles) as needed. This is not as fast as alternatives but it's pretty fast and so suitable for most purposes. This class can also be subclassed and relevant methods overridden for an immutable, view type setup. For an example see WeightMatrixViewer. Note that the first column of all tables is a special header column that displays row number or other information. For convenience and ease of use, special "logical" methods are provided that use the indices of the data itself(i.e. column 0 is the first column of the data, not the special row-header column).

Author:

Jeff Yoshimi

See Also:

SimbrainJTable, WeightMatrixViewer, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.util.List<T>>	rowData The data.

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
SimbrainDataTable()

Method Summary

Modifier and Type	Method and Description
void	addTableModelListener(javax.swing.event.TableModelListener l)
java.util.List<T>	asFlatList() Returns the contents of the table as a flat list.
java.lang.String[][]	asStringArray() Returns a string array representation of the table.
void	fill(T value) Fills the table with the given value.
java.lang.Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
java.lang.String	getColumnName(int columnIndex)
(package private) abstract java.lang.Class<?>	getDataType() Returns the datatype (T) for a given table type.
(package private) abstract T	getDefaultValue() Returns the default cell value for a given table type.
int	getLogicalColumnCount() Returns the number of columns in the underlying data, which is one less than the number of columns in the table data.
T	getLogicalValueAt(int row, int col) Get the value of a specific cell in the data structure backing this table data structure.
int	getRowCount()
java.lang.Object	getValueAt(int row, int column)
static com.thoughtworks.xstream.XStream	getXStream() Returns a properly initialized xstream object.
boolean	isCellEditable(int row, int column)
void	setColumnHeadings(java.util.List<java.lang.String> columnHeadings)
void	setDisplayColumnHeadings(boolean displayColumnHeadings) TODO: This only works for setting from true to false.
void	setLogicalValue(int row, int column, T value, boolean fireEvent) Set the value at specific position in the data underlying the table, and specify whether to fire a changed event (false useful when a lot of values need to be changed at once and it would waste time to update the GUI for every such change).
void	setValue(int row, int col, T value) Set the value at specific position in the table.
void	setValue(int row, int column, T value, boolean fireEvent) Set the value at specific position in the table, and specify whether to fire a changed event (false useful when a lot of values need to be changed at once and it would waste time to update the GUI for every such change).
void	setValueAt(java.lang.Object val, int rowIndex, int columnIndex)
void	shuffle() Shuffle the rows of the dataset.

Methods inherited from class javax.swing.table.AbstractTableModel

findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Field Detail

rowData

protected final java.util.List<java.util.List<T>> rowData

The data. For use with mutable tables. Subclasses can choose not to make use of this (e.g. WeightMatrixViewer)

Constructor Detail

SimbrainDataTable

public SimbrainDataTable()

Method Detail

getDefaultValue

abstract T getDefaultValue()

Returns the default cell value for a given table type.

Returns:

the default value.

getDataType

abstract java.lang.Class<?> getDataType()

Returns the datatype (T) for a given table type.

Returns:

the data type.

setValueAt

public void setValueAt(java.lang.Object val,
                       int rowIndex,
                       int columnIndex)

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class javax.swing.table.AbstractTableModel

setValue

public void setValue(int row,
                     int col,
                     T value)

Set the value at specific position in the table.

Parameters:

row - row index

col - column index

value - value to add

setValue

public void setValue(int row,
                     int column,
                     T value,
                     boolean fireEvent)

Set the value at specific position in the table, and specify whether to fire a changed event (false useful when a lot of values need to be changed at once and it would waste time to update the GUI for every such change).

Parameters:

row - row index

column - column index

value - value to add

fireEvent - true if an event should be fired, false otherwise.

getValueAt

public java.lang.Object getValueAt(int row,
                                   int column)

setLogicalValue

public void setLogicalValue(int row,
                            int column,
                            T value,
                            boolean fireEvent)

Set the value at specific position in the data underlying the table, and specify whether to fire a changed event (false useful when a lot of values need to be changed at once and it would waste time to update the GUI for every such change).

Parameters:

row - row index in the "logical" data

column - column index in the "logical" data

value - value to add

fireEvent - true if an event should be fired, false otherwise.

getLogicalValueAt

public T getLogicalValueAt(int row,
                           int col)

Get the value of a specific cell in the data structure backing this table data structure.

Parameters:

row - the row index

col - the column index

Returns:

the value at that cell

getColumnClass

public java.lang.Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

getColumnName

public java.lang.String getColumnName(int columnIndex)

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

getLogicalColumnCount

public int getLogicalColumnCount()

Returns the number of columns in the underlying data, which is one less than the number of columns in the table data.

Returns:

the number of columns in the data

getColumnCount

public int getColumnCount()

getRowCount

public int getRowCount()

fill

public void fill(T value)

Fills the table with the given value.

Parameters:

value - value to fill the table with.

shuffle

public void shuffle()

Shuffle the rows of the dataset.

asStringArray

public java.lang.String[][] asStringArray()

Returns a string array representation of the table.

Returns:

string array version of table

asFlatList

public java.util.List<T> asFlatList()

Returns the contents of the table as a flat list.

Returns:

contents as a list.

setColumnHeadings

public void setColumnHeadings(java.util.List<java.lang.String> columnHeadings)

Parameters:

columnHeadings - the columnHeadings to set

setDisplayColumnHeadings

public void setDisplayColumnHeadings(boolean displayColumnHeadings)

TODO: This only works for setting from true to false. Setting from false back to true does not work.

Parameters:

displayColumnHeadings - the displayColumnHeadings to set

getXStream

public static com.thoughtworks.xstream.XStream getXStream()

Returns a properly initialized xstream object.

Returns:

the XStream object

addTableModelListener

public void addTableModelListener(javax.swing.event.TableModelListener l)

Specified by:

addTableModelListener in interface javax.swing.table.TableModel

Overrides:

addTableModelListener in class javax.swing.table.AbstractTableModel