Package org.pgcodekeeper.core.database.ms.schema

Class MsAbstractCommonFunction

java.lang.Object

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

org.pgcodekeeper.core.database.ms.schema.MsAbstractStatement

org.pgcodekeeper.core.database.ms.schema.MsAbstractCommonFunction

All Implemented Interfaces:

IFunction, ISearchPath, IStatement, IHashable

Direct Known Subclasses:

MsAbstractClrFunction, MsAbstractFunction

public abstract class MsAbstractCommonFunction
extends MsAbstractStatement
implements IFunction

Abstract base class for database functions, procedures, and aggregates. Provides common functionality for callable database objects across different database types.

Method Summary

Modifier and Type	Method	Description
void	addArgument(Argument argument)	Adds an argument to this function.
ObjectState	appendAlterSQL(IStatement newCondition, SQLScript script)	Fill script with object changes and return change type
boolean	canDropBeforeCreate()	Checks if this statement can be dropped before being recreated.
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.
List<IArgument>	getArguments()	Getter for arguments.
void	getCreationSQL(SQLScript script)	Generates the SQL statements needed to create this database object.
String	getReturns()	Gets the return type of this function.
Map<String,String>	getReturnsColumns()	Gets the return columns for table-valued functions.
void	setReturns(String returns)	Sets the return type of this function.

Methods inherited from class org.pgcodekeeper.core.database.ms.schema.MsAbstractStatement

appendOwnerSQL, formatSql, getQuoter, getRenameCommand, getSeparator, isOwned

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

addDependency, addPrivilege, appendAlterComments, appendComments, appendPrivileges, canDrop, checkComments, clearPrivileges, compareChildren, deepCopy, equals, fillChildrenList, fillDescendantsList, getAuthor, getBareName, getChildren, getComment, getDependencies, getDescendants, getDropSQL, getDropSQL, getLibName, getLocation, getName, getObjectState, getObjectState, getOwner, getParent, getPrivileges, getQualifiedName, 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.IFunction

needDrop

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

getContainingSchema, getDatabase, getSchemaName, toObjectReference

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

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

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

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

getReturns

public String getReturns()

Description copied from interface: IFunction

Gets the return type of this function.

Specified by:

getReturns in interface IFunction

Returns:

the return type, or null if not applicable

canDropBeforeCreate

public boolean canDropBeforeCreate()

Description copied from interface: IStatement

Checks if this statement can be dropped before being recreated. Override in subclasses that support drop-before-create behavior.

Specified by:

canDropBeforeCreate in interface IStatement

Overrides:

canDropBeforeCreate in class AbstractStatement

Returns:

true if the statement can be dropped before recreation

setReturns

public void setReturns(String returns)

Description copied from interface: IFunction

Sets the return type of this function.

Specified by:

setReturns in interface IFunction

Parameters:

returns - the return type to set

getReturnsColumns

public Map<String,String> getReturnsColumns()

Description copied from interface: IFunction

Gets the return columns for table-valued functions.

Specified by:

getReturnsColumns in interface IFunction

Returns:

a map of column names to their types

getArguments

public List<IArgument> getArguments()

Getter for arguments. List cannot be modified.

Specified by:

getArguments in interface IFunction

Returns:

the list of arguments

addArgument

public void addArgument(Argument argument)

Adds an argument to this function.

Parameters:

argument - the argument to add

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