org.apache.openjpa.jdbc.schema
Class Constraint

java.lang.Object
  org.apache.openjpa.jdbc.schema.ReferenceCounter
      org.apache.openjpa.jdbc.schema.Constraint

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ForeignKey, LocalConstraint

public abstract class Constraint
extends ReferenceCounter

A table constraint. This class is closely aligned with the constraint information available from DatabaseMetaData.

Author:

Abe White

See Also:

Serialized Form

Constructor Summary

Constraint()
Default constructor.

Constraint(String name, Table table)
Constructor.

Method Summary

String	getColumnName() Return the column's name.
String	getFullName() Return the full name of the constraint.
String	getName() Return the name of the constraint.
String	getSchemaName() Return the column table's schema name.
Table	getTable() Return the table of this constraint.
String	getTableName() Return the column's table name.
boolean	isDeferred() Return true if this is a deferred constraint.
abstract boolean	isLogical() Return whether this constraint is a logical constraint only; i.e.
(package private) void	remove() Called when the constraint is removed from the owning table.
void	setColumnName(String name) Set the column's name.
void	setDeferred(boolean deferred) Make this constrain deferred.
void	setName(String name) Set the name of the constraint.
void	setSchemaName(String schema) Set the column table's schema name.
void	setTableName(String name) Set the column's table name.
String	toString()

Methods inherited from class org.apache.openjpa.jdbc.schema.ReferenceCounter

deref, getRefCount, ref

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Constraint

Constraint()

Default constructor.

Constraint

Constraint(String name,
           Table table)

Constructor.

Parameters:

name - the name of the constraint, or null if none

table - the local table of the constraint

Method Detail

remove

void remove()

Called when the constraint is removed from the owning table. Invalidates the constraint.

getTable

public Table getTable()

Return the table of this constraint.

getTableName

public String getTableName()

Return the column's table name.

setTableName

public void setTableName(String name)

Set the column's table name. You can only call this method on columns whose table object is not set.

getSchemaName

public String getSchemaName()

Return the column table's schema name.

setSchemaName

public void setSchemaName(String schema)

Set the column table's schema name. You can only call this method on columns whose tbale object is not set.

getColumnName

public String getColumnName()

Return the column's name.

setColumnName

public void setColumnName(String name)

Set the column's name. You can only call this method on columns whose table object is not set.

getName

public String getName()

Return the name of the constraint.

setName

public void setName(String name)

Set the name of the constraint. This method cannot be called if the constraint already belongs to a table.

getFullName

public String getFullName()

Return the full name of the constraint.

isLogical

public abstract boolean isLogical()

Return whether this constraint is a logical constraint only; i.e. if it does not exist in the database.

isDeferred

public boolean isDeferred()

Return true if this is a deferred constraint.

setDeferred

public void setDeferred(boolean deferred)

Make this constrain deferred.

toString

public String toString()

Overrides:

toString in class Object