oracle.javatools.db.datatypes
Class DataTypeID

java.lang.Object
  oracle.javatools.db.datatypes.DataTypeID

All Implemented Interfaces:

DBObjectID, Copyable

public final class DataTypeID
extends java.lang.Object
implements DBObjectID

INTERNAL USE ONLY. THIS CLASS IS NOT PART OF THE PUBLIC API. To retrieve DataTypes (and their IDs) use the DataType methods on a DBObjectProvider, or if working without a provider use the DataTypeRegistry.

DBObjectID implementation for DataTypes that belong to a provider (built-in types). The object is a bean that stores the name of the type and the provider class it is a built-in type for. To resolve the ID the DataTypeRegistry is used to lookup the name and provider. An appropriate instance of this object is assinged to every DataType registered with the DataTypeRegistry.

Constructor Summary

DataTypeID()
INTERNAL USE ONLY.

Method Summary

java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(DataTypeID target)
static DataTypeID	createFromString(java.lang.String idString)
boolean	equals(DBObjectID id)
boolean	equals(DBObjectID id, boolean strict) Whether the specified id is equivalent to this id.
boolean	equals(java.lang.Object obj)
protected boolean	equalsImpl(DataTypeID id)
DBObjectID	getParent() Retrieves the parent for this id if it has one.
java.lang.Class	getProviderClass()
java.lang.String	getSchemaName()
java.lang.String	getType() Retrieves the type of object referenced by this id.
java.lang.String	getTypeName()
static boolean	isIDType(java.lang.String idString)
DBObject	resolveID() Resolves the id into the object referenced.
void	setProviderClass(java.lang.Class clz)
void	setSchemaName(java.lang.String schemaName) By setting a schema name this id will attempt to resolve to a complex type in the registry rather than a simple type.
void	setTypeName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeID

public DataTypeID()

INTERNAL USE ONLY. THIS CLASS IS NOT PART OF THE PUBLIC API. To retrieve DataTypes (and their IDs) use the DataType methods on a DBObjectProvider, or if working without a provider use the DataTypeRegistry.

For internal use only. Application developers should not use this

Method Detail

getTypeName

public java.lang.String getTypeName()

setTypeName

public void setTypeName(java.lang.String name)

getProviderClass

public java.lang.Class getProviderClass()

setProviderClass

public void setProviderClass(java.lang.Class clz)

getSchemaName

public java.lang.String getSchemaName()

setSchemaName

public void setSchemaName(java.lang.String schemaName)

By setting a schema name this id will attempt to resolve to a complex type in the registry rather than a simple type.

equals

public boolean equals(DBObjectID id)

equals

public boolean equals(DBObjectID id,
                      boolean strict)

Description copied from interface: DBObjectID

Whether the specified id is equivalent to this id.

Specified by:

equals in interface DBObjectID

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

equalsImpl

protected boolean equalsImpl(DataTypeID id)

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.

copyToImpl

protected void copyToImpl(DataTypeID target)

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();

resolveID

public DBObject resolveID()
                   throws DBException

Description copied from interface: DBObjectID

Resolves the id into the object referenced.

Specified by:

resolveID in interface DBObjectID

Returns:

the DBObject referenced by this DBObjectID

Throws:

DBException

getParent

public DBObjectID getParent()

Description copied from interface: DBObjectID

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

Specified by:

getParent in interface DBObjectID

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isIDType

public static final boolean isIDType(java.lang.String idString)

createFromString

public static DataTypeID createFromString(java.lang.String idString)