org.apache.derby.catalog
Interface DependableFinder

All Known Implementing Classes:

DDdependableFinder

public interface DependableFinder

A DependableFinder is an object that can find an in-memory Dependable, given the Dependable's ID.

The DependableFinder is able to write itself to disk and, once read back into memory, locate the in-memory Dependable that it represents.

DependableFinder objects are stored in SYS.SYSDEPENDS to record dependencies between database objects.

Method Summary

Dependable	getDependable(java.lang.String dependableObjectID) Get the in-memory object associated with the passed-in object ID.
Dependable	getDependable(UUID dependableObjectID) Get the in-memory object associated with the passed-in object ID.
java.lang.String	getSQLObjectName(java.lang.String idString) Get the name of the SQL Object that corresponds to the specified UUID String.
java.lang.String	getSQLObjectType() The name of the class of Dependables as a "SQL Object" which this Finder can find.

Method Detail

getDependable

public Dependable getDependable(UUID dependableObjectID)
                         throws java.sql.SQLException

Get the in-memory object associated with the passed-in object ID.

Parameters:

dependableObjectID - the ID of a Dependable. Used to locate that Dependable.

Returns:

the associated Dependable

Throws:

java.sql.SQLException - thrown on error

getDependable

public Dependable getDependable(java.lang.String dependableObjectID)
                         throws java.sql.SQLException

Get the in-memory object associated with the passed-in object ID.

Parameters:

dependableObjectID - the UUID of the Dependable as a String. Used to locate that Dependable

Returns:

the associated Dependable

Throws:

java.sql.SQLException - thrown on error

getSQLObjectType

public java.lang.String getSQLObjectType()

The name of the class of Dependables as a "SQL Object" which this Finder can find. This is a value like "Table", "View", or "Publication". Every DependableFinder can find some class of Dependables.

Returns:

String type of the "SQL Object" which this Finder can find.

See Also:

Dependable

getSQLObjectName

public java.lang.String getSQLObjectName(java.lang.String idString)
                                  throws java.sql.SQLException

Get the name of the SQL Object that corresponds to the specified UUID String. For example, if getSQLObjectType() returns "Table", this will return the table name.

Parameters:

idString - the UUID String of a Dependable. Used to locate that Dependable.

Returns:

String Name of the associated Dependable

Throws:

java.sql.SQLException - thrown on error