alma.acs.logging.table

Class LogEntryTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

alma.acs.logging.table.LogEntryTable

All Implemented Interfaces:

ZoomProgressListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.CellEditorListener, javax.swing.event.ListSelectionListener, javax.swing.event.RowSorterListener, javax.swing.event.TableColumnModelListener, javax.swing.event.TableModelListener, javax.swing.Scrollable

public class LogEntryTable
extends javax.swing.JTable
implements ZoomProgressListener

Subclasses JTable allowing grouping and sorting depending on user's input. Creation date: (11/11/2001 13:45:22)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LogEntryTable.ColumnMenu Popup menu used to display the column options for the table.

Nested classes/interfaces inherited from class javax.swing.JTable

javax.swing.JTable.AccessibleJTable, javax.swing.JTable.DropLocation, javax.swing.JTable.PrintMode

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JTable

AUTO_RESIZE_ALL_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_OFF, AUTO_RESIZE_SUBSEQUENT_COLUMNS, autoCreateColumnsFromModel, autoResizeMode, cellEditor, cellSelectionEnabled, columnModel, dataModel, defaultEditorsByColumnClass, defaultRenderersByColumnClass, editingColumn, editingRow, editorComp, gridColor, preferredViewportSize, rowHeight, rowMargin, rowSelectionAllowed, selectionBackground, selectionForeground, showHorizontalLines, showVerticalLines, tableHeader

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
LogEntryTable(LoggingClient client, boolean initialDateFormat, boolean initalLogTypeFormat) LogEntryTable constructor.

Method Summary

Modifier and Type	Method and Description
void	changeSelection(int rowIndex, int columnIndex, boolean toggle, boolean extend) Override the method in JTable to catch the change of selection operated by the user and update the detailed log info accordingly.
void	close() Close the filterChooser dialog releasing all the resources.
protected int	columnToModel(int index) Utility method to provide mapping of column index to data fields.
javax.swing.table.TableCellRenderer	getCellRenderer(int row, int column) Align the text of the table to the top.
int	getColumnWidth(int n) Computes the total width of the table taking into consideration the visible columns' width.
org.w3c.dom.Node	getExtraInfo() Insert the method's description here.
FiltersVector	getFilters() Return the filters defined by the user.
java.lang.String	getFiltersString()
LogTableDataModel	getLCModel() Returns the LogTableDataModel.
int	getSortIndex() Sets the index of the column the table should be sorted by.
int	getViewRowCount() Shows the number of rows shown by the table.
boolean[]	getVisibleColumns(boolean zeroBased) Returns an array of boolean with true for each visible column The visibleComun array of this class starts counting the column from 1 instead of 0 (i.e.
void	hideColumn(int columnIndex) Hides a table column specified by index.
boolean	isSortAscending() Returns true if the elements are sorted in ascending order and false if in descending.
java.awt.Component	prepareRenderer(javax.swing.table.TableCellRenderer renderer, int rowIndex, int vColIndex) Sets a tool tip on all the cells.
void	scrollToFirstRow() Scroll the table to the first row
void	scrollToLastRow() Scroll the table to the last row
void	scrollToNextSelectedRow() Scroll the table to the next selected row and select it.
void	scrollToPrevSelectedRow() Scroll the table to the next selected row and select it.
void	scrollToSelectedRow() Scroll the table to the selected row
void	setAdditionalWidth(int n, int width) Assigns the additional width that is left to the right to Log Message column.
void	setFilters(FiltersVector newFilters, boolean append)
void	setLogLevel(LogTypeHelper newLevel) Set the new log level i.e.
void	setLogSelectionListener(ViewCoordinator.SingleLogSelectionListener listener) This is used only by ViewCoordinator.
void	setLogTypeDescriptionView(boolean showDescription) Show/Hide the description of the log type at the right side of the icon.
void	setOrdering(int field, boolean ascending) Set the order and the field for ordering at once.
void	setShortDateFormat(boolean shortFormat) Set the format used to show the timestamp in the date column
void	setSortIndex(int index) Sets the column the elements in this table should be sorted by.
void	setSortOrder(boolean ascending) Changes the order in which the elements are sorted.
void	showColumn(int columnIndex) Displays the column specified by index.
void	showFieldChooser() Displays the field chooser dialog.
void	sorterChanged(javax.swing.event.RowSorterEvent e)
void	zoom() Zoom over the selected logs.
void	zoomReadingFile(int num) Notifies the listener about the number of files currently read by the zoom engine.
void	zoomTotalFileToRead(int num) Inform the listener about the total number of files that the zoom engine needs to read.

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addNotify, addRowSelectionInterval, clearSelection, columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, configureEnclosingScrollPane, convertColumnIndexToModel, convertColumnIndexToView, convertRowIndexToModel, convertRowIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createDefaultTableHeader, createScrollPaneForTable, doLayout, editCellAt, editCellAt, editingCanceled, editingStopped, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoCreateRowSorter, getAutoResizeMode, getCellEditor, getCellEditor, getCellRect, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getDropLocation, getDropMode, getEditingColumn, getEditingRow, getEditorComponent, getFillsViewportHeight, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getPrintable, getRowCount, getRowHeight, getRowHeight, getRowMargin, getRowSelectionAllowed, getRowSorter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getUpdateSelectionOnSort, getValueAt, initializeLocalVars, isCellEditable, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, print, print, print, print, print, processKeyBinding, removeColumn, removeColumnSelectionInterval, removeEditor, removeNotify, removeRowSelectionInterval, resizeAndRepaint, rowAtPoint, selectAll, setAutoCreateColumnsFromModel, setAutoCreateRowSorter, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setDropMode, setEditingColumn, setEditingRow, setFillsViewportHeight, setGridColor, setIntercellSpacing, setModel, setPreferredScrollableViewportSize, setRowHeight, setRowHeight, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setRowSorter, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setUpdateSelectionOnSort, setValueAt, sizeColumnsToFit, sizeColumnsToFit, tableChanged, unconfigureEnclosingScrollPane, updateUI, valueChanged

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

LogEntryTable

public LogEntryTable(LoggingClient client,
                     boolean initialDateFormat,
                     boolean initalLogTypeFormat)
              throws java.lang.Exception

LogEntryTable constructor.

Parameters:

logClient - The LoggingClient that owns this table

initialDateFormat - The format to show the date (true means short)

initalLogTypeFormat - If true shows the written close to the icon of the log type

Throws:

java.lang.Exception

Method Detail

columnToModel

protected int columnToModel(int index)

Utility method to provide mapping of column index to data fields. Creation date: (1/25/02 11:11:43 AM)

Parameters:

index - int

Returns:

int

getExtraInfo

public org.w3c.dom.Node getExtraInfo()

Insert the method's description here. Creation date: (2/7/02 3:52:36 PM)

Returns:

java.lang.String

getLCModel

public LogTableDataModel getLCModel()

Returns the LogTableDataModel. This is a convenience method that returns properly case data model. Creation date: (11/24/2001 18:44:41)

Returns:

com.cosylab.logging.client.LCLogTableDataModel

getSortIndex

public int getSortIndex()

Sets the index of the column the table should be sorted by. If the table is currently unsorted, the result is -1.

Returns:

int

hideColumn

public void hideColumn(int columnIndex)

Hides a table column specified by index. Creation date: (12/4/2001 22:57:58)

Parameters:

columnIndex - int

prepareRenderer

public java.awt.Component prepareRenderer(javax.swing.table.TableCellRenderer renderer,
                                          int rowIndex,
                                          int vColIndex)

Sets a tool tip on all the cells. It pops up when the value is not fully displayed while the mose scrolls over it.

Overrides:

prepareRenderer in class javax.swing.JTable

See Also:

JTable.prepareRenderer(TableCellRenderer, int, int)

getColumnWidth

public int getColumnWidth(int n)

Computes the total width of the table taking into consideration the visible columns' width.

Returns:

number of columns

setAdditionalWidth

public void setAdditionalWidth(int n,
                               int width)

Assigns the additional width that is left to the right to Log Message column.

Parameters:

width -

number - of columns

isSortAscending

public boolean isSortAscending()

Returns true if the elements are sorted in ascending order and false if in descending. If the table is not sorted, this parameter has no meaning. Creation date: (1/24/02 10:49:21 AM)

Returns:

boolean

setSortIndex

public void setSortIndex(int index)

Sets the column the elements in this table should be sorted by. Setting it to -1 means the table is not sorted. To change both the index and the order, it is better to execute setOrdering

Parameters:

index - int

setSortOrder

public void setSortOrder(boolean ascending)

Changes the order in which the elements are sorted. Set true for ascending and false for descending. To change both the index and the order, it is better to execute setOrdering

Parameters:

ascending - The order for the table

setOrdering

public void setOrdering(int field,
                        boolean ascending)

Set the order and the field for ordering at once. Calling this method is faster the calling the setSortIndex and setSortOrder

Parameters:

field - The field of the logs for ordering -1 disable the ordering

ascending - The order ascending(true)/descending (false)

showColumn

public void showColumn(int columnIndex)

Displays the column specified by index. Creation date: (12/4/2001 22:56:11)

Parameters:

columnIndex - int

showFieldChooser

public void showFieldChooser()

Displays the field chooser dialog.

Creation date: (1/2/2002 23:20:27)

getVisibleColumns

public boolean[] getVisibleColumns(boolean zeroBased)

Returns an array of boolean with true for each visible column The visibleComun array of this class starts counting the column from 1 instead of 0 (i.e. 0 is not used)

Parameters:

zeroBased - If true the number 0 correspond to the first column (the array of visible columns uses 1 for the first column)

Returns:

An array of boolean describing which columns are displayed

close

public void close()

Close the filterChooser dialog releasing all the resources. This is intended to be the last operatione when the application is closing

setShortDateFormat

public void setShortDateFormat(boolean shortFormat)

Set the format used to show the timestamp in the date column

Parameters:

shortFormat - The format of the date (true means short, false means complete)

setLogTypeDescriptionView

public void setLogTypeDescriptionView(boolean showDescription)

Show/Hide the description of the log type at the right side of the icon.

When the description is disabled, the icon appear without the written. The column is also resized to use less space as possible.

Parameters:

showDescription - If true a string with the description of the log appear at the right side of the icon (default)

changeSelection

public void changeSelection(int rowIndex,
                            int columnIndex,
                            boolean toggle,
                            boolean extend)

Override the method in JTable to catch the change of selection operated by the user and update the detailed log info accordingly.

Overrides:

changeSelection in class javax.swing.JTable

See Also:

JTable.changeSelection(int rowIndex, int columnIndex, boolean toggle,boolean extend)

setLogSelectionListener

public void setLogSelectionListener(ViewCoordinator.SingleLogSelectionListener listener)

This is used only by ViewCoordinator.

scrollToNextSelectedRow

public void scrollToNextSelectedRow()

Scroll the table to the next selected row and select it.

If there is no row selected or the selected line is the last row of the table, the method return without scrolling the table.

scrollToPrevSelectedRow

public void scrollToPrevSelectedRow()

Scroll the table to the next selected row and select it.

If there is no row selected or the selected row is the first row of the table, the method return without scrolling the table

scrollToFirstRow

public void scrollToFirstRow()

Scroll the table to the first row

scrollToLastRow

public void scrollToLastRow()

Scroll the table to the last row

scrollToSelectedRow

public void scrollToSelectedRow()

Scroll the table to the selected row

If there is no selected row, the method return without scrolling.

The selected row could not be anymore present in the table for example because it has been deleted by the LogDeleter or the table has been cleared by the user.

getFilters

public FiltersVector getFilters()

Return the filters defined by the user.

Returns:

The user defined filters

setFilters

public void setFilters(FiltersVector newFilters,
                       boolean append)

Parameters:

newFilters -

append -

getFiltersString

public java.lang.String getFiltersString()

Returns:

A description of the active filters

See Also:

FiltersVector.getFilterString()

setLogLevel

public void setLogLevel(LogTypeHelper newLevel)

Set the new log level i.e. the level of the logs shown in the table.

Parameters:

newLevel -

getViewRowCount

public int getViewRowCount()

Shows the number of rows shown by the table.

Returns:

the number of rows shown by the table.

sorterChanged

public void sorterChanged(javax.swing.event.RowSorterEvent e)

Specified by:

sorterChanged in interface javax.swing.event.RowSorterListener

Overrides:

sorterChanged in class javax.swing.JTable

zoom

public void zoom()

Zoom over the selected logs.

The zoom consists of loading all the logs in the time interval defined by the selected logs. The zoom is delegated to the ZoomManager.

See Also:

ZoomManager}

zoomReadingFile

public void zoomReadingFile(int num)

Description copied from interface: ZoomProgressListener

Notifies the listener about the number of files currently read by the zoom engine.

This method of the listener is called when the loading of logs starts with a value of 0 while the zoom engine scans the folder looking for the files to read.
When the list is ready, the zoom engine executes this method passing the number of the file it has started to read.

Specified by:

zoomReadingFile in interface ZoomProgressListener

Parameters:

num - The number of files currently read.

zoomTotalFileToRead

public void zoomTotalFileToRead(int num)

Description copied from interface: ZoomProgressListener

Inform the listener about the total number of files that the zoom engine needs to read.

This method of the listener is executed only once by the engine, when it has generated the list of the files to read.

Specified by:

zoomTotalFileToRead in interface ZoomProgressListener

getCellRenderer

public javax.swing.table.TableCellRenderer getCellRenderer(int row,
                                                           int column)

Align the text of the table to the top.

By default the vertical alignment of text in the JLabel used to show text in table cells is centered.. This cause a problem when the text is multiline so we have to force a TOP alignment of the text.

Overrides:

getCellRenderer in class javax.swing.JTable

See Also:

JTable.getCellRenderer(int, int)