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

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(PlSqlAttribute copy, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object target)
boolean	equalsImpl(PlSqlAttribute copy)
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

copyToImpl, findParent, getParent, setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, 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.DBObject

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

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

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

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

copyToImpl

protected void copyToImpl(PlSqlAttribute copy,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

equalsImpl

public boolean equalsImpl(PlSqlAttribute copy)

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.