public class BuiltInFunction extends AbstractBuildableObject implements SQLCallable
AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE |
Constructor and Description |
---|
BuiltInFunction() |
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.
|
checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getName
public static final java.lang.String TYPE
public java.lang.String getType()
DBObject
public void setDescription(java.lang.String description)
public java.lang.String getDescription()
public void setAggregate(boolean aggregate)
public boolean isAggregate()
isAggregate
in interface SQLCallable
public void setWindow(boolean window)
public boolean isWindow()
isWindow
in interface SQLCallable
public boolean isVariableArgumentList()
isVariableArgumentList
in interface SQLCallable
public void setVariableArgumentList(boolean vararg)
public void setReturnTypeID(DBObjectID returnTypeID)
returnTypeID
- The ID of the return type.public DBObjectID getReturnTypeID()
getReturnTypeID
in interface SQLCallable
SQLCallable.getArgumentDefiningReturnType()
) or if the method is not a function.public void setArguments(BuiltInFunctionArgument[] arguments)
public BuiltInFunctionArgument[] getArguments()
getArguments
in interface SQLCallable
public void setArgumentDefiningReturnType(java.lang.Integer argNo)
public java.lang.Integer getArgumentDefiningReturnType()
getArgumentDefiningReturnType
in interface SQLCallable
public void setParenthesesRequired(boolean parenthesesRequired)
public boolean isParenthesesRequired()
isParenthesesRequired
in interface SQLCallable
public int getMaxArgs()
public int getMinArgs()
public boolean isFunction()
isFunction
in interface SQLCallable
public java.lang.String getSignature(boolean full)
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.public void setName(java.lang.String name)
DBObject
setName
in interface DBObject
setName
in class AbstractDBObject
name
- a string containing the new name for this object.