oracle.javatools.db
Class PlSqlAttribute

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.PlSqlAttribute

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class PlSqlAttribute
extends AbstractChildDBObject

Model of a PL/SQL attribute. For example a Type or Package can contain attributes as well as methods.

Since:

10.1.3

Nested Class Summary

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

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String

TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

PlSqlAttribute()
Constructs a new object type attribute.

PlSqlAttribute(java.lang.String name)
Constructs a new object type attribute with the specified name.

PlSqlAttribute(java.lang.String name, DataType dataType)
Deprecated. Constructs a new attribute with the specified name and default usage of the given datatype.

PlSqlAttribute(java.lang.String name, DataTypeUsage dataTypeUsage)
Constructs a new attribute with the specified name and datatype usage.

Method Summary

protected void	copyToImpl(AbstractDBObject other, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
protected boolean	equalsImpl(AbstractDBObject other) Equals implementation for testing equality with another AbstractDBObject.
DataTypeUsage	getDataTypeUsage()
protected void	getOwnedObjectsImpl(java.util.Collection<DBObject> objs, java.lang.String... types) Used by all the final children methods.
SpecPlSql	getSpecPlSql() Gets the ComplexType that owns this attribute.
java.lang.String	getSqljExternalName()
java.lang.String	getType() Returns the type of this object.
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
void	setDataTypeUsage(DataTypeUsage dataTypeUsage)
void	setSpecPlSql(SpecPlSql plsql) Sets the ComplexType that owns this attribute.
void	setSqljExternalName(java.lang.String sqljExternalName)

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

findParent, getParent, getProperty, setParent, setProperty

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, setID, setName, setProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, setProperties

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PlSqlAttribute

public PlSqlAttribute()

Constructs a new object type attribute.

PlSqlAttribute

public PlSqlAttribute(java.lang.String name)

Constructs a new object type attribute with the specified name.

Parameters:

name - a string containing the attribute name

PlSqlAttribute

public PlSqlAttribute(java.lang.String name,
                      DataTypeUsage dataTypeUsage)

Constructs a new attribute with the specified name and datatype usage.

Parameters:

name - a string containing the attribute name

dataType - the datatype of the attribute

PlSqlAttribute

@Deprecated
public PlSqlAttribute(java.lang.String name,
                                 DataType dataType)

Deprecated. Constructs a new attribute with the specified name and default usage of the given datatype.

Parameters:

name - a string containing the attribute name

dataType - the datatype of the attribute

Method Detail

copyToImpl

protected void copyToImpl(AbstractDBObject other,
                          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 AbstractChildDBObject

Parameters:

other - 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.

equalsImpl

protected boolean equalsImpl(AbstractDBObject other)

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

getSpecPlSql

public SpecPlSql getSpecPlSql()

Gets the ComplexType that owns this attribute.

Returns:

the object type that owns this attribute

setSpecPlSql

public void setSpecPlSql(SpecPlSql plsql)

Sets the ComplexType that owns this attribute.

Parameters:

relation - the object type that owns this attribute.

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.

setSqljExternalName

public void setSqljExternalName(java.lang.String sqljExternalName)

getSqljExternalName

public java.lang.String getSqljExternalName()

setDataTypeUsage

public void setDataTypeUsage(DataTypeUsage dataTypeUsage)

getDataTypeUsage

public DataTypeUsage getDataTypeUsage()

getOwnedObjectsImpl

protected void getOwnedObjectsImpl(java.util.Collection<DBObject> objs,
                                   java.lang.String... types)

Description copied from class: AbstractDBObject

Used by all the final children methods. Subclasses should start with super.getOwnedObjectsImpl(type) and then add to the passed list. Use includesType to check the types vararg.

Overrides:

getOwnedObjectsImpl in class AbstractDBObject

Parameters:

objs - a Collection of the apppropriate children.

types - a vararg of the type(s) to search for

See Also:

AbstractDBObject.includesType(java.lang.String, java.lang.String...)

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map<DBObjectID,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.