oracle.javatools.db

Class CheckConstraint

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.Constraint

oracle.javatools.db.CheckConstraint

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable

public class CheckConstraint
extends Constraint

A CheckConstraint constrains a table or view based on a conditional expression.

Nested Class Summary

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

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	CONSTRAINT_TYPE

Fields inherited from class oracle.javatools.db.Constraint

TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
CheckConstraint() Creates a new CheckConstraint.
CheckConstraint(java.lang.String name, Relation relation) Constructs a new CheckConstraint for a relation with a specific name.

Method Summary

Modifier and Type	Method and Description
protected void	copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
DBObject	findOwnedObject(DBObjectID id, boolean strict) Returns a child of this object that has the given ID.
java.lang.String	getCheckCondition() Retrieves the conditional expression represented by this constraint.
SQLFragment	getCheckConditionFragment() Retrieves the conditional expression represented by this constraint which is derived from the check condition.
java.lang.String	getConstraintType() Retrieves the type of constraint represented by this instance.
void	setCheckCondition(java.lang.String condition) Sets the conditional expression represented by this constraint.
void	setCheckConditionFragment(SQLFragment condition) Sets the conditional expression represented by this constraint which is derived from the check condition.

Methods inherited from class oracle.javatools.db.Constraint

getConstraints, getConstraintTypes, getDeferrableState, getRelation, getType, isEnabled, setDeferrableState, setEnabled, setRelation

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, 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, 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.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

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

Field Detail

CONSTRAINT_TYPE

public static final java.lang.String CONSTRAINT_TYPE

See Also:

Constant Field Values

Constructor Detail

CheckConstraint

public CheckConstraint(java.lang.String name,
                       Relation relation)

Constructs a new CheckConstraint for a relation with a specific name. The new constraint will not be added to the Table, this must be done using Relation.addConstraint(Constraint) when the constraint definition is complete.

Parameters:

name - a string representing name of the constraint

relation - the relation being constrained

CheckConstraint

public CheckConstraint()

Creates a new CheckConstraint.

Method Detail

getConstraintType

public java.lang.String getConstraintType()

Description copied from class: Constraint

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.

Specified by:

getConstraintType in class Constraint

Returns:

a string value indicating the type of constraint.

getCheckCondition

public java.lang.String getCheckCondition()

Retrieves the conditional expression represented by this constraint.

Returns:

a string containing the conditional expression

setCheckCondition

public void setCheckCondition(java.lang.String condition)

Sets the conditional expression represented by this constraint.

Parameters:

condition - a string containing the conditional expression

getCheckConditionFragment

public SQLFragment getCheckConditionFragment()

Retrieves the conditional expression represented by this constraint which is derived from the check condition.

Returns:

a SQLFragment representing the conditional expression

setCheckConditionFragment

public void setCheckConditionFragment(SQLFragment condition)

Sets the conditional expression represented by this constraint which is derived from the check condition. Setting this does not set the check condition, that should already have been set before this is called to set the declarative representation.

Parameters:

condition - a SQLFragment representing the expression set as the "check condition".

See Also:

setCheckCondition(String)

findOwnedObject

public DBObject findOwnedObject(DBObjectID id,
                                boolean strict)

Description copied from interface: DBObject

Returns a child of this object that has the given ID. The child is located by comparing IDs, not by calling resolveID() and is therefore the quickest way to locate a DBObject if you know its parent.

Note: an unstrict comparison can be time consuming, only request it if you need it (i.e. you are searching using a DBObjectID that did not originate in this object's heirarchy).

The method does not recurse to look for children of children.

This will not find SchemaObjects in a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Specified by:

findOwnedObject in interface DBObject

Overrides:

findOwnedObject in class AbstractDBObject

Parameters:

id - the id to look for

strict - whether to stricly compare IDs or not

Returns:

a child object found with a matching id, or null if no child is found

See Also:

DBObjectID.equals(DBObjectID,boolean)

copyToImpl

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

Description copied from class: AbstractDBObject

Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.

Overrides:

copyToImpl in class AbstractBuildableObject

Parameters:

copy - the copy being created of this object

copyParent - if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.

idPolicy - the policy for copying the object's ID.