org.ka2ddo.yaac.gui

Class LocalObjectTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

org.ka2ddo.yaac.gui.LocalObjectTableModel

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel, LocalObjectTracker.LocalObjectListener, FastComparableTableModel, ExtraColumnProviderChangeListener, ClearableTableModel

public class LocalObjectTableModel
extends javax.swing.table.AbstractTableModel
implements LocalObjectTracker.LocalObjectListener, ClearableTableModel, FastComparableTableModel, ExtraColumnProviderChangeListener

This class provides the table information for displaying all locally managed Objects/Items.

Author:

Andrew Pavlin, KA2DDO

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.ka2ddo.yaac.util.ClearableTableModel

ClearableTableModel.ClearType

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Method Summary

Modifier and Type	Method and Description
void	addTableModelListener(javax.swing.event.TableModelListener l) Adds a listener to the list that's notified each time a change to the data model occurs.
void	cellValueChanged(ExtraColumnProvider provider, GuiContentType guiContentType, int extraColumnIndex, SupportsExtraData rowData) This method is called by an ExtraColumnProvider when the value in a cell of an extra column changes (corresponding to a TableModelEvent.UPDATE on the displaying table's model).
void	columnListChanged(ExtraColumnProvider provider, GuiContentType guiContentType) This method is called by an ExtraColumnProvider when its set of columns changes.
int	compareRows(int rowIndex1, int rowIndex2, int columnIndex) Compare the selected column of the two rows.
int	deleteAllRows(ClearableTableModel.ClearType clearType) Delete all rows from this table.
java.lang.Class<?>	getColumnClass(int columnIndex) Returns the Class for interpreting the value of the specified column
int	getColumnCount() Returns the number of columns in the model.
java.lang.String	getColumnName(int column) Returns the name for the column,
java.lang.String	getRecordTypeTag() Get a tag that can be given to the Localizer to return the term for the records to be or that have been deleted.
int	getRowCount() Returns the number of rows in the model.
java.lang.Object	getValueAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
boolean	isCellEditable(int rowIndex, int columnIndex) Reports whether the specified cell can be modified by the user.
void	objectAdded(int index, LocalObjectTracker.ObjectLink objectLink) Report that an Object was added to the LocalObjectTracker.
void	objectDeleted(int index, LocalObjectTracker.ObjectLink objectLink) Report that an Object was deleted from the LocalObjectTracker.
void	objectModified(int index, LocalObjectTracker.ObjectLink objectLink) Report that an Object was modified in the LocalObjectTracker.
void	removeTableModelListener(javax.swing.event.TableModelListener l) Removes a listener from the list that's notified each time a change to the data model occurs.
void	setValueAt(java.lang.Object aValue, int rowIndex, int columnIndex) Set the value of editable cells of the table.
boolean	tableCanContainPlayback() Identifies whether this table can contain playback (historical) data.
boolean	tableCanContainRealtime() Identifies whether this table can contain realtime data.

Methods inherited from class javax.swing.table.AbstractTableModel

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

Methods inherited from class java.lang.Object

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

Method Detail

getColumnCount

public int getColumnCount()

Returns the number of columns in the model.

Specified by:

getColumnCount in interface javax.swing.table.TableModel

Returns:

the number of columns in the model

See Also:

getRowCount()

getColumnClass

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

Returns the Class for interpreting the value of the specified column

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

Parameters:

columnIndex - the column being queried

Returns:

the Class for the specified column

getColumnName

public java.lang.String getColumnName(int column)

Returns the name for the column,

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

Parameters:

column - the column being queried

Returns:

a string containing the name of column

getRowCount

public int getRowCount()

Returns the number of rows in the model. A JTable uses this method to determine how many rows it should display. This method should be quick, as it is called frequently during rendering.

Specified by:

getRowCount in interface javax.swing.table.TableModel

Returns:

the number of rows in the model

See Also:

getColumnCount()

getValueAt

public java.lang.Object getValueAt(int rowIndex,
                                   int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

Specified by:

getValueAt in interface javax.swing.table.TableModel

Parameters:

rowIndex - the row whose value is to be queried

columnIndex - the column whose value is to be queried

Returns:

the value Object at the specified cell

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Reports whether the specified cell can be modified by the user.

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

Parameters:

rowIndex - the row being queried

columnIndex - the column being queried

Returns:

boolean true if cell is editable

setValueAt

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

Set the value of editable cells of the table.

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class javax.swing.table.AbstractTableModel

Parameters:

aValue - value to assign to cell

rowIndex - row of cell

columnIndex - column of cell

addTableModelListener

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

Adds a listener to the list that's notified each time a change to the data model occurs.

Specified by:

addTableModelListener in interface javax.swing.table.TableModel

Overrides:

addTableModelListener in class javax.swing.table.AbstractTableModel

Parameters:

l - the TableModelListener

removeTableModelListener

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

Removes a listener from the list that's notified each time a change to the data model occurs.

Specified by:

removeTableModelListener in interface javax.swing.table.TableModel

Overrides:

removeTableModelListener in class javax.swing.table.AbstractTableModel

Parameters:

l - the TableModelListener

deleteAllRows

public int deleteAllRows(ClearableTableModel.ClearType clearType)

Delete all rows from this table.

Specified by:

deleteAllRows in interface ClearableTableModel

Parameters:

clearType - type of rows to be deleted

Returns:

number of rows deleted

tableCanContainPlayback

public boolean tableCanContainPlayback()

Identifies whether this table can contain playback (historical) data.

Specified by:

tableCanContainPlayback in interface ClearableTableModel

Returns:

boolean true if table can contain playback data.

tableCanContainRealtime

public boolean tableCanContainRealtime()

Identifies whether this table can contain realtime data.

Specified by:

tableCanContainRealtime in interface ClearableTableModel

Returns:

boolean true if table can contain realtime data.

getRecordTypeTag

public java.lang.String getRecordTypeTag()

Get a tag that can be given to the Localizer to return the term for the records to be or that have been deleted. Should translate to a plural term, i.e., "messages" rather than "message".

Specified by:

getRecordTypeTag in interface ClearableTableModel

Returns:

tag for looking up in a ResourceBundle

objectAdded

public void objectAdded(int index,
                        LocalObjectTracker.ObjectLink objectLink)

Report that an Object was added to the LocalObjectTracker.

Specified by:

objectAdded in interface LocalObjectTracker.LocalObjectListener

Parameters:

index - zero-based index into tracker list

objectLink - ObjectLink containing the new Object

objectModified

public void objectModified(int index,
                           LocalObjectTracker.ObjectLink objectLink)

Report that an Object was modified in the LocalObjectTracker.

Specified by:

objectModified in interface LocalObjectTracker.LocalObjectListener

Parameters:

index - zero-based index into tracker list

objectLink - ObjectLink containing the modified Object

objectDeleted

public void objectDeleted(int index,
                          LocalObjectTracker.ObjectLink objectLink)

Report that an Object was deleted from the LocalObjectTracker.

Specified by:

objectDeleted in interface LocalObjectTracker.LocalObjectListener

Parameters:

index - zero-based index into tracker list

objectLink - ObjectLink containing the deleted Object

compareRows

public int compareRows(int rowIndex1,
                       int rowIndex2,
                       int columnIndex)

Compare the selected column of the two rows.

Specified by:

compareRows in interface FastComparableTableModel

Parameters:

rowIndex1 - zero-based model row index of first row to compare

rowIndex2 - zero-based model row index of second row to compare

columnIndex - zero-based model column index of column to compare

Returns:

+1 if the 1st row's column is after the 2nd row's column, -1 if before, or 0 if equal precedence

columnListChanged

public void columnListChanged(ExtraColumnProvider provider,
                              GuiContentType guiContentType)

This method is called by an ExtraColumnProvider when its set of columns changes. Note this does not mean the values of individual rows for the column, but when the presence/absence, data type, or column name of any column provided by this provider is modified. Typically, this event would cause a table model data structure change on tables using these columns.

Specified by:

columnListChanged in interface ExtraColumnProviderChangeListener

Parameters:

provider - the ExtraColumnProvider reporting the change

guiContentType - the GuiContentType of the set of modified extra columns

cellValueChanged

public void cellValueChanged(ExtraColumnProvider provider,
                             GuiContentType guiContentType,
                             int extraColumnIndex,
                             SupportsExtraData rowData)

This method is called by an ExtraColumnProvider when the value in a cell of an extra column changes (corresponding to a TableModelEvent.UPDATE on the displaying table's model). Allows ExtraColumnProvider instances to have dynamically changing values.

Specified by:

cellValueChanged in interface ExtraColumnProviderChangeListener

Parameters:

provider - the ExtraColumnProvider reporting the change

guiContentType - the GuiContentType of the set of extra columns

extraColumnIndex - zero-based index of extra column from this provider that changed

rowData - SupportsExtraData object for the modified row, or null for all rows