data.swing
Class CatalogTableModel

java.lang.Object
  javax.swing.table.AbstractTableModel
      util.swing.AbstractTableModel
          data.swing.CatalogTableModel

All Implemented Interfaces:

CatalogChangeListener, PropertyChangeListener, Serializable, EventListener, TableModel, HelpableListener

public class CatalogTableModel
extends AbstractTableModel
implements HelpableListener, CatalogChangeListener, PropertyChangeListener, Serializable

A TableModel that models the contents of a Catalog.

Since:

v2.0

Author:

Steffen Zschaler

See Also:

Serialized Form

Field Summary

protected Catalog<?>	m_cModel The Catalog that is being modelled.
protected Comparator<CatalogItem>	m_cmpComparator The Comparator that defines the sorting order of records in the model.
protected DataBasket	m_dbBasket The DataBasket used to determine visibility.
protected List<String>	m_lKeys The internal model.

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

CatalogTableModel(Catalog c, DataBasket db, Comparator<CatalogItem> cmp, TableEntryDescriptor ted)
Create a new CatalogTableModel.

Method Summary

void	addedCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	canEditCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	canRemoveCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
protected void	checkAdd(CatalogItem ci) Internal helper method.
protected void	checkRemove(CatalogItem ci) Internal helper method.
protected void	checkUpdate(CatalogItem ci) Internal helper method.
void	commitedAddCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	commitEditCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	commitedRemoveCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	editingCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
Comparator<CatalogItem>	getComparator()
Object	getRecord(int row) Get the record at the given index.
int	getRowCount() Get the number of records in this model.
void	noEditCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	noRemoveCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	propertyChange(PropertyChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	removedCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	rollbackEditCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	rolledbackAddCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	rolledbackRemoveCatalogItem(CatalogChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	setData(Object n_cModel) Set the table's data.
void	subscribe() Subscribe as a listener to the model.
void	unsubscribe() Un-Subscribe as a listener from the model.
void	updateModel() Update the internal model based on the modelled Catalog.

Methods inherited from class util.swing.AbstractTableModel

getColumnClass, getColumnCount, getColumnName, getEntryDescriptor, getValueAt, isCellEditable, orderByColumn, reOrderBy, setValueAt

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, 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

m_dbBasket

protected DataBasket m_dbBasket

The DataBasket used to determine visibility.

m_cModel

protected Catalog<?> m_cModel

The Catalog that is being modelled.

m_cmpComparator

protected Comparator<CatalogItem> m_cmpComparator

The Comparator that defines the sorting order of records in the model. It compares CatalogItems.

m_lKeys

protected List<String> m_lKeys

The internal model. A list of the CatalogItems' keys.

Constructor Detail

CatalogTableModel

public CatalogTableModel(Catalog c,
                         DataBasket db,
                         Comparator<CatalogItem> cmp,
                         TableEntryDescriptor ted)

Create a new CatalogTableModel.

Parameters:

c - the Catalog to be modelled. May be filtered.

db - the DataBasket to be used to determine visibility.

cmp - a Comparator defining the sort order of the records. If null, records are ordered according to the natural ordering of the CatalogItems.

ted - a TableEntryDescriptor that can split individual CatalogItems into a table's cells.

Method Detail

setData

public void setData(Object n_cModel)

Set the table's data. Data is Catalog

Specified by:

setData in class AbstractTableModel

Parameters:

n_cModel - the new data

getComparator

public Comparator<CatalogItem> getComparator()

getRecord

public Object getRecord(int row)

Get the record at the given index.

Specified by:

getRecord in class AbstractTableModel

Parameters:

row - the index for which to retrieve the record. Element of [0, getRowCount()).

Returns:

the CatalogItem to be displayed at the given index. May return null if either there is no record at the indicated position or an exception occurs.

Override:

Never

getRowCount

public int getRowCount()

Get the number of records in this model.

Specified by:

getRowCount in interface TableModel

Override:

Never

subscribe

public void subscribe()

Subscribe as a listener to the model. If the modelled Catalog is a ListenableCatalog, subscribe as a listener.

Specified by:

subscribe in interface HelpableListener

Override:

Never

unsubscribe

public void unsubscribe()

Un-Subscribe as a listener from the model. If the modelled Catalog is a ListenableCatalog, un-subscribe as a listener.

Specified by:

unsubscribe in interface HelpableListener

Override:

Never

updateModel

public void updateModel()

Update the internal model based on the modelled Catalog.

Specified by:

updateModel in interface HelpableListener

Override:

Never

addedCatalogItem

public void addedCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

addedCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

commitedAddCatalogItem

public void commitedAddCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

commitedAddCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

rolledbackAddCatalogItem

public void rolledbackAddCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

rolledbackAddCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

canRemoveCatalogItem

public void canRemoveCatalogItem(CatalogChangeEvent e)
                          throws VetoException

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

canRemoveCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Throws:

VetoException - if the listener wants to veto the removal.

Override:

Never

noRemoveCatalogItem

public void noRemoveCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

noRemoveCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

removedCatalogItem

public void removedCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

removedCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

commitedRemoveCatalogItem

public void commitedRemoveCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

commitedRemoveCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

rolledbackRemoveCatalogItem

public void rolledbackRemoveCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

rolledbackRemoveCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

canEditCatalogItem

public void canEditCatalogItem(CatalogChangeEvent e)
                        throws VetoException

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

canEditCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Throws:

VetoException - if the listener wants to veto the editing.

Override:

Never

noEditCatalogItem

public void noEditCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

noEditCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

editingCatalogItem

public void editingCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

editingCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

commitEditCatalogItem

public void commitEditCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

commitEditCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

rollbackEditCatalogItem

public void rollbackEditCatalogItem(CatalogChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

rollbackEditCatalogItem in interface CatalogChangeListener

Parameters:

e - an event object describing the event.

Override:

Never

propertyChange

public void propertyChange(PropertyChangeEvent e)

Update the internal model and inform any listeners according to the received event.

This method is public as an implementation detail and must not be called directly.

Specified by:

propertyChange in interface PropertyChangeListener

Override:

Never

checkAdd

protected void checkAdd(CatalogItem ci)

Internal helper method. Check where, if at all, the given CatalogItem has been added with respect to the internal model.

Parameters:

ci - the added CatalogItem

Override:

Never

checkRemove

protected void checkRemove(CatalogItem ci)

Internal helper method. Check from where, if at all, the given CatalogItem has been removed with respect to the internal model.

Parameters:

ci - the removed CatalogItem

Override:

Never

checkUpdate

protected void checkUpdate(CatalogItem ci)

Internal helper method. Check for updates in the given CatalogItem.

Parameters:

ci - the updated CatalogItem

Override:

Never