Class ChainsawCyclicBufferTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

org.apache.log4j.chainsaw.ChainsawCyclicBufferTableModel

All Implemented Interfaces:

PropertyChangeListener, Serializable, EventListener, TableModel, EventContainer, LoggerNameModel, SortTableModel

class ChainsawCyclicBufferTableModel
extends AbstractTableModel
implements EventContainer, PropertyChangeListener

A CyclicBuffer implementation of the EventContainer.

NOTE: This implementation prevents duplicate rows from being added to the model.

Ignoring duplicates was added to support receivers which may attempt to deliver the same event more than once but can be safely ignored (for example, the database receiver when set to retrieve in a loop).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ChainsawCyclicBufferTableModel.ModelChanger

Field Summary

Fields

Modifier and Type	Field	Description
private RuleColorizer	colorizer
private final List<String>	columnNames
private boolean	currentSortAscending
private int	currentSortColumn
private boolean	cyclic
private int	cyclicBufferSize
private static final int	DEFAULT_CAPACITY
private final EventListenerList	eventListenerList
(package private) List	filteredList
private final org.apache.log4j.Logger	logger
private final LoggerNameModel	loggerNameModelDelegate
private final Object	mutex
private final PropertyChangeSupport	propertySupport
private boolean	reachedCapacity
private org.apache.log4j.rule.Rule	ruleMediator
private boolean	sortEnabled
private final String	tableModelName
(package private) List	unfilteredList
private final Set	uniquePropertyKeys
(package private) int	uniqueRow

Fields inherited from class AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor	Description
ChainsawCyclicBufferTableModel(int cyclicBufferSize, RuleColorizer colorizer, String tableModelName)

Method Summary

Modifier and Type	Method	Description
void	addEventCountListener(EventCountListener listener)	Adds an EventCountListener, to be notified when the # of events changes
boolean	addLoggerName(String loggerName)	Attempts to add the loggerName to the model, and returns true if it does, i.e that the loggerName is new, otherwise it is ignored.
void	addLoggerNameListener(LoggerNameListener l)
void	addNewKeyListener(NewKeyListener l)	Adds a NewKeyListener to be notified when unique Key (Property keys) arrive into this EventContainer
void	addPropertyChangeListener(PropertyChangeListener l)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l)
private void	checkForNewColumn(LoggingEventWrapper loggingEventWrapper)
void	clearModel()	Clears the model completely
int	findColoredRow(int startLocation, boolean searchForward)	Determine next row with a non-default color
private void	fireNewKeyColumnAdded(NewKeyEvent e)
void	fireRowUpdated(int row, boolean checkForNewColumns)	A row was updated
void	fireTableEvent(int begin, int end, int count)	Fire appropriate table update events for the range.
List	getAllEvents()	Returns a copied list of all the event in the model.
int	getColumnCount()
String	getColumnName(int column)
List	getFilteredEvents()	Returns a copied list containing the events in the model with filter applied
Collection	getLoggerNames()	Returns an unmodifiable Collection of the uniquely known LoggerNames within this model.
List<LoggingEventWrapper>	getMatchingEvents(org.apache.log4j.rule.Rule rule)
int	getMaxSize()	If this container is in Cyclic mode, returns the Size of the cyclic buffer, otherwise this method throws an IllegalStateException, when in unlimited mode, this method has no meaning.
LoggingEventWrapper	getRow(int row)	Returns the vector representing the row.
int	getRowCount()
int	getRowIndex(LoggingEventWrapper loggingEventWrapper)	Returns the index of the LoggingEventWrapper
int	getSearchMatchCount()	Return the visible search match count
Object	getValueAt(int rowIndex, int columnIndex)
boolean	isAddRow(LoggingEventWrapper loggingEventWrapper)	Adds a row to the model.
boolean	isCellEditable(int rowIndex, int columnIndex)
boolean	isSortable(int col)
boolean	isSortEnabled()
int	locate(org.apache.log4j.rule.Rule rule, int startLocation, boolean searchForward)	Locates a row number, starting from startRow, matching the rule provided
void	notifyCountListeners()	Allow a forced notification of the EventCountListeners
void	propertyChange(PropertyChangeEvent evt)
void	reFilter()	Force a re-processing of the table layout
void	removeLoggerNameListener(LoggerNameListener l)
void	removeNewKeyListener(NewKeyListener l)	Removes a listener from being notified of NewKey events.
void	removePropertyFromEvents(String propName)	Remove property from all events in container
void	reset()	The logger names have been cleared
void	setCyclic(boolean cyclic)	Configures this model to use Cyclic or non-cyclic models.
void	setRuleMediator(RuleMediator ruleMediator)	Changes the underlying display rule in use.
int	size()	Returns the total number of events currently in the model (all, not just filtered)
void	sort()
void	sortColumn(int col, boolean ascending)
String	toString()
private void	updateEventMillisDelta(LoggingEventWrapper loggingEventWrapper, LoggingEventWrapper lastLoggingEventWrapper)
int	updateEventsWithFindRule(org.apache.log4j.rule.Rule findRule)	Evaluate all events against the find rule

Methods inherited from class AbstractTableModel

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

Methods inherited from class Object

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

Methods inherited from interface TableModel

addTableModelListener, getColumnClass, removeTableModelListener, setValueAt

Field Details

DEFAULT_CAPACITY

private static final int DEFAULT_CAPACITY

See Also:

• Constant Field Values

cyclic

private boolean cyclic

cyclicBufferSize

private int cyclicBufferSize

unfilteredList

List unfilteredList

filteredList

List filteredList

currentSortAscending

private boolean currentSortAscending

currentSortColumn

private int currentSortColumn

eventListenerList

private final EventListenerList eventListenerList

columnNames

private final List<String> columnNames

sortEnabled

private boolean sortEnabled

reachedCapacity

private boolean reachedCapacity

logger

private final org.apache.log4j.Logger logger

loggerNameModelDelegate

private final LoggerNameModel loggerNameModelDelegate

mutex

private final Object mutex

uniqueRow

int uniqueRow

uniquePropertyKeys

private final Set uniquePropertyKeys

ruleMediator

private org.apache.log4j.rule.Rule ruleMediator

propertySupport

private final PropertyChangeSupport propertySupport

colorizer

private RuleColorizer colorizer

tableModelName

private final String tableModelName

Constructor Details

ChainsawCyclicBufferTableModel

public ChainsawCyclicBufferTableModel(int cyclicBufferSize,
 RuleColorizer colorizer,
 String tableModelName)

Method Details

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

getMatchingEvents

public List<LoggingEventWrapper> getMatchingEvents(org.apache.log4j.rule.Rule rule)

Specified by:

getMatchingEvents in interface EventContainer

reFilter

public void reFilter()

Description copied from interface: EventContainer

Force a re-processing of the table layout

Specified by:

reFilter in interface EventContainer

locate

public int locate(org.apache.log4j.rule.Rule rule,
 int startLocation,
 boolean searchForward)

Description copied from interface: EventContainer

Locates a row number, starting from startRow, matching the rule provided

Specified by:

locate in interface EventContainer

Parameters:

rule -

startLocation -

searchForward -

removeLoggerNameListener

public void removeLoggerNameListener(LoggerNameListener l)

Specified by:

removeLoggerNameListener in interface LoggerNameModel

Parameters:

l -

addLoggerName

public boolean addLoggerName(String loggerName)

Description copied from interface: LoggerNameModel

Attempts to add the loggerName to the model, and returns true if it does, i.e that the loggerName is new, otherwise it is ignored.

If the loggerName is new for this model, all the LoggerNameListeners are notified using this thread.

Specified by:

addLoggerName in interface LoggerNameModel

Parameters:

loggerName -

Returns:

toString

public String toString()

Overrides:

toString in class Object

reset

public void reset()

Description copied from interface: LoggerNameModel

The logger names have been cleared

Specified by:

reset in interface LoggerNameModel

addLoggerNameListener

public void addLoggerNameListener(LoggerNameListener l)

Specified by:

addLoggerNameListener in interface LoggerNameModel

Parameters:

l -

getLoggerNames

public Collection getLoggerNames()

Description copied from interface: LoggerNameModel

Returns an unmodifiable Collection of the uniquely known LoggerNames within this model.

Specified by:

getLoggerNames in interface LoggerNameModel

Returns:

addEventCountListener

public void addEventCountListener(EventCountListener listener)

Description copied from interface: EventContainer

Adds an EventCountListener, to be notified when the # of events changes

Specified by:

addEventCountListener in interface EventContainer

Parameters:

listener -

isSortable

public boolean isSortable(int col)

Specified by:

isSortable in interface SortTableModel

notifyCountListeners

public void notifyCountListeners()

Description copied from interface: EventContainer

Allow a forced notification of the EventCountListeners

Specified by:

notifyCountListeners in interface EventContainer

setRuleMediator

public void setRuleMediator(RuleMediator ruleMediator)

Changes the underlying display rule in use. If there was a previous Rule defined, this Model removes itself as a listener from the old rule, and adds itself to the new rule (if the new Rule is not Null).

In any case, the model ensures the Filtered list is made up to date in a separate thread.

Specified by:

setRuleMediator in interface EventContainer

Parameters:

ruleMediator -

sort

public void sort()

Specified by:

sort in interface SortTableModel

isSortEnabled

public boolean isSortEnabled()

Specified by:

isSortEnabled in interface SortTableModel

sortColumn

public void sortColumn(int col,
 boolean ascending)

Specified by:

sortColumn in interface SortTableModel

clearModel

public void clearModel()

Description copied from interface: EventContainer

Clears the model completely

Specified by:

clearModel in interface EventContainer

getAllEvents

public List getAllEvents()

Description copied from interface: EventContainer

Returns a copied list of all the event in the model.

Specified by:

getAllEvents in interface EventContainer

getFilteredEvents

public List getFilteredEvents()

Description copied from interface: EventContainer

Returns a copied list containing the events in the model with filter applied

Specified by:

getFilteredEvents in interface EventContainer

getRowIndex

public int getRowIndex(LoggingEventWrapper loggingEventWrapper)

Description copied from interface: EventContainer

Returns the index of the LoggingEventWrapper

Specified by:

getRowIndex in interface EventContainer

Parameters:

loggingEventWrapper -

removePropertyFromEvents

public void removePropertyFromEvents(String propName)

Description copied from interface: EventContainer

Remove property from all events in container

Specified by:

removePropertyFromEvents in interface EventContainer

Parameters:

propName - the property name to remove

updateEventsWithFindRule

public int updateEventsWithFindRule(org.apache.log4j.rule.Rule findRule)

Description copied from interface: EventContainer

Evaluate all events against the find rule

Specified by:

updateEventsWithFindRule in interface EventContainer

Parameters:

findRule -

findColoredRow

public int findColoredRow(int startLocation,
 boolean searchForward)

Description copied from interface: EventContainer

Determine next row with a non-default color

Specified by:

findColoredRow in interface EventContainer

Parameters:

startLocation -

searchForward -

Returns:

getSearchMatchCount

public int getSearchMatchCount()

Description copied from interface: EventContainer

Return the visible search match count

Specified by:

getSearchMatchCount in interface EventContainer

Returns:

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

getColumnName

public String getColumnName(int column)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getRow

public LoggingEventWrapper getRow(int row)

Description copied from interface: EventContainer

Returns the vector representing the row.

Specified by:

getRow in interface EventContainer

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getValueAt

public Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

isAddRow

public boolean isAddRow(LoggingEventWrapper loggingEventWrapper)

Description copied from interface: EventContainer

Adds a row to the model.

Specified by:

isAddRow in interface EventContainer

Parameters:

loggingEventWrapper - event

Returns:

flag representing whether or not the row is being displayed (not filtered)

updateEventMillisDelta

private void updateEventMillisDelta(LoggingEventWrapper loggingEventWrapper,
 LoggingEventWrapper lastLoggingEventWrapper)

checkForNewColumn

private void checkForNewColumn(LoggingEventWrapper loggingEventWrapper)

fireTableEvent

public void fireTableEvent(int begin,
 int end,
 int count)

Description copied from interface: EventContainer

Fire appropriate table update events for the range.

Specified by:

fireTableEvent in interface EventContainer

fireRowUpdated

public void fireRowUpdated(int row,
 boolean checkForNewColumns)

Description copied from interface: EventContainer

A row was updated

Specified by:

fireRowUpdated in interface EventContainer

Parameters:

row -

checkForNewColumns -

fireNewKeyColumnAdded

private void fireNewKeyColumnAdded(NewKeyEvent e)

Parameters:

e -

getMaxSize

public int getMaxSize()

Description copied from interface: EventContainer

If this container is in Cyclic mode, returns the Size of the cyclic buffer, otherwise this method throws an IllegalStateException, when in unlimited mode, this method has no meaning.

Specified by:

getMaxSize in interface EventContainer

Returns:

addNewKeyListener

public void addNewKeyListener(NewKeyListener l)

Description copied from interface: EventContainer

Adds a NewKeyListener to be notified when unique Key (Property keys) arrive into this EventContainer

Specified by:

addNewKeyListener in interface EventContainer

Parameters:

l -

removeNewKeyListener

public void removeNewKeyListener(NewKeyListener l)

Description copied from interface: EventContainer

Removes a listener from being notified of NewKey events.

Specified by:

removeNewKeyListener in interface EventContainer

Parameters:

l -

isCellEditable

public boolean isCellEditable(int rowIndex,
 int columnIndex)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

setCyclic

public void setCyclic(boolean cyclic)

Description copied from interface: EventContainer

Configures this model to use Cyclic or non-cyclic models. This method should fire a property Change event if it involves an actual change in the underlying model.

This method does nothing if there is no change in proprty.

Specified by:

setCyclic in interface EventContainer

Parameters:

cyclic -

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface EventContainer

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface EventContainer

size

public int size()

Description copied from interface: EventContainer

Returns the total number of events currently in the model (all, not just filtered)

Specified by:

size in interface EventContainer

Returns:

size