org.salespointframework.desktop.models
Class StoringStockTableModel

java.lang.Object
  javax.swing.table.AbstractTableModel
      org.salespointframework.desktop.models.AbstractTableModel
          org.salespointframework.desktop.models.StoringStockTableModel

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.swing.table.TableModel, DatasourceChangeListener, StockChangeListener, HelpableListener, FilterableModel

public class StoringStockTableModel
extends AbstractTableModel
implements HelpableListener, StockChangeListener, FilterableModel

A TableModel that models the contents of a Stock, representing each StockItem as an individual record.

Since:

v2.0

Version:

2.0 23/08/1999

Author:

Steffen Zschaler

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.salespointframework.desktop.models.FilterableModel

FilterableModel.DefaultModelFilter, FilterableModel.ModelFilter, FilterableModel.ResultCountListener

Field Summary

protected java.util.Comparator<StockItem>	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 java.util.List<StockItem>	m_lItems The internal model.
protected Stock	m_stModel The Stock that is being modelled.
protected FilterableModel.ModelFilter	modelFilter model filter
protected java.util.List<FilterableModel.ResultCountListener>	resultCountListeners result count listener list

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

StoringStockTableModel(Stock st, DataBasket db, java.util.Comparator<StockItem> cmp, TableEntryDescriptor ted)
Create a new StoringStockTableModel.

Method Summary

void	addedStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
boolean	addResultCountListener(FilterableModel.ResultCountListener rcs) add a FilterableModel.ResultCountListener
void	canEditStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	canRemoveStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
protected void	checkAdd(StockChangeEvent e) Internal helper method.
protected void	checkRemove(StockChangeEvent e) Internal helper method.
protected void	checkUpdate(StockChangeEvent e) Internal helper method.
void	commitAddStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	commitEditStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	commitRemoveStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	DatasourceChanged(boolean pumpUp) The datasource changed. force the model to invalidate its internal structures and pump up the event
void	editingStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	filterPropertyChanged() apply filter and reload items
java.lang.Object	getRecord(int row) Get the record at the given index.
int	getRowCount() Get the number of records in this model.
void	noEditStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	noRemoveStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	removedStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	removeResultCountListener(FilterableModel.ResultCountListener rcs) remove FilterableModel.ResultCountListener
void	rollbackAddStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	rollbackEditStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	rollbackRemoveStockItems(StockChangeEvent e) Update the internal model and inform any listeners according to the received event.
void	setData(java.lang.Object n_stModel) Set the table's data.
void	setModelFilter(FilterableModel.ModelFilter modelFilter) set new model filter and reload items
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 Stock.

Methods inherited from class org.salespointframework.desktop.models.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_stModel

protected Stock m_stModel

The Stock that is being modelled.

m_dbBasket

protected DataBasket m_dbBasket

The DataBasket used to determine visibility.

m_cmpComparator

protected java.util.Comparator<StockItem> m_cmpComparator

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

resultCountListeners

protected java.util.List<FilterableModel.ResultCountListener> resultCountListeners

result count listener list

modelFilter

protected FilterableModel.ModelFilter modelFilter

model filter

m_lItems

protected java.util.List<StockItem> m_lItems

The internal model. A list of StockItems.

Constructor Detail

StoringStockTableModel

public StoringStockTableModel(Stock st,
                              DataBasket db,
                              java.util.Comparator<StockItem> cmp,
                              TableEntryDescriptor ted)

Create a new StoringStockTableModel.

Parameters:

st - the Stock to be modelled.

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 StockItems.

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

Method Detail

setData

public void setData(java.lang.Object n_stModel)

Set the table's data. Data is data.StoringStock

Specified by:

setData in class AbstractTableModel

Parameters:

n_stModel - the new data

getRecord

public java.lang.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 StockItem to be displayed at the given index. May return null if there is no record at the indicated position.

getRowCount

public int getRowCount()

Get the number of records in this model.

Specified by:

getRowCount in interface javax.swing.table.TableModel

subscribe

public void subscribe()

Subscribe as a listener to the model. If the modelled Stock is a ListenableStock, subscribe as a listener.

Specified by:

subscribe in interface HelpableListener

unsubscribe

public void unsubscribe()

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

Specified by:

unsubscribe in interface HelpableListener

updateModel

public void updateModel()

Update the internal model based on the modelled Stock.

Specified by:

updateModel in interface HelpableListener

addedStockItems

public void addedStockItems(StockChangeEvent 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:

addedStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

commitAddStockItems

public void commitAddStockItems(StockChangeEvent 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:

commitAddStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

rollbackAddStockItems

public void rollbackAddStockItems(StockChangeEvent 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:

rollbackAddStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

canRemoveStockItems

public void canRemoveStockItems(StockChangeEvent 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:

canRemoveStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

Throws:

VetoException - if the listener wants to veto the removal.

noRemoveStockItems

public void noRemoveStockItems(StockChangeEvent 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:

noRemoveStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

removedStockItems

public void removedStockItems(StockChangeEvent 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:

removedStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

commitRemoveStockItems

public void commitRemoveStockItems(StockChangeEvent 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:

commitRemoveStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

rollbackRemoveStockItems

public void rollbackRemoveStockItems(StockChangeEvent 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:

rollbackRemoveStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

canEditStockItems

public void canEditStockItems(StockChangeEvent 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:

canEditStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

Throws:

VetoException - if the listener wants to veto the editing.

noEditStockItems

public void noEditStockItems(StockChangeEvent 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:

noEditStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

editingStockItems

public void editingStockItems(StockChangeEvent 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:

editingStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

commitEditStockItems

public void commitEditStockItems(StockChangeEvent 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:

commitEditStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

rollbackEditStockItems

public void rollbackEditStockItems(StockChangeEvent 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:

rollbackEditStockItems in interface StockChangeListener

Parameters:

e - an event object describing the event.

checkAdd

protected void checkAdd(StockChangeEvent e)

Internal helper method. Check where, if at all, the indicated StockItems have been added with respect to the internal model.

checkRemove

protected void checkRemove(StockChangeEvent e)

Internal helper method. Check from where, if at all, the indicated StockItems have been removed with respect to the internal model.

checkUpdate

protected void checkUpdate(StockChangeEvent e)

Internal helper method. Check for an update in the indicated StockItems.

DatasourceChanged

public void DatasourceChanged(boolean pumpUp)

The datasource changed. force the model to invalidate its internal structures and pump up the event

Specified by:

DatasourceChanged in interface DatasourceChangeListener

Parameters:

pumpUp - true if the event should be pumped up to hosts, because this event is mostly triggered twice. first time to invalidate caches. second time for load new data

addResultCountListener

public boolean addResultCountListener(FilterableModel.ResultCountListener rcs)

add a FilterableModel.ResultCountListener

Specified by:

addResultCountListener in interface FilterableModel

Returns:

true, on success

filterPropertyChanged

public void filterPropertyChanged()

apply filter and reload items

Specified by:

filterPropertyChanged in interface FilterableModel

removeResultCountListener

public void removeResultCountListener(FilterableModel.ResultCountListener rcs)

remove FilterableModel.ResultCountListener

Specified by:

removeResultCountListener in interface FilterableModel

setModelFilter

public void setModelFilter(FilterableModel.ModelFilter modelFilter)

set new model filter and reload items

Specified by:

setModelFilter in interface FilterableModel

Parameters:

modelFilter - new model filter