oracle.javatools.db

Class SchemaObjectManager

java.lang.Object

oracle.javatools.db.CascadeManager

oracle.javatools.db.SchemaObjectManager

public class SchemaObjectManager
extends CascadeManager

This class is for internal use only. The public API is CascadeManager

Since:

10.1.3

For internal use only. Application developers should not use this

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.CascadeManager

CascadeManager.LookupCriteria, CascadeManager.NoCascadeRequiredException

Constructor Summary

Constructors

Constructor and Description
SchemaObjectManager(DBObjectProvider provider)

Method Summary

Modifier and Type	Method and Description
protected void	checkInit() By default this does nothing.
protected void	clearAllCaches()
static SystemObject[]	getDependencies(SystemObject obj, DBObjectProvider pro, boolean recurse) Deprecated. use CascadeManager.listReferencedObjects(SystemObject,boolean) on a manager instance. This method always returns an empty array.
DBObjectID[]	getReferers(DBObject obj) Deprecated. use listReferers(DBObject) - this method simply returns an empty array.
DBObjectID[]	getSchemaObjectReferers(SystemObject obj, boolean deep) Deprecated. use CascadeManager.listTopLevelReferers(oracle.javatools.db.SystemObject,boolean) this method simply returns an empty array.
protected boolean	haveRegisteredAll() Checks whether the whole provider has been loaded into the manager.
protected java.lang.String[]	listObjectTypes()
java.util.Collection<DBObjectID>	listReferers(DBObject obj) Lists all the references to the given object and its children.
protected Schema[]	listSchemas()
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).
protected boolean	needsInitialization(SystemObject obj) Returns true if the given schema object isn't built yet (i.e.
protected void	registerAllObjects() Registers all objects in the underlying DBObjectProvider with this manager.
protected void	registerDependency(SystemObject key, DBObject referer, DBObjectID referedTo) Registers a DBObject -> DBObject dependency (e.g.
void	registerObject(SystemObject obj) Register the given SystemObject with this manager.
void	registerObject(SystemObject obj, boolean loadOnly) Registers an object on the understanding that this is a load of the object, not a create or update.
protected void	setRegisterProgress(int objN, int objT, int schemaN, int schemaT, java.lang.String schemaName)
protected boolean	shouldRegister(SystemObject obj, boolean loadOnly) Online we register objects as they are loaded because all we care about is keeping our cache up-to-date (i.e.
void	unregisterObject(SystemObject obj) Unregisters the given object from the object manager.

Methods inherited from class oracle.javatools.db.CascadeManager

cascadeDelete, cascadeDelete, createIDMap, createIDSet, doCascadeDelete, findPropertyReferences, findReferers, getLogger, getProvider, includeSchemaObjects, isUnresolvedReference, listReferencedObjects, listReferencedObjects, listTopLevelReferers, listUnresolvedReferers, resolveUnresolvedReferences, resolveUnresolvedReferences

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaObjectManager

public SchemaObjectManager(DBObjectProvider provider)

Method Detail

haveRegisteredAll

protected final boolean haveRegisteredAll()

Checks whether the whole provider has been loaded into the manager.

clearAllCaches

protected void clearAllCaches()

registerObject

public void registerObject(SystemObject obj)

Register the given SystemObject with this manager. The object must have valid IDs setup. If this manager isn't initialised yet (i.e. hasn't parsed the whole provider) then nothing will be done as this object will be registered when that is first done.

registerObject

public void registerObject(SystemObject obj,
                           boolean loadOnly)

Registers an object on the understanding that this is a load of the object, not a create or update.

See Also:

registerObject(SystemObject)

shouldRegister

protected boolean shouldRegister(SystemObject obj,
                                 boolean loadOnly)

Online we register objects as they are loaded because all we care about is keeping our cache up-to-date (i.e. the objects we've already looked at). The database will sort itself out.

needsInitialization

protected final boolean needsInitialization(SystemObject obj)

Returns true if the given schema object isn't built yet (i.e. is waiting to be lazy loaded).

unregisterObject

public void unregisterObject(SystemObject obj)

Unregisters the given object from the object manager.

getSchemaObjectReferers

@Deprecated
public DBObjectID[] getSchemaObjectReferers(SystemObject obj,
                                                        boolean deep)

Deprecated. use CascadeManager.listTopLevelReferers(oracle.javatools.db.SystemObject,boolean) this method simply returns an empty array.

listTopLevelReferers

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

Description copied from class: CascadeManager

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.

Specified by:

listTopLevelReferers in class CascadeManager

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.

getReferers

@Deprecated
public DBObjectID[] getReferers(DBObject obj)

Deprecated. use listReferers(DBObject) - this method simply returns an empty array.

listReferers

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

Lists all the references to the given object and its children.

Specified by:

listReferers in class CascadeManager

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.

registerDependency

protected void registerDependency(SystemObject key,
                                  DBObject referer,
                                  DBObjectID referedTo)

Registers a DBObject -> DBObject dependency (e.g. PK depended on by FK).

Parameters:

key - the top level SystemObject

referer - the DBObject that holds the reference property

referedTo - the reference property value

checkInit

protected void checkInit()
                  throws CancelledException

By default this does nothing. The expectation for a live database is that the SchemaObjectManager maintains a track of the references only for the objects that have been loaded into memory. That way it can be used to invalidate the cache of any object whose dependency is changed.

Throws:

CancelledException

registerAllObjects

protected final void registerAllObjects()
                                 throws CancelledException

Registers all objects in the underlying DBObjectProvider with this manager.

Throws:

CancelledException

listObjectTypes

protected java.lang.String[] listObjectTypes()

listSchemas

protected Schema[] listSchemas()
                        throws DBException

Throws:

DBException

setRegisterProgress

protected void setRegisterProgress(int objN,
                                   int objT,
                                   int schemaN,
                                   int schemaT,
                                   java.lang.String schemaName)
                            throws CancelledException

Throws:

CancelledException

getDependencies

@Deprecated
public static final SystemObject[] getDependencies(SystemObject obj,
                                                               DBObjectProvider pro,
                                                               boolean recurse)

Deprecated. use CascadeManager.listReferencedObjects(SystemObject,boolean) on a manager instance. This method always returns an empty array.