oracle.javatools.db.sql

Class BuiltInFunction

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.sql.BuiltInFunction

All Implemented Interfaces:

DBObject, SQLCallable, Copyable

public class BuiltInFunction
extends AbstractBuildableObject
implements SQLCallable

Class used for defining built in functions for the database.

Since:

12.1.3

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
BuiltInFunction()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getArgumentDefiningReturnType() If the return type of the function is dependent upon the datatypes of its arguments, this method gets which argument defines the return type.
BuiltInFunctionArgument[]	getArguments() Gets the arguments for the function.
java.lang.String	getDescription() Returns a description for the function.
int	getMaxArgs() Returns the number of arguments the function takes.
int	getMinArgs() Returns the number of arguments the function takes.
DBObjectID	getReturnTypeID() Gets the ID of the return type of the function.
java.lang.String	getSignature(boolean full) Returns the signature of the function
java.lang.String	getType() Returns the type of this object.
boolean	isAggregate() Gets whether this is an aggregate (grouping) function.
boolean	isFunction()
boolean	isParenthesesRequired() Gets whether this function requires parentheses in the call.
boolean	isVariableArgumentList() Gets whether this function supports a variable argument list (aka varargs).
boolean	isWindow() Gets whether this is an windowing (a) function.
void	setAggregate(boolean aggregate) Sets whether this is an aggregate (grouping) function.
void	setArgumentDefiningReturnType(java.lang.Integer argNo) If the return type of the function is dependent upon the datatypes of its arguments, this method sets which argument defines the return type.
void	setArguments(BuiltInFunctionArgument[] arguments) Sets the arguments for the function.
void	setDescription(java.lang.String description) Sets a textual description of the BuiltInFunction
void	setName(java.lang.String name) Sets the name of this object.
void	setParenthesesRequired(boolean parenthesesRequired) Sets whether this function requires parentheses in the call.
void	setReturnTypeID(DBObjectID returnTypeID) Sets return type of the function.
void	setVariableArgumentList(boolean vararg) Sets whether this function supports a variable argument list (aka varargs).
void	setWindow(boolean window) Sets whether this is an windowing (a) function.

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.sql.SQLCallable

getName

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

BuiltInFunction

public BuiltInFunction()

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Specified by:

getType in interface DBObject

Returns:

a string describing the type of object.

setDescription

public void setDescription(java.lang.String description)

Sets a textual description of the BuiltInFunction

getDescription

public java.lang.String getDescription()

Returns a description for the function.

setAggregate

public void setAggregate(boolean aggregate)

Sets whether this is an aggregate (grouping) function.

isAggregate

public boolean isAggregate()

Gets whether this is an aggregate (grouping) function.

Specified by:

isAggregate in interface SQLCallable

Returns:

True if this is an aggregate (aka grouping) function. False otherwise.

setWindow

public void setWindow(boolean window)

Sets whether this is an windowing (a) function.

isWindow

public boolean isWindow()

Gets whether this is an windowing (a) function.

Specified by:

isWindow in interface SQLCallable

Returns:

True if this is an window (aka analytic) function. False otherwise.

isVariableArgumentList

public boolean isVariableArgumentList()

Gets whether this function supports a variable argument list (aka varargs).

Specified by:

isVariableArgumentList in interface SQLCallable

Returns:

True if the method can take a variable number of arguments

setVariableArgumentList

public void setVariableArgumentList(boolean vararg)

Sets whether this function supports a variable argument list (aka varargs).

setReturnTypeID

public void setReturnTypeID(DBObjectID returnTypeID)

Sets return type of the function.

Parameters:

returnTypeID - The ID of the return type.

getReturnTypeID

public DBObjectID getReturnTypeID()

Gets the ID of the return type of the function.

Specified by:

getReturnTypeID in interface SQLCallable

Returns:

The id of the method return type (or an approximation) if known. Can be null if the return type is not known, or is defined by one of the arguments (see SQLCallable.getArgumentDefiningReturnType()) or if the method is not a function.

setArguments

public void setArguments(BuiltInFunctionArgument[] arguments)

Sets the arguments for the function.

getArguments

public BuiltInFunctionArgument[] getArguments()

Gets the arguments for the function.

Specified by:

getArguments in interface SQLCallable

Returns:

The arguments to the method

setArgumentDefiningReturnType

public void setArgumentDefiningReturnType(java.lang.Integer argNo)

If the return type of the function is dependent upon the datatypes of its arguments, this method sets which argument defines the return type.

getArgumentDefiningReturnType

public java.lang.Integer getArgumentDefiningReturnType()

If the return type of the function is dependent upon the datatypes of its arguments, this method gets which argument defines the return type.

Specified by:

getArgumentDefiningReturnType in interface SQLCallable

Returns:

The argument number that specifies the return type, if any.

setParenthesesRequired

public void setParenthesesRequired(boolean parenthesesRequired)

Sets whether this function requires parentheses in the call.

isParenthesesRequired

public boolean isParenthesesRequired()

Gets whether this function requires parentheses in the call.

Specified by:

isParenthesesRequired in interface SQLCallable

Returns:

True if a call to this function requires parentheses. False otherwise.

getMaxArgs

public int getMaxArgs()

Returns the number of arguments the function takes.

getMinArgs

public int getMinArgs()

Returns the number of arguments the function takes.

isFunction

public boolean isFunction()

Specified by:

isFunction in interface SQLCallable

Returns:

True if the method returns a value

getSignature

public java.lang.String getSignature(boolean full)

Returns the signature of the function

Parameters:

full - if true, signature includes details of argument(s) and return datatypes where known, and an indicator of whether the function is aggregate and/or analytic.

setName

public void setName(java.lang.String name)

Description copied from interface: DBObject

Sets the name of this object.

Specified by:

setName in interface DBObject

Overrides:

setName in class AbstractDBObject

Parameters:

name - a string containing the new name for this object.