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

Class PgConstraintExclude

java.lang.Object

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

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

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

org.pgcodekeeper.core.database.pg.schema.PgConstraintExclude

All Implemented Interfaces:

IConstraint, ISearchPath, ISimpleColumnContainer, IStatement, ISubElement, PgIndexParamContainer, IHashable

public class PgConstraintExclude
extends PgConstraint
implements PgIndexParamContainer, ISimpleColumnContainer

PostgreSQL EXCLUDE constraint implementation. EXCLUDE constraints ensure that if any two rows are compared on specified columns using specified operators, not all comparisons will return TRUE.

Constructor Summary

Constructors

Constructor	Description
PgConstraintExclude(String name)	Creates a new PostgreSQL EXCLUDE constraint.

Method Summary

Modifier and Type	Method	Description
void	addColumn(SimpleColumn column)	Adds a column reference to this container.
void	addInclude(String include)	Adds a column to the INCLUDE clause of the index.
void	addParam(String key, String value)	Adds an index parameter (WITH clause option).
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.
Set<String>	getColumns()	Gets the columns involved in this constraint.
String	getDefinition()	Gets the SQL definition of this constraint.
String	getErrorCode()
void	setIndexMethod(String indexMethod)
void	setPredicate(String predicate)
void	setTablespace(String tablespace)	Sets the tablespace for this index.

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

appendAlterSQL, appendOptions, getCreationSQL, getDropSQL, getTableName, isNotValid, setDeferrable, setInitially, setNotEnforced, setNotValid

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

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, appendAlterSQL, appendOwnerSQL, canDrop, canDropBeforeCreate, clearPrivileges, deepCopy, formatSql, getAuthor, getBareName, getChildren, getComment, getCreationSQL, getDependencies, getDescendants, getDropSQL, 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

Constructor Details

PgConstraintExclude

public PgConstraintExclude(String name)

Creates a new PostgreSQL EXCLUDE constraint.

Parameters:

name - constraint name

Method Details

getDefinition

public String getDefinition()

Description copied from interface: IConstraint

Gets the SQL definition of this constraint.

Specified by:

getDefinition in interface IConstraint

Returns:

the constraint definition

getErrorCode

public String getErrorCode()

addInclude

public void addInclude(String include)

Description copied from interface: PgIndexParamContainer

Adds a column to the INCLUDE clause of the index.

Specified by:

addInclude in interface ISimpleColumnContainer

Specified by:

addInclude in interface PgIndexParamContainer

Parameters:

include - column name to include

getColumns

public Set<String> getColumns()

Description copied from interface: IConstraint

Gets the columns involved in this constraint.

Specified by:

getColumns in interface IConstraint

Overrides:

getColumns in class PgConstraint

Returns:

a collection of column names

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

Overrides:

containsColumn in class PgConstraint

Parameters:

name - the column name to check

Returns:

true if the column is part of this constraint

addColumn

public void addColumn(SimpleColumn column)

Description copied from interface: ISimpleColumnContainer

Adds a column reference to this container.

Specified by:

addColumn in interface ISimpleColumnContainer

Parameters:

column - the simple column to add

addParam

public void addParam(String key,
 String value)

Description copied from interface: PgIndexParamContainer

Adds an index parameter (WITH clause option).

Specified by:

addParam in interface PgIndexParamContainer

Parameters:

key - parameter name

value - parameter value

setIndexMethod

public void setIndexMethod(String indexMethod)

setPredicate

public void setPredicate(String predicate)

setTablespace

public void setTablespace(String tablespace)

Description copied from interface: PgIndexParamContainer

Sets the tablespace for this index.

Specified by:

setTablespace in interface PgIndexParamContainer

Parameters:

tablespace - tablespace name

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

Overrides:

computeHash in class PgConstraint

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 PgConstraint