org.josef.jdbc

Class Constraint

java.lang.Object

org.josef.jdbc.Constraint

public class Constraint
extends Object

Abstraction of a database constraint.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
Constraint()

Method Summary

Modifier and Type	Method and Description
String	getDeleteRule() Gets the delete rule.
String	getName() Gets the name of this constraint.
String	getOwner() Gets the owner of this constraint.
List<String>	getReferencedColumns() Gets the referenced column names for this constraint.
String	getReferencedConstraintName() Gets the referenced constraint name.
String	getReferencedTableName() Gets the referenced table name for this constraint.
String	getTableName() Gets the table name for this constraint.
ConstraintType	getType() Gets the type of this constraint.
void	setDeleteRule(String deleteRule) Sets the delete rule.
void	setName(String name) Sets the name of this constraint.
void	setOwner(String owner) Sets the owner of this constraint.
void	setReferencedColumns(List<String> referencedColumns) Sets the referenced columns for this constraint.
void	setReferencedConstraintName(String referencedConstraintName) Sets the referenced constraint name.
void	setReferencedTableName(String referencedTableName) Sets the referenced table name for this constraint.
void	setTableName(String tableName) Sets the table name for this constraint.
void	setType(ConstraintType type) Sets the type of this constraint.
String	toString() Creates a String representation of this constraint.

Methods inherited from class java.lang.Object

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

Constructor Detail

Constraint

public Constraint()

Method Detail

getOwner

public String getOwner()

Gets the owner of this constraint.

Returns:

The owner of this constraint.

setOwner

public void setOwner(String owner)

Sets the owner of this constraint.

Parameters:

owner - The owner of this constraint.

Throws:

NullPointerException - When the supplied owner is null.

IllegalArgumentException - When the supplied owner is empty.

getName

public String getName()

Gets the name of this constraint.

Returns:

The name of this constraint.

setName

public void setName(String name)

Sets the name of this constraint.

Parameters:

name - The name of this constraint.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

getType

public ConstraintType getType()

Gets the type of this constraint.

Returns:

The type of this constraint.
Normally "U" for unique or "P" for primary.

setType

public void setType(ConstraintType type)

Sets the type of this constraint.

Parameters:

type - The type of this constraint.

Throws:

NullPointerException - When the supplied type is null.

getTableName

public String getTableName()

Gets the table name for this constraint.

Returns:

The table name for this constraint.

setTableName

public void setTableName(String tableName)

Sets the table name for this constraint.

Parameters:

tableName - The table name for this constraint.

Throws:

NullPointerException - When the supplied tableName is null.

IllegalArgumentException - When the supplied tableName is empty.

getReferencedConstraintName

public String getReferencedConstraintName()

Gets the referenced constraint name.
A value will only exist when the type of this constraint is "R".

Returns:

The referenced constraint name.

setReferencedConstraintName

public void setReferencedConstraintName(String referencedConstraintName)

Sets the referenced constraint name.
Only applicable when the type of this constraint is "R".

Parameters:

referencedConstraintName - The referenced constraint name.

getDeleteRule

public String getDeleteRule()

Gets the delete rule.

Returns:

The delete rule.
Normally one of CASCADE, RESTRICT or NO ACTION

setDeleteRule

public void setDeleteRule(String deleteRule)

Sets the delete rule.

Parameters:

deleteRule - The delete rule to set.
Normally this is one of CASCADE,RESTRICT or NO ACTION but no check is made on this parameter.

getReferencedTableName

public String getReferencedTableName()

Gets the referenced table name for this constraint.

Returns:

The referenced table name for this constraint or null when this constraint does not reference another table.

setReferencedTableName

public void setReferencedTableName(String referencedTableName)

Sets the referenced table name for this constraint.

Parameters:

referencedTableName - The referenced table name for this constraint. Supply null when this constraint does not reference another table/

getReferencedColumns

public List<String> getReferencedColumns()

Gets the referenced column names for this constraint.

Returns:

The referenced columns or an empty list when this constraint does not reference other columns.

setReferencedColumns

public void setReferencedColumns(List<String> referencedColumns)

Sets the referenced columns for this constraint.

Parameters:

referencedColumns - The referenced columns for this constraint.

toString

public String toString()

Creates a String representation of this constraint.

Overrides:

toString in class Object

Returns:

A String representation of this constraint.