oracle.javatools.db

Class Relation

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractSystemObject

oracle.javatools.db.AbstractSchemaObject

oracle.javatools.db.Relation

All Implemented Interfaces:

DBObject, SchemaObject, SystemObject, Copyable

Direct Known Subclasses:

Table, View

public abstract class Relation
extends AbstractSchemaObject

A Relation represents the basic entity of a relational database. Examples of relations include tables and views.

A Relation contains a list of Columns and a list of Constraints on the values for the columns in the Relation. Column and Constraint instances are managed by Relation instances; making a copy of a Relation implies making a copy of each Column and Constraint contained within the Relation.

Since:

9.0.5

Nested Class Summary

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

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Relation() Constructs a new Relation.
protected	Relation(java.lang.String name, Schema schema) Constructs a new Relation with the specified name in the specified schema.

Method Summary

Modifier and Type	Method and Description
void	addColumn(Column col) Adds one column to this relation.
void	addColumn(int index, Column col) Adds one column to this relation at the given index.
void	addConstraint(Constraint constraint) Adds a Constraint to this relation.
Column	getColumn(java.lang.String name) Retrieves a column by name.
Column[]	getColumns() Retrieves the list of columns contained in this relation.
Constraint	getConstraint(java.lang.String name) Retrieves a constraint by name.
Constraint[]	getConstraints() Retrieves the list of constraints on this relation.
protected void	getOwnedObjectsImpl(java.util.Collection<DBObject> c, java.lang.String... types) Implementation first checks that the object has been built - then returns the collection from suprt.getOwnedObjectsImpl().
void	removeColumn(Column col) Removes a column from this relation.
void	removeConstraint(Constraint constraint) Removes a Constraint from this relation.
void	setColumns(Column[] newCols) Sets the entire list of columns, replacing any that have previously been added.
void	setConstraints(Constraint[] constraints) Sets the list of constraints on this relation.

Methods inherited from class oracle.javatools.db.AbstractSchemaObject

getSchema, setSchema

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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.SchemaObject

addObjectListener, removeObjectListener

Methods inherited from interface oracle.javatools.db.SystemObject

addObjectListener, fireObjectUpdated, removeObjectListener

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperties, getProperty, getProperty, getReferenceIDs, getType, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Constructor Detail

Relation

protected Relation()

Constructs a new Relation.

Relation

protected Relation(java.lang.String name,
                   Schema schema)

Constructs a new Relation with the specified name in the specified schema.

Parameters:

name - a string containing the name of the new relation

schema - the schema containing the new relation

Method Detail

setColumns

public void setColumns(Column[] newCols)

Sets the entire list of columns, replacing any that have previously been added.

Parameters:

newCols - an array containing the new list of columns

getColumns

public Column[] getColumns()

Retrieves the list of columns contained in this relation.

Returns:

an array containing the list of columns

addColumn

public void addColumn(Column col)

Adds one column to this relation.

Parameters:

col - the new column to add

addColumn

public void addColumn(int index,
                      Column col)

Adds one column to this relation at the given index. Shift the Column at that position (and any subesquent Columns) down one place.

Parameters:

index - the index to add the new column at

col - the new column to add

getColumn

public Column getColumn(java.lang.String name)

Retrieves a column by name. The lookup is case sensitive, for a specific case policy use DBUtil.findChildByName(oracle.javatools.db.DBObject, java.lang.String, java.lang.String, oracle.javatools.db.DBObjectProvider) instead.

Parameters:

name - string containing the desired column name

Returns:

The column requested or null

removeColumn

public void removeColumn(Column col)

Removes a column from this relation.

Parameters:

col - the column to remove

getConstraints

public Constraint[] getConstraints()

Retrieves the list of constraints on this relation.

Returns:

an array containing the list of constraints

setConstraints

public void setConstraints(Constraint[] constraints)

Sets the list of constraints on this relation.

Parameters:

constraints - an array containing the list of constraints

getConstraint

public Constraint getConstraint(java.lang.String name)

Retrieves a constraint by name. The lookup is case sensitive, for a specific case policy use DBUtil.findChildByName(oracle.javatools.db.DBObject, java.lang.String, java.lang.String, oracle.javatools.db.DBObjectProvider) instead.

Parameters:

name - string containing the desired constraint name

Returns:

The constraint requested or null

addConstraint

public void addConstraint(Constraint constraint)

Adds a Constraint to this relation.

Parameters:

constraint - the constraint to add

removeConstraint

public void removeConstraint(Constraint constraint)

Removes a Constraint from this relation.

Parameters:

constraint - the constraint to remove

getOwnedObjectsImpl

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

Description copied from class: AbstractBuildableObject

Implementation first checks that the object has been built - then returns the collection from suprt.getOwnedObjectsImpl(). All overrides must call this first to ensure the object has been built.

Overrides:

getOwnedObjectsImpl in class AbstractBuildableObject

Parameters:

c - 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...)