oracle.jdeveloper.cm.ds.db
Class Column

java.lang.Object
  oracle.jdeveloper.cm.ds.db.DBObject
      oracle.jdeveloper.cm.ds.db.SchemaObject
          oracle.jdeveloper.cm.ds.db.Column

All Implemented Interfaces:

Copyable

public class Column

extends SchemaObject

Model of a database column.

Field Summary

Fields inherited from class oracle.jdeveloper.cm.ds.db.DBObject

ANONYMOUS_BLOCK, COLUMN, CONSTRAINT, FUNCTION, INDEX, PACKAGE_BODY, PACKAGE_SPEC, PROCEDURE, SEQUENCE, SYNONYM, TABLE, WORKAREA

Constructor Summary

Column()
Constructor

Column(java.lang.String name)

Column(java.lang.String name, DataType dataType)

Method Summary

java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(Column copy)
boolean	equals(java.lang.Object target)
boolean	equalsImpl(Column copy)
java.util.Iterator	getChildren() If this object has subobjects (i.e.
java.lang.String	getComment()
DataType	getDataType()
java.lang.String	getDataTypeString()
java.lang.Object	getDefault()
java.lang.Long	getPrecision()
java.lang.Long	getScale()
java.lang.String	getTableName()
java.lang.String	getType() Returns the type of object this is.
boolean	isNotNull()
void	setComment(java.lang.String comment)
void	setDataType(DataType dataType)
void	setDataTypeString(java.lang.String dataTypeStr)
void	setDefault(java.lang.Object defaultValue)
void	setNotNull(boolean newNotNull)
void	setPrecision(java.lang.Long newPrecision)
void	setScale(java.lang.Long newScale)
void	setTableName(java.lang.String table) Sets the reference to the owning table, note, this is set on the call to Table.addColumn(Column)

Methods inherited from class oracle.jdeveloper.cm.ds.db.SchemaObject

copyToImpl, equalsImpl, getCatalog, getSchema, setCatalog, setSchema

Methods inherited from class oracle.jdeveloper.cm.ds.db.DBObject

copyToImpl, equalsImpl, getName, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column()

Constructor

Column

public Column(java.lang.String name)

Column

public Column(java.lang.String name,
              DataType dataType)

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

Specified by:

copyTo in class DBObject

copyToImpl

protected void copyToImpl(Column copy)

equals

public boolean equals(java.lang.Object target)

Specified by:

equals in class DBObject

equalsImpl

public boolean equalsImpl(Column copy)

setDefault

public void setDefault(java.lang.Object defaultValue)

getDefault

public java.lang.Object getDefault()

isNotNull

public boolean isNotNull()

setNotNull

public void setNotNull(boolean newNotNull)

getPrecision

public java.lang.Long getPrecision()

setPrecision

public void setPrecision(java.lang.Long newPrecision)

getScale

public java.lang.Long getScale()

setScale

public void setScale(java.lang.Long newScale)

getType

public java.lang.String getType()

Description copied from class: DBObject

Returns the type of object this is. The object type is defined as constants in DBObject

Specified by:

getType in class DBObject

See Also:

DBObject.TABLE, DBObject.WORKAREA, DBObject.COLUMN

setDataType

public void setDataType(DataType dataType)

getDataType

public DataType getDataType()

setDataTypeString

public void setDataTypeString(java.lang.String dataTypeStr)

getDataTypeString

public java.lang.String getDataTypeString()

setTableName

public void setTableName(java.lang.String table)

Sets the reference to the owning table, note, this is set on the call to Table.addColumn(Column)

See Also:

Table.addColumn(oracle.jdeveloper.cm.ds.db.Column)

getTableName

public java.lang.String getTableName()

getChildren

public java.util.Iterator getChildren()

Description copied from class: DBObject

If this object has subobjects (i.e. a table contains columns), then this will return an Iterator on that list of children, otherwise it will return null.

Specified by:

getChildren in class DBObject

getComment

public java.lang.String getComment()

setComment

public void setComment(java.lang.String comment)