Top Description Fields Constructors Methods
org.apache.derby.impl.sql.catalog

public Class DDdependableFinder

extends Object
implements DependableFinder, Formatable
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.services.io.Formatable, org.apache.derby.iapi.services.io.TypedFormat, java.io.Externalizable, java.io.Serializable, org.apache.derby.catalog.DependableFinder
Known Direct Subclasses
org.apache.derby.impl.sql.catalog.DDColumnDependableFinder
Imports
java.io.IOException, .ObjectInput, .ObjectOutput, org.apache.derby.catalog.Dependable, .DependableFinder, .UUID, org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.reference.SQLState, org.apache.derby.iapi.services.io.Formatable, .StoredFormatIds, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.dictionary.ColumnDescriptor, .DataDictionary, .DefaultDescriptor
Class for most DependableFinders in the core DataDictionary. This class is stored in SYSDEPENDS for the finders for the provider and dependent. It stores no state, its functionality is driven off its format identifier.

Field Summary

Modifier and TypeField and Description
private final int
formatId

Constructor Summary

AccessConstructor and Description
public
DDdependableFinder(int formatId)

Public constructor for Formatable hoo-hah.

Method Summary

Modifier and TypeMethod and Description
pack-priv Dependable
findDependable(DataDictionary dd, UUID dependableObjectID)

Find the dependable for getDependable.

public final Dependable
getDependable(DataDictionary
DataDictionary to use for lookup.
dd, UUID
the ID of a Dependable. Used to locate that Dependable.
dependableObjectID)

Implements org.apache.derby.catalog.DependableFinder.getDependable.

Get the dependable for the given UUID

public String
getSQLObjectType()

Implements org.apache.derby.catalog.DependableFinder.getSQLObjectType.

The name of the class of Dependables as a "SQL Object" which this Finder can find.

public final int

Returns:

the formatID of this class
getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

public void
readExternal(ObjectInput
read this.
in)

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
writeExternal(ObjectOutput
write bytes here.
out)

Implements java.io.Externalizable.writeExternal.

Write this object to a stream of stored objects.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

formatIdback to summary
private final int formatId

Constructor Detail

DDdependableFinderback to summary
public DDdependableFinder(int formatId)

Public constructor for Formatable hoo-hah.

Method Detail

findDependableback to summary
pack-priv Dependable findDependable(DataDictionary dd, UUID dependableObjectID) throws StandardException

Find the dependable for getDependable. Can return a null references, in which case getDependable() will thrown an exception.

getDependableback to summary
public final Dependable getDependable(DataDictionary dd, UUID dependableObjectID) throws StandardException

Implements org.apache.derby.catalog.DependableFinder.getDependable.

Get the dependable for the given UUID

Parameters
dd:DataDictionary

Doc from org.apache.derby.catalog.DependableFinder.getDependable.

DataDictionary to use for lookup.

dependableObjectID:UUID

Doc from org.apache.derby.catalog.DependableFinder.getDependable.

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

Returns:Dependable

Doc from org.apache.derby.catalog.DependableFinder.getDependable.

the associated Dependable

Exceptions
StandardException:
thrown on error
getSQLObjectTypeback to summary
public String getSQLObjectType()

Implements org.apache.derby.catalog.DependableFinder.getSQLObjectType.

Doc from org.apache.derby.catalog.DependableFinder.getSQLObjectType.

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

Returns:String

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

See Also
DependableFinder#getSQLObjectType
getTypeFormatIdback to summary
public final int getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

Returns:int

the formatID of this class

readExternalback to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects. Nothing to do. Our persistent representation is just a 2-byte format id.

Parameters
in:ObjectInput

read this.

Exceptions
IOException:

Doc from java.io.Externalizable.readExternal.

if I/O errors occur

ClassNotFoundException:

Doc from java.io.Externalizable.readExternal.

If the class for an object being restored cannot be found.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

writeExternalback to summary
public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Write this object to a stream of stored objects. Again, nothing to do. We just stamp the output stream with our Format id.

Parameters
out:ObjectOutput

write bytes here.

Exceptions
IOException:

Doc from java.io.Externalizable.writeExternal.

Includes any I/O exceptions that may occur