oracle.javatools.db

Class IdentifierBasedID

java.lang.Object

oracle.javatools.db.AbstractDBObjectID

oracle.javatools.db.BaseObjectID

oracle.javatools.db.IdentifierBasedID

All Implemented Interfaces:

DBObjectID, Copyable

Direct Known Subclasses:

OfflineDBObjectID, SQLFragmentID

public class IdentifierBasedID
extends BaseObjectID

The representation of an Object ID for an object in a provider that can be uniquely identified by an identifier (other than name).

Previously (9.0.5.1 - 10.1.3) this was oracle.javatools.db.ora.TopLevelObjectID.

Since:

11.0

Field Summary

Fields inherited from class oracle.javatools.db.BaseObjectID

SEP

Fields inherited from interface oracle.javatools.db.DBObjectID

UNSPECIFIED_TYPE

Constructor Summary

Constructors

Constructor and Description
IdentifierBasedID()
IdentifierBasedID(DBObject obj, java.lang.Object identifier, AbstractDBObjectProvider pro)
IdentifierBasedID(java.lang.String type, java.lang.Object identifier)
IdentifierBasedID(java.lang.String type, java.lang.Object identifier, AbstractDBObjectProvider pro)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canEquateWithNullParent(DBObjectID other) Tests whether this ID can equate to the given other id if the other id has no parent itself.
void	construct(java.lang.String id) INTERNAL USE ONLY Constructs the ID from the information in the string parameter.
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(IdentifierBasedID target)
protected boolean	equalsImpl(DBObjectID id, boolean strict) Subclasses should implement as appropriate to their equals implementation, calling AbstractDBObjectID.equalsImpl(AbstractDBObjectID) when appropriate.
java.lang.Object	getIdentifier() Gets the ID (identifier) that this ID is using.
DBObject	resolveID() Resolves the id into the object referenced.
void	setIdentifier(java.lang.Object id) Sets the ID (identifier) that this ID is using.
protected java.lang.String	toStringImpl()

Methods inherited from class oracle.javatools.db.BaseObjectID

clearToString, copyToImpl, copyWithNewProvider, createFromString, equalsImpl, getDatabaseName, getName, getProvider, getSchemaName, hasSameObjectName, hasSameProvider, isRecognizedType, resolveFromProvider, resolveInParentObject, setDatabaseName, setName, setParent, setProvider, setProviderImpl, setSchema, setSchemaName, toString

Methods inherited from class oracle.javatools.db.AbstractDBObjectID

copyToImpl, copyWithNewType, equals, equals, equalsImpl, getParent, getType, hashCode, hasSameParent, resolveFromParent, setType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IdentifierBasedID

public IdentifierBasedID()

IdentifierBasedID

public IdentifierBasedID(java.lang.String type,
                 java.lang.Object identifier)

IdentifierBasedID

public IdentifierBasedID(java.lang.String type,
                 java.lang.Object identifier,
                 AbstractDBObjectProvider pro)

IdentifierBasedID

public IdentifierBasedID(DBObject obj,
                 java.lang.Object identifier,
                 AbstractDBObjectProvider pro)

Method Detail

construct

public void construct(java.lang.String id)

INTERNAL USE ONLY Constructs the ID from the information in the string parameter. API users should use the createFromString method in BaseObjectID.

Specified by:

construct in class BaseObjectID

Parameters:

id - The ID in string form.

For internal use only. Application developers should not use this

equalsImpl

protected boolean equalsImpl(DBObjectID id,
                 boolean strict)

Description copied from class: AbstractDBObjectID

Subclasses should implement as appropriate to their equals implementation, calling AbstractDBObjectID.equalsImpl(AbstractDBObjectID) when appropriate.

Specified by:

equalsImpl in class AbstractDBObjectID

getIdentifier

public final java.lang.Object getIdentifier()

Gets the ID (identifier) that this ID is using.

setIdentifier

public final void setIdentifier(java.lang.Object id)

Sets the ID (identifier) that this ID is using.

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected void copyToImpl(IdentifierBasedID target)

toStringImpl

protected java.lang.String toStringImpl()

Specified by:

toStringImpl in class BaseObjectID

canEquateWithNullParent

protected boolean canEquateWithNullParent(DBObjectID other)

Description copied from class: AbstractDBObjectID

Tests whether this ID can equate to the given other id if the other id has no parent itself. This will only be called if the two IDs have equated using equalsImpl.

Overrides:

canEquateWithNullParent in class AbstractDBObjectID

resolveID

public DBObject resolveID()
                   throws DBException

Description copied from interface: DBObjectID

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.

Specified by:

resolveID in interface DBObjectID

Overrides:

resolveID in class BaseObjectID

Returns:

the DBObject referenced by this DBObjectID

Throws:

DBException