oracle.ide.db.panels.sql

Class SQLQueryEditDialog

java.lang.Object

oracle.ide.db.panels.sql.SQLQueryEditDialog

All Implemented Interfaces:

java.util.Comparator

public final class SQLQueryEditDialog
extends java.lang.Object
implements java.util.Comparator

Dialog launcher for editing SQL queries.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HELP_CONNECTBY_INFO
static java.lang.String	HELP_FROM_INFO
static java.lang.String	HELP_GROUPBY_INFO
static java.lang.String	HELP_HAVING_INFO
static java.lang.String	HELP_ORDERBY_INFO
static java.lang.String	HELP_PICKER
static java.lang.String	HELP_QUERY_INFO
static java.lang.String	HELP_SELECT_INFO
static java.lang.String	HELP_WHERE_INFO

Constructor Summary

Constructors

Constructor and Description
SQLQueryEditDialog() Creates a new launcher for an edit dialog for sql queries.
SQLQueryEditDialog(boolean noOrderBy) Creates a new launcher for an edit dialog for sql queries.

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.Object o1, java.lang.Object o2) Dummy Comparator implementation that always returns equal.
Namespace	createNamespace(SQLQuery query, DBObjectProvider provider, Schema defaultSchema) Creates a Namespace suitable for using as the basis of the Traversable mechanism when entering and exiting the sql query edit panels.
SQLQuery	editQuery(SQLQuery query, DBObjectProvider provider, Schema defaultSchema) Edits the given query.
SQLQuery	editQuery(SQLQuery query, SQLFragment defaultObject, DBObjectProvider provider, Schema defaultSchema) Edits the given query.
java.lang.String	editQuery(java.lang.String sqlText, DBObjectProvider provider, Schema defaultSchema) Edits the given query sql text.
Navigable	getMasterNavigable() Returns a master Navigable object that has all the required child naviagables for editing a query.
Navigable[]	getNavigables() Returns a set of Navigable objects for the pages required to edit a SQLQuery.
static java.lang.String[]	getStartPage(SQLFragment child, boolean incMaster) Returns the appropriate start page path for editing the given child of a query.
Step[]	getSteps() Returns a set of Step objects for the pages required to creating a SQLQuery.
static boolean	isAvailable(DBObjectProvider pro) Returns true if the SQLQueryEditDialog support the given provider.
static DBEditorConfig	newDefaultEditorConfig(DBObjectProvider pro, SQLQuery query) Creates a DBEditorConfig that can be put in the Namespace to edit a given query.
void	setBindVariables(java.util.Collection<java.lang.String> bindVars) Sets a list of the bind variables named in the query.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

HELP_PICKER

public static final java.lang.String HELP_PICKER

See Also:

Constant Field Values

HELP_SELECT_INFO

public static final java.lang.String HELP_SELECT_INFO

See Also:

Constant Field Values

HELP_FROM_INFO

public static final java.lang.String HELP_FROM_INFO

See Also:

Constant Field Values

HELP_WHERE_INFO

public static final java.lang.String HELP_WHERE_INFO

See Also:

Constant Field Values

HELP_GROUPBY_INFO

public static final java.lang.String HELP_GROUPBY_INFO

See Also:

Constant Field Values

HELP_HAVING_INFO

public static final java.lang.String HELP_HAVING_INFO

See Also:

Constant Field Values

HELP_ORDERBY_INFO

public static final java.lang.String HELP_ORDERBY_INFO

See Also:

Constant Field Values

HELP_CONNECTBY_INFO

public static final java.lang.String HELP_CONNECTBY_INFO

See Also:

Constant Field Values

HELP_QUERY_INFO

public static final java.lang.String HELP_QUERY_INFO

See Also:

Constant Field Values

Constructor Detail

SQLQueryEditDialog

public SQLQueryEditDialog()

Creates a new launcher for an edit dialog for sql queries.

SQLQueryEditDialog

public SQLQueryEditDialog(boolean noOrderBy)

Creates a new launcher for an edit dialog for sql queries.

Parameters:

materializedView - if true, the order by panel will not be included

Method Detail

getNavigables

public Navigable[] getNavigables()

Returns a set of Navigable objects for the pages required to edit a SQLQuery. If you use the Navigables in your own dialog, please ensure that the Namespace used is created using createNamespace(oracle.javatools.db.sql.SQLQuery, oracle.javatools.db.DBObjectProvider, oracle.javatools.db.Schema).

setBindVariables

public void setBindVariables(java.util.Collection<java.lang.String> bindVars)

Sets a list of the bind variables named in the query.

getMasterNavigable

public Navigable getMasterNavigable()

Returns a master Navigable object that has all the required child naviagables for editing a query.

getSteps

public Step[] getSteps()

Returns a set of Step objects for the pages required to creating a SQLQuery. If you use the Steps in your own wizard, please ensure that the Namespace used is created using createNamespace(oracle.javatools.db.sql.SQLQuery, oracle.javatools.db.DBObjectProvider, oracle.javatools.db.Schema).

editQuery

public java.lang.String editQuery(java.lang.String sqlText,
                                  DBObjectProvider provider,
                                  Schema defaultSchema)

Edits the given query sql text. Throws a SQLQueryException if the query text does not parse as a valid SQL query.

Parameters:

sqlText - the query text to edit

provider - the provider to use

defaultSchema - the default schema for the query (can be null).

Returns:

String the edited query or null, if the user cancelled the edit

editQuery

public SQLQuery editQuery(SQLQuery query,
                          DBObjectProvider provider,
                          Schema defaultSchema)

Edits the given query. Throws a SQLQueryException if the query text does not parse as a valid SQL query.

Parameters:

query - the query to edit

provider - the provider to use

defaultSchema - the default schema for the query.

Returns:

the edited query

editQuery

public SQLQuery editQuery(SQLQuery query,
                          SQLFragment defaultObject,
                          DBObjectProvider provider,
                          Schema defaultSchema)

Edits the given query.

Parameters:

query - the query to edit

defaultObject - the default object within the query to start the edit with

provider - the provider to use

defaultSchema - the default schema for the query

Returns:

the edited query or null, if the user cancelled the edit

createNamespace

public Namespace createNamespace(SQLQuery query,
                                 DBObjectProvider provider,
                                 Schema defaultSchema)

Creates a Namespace suitable for using as the basis of the Traversable mechanism when entering and exiting the sql query edit panels.

Parameters:

query - the query being edited

provider - the provider the query is in

defaultSchema - the default schema in the provider for the query

Returns:

a Namespace suitable for traversing the sql query Navigables

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

Dummy Comparator implementation that always returns equal.

Specified by:

compare in interface java.util.Comparator

newDefaultEditorConfig

public static final DBEditorConfig newDefaultEditorConfig(DBObjectProvider pro,
                                                          SQLQuery query)

Creates a DBEditorConfig that can be put in the Namespace to edit a given query.

getStartPage

public static final java.lang.String[] getStartPage(SQLFragment child,
                                                    boolean incMaster)

Returns the appropriate start page path for editing the given child of a query. Supports SelectObject, FromObject, WhereObject, GroupByObject and OrderByObject.

Parameters:

child - the child of the query whose page we require.

incMaster - whether the master panel is inculded in the path.

isAvailable

public static boolean isAvailable(DBObjectProvider pro)

Returns true if the SQLQueryEditDialog support the given provider. This tests whether the API has a SQLQueryBuilderFactory for the given provider.