oracle.javatools.db

Interface DBObjectID

All Superinterfaces:

Copyable

All Known Subinterfaces:

ColumnConstraintReferenceID, DBReferenceID

All Known Implementing Classes:

AbstractDBObjectID, BaseObjectID, ConstraintID, DataTypeID, IdentifierBasedID, NameBasedID, NameBasedRefID, OfflineDBObjectID, ReferenceID, SQLFragmentID, TemporaryObjectID

public interface DBObjectID
extends Copyable

Interface representing an immutable object ID for a DBObject. DBObjectID instances are used to provide a reference between different DBObjects. For example, a Foreign Key can refer to the referenced relation through the DBObjectID instead of the relation directly. Because the DBObjectIDs are independent of the actual object, they provide a reliable level of indirection.

Since:

9.0.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNSPECIFIED_TYPE Fake object type used for ids that identify an object but the type is not known.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(DBObjectID id, boolean strict) Whether the specified id is equivalent to this id.
DBObjectID	getParent() Retrieves the parent for this id if it has one.
java.lang.String	getType() Retrieves the type of object referenced by this id.
DBObject	resolveID() Resolves the id into the object referenced.

Methods inherited from interface oracle.javatools.util.Copyable

copyTo

Field Detail

UNSPECIFIED_TYPE

static final java.lang.String UNSPECIFIED_TYPE

Fake object type used for ids that identify an object but the type is not known. For example the DBObjectID for a Synonym's reference property might only contain the name information if that is all that's stored in the database dictionary.

See Also:

getType(), Constant Field Values

Method Detail

equals

boolean equals(DBObjectID id,
             boolean strict)

Whether the specified id is equivalent to this id. A strict comparison checks that the ids are identifying exactly the same object. A non-strict comparison varies by implementation, but basically checks whether the object identified has the same basic details (e.g name/type and name/type of parent).

Parameters:

id - the DBObjectID being checked for equality

strict - whether a strict definition of equality should be used.

Returns:

whether the id is equal to this

getType

java.lang.String getType()

Retrieves the type of object referenced by this id.

Returns:

the type of object

See Also:

DBObject.getType()

resolveID

DBObject resolveID()
                   throws DBException

Resolves the id into the object referenced. Not all DBObjectIDs will resolve, this can return null if the id definition is incomplete, or if the object referenced cannot be found.

Returns:

the DBObject referenced by this DBObjectID

Throws:

DBException

getParent

DBObjectID getParent()

Retrieves the parent for this id if it has one. Can return null.