oracle.javatools.db.datatypes

Class DataTypeUsage

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractChildDBObject

oracle.javatools.db.datatypes.DataTypeUsage

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

ObjectTypeUsage, PredefinedDataTypeUsage

public class DataTypeUsage
extends AbstractChildDBObject

To "use" a DataType is to refere to it by ID and store values for any attributes that DataType may have (e.g. precision, scale, size). All attribute values are stored in a map against that attribute's name. The ID of the DataType being used is also stored.

A DataTypeUsage can be "validated" by its corresponding DataType.

This replaces the deprecated way of storing scale and precision on a Column which was not flexible enough to support all datatype attributes.

To get a String representation of the usage and attributes use the DataType.getDDL(oracle.javatools.db.datatypes.DataTypeUsage) method.

Code examples for using DataTypeUsages are available in the datatypes datatypes package summary

Since:

10.1.3

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
DataTypeUsage()
DataTypeUsage(DataType dt)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyToImpl(AbstractDBObject target, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
void	deleteAttributeValue(java.lang.String name) Deletes entry named name.
protected boolean	equalsImpl(AbstractDBObject target) Equals implementation for testing equality with another AbstractDBObject.
java.lang.Object	getAttributeValue(java.lang.String name) Gets the value of the given named attribute.
java.util.Map<java.lang.String,java.lang.Object>	getAttributeValues() Returns a Map of the keys/values of all attributes in this usage.
DBObjectID	getDataTypeID() Gets the id of the DataType being used.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
java.lang.String	getType() Returns the type of this object.
boolean	hasAttributeValue(java.lang.String name) Returns true if there is an entry for the given attribute name.
void	putAttributeValue(java.lang.String name, java.lang.Object value) Adds {attribute_name, attribute_value} to self or replaces value where an entry for name already exists.
boolean	replaceReferenceIDs(java.util.Map<? extends DBObjectID,? extends DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
void	setAttributeValues(java.util.Map<java.lang.String,java.lang.Object> attributeValues) Sets the keys/values of all attributes in this usage.
void	setDataTypeID(DBObjectID dataTypeID) Sets the id of the DataType being used.

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getParent, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, removeObjectListener, removeOwnedObject, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

DataTypeUsage

public DataTypeUsage()

DataTypeUsage

public DataTypeUsage(DataType dt)

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

equalsImpl

protected boolean equalsImpl(AbstractDBObject target)

Description copied from class: AbstractDBObject

Equals implementation for testing equality with another AbstractDBObject. Override this method (with exact signature) to customise the equality comparison.

Overrides:

equalsImpl in class AbstractDBObject

copyToImpl

protected void copyToImpl(AbstractDBObject target,
              DBObject copyParent,
              IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.

Overrides:

copyToImpl in class AbstractDBObject

Parameters:

target - the copy being created of this object

copyParent - if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.

idPolicy - the policy for copying the object's ID.

setDataTypeID

public final void setDataTypeID(DBObjectID dataTypeID)

Sets the id of the DataType being used.

getDataTypeID

public final DBObjectID getDataTypeID()

Gets the id of the DataType being used.

Returns:

the DataTypeID of this usage.

setAttributeValues

public final void setAttributeValues(java.util.Map<java.lang.String,java.lang.Object> attributeValues)

Sets the keys/values of all attributes in this usage. The contents of the given Map are copied to this object. Subsequent changes to the Map will not change the object.

Parameters:

attributeValues - (attribute_name, attribute_value) map of usage values

getAttributeValues

public final java.util.Map<java.lang.String,java.lang.Object> getAttributeValues()

Returns a Map of the keys/values of all attributes in this usage. If you alter this Map you will be altering the attribute values of this object directly..

Returns:

{attribute_name, attribute_value} copied map of usage values

getAttributeValue

public final java.lang.Object getAttributeValue(java.lang.String name)

Gets the value of the given named attribute.

Parameters:

name -

Returns:

attribute value for attribute name, or null if no value exists.

putAttributeValue

public final void putAttributeValue(java.lang.String name,
                     java.lang.Object value)

Adds {attribute_name, attribute_value} to self or replaces value where an entry for name already exists.

Parameters:

name -

value -

deleteAttributeValue

public final void deleteAttributeValue(java.lang.String name)

Deletes entry named name.

Parameters:

name -

hasAttributeValue

public final boolean hasAttributeValue(java.lang.String name)

Returns true if there is an entry for the given attribute name.

Parameters:

name -

Returns:

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)

Description copied from class: AbstractDBObject

Used by the final getReferenceID() implementation. The list should not contain null values, or be null. Subclasses should start with super.getReferenceIDsImpl() and then add to the passed list as appopriate.

Overrides:

getReferenceIDsImpl in class AbstractDBObject

Parameters:

refs - the collection of ids this object references

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map<? extends DBObjectID,? extends DBObjectID> idMap)

Description copied from class: AbstractDBObject

Override in subclasses to replace reference IDs as appropriate. Always call super in the overridden implementation to make sure the default implementation (which checks the property map) is called.

Specified by:

replaceReferenceIDs in interface DBObject

Overrides:

replaceReferenceIDs in class AbstractDBObject

Parameters:

idMap - key = old DBObjectID, value = new DBObjectID

Returns:

true if any ids were replaced.