Package org.pgcodekeeper.core.database.pg.schema

Class PgConstraint

java.lang.Object

org.pgcodekeeper.core.database.base.schema.AbstractStatement

org.pgcodekeeper.core.database.pg.schema.PgAbstractStatement

org.pgcodekeeper.core.database.pg.schema.PgConstraint

All Implemented Interfaces:

IConstraint, ISearchPath, IStatement, ISubElement, IHashable

Direct Known Subclasses:

PgConstraintCheck, PgConstraintExclude, PgConstraintFk, PgConstraintNotNull, PgConstraintPk

public abstract class PgConstraint
extends PgAbstractStatement
implements IConstraint, ISubElement

Base PostgreSQL constraint implementation. Provides common functionality for all PostgreSQL constraint types including deferrable and initially deferred properties.

Method Summary

Modifier and Type	Method	Description
ObjectState	appendAlterSQL(IStatement newCondition, SQLScript script)	Fill script with object changes and return change type
void	appendOptions(SQLScript script, StringBuilder sbSQL, boolean needNotValid)
boolean	compare(IStatement obj)	This method does not account for nested child PgStatements.
void	computeHash(Hasher hasher)	Computes the hash of the implementing object using the provided hasher.
boolean	containsColumn(String name)	Checks if this constraint involves the specified column.
Collection<String>	getColumns()	Gets the columns involved in this constraint.
void	getCreationSQL(SQLScript script)	Generates the SQL statements needed to create this database object.
void	getDropSQL(SQLScript script, boolean optionExists)	Generates DROP SQL for this statement.
String	getTableName()	Gets the name of the table this constraint belongs to.
boolean	isNotValid()
void	setDeferrable(boolean deferrable)
void	setInitially(boolean initially)
void	setNotEnforced(boolean notEnforced)
void	setNotValid(boolean isNotValid)

Methods inherited from class org.pgcodekeeper.core.database.pg.schema.PgAbstractStatement

addPrivilege, appendDefaultPrivileges, appendOwnerSQL, formatSql, getQuoter, getRenameCommand, isOwned

Methods inherited from class org.pgcodekeeper.core.database.base.schema.AbstractStatement

addDependency, appendAlterComments, appendComments, appendPrivileges, canDrop, canDropBeforeCreate, checkComments, clearPrivileges, compareChildren, deepCopy, equals, fillChildrenList, fillDescendantsList, getAuthor, getBareName, getChildren, getComment, getDependencies, getDescendants, getDropSQL, getLibName, getLocation, getName, getObjectState, getObjectState, getOwner, getParent, getPrivileges, getQualifiedName, getSeparator, getSQL, getTwin, hasChildren, hashCode, isLib, setAuthor, setComment, setLibName, setLocation, setOwner, setParent, shallowCopy, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IConstraint

getDefinition, getStatementType, isPrimaryKey

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.ISearchPath

getDatabase, getSchemaName

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IStatement

addDependency, appendOwnerSQL, canDrop, canDropBeforeCreate, clearPrivileges, deepCopy, formatSql, getAuthor, getBareName, getChildren, getComment, getDependencies, getDescendants, getLibName, getLocation, getName, getOwner, getParent, getPrivileges, getQualifiedName, getQuotedName, getQuoter, getRenameCommand, getSeparator, getSQL, getTwin, getTypeName, hasChildren, isLib, isOwned, quote, setComment, setLibName, setLocation, setOwner, shallowCopy

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.ISubElement

getContainingSchema, toObjectReference

Method Details

getCreationSQL

public void getCreationSQL(SQLScript script)

Description copied from interface: IStatement

Generates the SQL statements needed to create this database object. This is an abstract method that must be implemented by subclasses to provide the specific CREATE SQL for each object type.

Specified by:

getCreationSQL in interface IStatement

Parameters:

script - the SQL script to append creation statements to

appendOptions

public void appendOptions(SQLScript script,
 StringBuilder sbSQL,
 boolean needNotValid)

appendAlterSQL

public ObjectState appendAlterSQL(IStatement newCondition,
 SQLScript script)

Description copied from interface: IStatement

Fill script with object changes and return change type

Specified by:

appendAlterSQL in interface IStatement

Parameters:

newCondition - new object state

script - script to collect changes

Returns:

object change type

getDropSQL

public void getDropSQL(SQLScript script,
 boolean optionExists)

Description copied from interface: IStatement

Generates DROP SQL for this statement.

Specified by:

getDropSQL in interface IStatement

Overrides:

getDropSQL in class AbstractStatement

Parameters:

script - the SQL script to append the DROP statement to

optionExists - whether to include "IF EXISTS" in the DROP statement

containsColumn

public boolean containsColumn(String name)

Description copied from interface: IConstraint

Checks if this constraint involves the specified column.

Specified by:

containsColumn in interface IConstraint

Parameters:

name - the column name to check

Returns:

true if the column is part of this constraint

setNotValid

public void setNotValid(boolean isNotValid)

isNotValid

public boolean isNotValid()

setDeferrable

public void setDeferrable(boolean deferrable)

setInitially

public void setInitially(boolean initially)

setNotEnforced

public void setNotEnforced(boolean notEnforced)

getTableName

public String getTableName()

Description copied from interface: IConstraint

Gets the name of the table this constraint belongs to.

Specified by:

getTableName in interface IConstraint

Returns:

the table name

getColumns

public Collection<String> getColumns()

Description copied from interface: IConstraint

Gets the columns involved in this constraint.

Specified by:

getColumns in interface IConstraint

Returns:

a collection of column names

computeHash

public void computeHash(Hasher hasher)

Description copied from interface: IHashable

Computes the hash of the implementing object using the provided hasher. The implementation should call appropriate put methods on the hasher for all fields that should contribute to the hash value.

Specified by:

computeHash in interface IHashable

Parameters:

hasher - the hasher instance to use for hash computation

compare

public boolean compare(IStatement obj)

Description copied from class: AbstractStatement

This method does not account for nested child PgStatements. Shallow version of AbstractStatement.equals(Object)

Specified by:

compare in interface IStatement

Overrides:

compare in class AbstractStatement