oracle.jdeveloper.cm.ds.db
Class Table

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

All Implemented Interfaces:

Copyable

public class Table

extends SchemaObject

Model of a database table.

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

Table()
Constructor

Table(java.lang.String name)

Method Summary

void	addColumn(Column col) Adds one column to the table
void	addConstraint(Constraint constraint)
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(Table copy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(Table target)
java.lang.String[]	generateSQL()
java.util.Iterator	getChildren() If this object has subobjects (i.e.
Column	getColumn(java.lang.String name) Retrieves one column by name
java.util.List	getColumns() returns the entire list of columns, replacing any that have previously been added.
java.lang.String	getComment()
java.util.List	getConstraints()
java.lang.String	getType() Returns the type of object this is.
void	removeColumn(Column col) Removes a column from this table
void	removeConstraint(Constraint constraint)
void	setColumns(java.util.List cols) Set the entire list of columns, replacing any that have previously been added.
void	setComment(java.lang.String comment)
void	setConstraints(java.util.List constraints)

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

Table

public Table()

Constructor

Table

public Table(java.lang.String name)

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(Table copy)

equals

public boolean equals(java.lang.Object target)

Specified by:

equals in class DBObject

equalsImpl

protected boolean equalsImpl(Table target)

setColumns

public void setColumns(java.util.List cols)

Set the entire list of columns, replacing any that have previously been added. This method exist to satisfy the JavaBeans requirement (of a setter for every data member), for use by Jojo's XML marshaling classes.

getColumns

public java.util.List getColumns()

returns the entire list of columns, replacing any that have previously been added. This method exist to satisfy the JavaBeans requirement (of a getter for every data member), for use by Jojo's XML marshaling classes.

addColumn

public void addColumn(Column col)

Adds one column to the table

getColumn

public Column getColumn(java.lang.String name)

Retrieves one column by name

Returns:

The requested column or null.

removeColumn

public void removeColumn(Column col)

Removes a column from this table

getConstraints

public java.util.List getConstraints()

setConstraints

public void setConstraints(java.util.List constraints)

addConstraint

public void addConstraint(Constraint constraint)

removeConstraint

public void removeConstraint(Constraint constraint)

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

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)

generateSQL

public java.lang.String[] generateSQL()