oracle.javatools.db

Class TemporaryObjectID

java.lang.Object

oracle.javatools.db.TemporaryObjectID

All Implemented Interfaces:

DBObjectID, Copyable

public class TemporaryObjectID
extends java.lang.Object
implements DBObjectID

Implementation of the DBObjectID interface for objects that only exist in memory. The Object ID in this case can point directly to the object.

Since:

9.0.5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemporaryObjectID.CopyBackPolicy IDPolicy to use when copying the temp copy of an object back over its original object.
static class	TemporaryObjectID.TemporaryIDPolicy IDPolicy that creates a TemporaryObjectID for every object that has the original object set.

Field Summary

Fields inherited from interface oracle.javatools.db.DBObjectID

UNSPECIFIED_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
static DBObjectID	createID(DBObject obj) Creates a new DBObjectID pointing to a specific object.
static DBObjectID	createID(DBObject obj, DBObject original) Creates a new DBObjectID pointing to a specific object.
boolean	equals(DBObjectID other, boolean strict) Returns whether the DBObjectID other is "equal" to this id.
boolean	equals(java.lang.Object obj)
static DBObjectID	findOriginalID(TemporaryObjectID id) Finds the original most ID in the given TemporaryObjectID's "original object" heirachy.
static <T extends DBObject> T	findOriginalObject(T obj) Recursively finds the original object for the given object, if the given object is a copy with a TemporaryObjectID.
static DBObject	findOriginalObject(TemporaryObjectID id) Returns the original object's id, or null if there is no original object.
static <T extends DBObject> T	getOriginalObject(T obj) Gets the original object for the given object, if it has a TemporaryObjectID.
DBObjectID	getParent() Returns null.
java.lang.String	getType() Retrieves the type of object referenced by this id.
int	hashCode()
DBObject	resolveID() Resolves the id into the object referenced.
DBObject	resolveOriginalID() Get the original object which this temporary one was copied from.
static void	setID(DBObject obj, boolean recurse) If the given object doesn't have an ID, this sets a new TemporaryObjectID on the object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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.

Specified by:

copyTo in interface Copyable

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.

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(DBObjectID other,
             boolean strict)

Returns whether the DBObjectID other is "equal" to this id. Due to the nature of TemporaryObjectIDs the notion of "strict" is slightly looser than it is for other ids. Strict equality for TemporaryObjectID means one the following must be true:

• other is a TemporaryObjectID and one of the following is also true:
  • both ids have the same object, or the same original object.
  • this id's object is anywhere in other's original chain.
  • other's object is anywhere in this id's original chain.
  • neither id has an original object and their objects match by name/type/schema/parent.
• other equates strictly to the id of any object in this id's original object chain.
• other is NameBasedID that has matching details to the underlying object in this id.

For a non-strict equality the two ids both resolve to objects that have the same name/type/schema/parent.

Note that in order to make equals commutative there is code in AbstractDBObjectID to ensure comparison of a TemporaryObjectID and a non-TemporaryObjectID is always done by this method. If another DBObjectID subclass does not extend AbstractDBObjectID it must ensure that as well.

Specified by:

equals in interface DBObjectID

Parameters:

other - the other id to compare to this id

strict - whether to perform a strict comparison

Returns:

true if the ids are "equal"

getType

public java.lang.String getType()

Description copied from interface: DBObjectID

Retrieves the type of object referenced by this id.

Specified by:

getType in interface DBObjectID

Returns:

the type of object

See Also:

DBObject.getType()

getParent

public DBObjectID getParent()

Returns null.

Specified by:

getParent in interface DBObjectID

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

Returns:

the DBObject referenced by this DBObjectID

Throws:

DBException

resolveOriginalID

public DBObject resolveOriginalID()
                           throws DBException

Get the original object which this temporary one was copied from. Can return null if the id had no original object.

Throws:

DBException

See Also:

findOriginalObject(oracle.javatools.db.TemporaryObjectID)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

createID

public static DBObjectID createID(DBObject obj)

Creates a new DBObjectID pointing to a specific object.

Parameters:

obj - the DBObject referenced by this ID

Returns:

a DBObjectID pointing to the specified object

setID

public static void setID(DBObject obj,
         boolean recurse)

If the given object doesn't have an ID, this sets a new TemporaryObjectID on the object.

Parameters:

obj - the DBObject referenced by this ID

recurse - whether to set TemporaryObjectIDs on obj's descendents

createID

public static DBObjectID createID(DBObject obj,
                  DBObject original)

Creates a new DBObjectID pointing to a specific object.

Parameters:

obj - the DBObject referenced by this ID

original - the DBObject which has been copied to create the temporary object

Returns:

a DBObjectID pointing to the specified object

findOriginalID

public static DBObjectID findOriginalID(TemporaryObjectID id)

Finds the original most ID in the given TemporaryObjectID's "original object" heirachy. Returns null if the original most object has no ID, or has a TemporaryObjectID that has no original object.

findOriginalObject

public static DBObject findOriginalObject(TemporaryObjectID id)

Returns the original object's id, or null if there is no original object. If the original object also has a temp id then it recurses. This will therefore only return an object that is an original on a temp id, and does not have a temp id of its own.

Returns:

the original object from the (potential chain of) temporary copying.

findOriginalObject

public static <T extends DBObject> T findOriginalObject(T obj)

Recursively finds the original object for the given object, if the given object is a copy with a TemporaryObjectID. If you only want the direct original use getOriginalObject(DBObject).

Parameters:

obj - the copy to find the original for

Returns:

the original object, or null if obj is null or its id isn't a TemporaryObjectID with an original.

See Also:

findOriginalObject(TemporaryObjectID)

getOriginalObject

public static <T extends DBObject> T getOriginalObject(T obj)

Gets the original object for the given object, if it has a TemporaryObjectID. This will not recurse like the findOriginalObject methods do.

Parameters:

obj - the copy to find the direct original for

Returns:

the original object, or null if obj's id isn't a TemporaryObjectID with an original.

See Also:

findOriginalObject(DBObject)