alma.acs.logging.table

Class LogEntryTableModelBase

java.lang.Object

javax.swing.table.AbstractTableModel

alma.acs.logging.table.LogEntryTableModelBase

All Implemented Interfaces:

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

Direct Known Subclasses:

LogTableDataModel

public class LogEntryTableModelBase
extends javax.swing.table.AbstractTableModel
implements java.lang.Runnable

The table model with basic functionalities like add logs and remove all the logs. The model can be bounded to a max number of logs (by default unlimited).

Each log in the model is identified by a integer key; the association between keys and logs is done by the allLogs. rows represents a entry in the table i.e. a log identified by its key. So to get a log in a row, we must first get its key and then get the log from the cache.
This indirection allows to avoid keeping all the logs in memory The list of keys (rows) and the map (allLogs) must be consistent in the sense that the map must always contain the keys of all the logs in the table but it can have more keys. For example if a log is removed from the table its key can be removed from the map at a latter time.

The model is modified inside the EDT. The consistency between (rows) and the map (allLogs) is also obtained by modifying their contents inside the EDT. EDTExecutor is used to ensure to access the model from inside the EDT.

To reduce the overload refreshing the content of the table when a lot of logs have been added or removed, the refresh is triggered only after a certain amount of time by a dedicated thread (see run()).

When a log is deleted, it key is immediately removed from the List of logs (rows but the key is still in the cache (allLogs). A dedicated thread, KeysDeleter, is in charge of removing unused keys. This operation can be safely done in a non-EDT thread.

LogEntryTableModelBase can be reused by log tables with basic functionalities like the error browsers.

TODO: manage threads with a ScheduledThreadPoolExecutor

Author:

acaproni

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LogCache	allLogs The cache of all the logs received.
protected LoggingClient	loggingClient The LoggingClient that owns this table model
protected RowEntries	rows Each row of the table shows a log identified by a key returned by the cache.
protected java.lang.Thread	tableUpdater The thread to refresh the content of the table

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
LogEntryTableModelBase(LoggingClient client) Constructor

Method Summary

Modifier and Type	Method and Description
void	appendLog(ILogEntry log) Adds a log to TableUpdater#rowsToAdd ready to be flushed in the table at the next iteration.
void	clearAll() Remove all the logs.
void	close(boolean sync) Closes all the threads and frees the resources This is the last method to call before closing the application
int	findKeyPos(java.lang.Integer key) Return the position of the key in the vector.
java.lang.Class<?>	getColumnClass(int column) Returns default class for column.
int	getColumnCount() Return number of columns in table
java.lang.String	getColumnName(int columnIndex) Returns name of the column based LogEntryXML fields.
java.lang.Integer	getLogKey(int index) Return the key of the log in the given position of the vector of keys.
int	getRowCount()
java.util.Calendar	getTimeFrame()
java.lang.Object	getValueAt(int row, int column) Returns an item according to the row and the column of its position.
ILogEntry	getVisibleLogEntry(int row) Return the log shown in the passed row.
int	numberOfUsedFiles()
void	replaceLog(int pos, ILogEntry newEntry) Replace a log entry with another.
void	run()
void	setMaxLog(int max) Set the max number of logs to keep in cache This is the max number of logs stored in cache (the visible logs can be less)
void	start() Start the thread to update the table model.
long	totalLogNumber() Return the number of logs in cache without those waiting to be added in TableUpdater#rowsToAdd.
long	usedDiskSpace()

Methods inherited from class javax.swing.table.AbstractTableModel

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

Methods inherited from class java.lang.Object

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

Field Detail

allLogs

protected LogCache allLogs

The cache of all the logs received.

rows

protected final RowEntries rows

Each row of the table shows a log identified by a key returned by the cache.

This vector stores the key of each log in the table.

tableUpdater

protected java.lang.Thread tableUpdater

The thread to refresh the content of the table

loggingClient

protected final LoggingClient loggingClient

The LoggingClient that owns this table model

Constructor Detail

LogEntryTableModelBase

public LogEntryTableModelBase(LoggingClient client)
                       throws java.lang.Exception

Constructor

Throws:

java.lang.Exception

Method Detail

start

public void start()

Start the thread to update the table model.

See Also:

LogEntryTableModelBase#tableUpdater}

getColumnCount

public final int getColumnCount()

Return number of columns in table

Specified by:

getColumnCount in interface javax.swing.table.TableModel

numberOfUsedFiles

public int numberOfUsedFiles()

Returns:

The number of files used by the cache

usedDiskSpace

public long usedDiskSpace()
                   throws java.io.IOException

Returns:

The amount of disk space used by the files of the cache

Throws:

java.io.IOException - In case of error getting the size of at least one of the used cache files

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface javax.swing.table.TableModel

See Also:

TableModel.getRowCount()

getValueAt

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

Returns an item according to the row and the column of its position.

Specified by:

getValueAt in interface javax.swing.table.TableModel

Parameters:

row - int

column - int

Returns:

java.lang.Object

getVisibleLogEntry

public ILogEntry getVisibleLogEntry(int row)

Return the log shown in the passed row.

This must be called inside the EDT.

Parameters:

row - The row of the table containing the log

Returns:

The log in the passed row

clearAll

public void clearAll()

Remove all the logs.

totalLogNumber

public long totalLogNumber()

Return the number of logs in cache without those waiting to be added in TableUpdater#rowsToAdd.

Returns:

The number of logs in cache

getTimeFrame

public java.util.Calendar getTimeFrame()

Returns:

The time frame of the log in cache

See Also:

LogCache

getLogKey

public java.lang.Integer getLogKey(int index)

Return the key of the log in the given position of the vector of keys.

There are several cases that forbids to retrieve the key in the given position, in such a situations the method return null. One typical situation is when the entry has been deleted by the LogDeleter.

Parameters:

index - The position in the model of the key

Returns:

The key in the passed position or null if it is not possible to return the key

See Also:

findKeyPos(Integer key)

findKeyPos

public int findKeyPos(java.lang.Integer key)

Return the position of the key in the vector.

There are cases when the key is not anymore in the vector and in such situations this method return null.
For example it could happen if the log has been deleted by the LogDeleter.

Parameters:

key - The key whose position in the vector has to be found

Returns:

The position of the key in the vector of logs or -1 if the key is not in the vector

getColumnName

public final java.lang.String getColumnName(int columnIndex)

Returns name of the column based LogEntryXML fields. If the specified index does not return a valid column, blank string is returned. Creation date: (11/11/2001 13:50:16)

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

Parameters:

columnIndex - int

Returns:

java.lang.String

getColumnClass

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

Returns default class for column. Creation date: (12/1/2001 14:18:53)

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

Parameters:

column - int

Returns:

java.lang.Class

replaceLog

public void replaceLog(int pos,
                       ILogEntry newEntry)

Replace a log entry with another.

Parameters:

pos - The position in the cache of the log to replace

newEntry - The new LogEntryXML

close

public void close(boolean sync)

Closes all the threads and frees the resources This is the last method to call before closing the application

Parameters:

sync - If it is true wait the termination of the threads before returning

appendLog

public void appendLog(ILogEntry log)

Adds a log to TableUpdater#rowsToAdd ready to be flushed in the table at the next iteration.

To avoid updating the table very frequently, the logs to add are immediately inserted in the LogCache but their insertion in the table is delayed and done by the TableUpdater thread.
For this reason each log is inserted in the temporary vector rowsToAdd that will be flushed into rows by the thread.

Parameters:

log - The log to add

setMaxLog

public void setMaxLog(int max)

Set the max number of logs to keep in cache This is the max number of logs stored in cache (the visible logs can be less)

Parameters:

max - The max number of logs 0 means unlimited

run

public void run()

Specified by:

run in interface java.lang.Runnable