oracle.jdeveloper.db.dependency

Class DBObjectDeclarationFactory

java.lang.Object

oracle.jdeveloper.db.dependency.DBObjectDeclarationFactory

public final class DBObjectDeclarationFactory
extends java.lang.Object

This factory is used to create Declaration implementations for database objects in the IDE. They are based on declaration ids - strings to be used with the IDE's IdDeclaration and IdReference.

Examples:
(Column, Table and DBObjectProvider are all in package oracle.javatools.db)

1) Create a reference to table "EMP" in schema "SCOTT" in a given DBObjectProvider (pro):

   DBObjectDeclarationFactory factory = DBObjectDeclarationFactory.getInstance();
   DBObjectDeclaration decl =
      factory.createDeclaration( pro, "SCOTT", Table.TYPE, "EMP" );
 

2) Create a reference to column "ENAME" in table "EMP" using the default schema a DBObjectProvider (pro):

   DBObjectDeclarationFactory factory = DBObjectDeclarationFactory.getInstance();
   DBObjectDeclaration decl =
     factory.createDelcaration( pro, null, Table.TYPE, "EMP", Column.TYPE, "ENAME" );
 

Since:

11.1.1.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBObjectDeclarationFactory.DeclarationHelper<T extends DBObjectProvider> A DeclarationHelper is repsonsible for uniquely identifying a given type of DBObjectProvider.

Method Summary

Methods

Modifier and Type	Method and Description
DBObjectDeclaration	createDeclaration(BaseObjectID id) Creates a new declaration to the object represented by the given ID
DBObjectDeclaration	createDeclaration(DBObjectProvider pro, java.lang.String schemaName, java.lang.String type, java.lang.String name) Creates a new declaration to an object in the given provider by schema name, type and object name.
DBObjectDeclaration	createDeclaration(DBObjectProvider pro, java.lang.String schemaName, java.lang.String type, java.lang.String name, java.lang.String childType, java.lang.String childName) Creates a new declaration to a child object in the given provider by name and type of both the child object and its parent.
DBObjectDeclaration	createDeclaration(java.lang.String declarationId) Creates a DBObjectDeclaration for the given declarationId.
java.lang.String	createDeclarationId(BaseObjectID id) Creates a unique identifier that can be used to create a DBObjectDeclaration for the given DBObjectID for a DBObject in a DBObjectProvider.
java.lang.String	createDeclarationId(DBObjectProvider pro, DBObject obj) Creates a unique identifier that can be used to create a DBObjectDeclaration to any DBObject object (e.g.
java.lang.String	createDeclarationId(DBObjectProvider pro, DBObjectID id) Creates a unique identifier that can be used to create a DBObjectDeclaration for the given DBObjectID for a DBObject in a DBObjectProvider.
java.lang.String	createDeclarationId(DBObjectProvider pro, java.lang.String schemaName, java.lang.String type, java.lang.String name) Creates a unique identifier that can be used to create a DBObjectDeclaration.
java.lang.String	createDeclarationId(DBObjectProvider pro, java.lang.String schemaName, java.lang.String type, java.lang.String name, java.lang.String childType, java.lang.String childName) Creates a unique identifier that can be used to create a DBObjectDeclaration to a child object (e.g.
DBObjectProviderDeclaration	createProviderDeclaration(DBObjectProvider pro) Creates a DBObjectProviderDeclaration to represent the given DBObjectProvider in the IDE declaration framework.
DBObjectProviderDeclaration	createProviderDeclaration(DBObjectProviderID proID) Creates a DBObjectProviderDeclaration to represent the DBObjectProvider identified by the given ID in the IDE declaration framework.
DBObjectProviderDeclaration	createProviderDeclaration(java.lang.String declarationId) Creates a DBObjectDeclaration for the given declarationId.
java.lang.String	createProviderDeclarationId(DBObjectProvider pro) Creates a unique identifier that can be used to create a DBObjectProviderDeclaration for the given DBObjectProvider.
java.lang.String	createProviderDeclarationId(DBObjectProviderID proID) Creates a unique identifier that can be used to create a DBObjectProviderDeclaration for the DBObjectProvider identified by the given ID.
java.util.Collection<? extends DBObjectProvider>	findReferenceProviders(DBObjectProvider pro, Scope scope) Finds all providers "in Scope" that can contain References to the given DBObjectProvider.
BaseObjectID	getDBObjectID(Context context, java.lang.String declarationID) Creates a BaseObjectID that will resolve to the DBObject identifier by the given declarationID.
DBObjectProvider	getDBObjectProvider(Context context, java.lang.String declarationID) Gets the DBObjectProvider for the given declaration identifier.
DBObjectProviderID	getDBObjectProviderID(Context context, java.lang.String declarationID) Gets the id for the DBObjectProvider from the given declaration identifier.
static DBObjectDeclarationFactory	getInstance()
Project	getProject(DBObjectProvider pro, Context context) Gets the Project that the given provider is in, or null if the provider doesn't belong to a Project.
void	registerHelper(DBObjectDeclarationFactory.DeclarationHelper helper) Registers a DeclarationHelper for processing a specific DBObjectProvider implementation.
boolean	supportsProvider(DBObjectProvider pro) Tests whether the given DBObjectProvider is supported by the declaration factory (and therefore the db dependency support as a whole).
boolean	supportsProviderType(java.lang.String proType) Tests whether the given type of DBObjectProvider is supported by the declaration factory (and therefore the db dependency support as a whole).
void	unregisterHelper(DBObjectDeclarationFactory.DeclarationHelper helper) Unregisters a DeclarationHelper for processing a specific DBObjectProvider implementation.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DBObjectDeclarationFactory getInstance()

createDeclaration

public DBObjectDeclaration createDeclaration(DBObjectProvider pro,
                                    java.lang.String schemaName,
                                    java.lang.String type,
                                    java.lang.String name)

Creates a new declaration to an object in the given provider by schema name, type and object name.

If the schema name is null, the default schema of the given provider will be assumed.

Parameters:

pro - the provider the object is in

schemaName - the schema the object is owned by, or null to default

type - the type of the object (e.g. oracle.javatoools.db.Table.TYPE )

name - the name of the object

Returns:

the declaration to the object with given details

createDeclaration

public DBObjectDeclaration createDeclaration(DBObjectProvider pro,
                                    java.lang.String schemaName,
                                    java.lang.String type,
                                    java.lang.String name,
                                    java.lang.String childType,
                                    java.lang.String childName)

Creates a new declaration to a child object in the given provider by name and type of both the child object and its parent.

If the schema name is null, the default schema of the given provider will be assumed.

Parameters:

pro - the provider the object is in

schemaName - the schema the object is owned by, or null to default

ownerType - the type of the owning (parent) object (e.g. oracle.javatoools.db.Table.TYPE )

ownerName - the name of the owning( parent) object

type - the type of the child object (e.g. oracle.javatools.db.Column.TYPE)

name - the name of the child object

Returns:

the declaration to the object with given details

createDeclaration

public DBObjectDeclaration createDeclaration(BaseObjectID id)

Creates a new declaration to the object represented by the given ID

Parameters:

id - the id for the object to create a declaration for

createDeclaration

public DBObjectDeclaration createDeclaration(java.lang.String declarationId)

Creates a DBObjectDeclaration for the given declarationId. The ID must be a valid declaration identifier created by the createDeclarationId methods on this factory.

Parameters:

declarationId - the unique identifier to create a declaration for

Returns:

a DBObjectDeclaration object for the given id.

createDeclarationId

public java.lang.String createDeclarationId(DBObjectProvider pro,
                                   java.lang.String schemaName,
                                   java.lang.String type,
                                   java.lang.String name)

Creates a unique identifier that can be used to create a DBObjectDeclaration. It can also be used in an Reference object to declare a reference on a DBObject.

Parameters:

pro - the provider containing the referenced object

schemaName - the name of the owning schema

type - the type of the object (e.g. Table.TYPE)

name - the name of the object

Returns:

a unique declaration identifier for the given object details

createDeclarationId

public java.lang.String createDeclarationId(DBObjectProvider pro,
                                   java.lang.String schemaName,
                                   java.lang.String type,
                                   java.lang.String name,
                                   java.lang.String childType,
                                   java.lang.String childName)

Creates a unique identifier that can be used to create a DBObjectDeclaration to a child object (e.g. a Column). It can also be used in a Reference object to declare a reference on a DBObject.

Parameters:

pro - the provider containing the referenced object

schemaName - the name of the owning schema

type - the type of the object (e.g. Table.TYPE)

name - the name of the object

childType - the type of the child object (e.g. Column.TYPE)

childName - the name of the child object to reference

Returns:

a unique declaration identifier for the given object details

createDeclarationId

public java.lang.String createDeclarationId(DBObjectProvider pro,
                                   DBObject obj)

Creates a unique identifier that can be used to create a DBObjectDeclaration to any DBObject object (e.g. a Table, Column etc). It can also be used in a Reference object to declare a reference on a DBObject.

Parameters:

pro - the provider containing the object

obj - the object to create an identifier for

Returns:

a declaration identifier for the given object

createDeclarationId

public java.lang.String createDeclarationId(BaseObjectID id)

Creates a unique identifier that can be used to create a DBObjectDeclaration for the given DBObjectID for a DBObject in a DBObjectProvider. It can also be used in a Reference object to declare a reference on a DBObject.

Parameters:

id - the BaseDBObjectID to create a declaration identifier for

createDeclarationId

public java.lang.String createDeclarationId(DBObjectProvider pro,
                                   DBObjectID id)

Creates a unique identifier that can be used to create a DBObjectDeclaration for the given DBObjectID for a DBObject in a DBObjectProvider. It can also be used in a Reference object to declare a reference on a DBObject.

Parameters:

pro - the DBObjectProvider containing the DBObject

id - the DBObjectID for the object in the provider.

getDBObjectProvider

public DBObjectProvider getDBObjectProvider(Context context,
                                   java.lang.String declarationID)

Gets the DBObjectProvider for the given declaration identifier. The declarationID should have been created by one of the createDeclarationID methods on this factory.

Parameters:

context - the IDE Context for finding the provider in

declarationID - the object (or provider) declaration identifier

Returns:

a DBObjectProvider for the given identifier.

getDBObjectProviderID

public DBObjectProviderID getDBObjectProviderID(Context context,
                                       java.lang.String declarationID)

Gets the id for the DBObjectProvider from the given declaration identifier. The declarationID should have been created by one of the createDeclarationID methods on this factory.

Parameters:

context - the IDE Context for finding the provider in

declarationID - the object (or provider) declaration identifier

Returns:

a DBObjectProviderID for the given identifier.

getDBObjectID

public BaseObjectID getDBObjectID(Context context,
                         java.lang.String declarationID)

Creates a BaseObjectID that will resolve to the DBObject identifier by the given declarationID. The declarationID should have been created by one of the createDeclarationID methods on this factory.

Parameters:

context - the IDE Context for finding the provider in

declarationID - the object declaration identifier

Returns:

a BaseObjectID for the declared object.

createProviderDeclaration

public DBObjectProviderDeclaration createProviderDeclaration(DBObjectProvider pro)

Creates a DBObjectProviderDeclaration to represent the given DBObjectProvider in the IDE declaration framework.

Parameters:

pro - the provider to represent

Returns:

a Declaration for the provider.

createProviderDeclaration

public DBObjectProviderDeclaration createProviderDeclaration(DBObjectProviderID proID)

Creates a DBObjectProviderDeclaration to represent the DBObjectProvider identified by the given ID in the IDE declaration framework.

Parameters:

pro - the provider to represent

Returns:

a Declaration for the provider.

createProviderDeclarationId

public java.lang.String createProviderDeclarationId(DBObjectProvider pro)

Creates a unique identifier that can be used to create a DBObjectProviderDeclaration for the given DBObjectProvider. It can also be used in a Reference object to reference a provider.

This declaration identifier is only useful for referencing the proider itself, not any object in that provider.

Parameters:

pro - the provider to create a declaration identifier for.

Returns:

a unqiue declaration identifier for the provider.

createProviderDeclarationId

public java.lang.String createProviderDeclarationId(DBObjectProviderID proID)

Creates a unique identifier that can be used to create a DBObjectProviderDeclaration for the DBObjectProvider identified by the given ID. It can also be used in a Reference object to reference a provider.

This declaration identifier is only useful for referencing the proider itself, not any object in that provider.

Parameters:

proID - the provider id to create a declaration identifier for.

Returns:

a unqiue declaration identifier for the provider.

createProviderDeclaration

public DBObjectProviderDeclaration createProviderDeclaration(java.lang.String declarationId)

Creates a DBObjectDeclaration for the given declarationId. The ID must be a valid declaration identifier created by the createDeclarationId methods on this factory.

Parameters:

declarationId - the unique identifier to create a declaration for

Returns:

a DBObjectDeclaration object for the given id if it is a valid provider declaration, otherwise returns null.

supportsProvider

public boolean supportsProvider(DBObjectProvider pro)

Tests whether the given DBObjectProvider is supported by the declaration factory (and therefore the db dependency support as a whole).

Parameters:

pro - the provider to test

Returns:

true if the provider is supported by the db dependency plugin

supportsProviderType

public boolean supportsProviderType(java.lang.String proType)

Tests whether the given type of DBObjectProvider is supported by the declaration factory (and therefore the db dependency support as a whole).

Parameters:

proType - the provider type to test

Returns:

true if the provider type is supported by the db dependency plugin

findReferenceProviders

public java.util.Collection<? extends DBObjectProvider> findReferenceProviders(DBObjectProvider pro,
                                                                      Scope scope)
                                                                        throws java.lang.InterruptedException

Finds all providers "in Scope" that can contain References to the given DBObjectProvider.

Parameters:

pro - the provider we want references to the objects in

scope - the scope to search for providers in

Returns:

any DBObjectProvider that can reference the given provider in Scope. This can (and should) include the given provider itself.

Throws:

java.lang.InterruptedException

getProject

public Project getProject(DBObjectProvider pro,
                 Context context)

Gets the Project that the given provider is in, or null if the provider doesn't belong to a Project.

Parameters:

pro - the provider to get the project for

context - the relevant IDE context

Returns:

the provider's containing project, or null.

registerHelper

public void registerHelper(DBObjectDeclarationFactory.DeclarationHelper helper)

Registers a DeclarationHelper for processing a specific DBObjectProvider implementation.

unregisterHelper

public void unregisterHelper(DBObjectDeclarationFactory.DeclarationHelper helper)

Unregisters a DeclarationHelper for processing a specific DBObjectProvider implementation.