oracle.javatools.db

Class CascadeManager

java.lang.Object

oracle.javatools.db.CascadeManager

Direct Known Subclasses:

SchemaObjectManager

public abstract class CascadeManager
extends java.lang.Object

Provides facilities for listing references between DBObjects in a DBObjectProvider, and provides cascade logic for cascading delete of an object.

The cascade manager interface supports the concept of "unresolved references" which are references in the model that don't resolve to a real object.

Since 12.1.3 any potentially long running methods in this class were changed to specifically throw a CancelledException to cope with the user cancelling long running processes.

Since:

11.1.2.0.0

See Also:

DBObjectProvider.getCascadeManager()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CascadeManager.LookupCriteria Used to customise the lookup of references or referers through the CascadeManager.
static class	CascadeManager.NoCascadeRequiredException Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CascadeManager(DBObjectProvider pro)

Method Summary

Methods

Modifier and Type	Method and Description
SystemObject	cascadeDelete(DBObject deleted, SystemObject referer) Deprecated. - cascade is automatic in providers that support it
SystemObject	cascadeDelete(DBObject deleted, SystemObject referer, boolean copyIfCascadeRequired) Deprecated. - cascade is automatic in providers that support it
protected <T> java.util.Map<DBObjectID,T>	createIDMap()
protected java.util.Set<DBObjectID>	createIDSet()
void	doCascadeDelete(SystemObject deleted, SystemObject referer) Deprecated. - cascade is automatic in providers that support it
java.util.Map<PropertyInfo,java.lang.Object>	findPropertyReferences(DBObject obj, DBObjectID reference) Finds the property/properties that reference the given ID on the given object.
java.util.Collection<DBObjectID>	findReferers(DBObject obj, DBObjectID to, java.util.Collection<DBObjectID> refdBy, boolean topLevel) Recursively builds up referers to the given object.
protected java.util.logging.Logger	getLogger()
protected DBObjectProvider	getProvider()
boolean	isUnresolvedReference(DBObjectID id) Returns true if the given id is an "unresolved reference".
java.util.Collection<SystemObject>	listReferencedObjects(SystemObject obj, boolean recurse) Returns the SystemObjects that this SystemObject, or any of its children, are dependent on (reference).
java.util.Collection<SystemObject>	listReferencedObjects(SystemObject obj, CascadeManager.LookupCriteria criteria) Returns the SystemObjects that this SystemObject, or any of its children, are dependent on (reference).
abstract java.util.Collection<DBObjectID>	listReferers(DBObject obj) Gets the ids of the DBObjects who directly reference the given object.
java.util.Collection<DBObjectID>	listTopLevelReferers(SystemObject obj, boolean deep) Gets the ids for the SystemObjects who reference (either directly or via their children) the given SystemObject (or one of its children).
abstract java.util.Collection<DBObjectID>	listTopLevelReferers(SystemObject obj, CascadeManager.LookupCriteria criteria) Gets the ids for the SystemObjects who reference (either directly or via their children) the given SystemObject (or one of its children).
java.util.Collection<Difference>	resolveUnresolvedReferences(SystemObject obj) If this manager supports unresolved references and the given object could potentially fix those references then this method finds any objects that have an unresolved reference and looks to resolve it.

Methods inherited from class java.lang.Object

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

Constructor Detail

CascadeManager

protected CascadeManager(DBObjectProvider pro)

Method Detail

getProvider

protected DBObjectProvider getProvider()

listReferers

public abstract java.util.Collection<DBObjectID> listReferers(DBObject obj)
                                                       throws CancelledException

Gets the ids of the DBObjects who directly reference the given object. (e.g for a UK this would return any FKs that reference it). Any references to children of this object are automatically included.

Parameters:

obj - the object being referenced (e.g. a PK)

Returns:

the ids of any objects directly referencing the given object

Throws:

CancelledException - if the lookup is cancelled while executing.

listTopLevelReferers

public final java.util.Collection<DBObjectID> listTopLevelReferers(SystemObject obj,
                                                    boolean deep)
                                                            throws CancelledException

Gets the ids for the SystemObjects who reference (either directly or via their children) the given SystemObject (or one of its children).

For example for a Table this would return any Tables, Views or Synonyms (etc) that reference it via FKs, ColumnUsages or Object references).

The referers will not contain the given object, even if it has internal references (e.g. a PK referencing its own Columns). The references are all external.

Parameters:

obj - the object to search for references to

deep - whether to traverse references to the referers etc.

Returns:

the ids of top level objects that reference the given object

Throws:

CancelledException - if the lookup is cancelled while executing.

listTopLevelReferers

public abstract java.util.Collection<DBObjectID> listTopLevelReferers(SystemObject obj,
                                                    CascadeManager.LookupCriteria criteria)
                                                               throws CancelledException

Gets the ids for the SystemObjects who reference (either directly or via their children) the given SystemObject (or one of its children).

For example for a Table this would return any Tables, Views or Synonyms (etc) that reference it via FKs, ColumnUsages or Object references).

The referers will not contain the given object, even if it has internal references (e.g. a PK referencing its own Columns). The references are all external.

Parameters:

obj - the object to lookup references to

criteria - restrictions on the lookup

Returns:

the ids of top level objects that reference the given object

Throws:

CancelledException - if the lookup is cancelled while executing.

cascadeDelete

@Deprecated
public SystemObject cascadeDelete(DBObject deleted,
                                    SystemObject referer)
                           throws CascadeManager.NoCascadeRequiredException

Deprecated. - cascade is automatic in providers that support it

Throws:

CascadeManager.NoCascadeRequiredException

cascadeDelete

@Deprecated
public SystemObject cascadeDelete(DBObject deleted,
                                    SystemObject referer,
                                    boolean copyIfCascadeRequired)
                           throws CascadeManager.NoCascadeRequiredException

Deprecated. - cascade is automatic in providers that support it

Throws:

CascadeManager.NoCascadeRequiredException

doCascadeDelete

@Deprecated
public void doCascadeDelete(SystemObject deleted,
                              SystemObject referer)
                     throws DBException

Deprecated. - cascade is automatic in providers that support it

Throws:

DBException

listReferencedObjects

public java.util.Collection<SystemObject> listReferencedObjects(SystemObject obj,
                                                       boolean recurse)
                                                         throws CancelledException

Returns the SystemObjects that this SystemObject, or any of its children, are dependent on (reference). Optionally recurses to include the dependencies of the dependencies, and so on.

Parameters:

obj - the object to look for references from

recurse - whether to look for references from the references etc

Returns:

the referenced objects

Throws:

CancelledException - if the lookup is cancelled while executing.

listReferencedObjects

public java.util.Collection<SystemObject> listReferencedObjects(SystemObject obj,
                                                       CascadeManager.LookupCriteria criteria)
                                                         throws CancelledException

Returns the SystemObjects that this SystemObject, or any of its children, are dependent on (reference). Optionally recurses to include the dependencies of the dependencies, and so on.

Parameters:

obj - the object to look for references from

criteria - restrictions on the lookup

Returns:

the referenced objects

Throws:

CancelledException - if the lookup is cancelled while executing.

isUnresolvedReference

public boolean isUnresolvedReference(DBObjectID id)

Returns true if the given id is an "unresolved reference". Subclasses should override as appropriate if they support unresolved references, the default implementation doesn't and will always return false.

resolveUnresolvedReferences

public java.util.Collection<Difference> resolveUnresolvedReferences(SystemObject obj)
                                                             throws CancelledException

If this manager supports unresolved references and the given object could potentially fix those references then this method finds any objects that have an unresolved reference and looks to resolve it. Any objects that are can have their unresolved references resolved are copied, updated and differenced.

Parameters:

obj - the object that is being created and could potentially resolve unresolved references.

Returns:

a collection containing Differences for each object that has unresolved references resolved by the incoming object. The collection might be empty, but will not be null.

Throws:

CancelledException - if the lookup is cancelled while executing.

getLogger

protected final java.util.logging.Logger getLogger()

createIDSet

protected java.util.Set<DBObjectID> createIDSet()

createIDMap

protected <T> java.util.Map<DBObjectID,T> createIDMap()

findPropertyReferences

public final java.util.Map<PropertyInfo,java.lang.Object> findPropertyReferences(DBObject obj,
                                                                  DBObjectID reference)

Finds the property/properties that reference the given ID on the given object. Can return null if there are no matching reference properties.

findReferers

public final java.util.Collection<DBObjectID> findReferers(DBObject obj,
                                            DBObjectID to,
                                            java.util.Collection<DBObjectID> refdBy,
                                            boolean topLevel)
                                                    throws CancelledException

Recursively builds up referers to the given object. By searching the given object and its children. Can return null.

Parameters:

obj - the object to look for references from

to - the object we're finding references to

refdBy - the references we've already found (to include in the returned list)

topLevel - whether to only record top level references

Returns:

a list of found references, or null if there are none.

Throws:

CancelledException - if the lookup is cancelled while executing.