arlut.csd.ganymede.client

Class gResultTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JInternalFrame

arlut.csd.ganymede.client.gResultTable

All Implemented Interfaces:

rowSelectCallback, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class gResultTable
extends javax.swing.JInternalFrame
implements rowSelectCallback, java.awt.event.ActionListener

Client internal window for displaying the results of a query dump in a table form.

This window is created when windowPanel's addTableWindow method is called.

Note that windowPanel's addTableWindow method is called from gclient's actionPerformed method, which spawns a separate thread in which the query is performed and the gResultTable window is created.

Constructors for this class take a Query object describing the query that this table was generated from, and a DumpResult object actually containing the dump results from the Ganymede server. gResultTable can resubmit the dump query to the server if the user chooses to refresh the query, but normally the dump query is performed by gclient.

Author:

Jonathan Abbey, jonabbey@arlut.utexas.edu

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon

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

Modifier and Type	Field and Description
(package private) javax.swing.JMenuItem	cloneMI
(package private) java.awt.Container	contentPane The contentPane for this internal window.
(package private) static java.lang.String	csv_option
(package private) static boolean	debug
(package private) javax.swing.JMenuItem	deleteMI
(package private) javax.swing.JMenuItem	editMI
(package private) static java.lang.String	html_option
(package private) javax.swing.JMenuItem	inactivateMI
(package private) static java.lang.String	mail_report
(package private) static java.lang.String	print_report
(package private) Query	query The actual Query used to create this gResultTable.
(package private) static java.lang.String	refresh_query
(package private) static java.lang.String	save_report
(package private) Session	session Main remote interface for communications with the server.
(package private) SmartTable	sTable Our key-indexed SmartTable
(package private) static java.lang.String	tab_option
(package private) static java.lang.String	TABLE_SAVE
(package private) javax.swing.JToolBar	toolbar
(package private) static TranslationService	ts TranslationService object for handling string localization in the Ganymede client.
boolean[]	used
(package private) javax.swing.JMenuItem	viewMI
(package private) windowPanel	wp Reference to the desktop pane containing the client's internal windows.
(package private) static java.lang.String	xml_option

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
gResultTable(windowPanel wp, Session session, Query query, DumpResult results) Constructor for gResultTable.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event)
void	colMenuPerformed(int menuCol, java.awt.event.ActionEvent event) Called when a pop-up menu is fired on a column header.
private javax.swing.JToolBar	createToolBar() Creates and initializes the JInternalFrame's toolbar.
(package private) java.lang.String	escapeCSV(java.lang.String string) This helper method makes a field string safe to emit to a CSV file.
(package private) java.lang.String	escapeHTML(java.lang.String string) This helper method makes a field string safe to emit to an HTML file.
(package private) java.lang.String	escapeString(java.lang.String string, char sepChar) This helper method makes a field string safe to emit to a sepChar separated text file.
(package private) java.lang.StringBuffer	generateCSV() This method generates a CSV representation of the table's contents, one line per row of the table.
(package private) java.lang.StringBuffer	generateHTMLRep() This method generates an HTML representation of the table's contents.
(package private) java.lang.StringBuffer	generateTextRep(char sepChar) This method generates a sepChar-separated dump of the table's contents, one line per row of the table.
(package private) java.lang.StringBuffer	generateXMLReport() This method generates a Ganymede XML data file containing the table's contents.
(package private) javax.swing.JToolBar	getToolBar()
void	loadResults(DumpResult results) This method loads the DumpResult into a table.
java.lang.String	paramString() Give access to the protected paramString() method of our ancestors for debug.
void	refreshQuery()
void	rowDoubleSelected(java.lang.Object key) Called when a row is unselected in the table
void	rowMenuPerformed(java.lang.Object key, java.awt.event.ActionEvent event) This function is called from inside SmartTable via the right click row menus, then passed back up to main client
void	rowSelected(java.lang.Object key) Called when a row is double selected (double clicked) in the table
void	rowUnSelected(java.lang.Object key, boolean endSelected) Called when a row is unselected in the table
void	sendReport(boolean mailit)
private void	setStatus(java.lang.String s)
private void	setStatus(java.lang.String s, int timeLimit)

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

ts

static final TranslationService ts

TranslationService object for handling string localization in the Ganymede client.

mail_report

static final java.lang.String mail_report

save_report

static final java.lang.String save_report

print_report

static final java.lang.String print_report

refresh_query

static final java.lang.String refresh_query

tab_option

static final java.lang.String tab_option

csv_option

static final java.lang.String csv_option

html_option

static final java.lang.String html_option

xml_option

static final java.lang.String xml_option

TABLE_SAVE

static final java.lang.String TABLE_SAVE

See Also:

Constant Field Values

wp

windowPanel wp

Reference to the desktop pane containing the client's internal windows. Used to access some GUI resources.

sTable

SmartTable sTable

Our key-indexed SmartTable

session

Session session

Main remote interface for communications with the server. Used to resubmit the query on query refresh.

query

Query query

The actual Query used to create this gResultTable. Used if the user asks that the query be refreshed.

contentPane

java.awt.Container contentPane

The contentPane for this internal window. We place the table in this container.

toolbar

javax.swing.JToolBar toolbar

viewMI

javax.swing.JMenuItem viewMI

editMI

javax.swing.JMenuItem editMI

cloneMI

javax.swing.JMenuItem cloneMI

deleteMI

javax.swing.JMenuItem deleteMI

inactivateMI

javax.swing.JMenuItem inactivateMI

used

public boolean[] used

Constructor Detail

gResultTable

public gResultTable(windowPanel wp,
            Session session,
            Query query,
            DumpResult results)
             throws java.rmi.RemoteException

Constructor for gResultTable. Creates the GUI table, loads it, and presents it. DumpResult is dissociated when this constructor is through with it, to aid GC.

Throws:

java.rmi.RemoteException

Method Detail

loadResults

public void loadResults(DumpResult results)

This method loads the DumpResult into a table. The DumpResult is dissociated when this method is through with it, to aid GC.

createToolBar

private javax.swing.JToolBar createToolBar()

Creates and initializes the JInternalFrame's toolbar.

getToolBar

javax.swing.JToolBar getToolBar()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

sendReport

public void sendReport(boolean mailit)

refreshQuery

public void refreshQuery()

rowSelected

public void rowSelected(java.lang.Object key)

Called when a row is double selected (double clicked) in the table

Specified by:

rowSelected in interface rowSelectCallback

Parameters:

key - Hash key for the selected row

rowDoubleSelected

public void rowDoubleSelected(java.lang.Object key)

Called when a row is unselected in the table

Specified by:

rowDoubleSelected in interface rowSelectCallback

Parameters:

key - Hash key for the unselected row

rowUnSelected

public void rowUnSelected(java.lang.Object key,
                 boolean endSelected)

Called when a row is unselected in the table

Specified by:

rowUnSelected in interface rowSelectCallback

Parameters:

key - Hash key for the row on which the popup menu item was performed

endSelected - false if the callback should assume that the final state of the system due to the user's present action will have no row selected

rowMenuPerformed

public void rowMenuPerformed(java.lang.Object key,
                    java.awt.event.ActionEvent event)

This function is called from inside SmartTable via the right click row menus, then passed back up to main client

Specified by:

rowMenuPerformed in interface rowSelectCallback

Parameters:

key - Hash key for the row on which the popup menu item was performed

event - the original ActionEvent from the popupmenu. See event.getSource() to identify the menu item performed.

colMenuPerformed

public void colMenuPerformed(int menuCol,
                    java.awt.event.ActionEvent event)

Description copied from interface: rowSelectCallback

Called when a pop-up menu is fired on a column header.

Specified by:

colMenuPerformed in interface rowSelectCallback

Parameters:

menuCol - The index for the column that the pop-up was fired on.

event - the original ActionEvent from the column menu.

generateHTMLRep

java.lang.StringBuffer generateHTMLRep()

This method generates an HTML representation of the table's contents.

generateCSV

java.lang.StringBuffer generateCSV()

This method generates a CSV representation of the table's contents, one line per row of the table.

generateTextRep

java.lang.StringBuffer generateTextRep(char sepChar)

This method generates a sepChar-separated dump of the table's contents, one line per row of the table.

generateXMLReport

java.lang.StringBuffer generateXMLReport()
                                   throws java.rmi.RemoteException

This method generates a Ganymede XML data file containing the table's contents.

Throws:

java.rmi.RemoteException

escapeString

java.lang.String escapeString(java.lang.String string,
                            char sepChar)

This helper method makes a field string safe to emit to a sepChar separated text file.

escapeCSV

java.lang.String escapeCSV(java.lang.String string)

This helper method makes a field string safe to emit to a CSV file.

escapeHTML

java.lang.String escapeHTML(java.lang.String string)

This helper method makes a field string safe to emit to an HTML file.

setStatus

private final void setStatus(java.lang.String s)

setStatus

private final void setStatus(java.lang.String s,
             int timeLimit)

paramString

public java.lang.String paramString()

Give access to the protected paramString() method of our ancestors for debug.

Overrides:

paramString in class javax.swing.JInternalFrame