IRISLIB database
function Class Reference

This class defines a function within a DeepSee query. More...

Inheritance diagram for function:
Collaboration diagram for function:

Public Attributes

 function
 Name of the function. More...
 
 label
 Label to display for the function (used internally). More...
 
 subqueryKey
 Handle of subquery for this function (if needed). More...
 
- Public Attributes inherited from group
 children
 Children of this group. More...
 
- Public Attributes inherited from node
 parent
 Parent of this node. More...
 
 value
 Value of this node. More...
 

Static Public Attributes

 FUNCTIONCLASS = None
 This class defines a function within a DeepSee query. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Private Member Functions

_.Library.String GetType ()
 Return type of this node.
 

Static Private Member Functions

_.Library.Status BuildFunctionMetaData ()
 Test if function metadata is in the DeepSeeFunctionGLVN global. More...
 
_.Library.Boolean GetFunctionInfo (_.Library.String pFunction, _.Library.Boolean pIsImplemented, _.Library.Integer pArgCount, _.Library.String pReturns, _.Library.List pArgTypes, _.Library.List pArgDesc)
 Return meta-data for the function pFunction. More...
 
_.Library.String GetFunctionSignature (_.Library.String pFunction)
 Return a string containing the signature for the given function. More...
 
_.Library.String TypeFlagToString (pTypeFlag)
 Convert a ds Type to a printable string. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 

Detailed Description

This class defines a function within a DeepSee query.


The actual behavior of functions is implemented within the subclasses of this class.

Member Function Documentation

◆ BuildFunctionMetaData()

_.Library.Status BuildFunctionMetaData ( )
staticprivate

Test if function metadata is in the DeepSeeFunctionGLVN global.

If not, put it there.

Reimplemented in setFunction, and memberFunction.

◆ GetFunctionInfo()

_.Library.Boolean GetFunctionInfo ( _.Library.String  pFunction,
_.Library.Boolean  pIsImplemented,
_.Library.Integer  pArgCount,
_.Library.String  pReturns,
_.Library.List  pArgTypes,
_.Library.List  pArgDesc 
)
staticprivate

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()

_.Library.String GetFunctionSignature ( _.Library.String  pFunction)
staticprivate

Return a string containing the signature for the given function.

(used for error messages).

◆ TypeFlagToString()

_.Library.String TypeFlagToString (   pTypeFlag)
staticprivate

Convert a ds Type to a printable string.

Used for error reporting.

Member Data Documentation

◆ FUNCTIONCLASS

FUNCTIONCLASS = None
static

This class defines a function within a DeepSee query.


The actual behavior of functions is implemented within the subclasses of this class.

Used to indicate which class of functions this class supports.

◆ function

Name of the function.

 

◆ label

label

Label to display for the function (used internally).

 

◆ subqueryKey

subqueryKey

Handle of subquery for this function (if needed).