Package org.pgcodekeeper.core.schema.meta

Class MetaFunction

java.lang.Object

org.pgcodekeeper.core.schema.meta.MetaStatement

org.pgcodekeeper.core.schema.meta.MetaFunction

All Implemented Interfaces:

Serializable, IFunction, ISearchPath, IStatement

public final class MetaFunction
extends MetaStatement
implements IFunction

Represents a database function metadata object. Stores information about function signatures, arguments, return types, and special properties like SETOF functions and aggregate order by clauses.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetaFunction(String schemaName, String name, String bareName)	Creates a new function metadata object.
MetaFunction(PgObjLocation object, String bareName)	Creates a new function metadata object with location information.

Method Summary

Modifier and Type	Method	Description
void	addArgument(Argument arg)	Adds an argument to this function.
void	addOrderBy(Argument type)	Adds an ORDER BY argument for aggregate functions.
void	addReturnsColumn(String name, String type)	Adds a column to the returns table for table-returning functions.
List<Argument>	getArguments()	Gets the list of function arguments.
String	getBareName()	Gets the bare name without qualifiers or arguments.
ISchema	getContainingSchema()	Returns the containing schema of this function.
String	getName()	Alias for getSignature() which provides a unique function ID.
String	getReturns()	Gets the return type of this function.
Map<String,String>	getReturnsColumns()	Gets the return columns for table-valued functions.
String	getSchemaName()	Returns the schema name of this function.
String	getSignature()	Returns function signature.
boolean	isSetof()	Returns whether this function returns a set of values.
void	setReturns(String returns)	Sets the return type of this function.
void	setSetof(boolean setof)

Methods inherited from class org.pgcodekeeper.core.schema.meta.MetaStatement

getComment, getDatabase, getFilePath, getGenericColumn, getLineNumber, getObject, getObjLength, getOffset, getParent, getQualifiedName, getStatementType, setComment

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDatabase

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

getComment, getParent, getQualifiedName, getStatementType

Constructor Details

MetaFunction

public MetaFunction(PgObjLocation object,
 String bareName)

Creates a new function metadata object with location information.

Parameters:

object - the object location information

bareName - the bare function name without signature

MetaFunction

public MetaFunction(String schemaName,
 String name,
 String bareName)

Creates a new function metadata object.

Parameters:

schemaName - the schema name

name - the function name (typically the signature)

bareName - the bare function name without signature

Method Details

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

addReturnsColumn

public void addReturnsColumn(String name,
 String type)

Adds a column to the returns table for table-returning functions.

Parameters:

name - the column name

type - the column type

getArguments

public List<Argument> getArguments()

Description copied from interface: IFunction

Gets the list of function arguments.

Specified by:

getArguments in interface IFunction

Returns:

the list of arguments

addArgument

public void addArgument(Argument arg)

Adds an argument to this function.

Parameters:

arg - the argument to add

isSetof

public boolean isSetof()

Returns whether this function returns a set of values.

Returns:

true if this is a SETOF function, false otherwise

setSetof

public void setSetof(boolean setof)

addOrderBy

public void addOrderBy(Argument type)

Adds an ORDER BY argument for aggregate functions.

Parameters:

type - the order by argument

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

getName

public String getName()

Alias for getSignature() which provides a unique function ID.

Use getBareName() to get just the function name.

Specified by:

getName in interface IStatement

Overrides:

getName in class MetaStatement

Returns:

the statement name

getBareName

public String getBareName()

Description copied from interface: IStatement

Gets the bare name without qualifiers or arguments.

Specified by:

getBareName in interface IStatement

Overrides:

getBareName in class MetaStatement

Returns:

the bare name

getSignature

public String getSignature()

Returns function signature. It consists of unquoted name and argument data types.

Returns:

function signature

getContainingSchema

public ISchema getContainingSchema()

Returns the containing schema of this function. This operation is not supported for metadata functions.

Specified by:

getContainingSchema in interface ISearchPath

Returns:

never returns normally

Throws:

IllegalStateException - always thrown as this operation is unsupported

getSchemaName

public String getSchemaName()

Returns the schema name of this function.

Specified by:

getSchemaName in interface ISearchPath

Returns:

the schema name