Skip to main content

%DeepSee.Query.function

Class %DeepSee.Query.function Extends group [ Abstract, System = 3 ]

This class defines a function within a DeepSee query.
The actual behavior of functions is implemented within the subclasses of this class.

Parameters​

FUNCTIONCLASS​

Parameter FUNCTIONCLASS As STRING;

Used to indicate which class of functions this class supports.

Properties​

function​

Property function As %DeepSee.Datatype.string(XMLPROJECTION = "attribute");

Name of the function.

label​

Property label As %DeepSee.Datatype.string(XMLPROJECTION = "attribute");

Label to display for the function (used internally).

subqueryKey​

Property subqueryKey As %Integer(XMLPROJECTION = "none");

Handle of subquery for this function (if needed).

Methods​

%KillFunctionTable​

Method %KillFunctionTable() As %String [ CodeMode = objectgenerator, Internal, Private ]

Make sure function table global is deleted whenever the function class is compiled.

%GetFunctionVersionNo​

ClassMethod %GetFunctionVersionNo() As %Integer [ CodeMode = objectgenerator, Internal, Private ]

Return a version number for the metadata.

%GetType​

Method %GetType() As %String

Return type of this node.

%TypeFlagToString​

ClassMethod %TypeFlagToString(pTypeFlag) As %String

Convert a ds Type to a printable string. Used for error reporting.

%BuildFunctionMetaData​

ClassMethod %BuildFunctionMetaData() As %Status

Test if function metadata is in the DeepSeeFunctionGLVN global. If not, put it there.

%GetFunctionInfo​

ClassMethod %GetFunctionInfo(pFunction As %String, Output pIsImplemented As %Boolean, Output pArgCount As %Integer, Output pReturns As %String, Output pArgTypes As %List, Output pArgDesc As %List) As %Boolean [ Final ]

Return meta-data for the function pFunction. Returns true if the function exists.
On return, pIsImplemented if the function is implemented.
pArgCount returns the number of required arguments the function expects or "" if this function does not take arguments.
pReturns is the return type.
pArgTypes is a list of argument types for the function.
pArgDesc is a list of argument descriptors for the function.

%GetFunctionSignature​

ClassMethod %GetFunctionSignature(pFunction As %String) As %String [ Final ]

Return a string containing the signature for the given function (used for error messages).