oracle.ide.db.panels.sql.tester

Class SQLQueryTester

java.lang.Object

oracle.ide.db.panels.sql.tester.SQLQueryTester

public class SQLQueryTester
extends java.lang.Object

Utility that pops up a dialog for testing a sql query. The query checked against a chosen database connection, and optional components are registered for offering "Explain Plan" and "Results" tabs as well.

Since:

11.1.1.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLQueryTester.Result Result object that encapsulates information about the result from when the query was last tested against a db.

Constructor Summary

Constructors

Constructor and Description
SQLQueryTester(Database db) Creates a Tester that includes all tester component panels that are registered by extension in the product.
SQLQueryTester(Database db, boolean dbOnly) Creates a Tester that optionally contains only db specific tester components.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getBindVariables() Gets the bind variable Map that this tester has.
Context	getContext() Gets the IDE Context for the tester (can be null).
java.lang.String	getDefaultConnectionStore() Gets the default connection store to use in the tester (if set).
static void	registerComponent(java.lang.Class<? extends TesterComponent> clz) Deprecated. use the trigger hook <database-hook>, specifically the <sql-tester-components> element.
void	setBindVariables(java.util.Map<java.lang.String,?> bindVariables) Sets values for the bind variables that are present in the query.
void	setContext(Context ideContext) Sets the current IDE Context.
void	setDefaultConnectionStore(java.lang.String storeName) Sets a default connection store that should be used when dealing with connection names.
void	setShowConnectionPicker(boolean showPicker) By default the tester shows a connection picker that allows the user to choose and change the connection that the query is tested against.
void	setSQLText(java.lang.String txt) Deprecated.
SQLQueryTester.Result	showDialog(java.awt.Component owner, java.lang.String sqlText) Shows the tester dialog with the given owner component, to test the given query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLQueryTester

public SQLQueryTester(Database db)

Creates a Tester that includes all tester component panels that are registered by extension in the product.

Parameters:

db - the db to test again ( can be null ).

SQLQueryTester

public SQLQueryTester(Database db,
                      boolean dbOnly)

Creates a Tester that optionally contains only db specific tester components.

Parameters:

db - the db to test again ( can be null ).

dbOnly - if true only the "Query Results" and "Exaplin Plan" components will be included.

Method Detail

setBindVariables

public void setBindVariables(java.util.Map<java.lang.String,?> bindVariables)

Sets values for the bind variables that are present in the query. The tester will automatically identify bind variables and prompt the user for them if an action is performed that needs them (e.g. the "Query Results" page.

The contents of the Map is used, not the Map instance itself. When the dialog has finished, if the values the user entered when prompted are required use getBindVariables().

getBindVariables

public java.util.Map<java.lang.String,java.lang.Object> getBindVariables()

Gets the bind variable Map that this tester has. This will contain any mappings set by a call to setBindVariables(Map), as well as any values the user has entered themselves when prompted in the course of testing the query.

getContext

public Context getContext()

Gets the IDE Context for the tester (can be null).

Returns:

the IDE Context, if one was not set when the tester was configured this will create a new IDE Context

setContext

public void setContext(Context ideContext)

Sets the current IDE Context.

setShowConnectionPicker

public void setShowConnectionPicker(boolean showPicker)

By default the tester shows a connection picker that allows the user to choose and change the connection that the query is tested against. This method can be used to suppress the showing of this picker.

Parameters:

showPicker - whether to show or hide the connection picker in the tester.

getDefaultConnectionStore

public java.lang.String getDefaultConnectionStore()

Gets the default connection store to use in the tester (if set).

Returns:

the name of the default connection store.

setDefaultConnectionStore

public void setDefaultConnectionStore(java.lang.String storeName)

Sets a default connection store that should be used when dealing with connection names.

Parameters:

storeName - the default store name.

showDialog

public SQLQueryTester.Result showDialog(java.awt.Component owner,
                                        java.lang.String sqlText)

Shows the tester dialog with the given owner component, to test the given query. The dialog automatically tests the query against a database if one is available. The user can always create or select a different database connection. The result of the last test is returned.

Parameters:

owner - the component (e.g. Button) that is firing the tester

sqlText - the query to test

Returns:

the result of the last test done by the dialog against a database. This can be null if no test was performed (e.g. user cancelled, no database connection exists etc).

setSQLText

@Deprecated
public void setSQLText(java.lang.String txt)

Deprecated.

Changes the query that is being tested in the current dialog

Parameters:

txt - the new query text

registerComponent

@Deprecated
public static void registerComponent(java.lang.Class<? extends TesterComponent> clz)

Deprecated. use the trigger hook <database-hook>, specifically the <sql-tester-components> element.