oracle.jdeveloper.db.navigator

Class DatabaseNavigatorHelper

java.lang.Object

oracle.jdeveloper.db.navigator.DatabaseNavigatorHelper

public class DatabaseNavigatorHelper
extends java.lang.Object

Set of helper methods for JDeveloper code to use to integrate with the Database Navigator. Using this wrapper makes absorbing API changes from SQLDeveloper easier to manage.

Since:

11

Constructor Summary

Constructors

Constructor and Description
DatabaseNavigatorHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static DatabaseNode	findConnectionNode(Database db) Gets the node in the Database Navigator that respresents the given database.
static DatabaseNode	findConnectionNode(java.lang.String storeName, java.lang.String connName) Finds the connection node in the database navigator for the given store name and connection name.
static DBObjectNode	findObjectNode(Database db, SystemObject obj) Gets the node in the Database Navigator for the given object within the given Database.
static DBObjectTypeNode	findTypeNode(Database db, Schema schema, java.lang.String type) Gets the given type folder in the Database Navigator (e.g.
static NavigatorManager	getDatabaseNavigatorManager() Deprecated. The Database Navigator no longer has a manager instance of the IDE's NavigatorManager. Use getDatabaseNavigatorWindow() or getDatabaseNavigatorViewID() instead.
static ViewId	getDatabaseNavigatorViewID() Gets the default ViewId for the database navigator.
static DockableWindow	getDatabaseNavigatorWindow() Gets the DockableWindow that is the Database Navigator.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseNavigatorHelper

public DatabaseNavigatorHelper()

Method Detail

getDatabaseNavigatorManager

@Deprecated
public static NavigatorManager getDatabaseNavigatorManager()

Deprecated. The Database Navigator no longer has a manager instance of the IDE's NavigatorManager. Use getDatabaseNavigatorWindow() or getDatabaseNavigatorViewID() instead.

Throws:

java.lang.UnsupportedOperationException - every time it is called

getDatabaseNavigatorWindow

public static DockableWindow getDatabaseNavigatorWindow()

Gets the DockableWindow that is the Database Navigator.

Returns:

the dbnav window

getDatabaseNavigatorViewID

public static ViewId getDatabaseNavigatorViewID()

Gets the default ViewId for the database navigator.

Returns:

the dbnav view id

findConnectionNode

public static DatabaseNode findConnectionNode(java.lang.String storeName,
                              java.lang.String connName)

Finds the connection node in the database navigator for the given store name and connection name. This will not create the node if it doesn't already exist.

findConnectionNode

public static DatabaseNode findConnectionNode(Database db)

Gets the node in the Database Navigator that respresents the given database. This will not create the node if it doesn't already exist.

findTypeNode

public static DBObjectTypeNode findTypeNode(Database db,
                            Schema schema,
                            java.lang.String type)

Gets the given type folder in the Database Navigator (e.g. the "Tables" node). Note this will open the connection node (potentially firing worksheets) if the node isn't already open.

Parameters:

db - the database (connection) to look under

schema - the schema

type - the object type of folder we're looking for

Returns:

the type folder (containing all the database objects of that type)

findObjectNode

public static DBObjectNode findObjectNode(Database db,
                          SystemObject obj)

Gets the node in the Database Navigator for the given object within the given Database. Note this will open the connection node (potentially firing worksheets) if the node isn't already open.

Parameters:

db - the database the object is from

obj - the object whose node is required

Returns:

the node for the given object