Package ca.phon.app.query

Class QueryAndReportWizard

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ca.phon.ui.CommonModuleFrame

ca.phon.ui.wizard.WizardFrame

ca.phon.ui.wizard.BreadcrumbWizardFrame

ca.phon.app.opgraph.wizard.NodeWizard

ca.phon.app.query.QueryAndReportWizard

All Implemented Interfaces:

IExtendable, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class QueryAndReportWizard
extends NodeWizard

Wizard for executing queries and producing HTML reports.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	QueryAndReportWizard.ResultSetTreeNode

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_QUERY_PARAMETERS_FOLDER
static final String	DEFAULT_REPORT_FOLDER
static final String	DEFAULT_STOCK_REPORT_HASH_FILE
static final String	PREVIOUS_QUERY_PARAMETERS_FOLDER
static final String	PREVIOUS_REPORT_FOLDER
static final String	STOCK_REPORT_HASH_FILE

Fields inherited from class ca.phon.app.opgraph.wizard.NodeWizard

autoGenHTMLBox, btnRunAgain, btnStop, CASE_SENSITIVE_GLOBAL_OPTION, globalOptionsPanel, IGNORE_DIACRITICS_GLOBAL_OPTION, inInit, INVENTORY_GROUPING_GLOBAL_OPTION, ONLYOREXCEPT_GLOBAL_OPTION, optionalsStep, overridesButton, reportDataStep, reportTitledPanel, reportTreeDockingPanel, reportTreeViewToolbar, SELECTED_DIACRITICS_GLOBAL_OPTION

Fields inherited from class ca.phon.ui.wizard.BreadcrumbWizardFrame

breadcrumbScroller, breadCrumbViewer, nextButton

Fields inherited from class ca.phon.ui.wizard.WizardFrame

btnBack, btnCancel, btnFinish, btnNext, buttonPanel, stepPanel

Fields inherited from class ca.phon.ui.CommonModuleFrame

DEFAULT_MACOS_ENABLE_FULLSCREEN, MACOS_ENABLE_FULLSCREEN, title

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
QueryAndReportWizard(Project project, QueryScript queryScript, QueryAndReportWizardSettings settings)

Method Summary

Modifier and Type	Method	Description
void	close()
protected NodeWizardReportGenerator	createReportGenerator(ReportTree reportTree, String reportTemplate, OutputStream fout)
void	discardAllResults()
void	discardResults()
void	discardResults(QueryRunnerPanel panel)
void	executeGraph()	Executes graph.
void	executeQuery()
static List<Tuple<QueryAndReportWizard,Tuple<String,ResultSet>>>	findOpenResultSets(Session session)	Find all open results sets for the given session.
Tuple<String,String>	getNoun()	Return the noun associated with the type of graph executed in the wizard.
QueryHistoryAndNameToolbar	getQueryHistoryPanel()
Map<String,QueryRunnerPanel>	getQueryRunners()	Return the map of executed queries.
QueryScript	getQueryScript()
SimpleEditorPanel	getReportComposer()
void	gotoStep(int stepIdx)
boolean	isIncludeExcluded()
void	loadNamedQuery(ParamSetType paramSet)
void	newWindow()
void	newWindow(Project project)
void	next()
void	onDuplicateQueryWizard()
void	onStopQuery()
void	resetQueryParameters(PhonActionEvent<Void> pae)
void	selectResults(String queryName)
void	setJMenuBar(JMenuBar menuBar)
protected void	setupContext(ca.phon.opgraph.OpContext ctx)
void	showResults()
void	updateWindowName()

Methods inherited from class ca.phon.app.opgraph.wizard.NodeWizard

cancel, closeHTMLReport, createIntroStep, createOptionalsStep, createReportStep, createStep, executionEnded, executionStarted, generateHTML, generateHTMLReport, generateHTMLReport, getBufferPanel, getCurrentReportTree, getGraph, getOptionalsTree, getProcessor, getReportTreeContentView, getWizardExtension, gotoReport, gotoReportSection, htmlReportAvailable, loadDefaultReport, loadGraph, loadGraph, loadHTMLReport, loadReportTreeDockingPanel, onPrintReport, onStop, onZoomIn, onZoomOut, onZoomReset, resetReportStep, searchForTables, setProcessor, setupExportTablesMenu, setupGlobalOptions, setupOptionals, setupReportContext, setupReportTreeViewToolbar, setupWizardSteps, stopExecution, updateBreadcrumbButtons

Methods inherited from class ca.phon.ui.wizard.BreadcrumbWizardFrame

removeAllSteps, removeWizardStep, setBounds

Methods inherited from class ca.phon.ui.wizard.WizardFrame

addListener, addWizardStep, addWizardStep, addWizardStep, finish, fireWizardEvent, getCurrentStep, getCurrentStepIndex, getStepIndex, getWizardStep, numberOfSteps, prev, removeListener, setupButtons, setVisible, showBusyLabel, showWizard, stopBusyLabel

Methods inherited from class ca.phon.ui.CommonModuleFrame

addNewWindowListener, cascadeWindow, centerWindow, display, getCurrentFrame, getExtension, getExtensions, getOpenWindows, getParentFrame, getProjectWindows, getTitle, getUnsavedChangesMessage, getUnsavedChangesTitle, getWindowName, hasUnsavedChanges, hideStatusComponent, isShowInWindowMenu, placeTopRight, positionRelativeTo, putExtension, removeExtension, resetStatusComponent, saveAndClose, saveData, setModified, setParentFrame, setShowInWindowMenu, setUnsavedChangesMessage, setUnsavedChangesTitle, setWindowName, showErrorMessage, showMessageDialog, showOkCancelDialog, showOkDialog, showStatusMessage, showYesNoCancelDialog, showYesNoDialog

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

PREVIOUS_QUERY_PARAMETERS_FOLDER

public static final String PREVIOUS_QUERY_PARAMETERS_FOLDER

DEFAULT_QUERY_PARAMETERS_FOLDER

public static final String DEFAULT_QUERY_PARAMETERS_FOLDER

PREVIOUS_REPORT_FOLDER

public static final String PREVIOUS_REPORT_FOLDER

DEFAULT_REPORT_FOLDER

public static final String DEFAULT_REPORT_FOLDER

STOCK_REPORT_HASH_FILE

public static final String STOCK_REPORT_HASH_FILE

DEFAULT_STOCK_REPORT_HASH_FILE

public static final String DEFAULT_STOCK_REPORT_HASH_FILE

Constructor Details

QueryAndReportWizard

public QueryAndReportWizard(Project project,
 QueryScript queryScript,
 QueryAndReportWizardSettings settings)

Method Details

findOpenResultSets

public static List<Tuple<QueryAndReportWizard,Tuple<String,ResultSet>>> findOpenResultSets(Session session)

Find all open results sets for the given session.

Parameters:

session -

Returns:

all open result sets along with query names for given session

updateWindowName

public void updateWindowName()

setJMenuBar

public void setJMenuBar(JMenuBar menuBar)

Overrides:

setJMenuBar in class NodeWizard

loadNamedQuery

public void loadNamedQuery(ParamSetType paramSet)

close

public void close()

Overrides:

close in class NodeWizard

showResults

public void showResults()

resetQueryParameters

public void resetQueryParameters(PhonActionEvent<Void> pae)

newWindow

public void newWindow(Project project)

newWindow

public void newWindow()

onDuplicateQueryWizard

public void onDuplicateQueryWizard()

getQueryHistoryPanel

public QueryHistoryAndNameToolbar getQueryHistoryPanel()

getQueryScript

public QueryScript getQueryScript()

getReportComposer

public SimpleEditorPanel getReportComposer()

getQueryRunners

public Map<String,QueryRunnerPanel> getQueryRunners()

Return the map of executed queries.

Returns:

onStopQuery

public void onStopQuery()

executeQuery

public void executeQuery()

executeGraph

public void executeGraph()
                  throws ca.phon.opgraph.exceptions.ProcessingException

Description copied from class: NodeWizard

Executes graph. During execution, data generated may be printed to buffers which are displayed during this stage. If there is a buffer named 'Report Template' at the end of execution, a HTML report is generated using the contents of 'Report Template' which should be a velocity template.

Overrides:

executeGraph in class NodeWizard

Throws:

ca.phon.opgraph.exceptions.ProcessingException

createReportGenerator

protected NodeWizardReportGenerator createReportGenerator(ReportTree reportTree,
 String reportTemplate,
 OutputStream fout)

Overrides:

createReportGenerator in class NodeWizard

setupContext

protected void setupContext(ca.phon.opgraph.OpContext ctx)

Overrides:

setupContext in class NodeWizard

selectResults

public void selectResults(String queryName)

discardAllResults

public void discardAllResults()

discardResults

public void discardResults()

discardResults

public void discardResults(QueryRunnerPanel panel)

isIncludeExcluded

public boolean isIncludeExcluded()

getNoun

public Tuple<String,String> getNoun()

Description copied from class: NodeWizard

Return the noun associated with the type of graph executed in the wizard. The first element of the Tuple is the singleton version, while the second element is the plural. String should be returned as all lower case.

Overrides:

getNoun in class NodeWizard

Returns:

Tupleinvalid input: '<'String, String>

next

public void next()

Overrides:

next in class NodeWizard

gotoStep

public void gotoStep(int stepIdx)

Overrides:

gotoStep in class NodeWizard