Package org.pgcodekeeper.core.schema

Class AbstractFunction

java.lang.Object
org.pgcodekeeper.core.schema.PgStatement
org.pgcodekeeper.core.schema.AbstractFunction
All Implemented Interfaces:
IHashable, IFunction, ISearchPath, IStatement
Direct Known Subclasses:
AbstractMsClrFunction, AbstractMsFunction, AbstractPgFunction
public abstract class AbstractFunction extends PgStatement implements IFunction, ISearchPath
Abstract base class for database functions, procedures, and aggregates. Provides common functionality for callable database objects across different database types.

  • Method Details

    • 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

    • 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

    • 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

    • 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

    • canDropBeforeCreate

      public boolean canDropBeforeCreate()
      Description copied from class: PgStatement
      Checks if this statement can be dropped before being recreated. Override in subclasses that support drop-before-create behavior.
      Overrides:
      canDropBeforeCreate in class PgStatement
      Returns:
      true if the statement can be dropped before recreation

    • 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

    • getArguments

      public List<Argument> 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

    • 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

    • needDrop

      public abstract boolean needDrop(AbstractFunction newFunction)
      Determines whether this function needs to be dropped before creating the new version.
      Parameters:
      newFunction - the new function version to compare against
      Returns:
      true if the function needs to be dropped and recreated

    • 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

    • shallowCopy

      public AbstractFunction 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.