Package org.pgcodekeeper.core.schema.pg

Class PgDomain

java.lang.Object

org.pgcodekeeper.core.schema.PgStatement

org.pgcodekeeper.core.schema.pg.PgDomain

All Implemented Interfaces:

IHashable, ISearchPath, IStatement

public final class PgDomain
extends PgStatement
implements ISearchPath

PostgreSQL domain implementation. A domain is a user-defined data type that is based on another underlying type, with optional constraints, default values, and NOT NULL specifications.

Field Summary

Fields inherited from class org.pgcodekeeper.core.schema.PgStatement

GO

Constructor Summary

Constructors

Constructor	Description
PgDomain(String name)	Creates a new PostgreSQL domain.

Method Summary

Modifier and Type	Method	Description
void	addConstraint(AbstractConstraint constraint)	Adds a constraint to this domain.
ObjectState	appendAlterSQL(PgStatement newCondition, SQLScript script)	Fill script with object changes and return change type
void	appendComments(SQLScript script)	Appends comment SQL to the script if this statement has comments.
boolean	compare(PgStatement 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.
AbstractConstraint	getConstraint(String name)	Returns a constraint by name.
AbstractSchema	getContainingSchema()	Gets the schema that contains this object.
void	getCreationSQL(SQLScript script)	Generates the SQL statements needed to create this database object.
DbObjType	getStatementType()	Gets the type of this database object.
void	setCollation(String collation)
void	setDataType(String dataType)
void	setDefaultValue(String defaultValue)
void	setNotNull(boolean notNull)
PgDomain	shallowCopy()	Copies all object properties into a new object and leaves all its children empty.

Methods inherited from class org.pgcodekeeper.core.schema.PgStatement

addAllDeps, addDep, addPrivilege, appendAlterComments, appendOwnerSQL, canDrop, canDropBeforeCreate, checkComments, clearPrivileges, compareChildren, deepCopy, equals, getAuthor, getBareName, getChildren, getComment, getDbType, getDeps, getDescendants, getDropSQL, getDropSQL, getLibName, getLocation, getName, getObjectState, getObjectState, getOwner, getParent, getPrivileges, getQualifiedName, getSQL, getTwin, getTypeName, hasChildren, hashCode, isLib, isOwned, isSubElement, setAuthor, setComment, setLibName, setLocation, setOwner, setParent, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getDatabase, getSchemaName

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

getBareName, getComment, getName, getParent, getQualifiedName

Constructor Details

PgDomain

public PgDomain(String name)

Creates a new PostgreSQL domain.

Parameters:

name - domain name

Method Details

setDataType

public void setDataType(String dataType)

setCollation

public void setCollation(String collation)

setDefaultValue

public void setDefaultValue(String defaultValue)

setNotNull

public void setNotNull(boolean notNull)

getConstraint

public AbstractConstraint getConstraint(String name)

Returns a constraint by name.

Parameters:

name - constraint name

Returns:

constraint or null if not found

addConstraint

public void addConstraint(AbstractConstraint constraint)

Adds a constraint to this domain.

Parameters:

constraint - constraint to add

getStatementType

public DbObjType getStatementType()

Description copied from interface: IStatement

Gets the type of this database object.

Specified by:

getStatementType in interface IStatement

Returns:

the database object type

getCreationSQL

public void getCreationSQL(SQLScript script)

Description copied from class: PgStatement

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 class PgStatement

Parameters:

script - the SQL script to append creation statements to

appendAlterSQL

public ObjectState appendAlterSQL(PgStatement newCondition,
 SQLScript script)

Description copied from class: PgStatement

Fill script with object changes and return change type

Specified by:

appendAlterSQL in class PgStatement

Parameters:

newCondition - new object state

script - script to collect changes

Returns:

object change type

appendComments

public void appendComments(SQLScript script)

Description copied from class: PgStatement

Appends comment SQL to the script if this statement has comments.

Overrides:

appendComments in class PgStatement

Parameters:

script - the SQL script to append comments to

shallowCopy

public PgDomain shallowCopy()

Description copied from class: PgStatement

Copies all object properties into a new object and leaves all its children empty.

Specified by:

shallowCopy in class PgStatement

Returns:

shallow copy of a DB object.

compare

public boolean compare(PgStatement obj)

Description copied from class: PgStatement

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

Overrides:

compare in class PgStatement

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

getContainingSchema

public AbstractSchema getContainingSchema()

Description copied from interface: ISearchPath

Gets the schema that contains this object.

Specified by:

getContainingSchema in interface ISearchPath

Returns:

the containing schema