oracle.javatools.db

Class Constraint

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.Constraint

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

CheckConstraint, ColumnConstraint

public abstract class Constraint
extends AbstractChildBuildableObject

A Constraint represents a constraint on a table or view.

See Also:

Relation.getConstraints()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Constraint.DeferrableState

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

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Constraint() Constructs a new Constraint.
protected	Constraint(java.lang.String name, Relation relation) Constructs a new Constraint on a relation with a specific name, and adds the constraint to the relation.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Collection<Constraint>	getConstraints(Relation rel, java.lang.String... types) Lists the constraints on a given Relation that are of the given constraint types.
abstract java.lang.String	getConstraintType() Retrieves the type of constraint represented by this instance.
static java.util.Collection<java.lang.String>	getConstraintTypes() Gets a list of the valid constraint types support in the API.
Constraint.DeferrableState	getDeferrableState() The deferrable state of the Constraint.
Relation	getRelation() Gets the Relation that owns this Constraint.
java.lang.String	getType() Returns the type of this object.
boolean	isEnabled() Whether this constraint is current enabled.
void	setDeferrableState(Constraint.DeferrableState defer) Sets the deferrable state of this constraint.
void	setEnabled(boolean enabled) Sets the enabled state of this constraint.
void	setRelation(Relation relation) Sets the Relation that owns this Constraint.

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

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, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

Constraint

protected Constraint()

Constructs a new Constraint.

Constraint

protected Constraint(java.lang.String name,
          Relation relation)

Constructs a new Constraint on a relation with a specific name, and adds the constraint to the relation.

Parameters:

name - a string containing the constraint name

relation - the relation being constrained

Method Detail

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled state of this constraint. Disabled constraints are not enforced.

Parameters:

enabled - a boolean value indicating whether this constraint it is enabled.

isEnabled

public boolean isEnabled()

Whether this constraint is current enabled. Disabled constraints are not enforced.

Returns:

a boolean value indicating whether this constraint it is enabled.

setDeferrableState

public void setDeferrableState(Constraint.DeferrableState defer)

Sets the deferrable state of this constraint.

Parameters:

defer - the deferrable state for the constraint.

getDeferrableState

public Constraint.DeferrableState getDeferrableState()

The deferrable state of the Constraint.

Returns:

the deferrable state.

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.

getConstraintType

public abstract java.lang.String getConstraintType()

Retrieves the type of constraint represented by this instance. Valid constraint types can vary depending on the database. Examples of constraint types include primary key constraints, foreign key constraints, and check constraints.

Returns:

a string value indicating the type of constraint.

getRelation

public Relation getRelation()

Gets the Relation that owns this Constraint.

Returns:

the Relation that owns this constraint

setRelation

public void setRelation(Relation relation)

Sets the Relation that owns this Constraint.

Parameters:

relation - the Relation that owns this constraint.

getConstraints

public static java.util.Collection<Constraint> getConstraints(Relation rel,
                                              java.lang.String... types)

Lists the constraints on a given Relation that are of the given constraint types.

Parameters:

rel - the relation to list the constraints from

types - the types of constraint required

Returns:

a list of the constraints of given type

See Also:

getConstraintType()

getConstraintTypes

public static java.util.Collection<java.lang.String> getConstraintTypes()

Gets a list of the valid constraint types support in the API.