oracle.jdeveloper.db.dependency

Class DBObjectDeclarationFactory.DeclarationHelper<T extends DBObjectProvider>

java.lang.Object

oracle.jdeveloper.db.dependency.DBObjectDeclarationFactory.DeclarationHelper<T>

Enclosing class:

DBObjectDeclarationFactory

public abstract static class DBObjectDeclarationFactory.DeclarationHelper<T extends DBObjectProvider>
extends java.lang.Object

A DeclarationHelper is repsonsible for uniquely identifying a given type of DBObjectProvider. A single DeclarationHelper must be registered with the factory for every DBObjectProvider implementation that requires support in the IDE dependency framework.

Constructor Summary

Constructors

Constructor and Description
DeclarationHelper()

Method Summary

Modifier and Type	Method and Description
T	findProvider(java.lang.String id, Context context) Deprecated. replaced by #fromString(String,Context)
java.util.Collection<? extends DBObjectProvider>	findReferenceProviders(T pro, Scope scope) Find any DBObjectProviders in scope that could contain references to objects in the given provider.
abstract java.lang.Object	fromString(java.lang.String id) Create a DBObjectProvider identifier from the given id String that was created by toString(Object).
Project	getProject(T pro, Context context) Gets the Project that the given provider is in, or null if the provider doesn't belong to a Project.
java.lang.Class<T>	getProviderClass() Deprecated. replaced by getProviderType()
abstract java.lang.String	getProviderType() Gets the provider type that this helper if for.
java.lang.String	toString(DBObjectProvider pro) Deprecated. replaced by #toString(DBObjectProviderID)
abstract java.lang.String	toString(java.lang.Object ident) Creates a unique identifying String for the DBObjectProvider that is represented by the given identifier that we can use in a DBObjectDeclaration identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclarationHelper

public DeclarationHelper()

Method Detail

getProviderType

public abstract java.lang.String getProviderType()

Gets the provider type that this helper if for.

Returns:

the provider type this helper processes

fromString

public abstract java.lang.Object fromString(java.lang.String id)

Create a DBObjectProvider identifier from the given id String that was created by toString(Object).

Parameters:

id - the delcaration identifier string created by toString.

toString

public abstract java.lang.String toString(java.lang.Object ident)

Creates a unique identifying String for the DBObjectProvider that is represented by the given identifier that we can use in a DBObjectDeclaration identifier. The returned String must not contain the "double colon" separator used by the factory - i.e. "::"

findReferenceProviders

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

Find any DBObjectProviders in scope that could contain references to objects in the given provider. If pro itself is in scope it should be included.

Throws:

java.lang.InterruptedException

getProject

public Project getProject(T 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.

getProviderClass

@Deprecated
public java.lang.Class<T> getProviderClass()

Deprecated. replaced by getProviderType()

toString

@Deprecated
public java.lang.String toString(DBObjectProvider pro)

Deprecated. replaced by #toString(DBObjectProviderID)

findProvider

@Deprecated
public T findProvider(java.lang.String id,
                                  Context context)

Deprecated. replaced by #fromString(String,Context)