com.sptci.rwt.webui
Class ExecutorView

java.lang.Object
  nextapp.echo2.app.Component
      consultas.echo2consultas.SpWindowPane
          com.sptci.echo2.WindowPane
              com.sptci.rwt.webui.ExecutorView

All Implemented Interfaces:

com.sptci.echo2.View, Serializable, FloatingPane, ModalSupport, Pane, PaneContainer, RenderIdSupport

Direct Known Subclasses:

BatchQueryExecutorView, QueryExecutorView

public abstract class ExecutorView
extends com.sptci.echo2.WindowPane

An abstract base class for query executor view components used to interact with the AbstractQueryExecutor class.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: ExecutorView.java 4123 2008-05-25 21:49:01Z rakesh $

Author:

Rakesh Vidyadharan 2007-10-12

See Also:

Serialized Form

Field Summary

protected ConnectionManager	connectionManager The connection manager to use to interact with the database.
protected MainController	controller Parent Controller.
protected Map<String,String>	history The cache of previously executed statements in this view.
protected consultas.echo2consultas.LiveTextField	maxColumnLength The component used to specify the maximum number of characters to display in a table column.
protected consultas.echo2consultas.LiveTextField	maxResults The component used to specify the maximum number of rows of data to retrieve for select statements.
protected TextArea	query The component used to enter the SQL statement to execute.
protected Column	results The component used to display the results after executing a statement.

Fields inherited from class consultas.echo2consultas.SpWindowPane

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, INPUT_CLOSE, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_CLOSABLE, PROPERTY_CLOSE_ICON, PROPERTY_CLOSE_ICON_INSETS, PROPERTY_DEFAULT_CLOSE_OPERATION, PROPERTY_HEIGHT, PROPERTY_ICON, PROPERTY_ICON_INSETS, PROPERTY_INSETS, PROPERTY_MAXIMIZABLE, PROPERTY_MAXIMIZE_ICON, PROPERTY_MAXIMIZE_ICON_INSETS, PROPERTY_MAXIMIZED, PROPERTY_MAXIMUM_HEIGHT, PROPERTY_MAXIMUM_WIDTH, PROPERTY_MINIMIZABLE, PROPERTY_MINIMIZE_ICON, PROPERTY_MINIMIZE_ICON_INSETS, PROPERTY_MINIMIZED, PROPERTY_MINIMUM_HEIGHT, PROPERTY_MINIMUM_WIDTH, PROPERTY_MOVABLE, PROPERTY_POSITION_X, PROPERTY_POSITION_Y, PROPERTY_RESIZABLE, PROPERTY_TITLE, PROPERTY_TITLE_BACKGROUND, PROPERTY_TITLE_BACKGROUND_IMAGE, PROPERTY_TITLE_FONT, PROPERTY_TITLE_FOREGROUND, PROPERTY_TITLE_HEIGHT, PROPERTY_TITLE_INSETS, PROPERTY_WIDTH, Z_INDEX_CHANGED_PROPERTY

Fields inherited from class nextapp.echo2.app.Component

CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Fields inherited from interface nextapp.echo2.app.ModalSupport

MODAL_CHANGED_PROPERTY

Constructor Summary

protected

ExecutorView(MainController controller) Create instance of the pane using the specified controller.

Method Summary

void	addToHistory(String statement) Add the specified statement to history.
protected abstract Component	createControls() Create the layout component to use to display the maxResults component and the other controls used to execute the statement.
protected Component	createExecute() Create the Button used to trigger execution of the user entered SQL statement.
protected Component	createExport() Create the Button used to trigger export of the results of the query to Excel.
protected Component	createHistory() Create the Button used to display the history of statements executed in the current view.
protected consultas.echo2consultas.LiveTextField	createLiveTextField(String name, Component row) Create a numeric text field with the specified name.
protected void	createMaxColumnLength(Component row) Initialise the maxColumnLength component.
protected void	createMaxResults(Component row) Initialise the maxResults component.
protected Component	createQuery() Initialise the query component.
protected Component	createSave() Create the PopUp component used to display the component used to capture user input on the category and name to assign to a saved SQL statement.
ConnectionManager	getConnectionManager() Returns connectionManager.
Map<String,String>	getHistory() Returns history.
protected String	getListenerName() Get the fully qualified class name of the action listener used to execute the user entered statement.
int	getMaxColumnLength() Return the value entered in maxColumnLength.
int	getMaxResults() Return the value entered in maxResults.
String	getQuery() Return the SQL statement that was entered into query.
void	init() Create the UI components that are necessary for the pane.
void	reset() Removes the results of a previous query execution.
void	setQuery(String text) Sets the text displayed in query to the specified value.
void	setQueryFromHistory(String key) Sets the text displayed in query to the specified value from history.

Methods inherited from class consultas.echo2consultas.SpWindowPane

addWindowPaneListener, fireWindowClosing, getBackgroundImage, getBorder, getCloseIcon, getCloseIconInsets, getDefaultCloseOperation, getHeight, getIcon, getIconInsets, getInsets, getMaximizeIcon, getMaximizeIconInsets, getMaximumHeight, getMaximumWidth, getMinimizeIcon, getMinimizeIconInsets, getMinimumHeight, getMinimumWidth, getPositionX, getPositionY, getTitle, getTitleBackground, getTitleBackgroundImage, getTitleFont, getTitleForeground, getTitleHeight, getTitleInsets, getWidth, getZIndex, isClosable, isMaximizable, isMaximized, isMinimizable, isMinimized, isModal, isMovable, isResizable, isValidChild, isValidParent, processInput, removeWindowPaneListener, setBackgroundImage, setBorder, setClosable, setCloseIcon, setCloseIconInsets, setDefaultCloseOperation, setHeight, setIcon, setIconInsets, setInsets, setMaximizable, setMaximized, setMaximumHeight, setMaximumWidth, setMinimizable, setMinimized, setMinimumHeight, setMinimumWidth, setModal, setMovable, setPositionX, setPositionY, setResizable, setTitle, setTitleBackground, setTitleBackgroundImage, setTitleFont, setTitleForeground, setTitleHeight, setTitleInsets, setWidth, setZIndex, userClose

Methods inherited from class nextapp.echo2.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndexedProperty, getLayoutData, getLayoutDirection, getLocale, getParent, getProperty, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLayoutDirection, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, setBackground, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndexedProperty, setLayoutData, setLayoutDirection, setLocale, setProperty, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

query

protected TextArea query

The component used to enter the SQL statement to execute.

maxResults

protected consultas.echo2consultas.LiveTextField maxResults

The component used to specify the maximum number of rows of data to retrieve for select statements.

maxColumnLength

protected consultas.echo2consultas.LiveTextField maxColumnLength

The component used to specify the maximum number of characters to display in a table column.

Since:

Version 1.3

results

protected Column results

The component used to display the results after executing a statement.

controller

protected final MainController controller

Parent Controller.

connectionManager

protected final ConnectionManager connectionManager

The connection manager to use to interact with the database.

history

protected final Map<String,String> history

The cache of previously executed statements in this view.

Constructor Detail

ExecutorView

protected ExecutorView(MainController controller)

Create instance of the pane using the specified controller.

Parameters:

controller - The controller to use to interact with the rest of the application.

Method Detail

init

public void init()

Create the UI components that are necessary for the pane.

Overrides:

init in class com.sptci.echo2.WindowPane

See Also:

createQuery(), createControls()

createQuery

protected Component createQuery()

Initialise the query component.

Returns:

The properly initialised component.

createMaxResults

protected void createMaxResults(Component row)

Initialise the maxResults component.

Parameters:

row - The component to which the maxResults component and its associated label is to be added.

See Also:

createLiveTextField(java.lang.String, nextapp.echo2.app.Component)

createMaxColumnLength

protected void createMaxColumnLength(Component row)

Initialise the maxColumnLength component.

Parameters:

row - The component to which the maxColumnLength component and its associated label is to be added.

Since:

Version 1.3

See Also:

createLiveTextField(java.lang.String, nextapp.echo2.app.Component)

createLiveTextField

protected consultas.echo2consultas.LiveTextField createLiveTextField(String name,
                                                                     Component row)

Create a numeric text field with the specified name.

Parameters:

name - The name of the text field. Used to look up localised information.

row - The parent component to which the text field is to be added.

Returns:

The properly initialised text field.

Since:

Version 1.3

createExecute

protected Component createExecute()

Create the Button used to trigger execution of the user entered SQL statement.

Returns:

The button component.

See Also:

getListenerName()

createExport

protected Component createExport()

Create the Button used to trigger export of the results of the query to Excel.

Returns:

The component used to trigger the export action.

createSave

protected Component createSave()

Create the PopUp component used to display the component used to capture user input on the category and name to assign to a saved SQL statement.

Returns:

The component used to capture user input.

createHistory

protected Component createHistory()

Create the Button used to display the history of statements executed in the current view.

Returns:

The button component.

getListenerName

protected String getListenerName()

Get the fully qualified class name of the action listener used to execute the user entered statement.

Returns:

The fully qualified class name of the listener.

getQuery

public String getQuery()

Return the SQL statement that was entered into query.

Returns:

The sql statement that was entered.

setQuery

public void setQuery(String text)

Sets the text displayed in query to the specified value. Re-initialises query to get around the client not getting updated if client state has been modified.

Parameters:

text - The query value to set.

getMaxResults

public int getMaxResults()

Return the value entered in maxResults.

getMaxColumnLength

public int getMaxColumnLength()

Return the value entered in maxColumnLength.

reset

public void reset()

Removes the results of a previous query execution. Removes all the child components of results.

createControls

protected abstract Component createControls()

Create the layout component to use to display the maxResults component and the other controls used to execute the statement.

Returns:

The layout component.

getHistory

public Map<String,String> getHistory()

Returns history.

Returns:

The value/reference of/to history.

addToHistory

public void addToHistory(String statement)

Add the specified statement to history. Removes and re-adds duplicate statements to maintain execution order.

Parameters:

statement - The statement that is to be added.

setQueryFromHistory

public void setQueryFromHistory(String key)

Sets the text displayed in query to the specified value from history. The value specified is the key in history. The value set will be value.

Parameters:

key - The key to use to set the statement.

See Also:

setQuery(java.lang.String)

getConnectionManager

public ConnectionManager getConnectionManager()

Returns connectionManager.

Returns:

The value/reference of/to connectionManager.