eu.bandm.tools.message

Class MessageStore<M extends Message>

java.lang.Object

eu.bandm.tools.message.MessageStore<M>

All Implemented Interfaces:

MessageReceiver<M>

public class MessageStore<M extends Message>
extends Object
implements MessageReceiver<M>

Storage for a sequence of Messages with dynamic sorting, graphic interfaces and propagation facilities.

All messages received are added to an internal sequential storage. As long as no order is defined, per default in the order of their arrival. A different order can be achieved by calling setOrder(Comparator). Whenever this comparator is re-assigned, the store is re-ordered and all graphical representations are notified.

There are two kinds of graphic representations, both in the context of javax.swing, namely MessageStore.TableModel and MessageStore.ListModel. The user can derive from these classes and provide its own instance by setTableModel(TableModel) and setListModel(ListModel). If not, a standard implementation will be provided by getTableModel() and getListModel().
This class can also be used for collecting, sorting and further processing: all messages currently stored can be propagated explicitly to some MessageReceiver by calling drainTo(MessageReceiver).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MessageStore.ListModel standard specialisation of AbstractListModel.
class	MessageStore.TableModel standard specialisation of AbstractTableModel.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageStore.ListModel	listModel
protected List<M>	messages
protected Comparator<? super M>	order
protected MessageStore.TableModel	tableModel

Constructor Summary

Constructors

Constructor and Description
MessageStore()

Method Summary

Modifier and Type	Method and Description
void	clear() clears the internal storage, deleting all messages.
void	drainTo(MessageReceiver<? super M> receiver) send all currently contained messages (in their stored order) to the receiver.
MessageStore.ListModel	getListModel() returns the default (or a user-defined) list model, cf MessageStore.ListModel.
List<M>	getMessages() returns an unmodifiable façade to the current content.
Comparator	getOrder() Returns the comparator which rules the sequential order of storing.
int	getSize() returns the number of currently contained messages
MessageStore.TableModel	getTableModel() returns the default (or a user-defined) table model, MessageStore.TableModel.
protected void	notifyGuiAdd(int i) An item has been inserted at position "i".
protected void	notifyGuiChanged_ALL() Only called in case of sort order change: Re-arranged from-to.
void	receive(M message) adds the received message to the internal store and notifies all GUI objects.
void	setListModel(MessageStore.ListModel lm) only needed for inserting user-defined list model, cf MessageStore.ListModel.
void	setOrder(Comparator<? super M> comp) Set the comparator which rules the sequential order of storing.
void	setTableModel(MessageStore.TableModel tm) only needed for inserting user-defined table model, cf MessageStore.TableModel.

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected final List<M extends Message> messages

order

protected Comparator<? super M extends Message> order

tableModel

protected MessageStore.TableModel tableModel

listModel

protected MessageStore.ListModel listModel

Constructor Detail

MessageStore

public MessageStore()

Method Detail

setOrder

public void setOrder(Comparator<? super M> comp)

Set the comparator which rules the sequential order of storing. The current content will be re-ordered and the GUI models will be notified.

If comp==null, then no re-ordering takes place, and future messages will again be appended to the end of the store.

getOrder

public Comparator getOrder()

Returns the comparator which rules the sequential order of storing.

drainTo

public void drainTo(MessageReceiver<? super M> receiver)

send all currently contained messages (in their stored order) to the receiver. The contents of the store is not altered.

IMPLICIT CLEAR wg. atomizitaet waere nett FIXME FEHLT ( )

getMessages

public List<M> getMessages()

returns an unmodifiable façade to the current content.

This will change on future changes. FIXME STIMMT DAS ???

getSize

public int getSize()

returns the number of currently contained messages

setTableModel

public void setTableModel(MessageStore.TableModel tm)

only needed for inserting user-defined table model, cf MessageStore.TableModel.

setListModel

public void setListModel(MessageStore.ListModel lm)

only needed for inserting user-defined list model, cf MessageStore.ListModel.

getTableModel

public MessageStore.TableModel getTableModel()

returns the default (or a user-defined) table model, MessageStore.TableModel.

getListModel

public MessageStore.ListModel getListModel()

returns the default (or a user-defined) list model, cf MessageStore.ListModel.

clear

public void clear()

clears the internal storage, deleting all messages.

notifyGuiAdd

protected void notifyGuiAdd(int i)

An item has been inserted at position "i".

notifyGuiChanged_ALL

protected void notifyGuiChanged_ALL()

Only called in case of sort order change: Re-arranged from-to.

receive

public void receive(M message)

adds the received message to the internal store and notifies all GUI objects.
If a comparator has been defined by setOrder(Comparator) then the new message is inserted directly before those which are of greater value, ie. after all those of equal value, which are older. In the absence of a comparator it is appended at the end.

Specified by:

receive in interface MessageReceiver<M extends Message>