oracle.javatools.db

Class PKConstraint

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.Constraint

oracle.javatools.db.ColumnConstraint

oracle.javatools.db.UniqueConstraint

oracle.javatools.db.PKConstraint

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable

public class PKConstraint
extends UniqueConstraint

A PKConstraint represents a Primary Key constraint. A Primary Key combines a NOT NULL constraint and a unique constraint in a single declaration. That is, it prohibits multiple rows from having the same value in the same column or combination of columns and prohibits values from being null.

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
PKConstraint() Constructs a new PKConstraint.
PKConstraint(java.lang.String name, Relation relation) Constructs a new PKConstraint for the specified Relation with the specified name.

Method Summary

Modifier and Type	Method and Description
protected void	addColumnImpl(Column col, Relation relForColumn)
java.lang.String	getConstraintType() Retrieves the type of constraint represented by this instance.
static PKConstraint	getPrimaryKey(Relation table) Returns a primary key for the given table, if it owns one.

Methods inherited from class oracle.javatools.db.UniqueConstraint

getIndexID, isUnique, setIndexID

Methods inherited from class oracle.javatools.db.ColumnConstraint

addColumn, getColumnIDs, getColumns, isConstrained, removeColumn, setColumnIDs, setColumns

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, copyToImpl, 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, 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, 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

PKConstraint

public PKConstraint()

Constructs a new PKConstraint.

PKConstraint

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

Constructs a new PKConstraint for the specified Relation with the specified 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:

a - string containing the name of the constraint

relation - the relation on which this constraint acts

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.

Overrides:

getConstraintType in class UniqueConstraint

Returns:

a string value indicating the type of constraint.

getPrimaryKey

public static final PKConstraint getPrimaryKey(Relation table)

Returns a primary key for the given table, if it owns one.

addColumnImpl

protected void addColumnImpl(Column col,
                             Relation relForColumn)

Overrides:

addColumnImpl in class ColumnConstraint