Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > %SYS namespace > %DeepSee.Query.memberFunction
Private  Storage   

%DeepSee.Query.memberFunction


class %DeepSee.Query.memberFunction extends
function

This class defines a member function within a DeepSee query.
A "member" function is a function that is syntactically part of a member: member.FUNC or member.FUNC(a)
These are sometimes referred to as operators within MDX.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 10 24


Summary


Properties
%cmbrAgg %cmbrFormat %cmbrLabel %cmbrLiteral %cmbrMarker
%cmbrMeasure %cmbrQualifier %cmbrRelSpec %cmbrWrapper %member
children function label parent subqueryKey
value

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildFunctionMetaData
%BuildObjectGraph %ClassIsLatestVersion %ClassName %Close
%ConstructClone %CopyNode %DeleteNode %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Extends %GetFunctionInfo
%GetFunctionSignature %GetMemberProvider %GetParameter %GetType
%GetValue %HideNode %IncrementCount %IsA
%IsEnabled %IsModified %New %NormalizeObject
%ObjectModified %OriginalNamespace %PackageName %PreProcess
%PrintNode %ProcessAxes %ProcessFilter %ReduceNode
%RemoveFromSaveSet %SerializeObject %SetModified %ToString
%TypeFlagToString %ValidateObject %XMLGenerate FXAll
FXAllMember FXChangeAggregate FXChildren FXCurrentMember
FXFirstChild FXFirstSibling FXLag FXLastChild
FXLastSibling FXLead FXMembers FXNextMember
FXNot FXParent FXPrevMember FXProperties
FXRank FXSiblings XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters


• parameter FUNCTIONCLASS = "mbr";
Used to indicate which class of functions this class supports.

Properties


• property %cmbrAgg as %String(MAXLEN=50,XMLPROJECTION="none");
For CurrentMember functions, this is the function used to aggregate children of the currentMember reference, if any.
• property %cmbrFormat as %String(MAXLEN=250,XMLPROJECTION="none");
For CurrentMember functions, this is the format used for the current member.
• property %cmbrLabel as %String(MAXLEN=250,XMLPROJECTION="none");
For CurrentMember functions, this is the label used for the current member.
• property %cmbrLiteral as %String(MAXLEN=2000,XMLPROJECTION="none");
For CurrentMember functions, this a literal value to apply to children of the currentMember reference, if any.
• property %cmbrMarker as %String(MAXLEN=50,XMLPROJECTION="none");
For CurrentMember functions, this is used to output a marker value for this node when %ToString is called.
• property %cmbrMeasure as %String(MAXLEN=255,XMLPROJECTION="none");
For CurrentMember functions, this is the name of the measure used to aggregate children of the currentMember reference, if any.
• property %cmbrQualifier as %String(MAXLEN=1000,XMLPROJECTION="none");
For CurrentMember functions, this contains additional functions to apply to the current member once it is resolved.
• property %cmbrRelSpec as %String(MAXLEN=2000,XMLPROJECTION="none");
For CurrentMember functions, this is the relationship part of the member spec, if applicable. E.g., "[Doctors]".
• property %cmbrWrapper as %String(MAXLEN=1000,XMLPROJECTION="none");
For CurrentMember functions, this contains any MDX that wraps the current member.
• property %member as %DeepSee.Query.member(XMLPROJECTION="none");
Member object that provides the member API for the member returned by this function, if any. This is created during the axis-processing phase.

Methods


• classmethod %BuildFunctionMetaData() as %Status
Test if function metadata is in the DeepSeeFunctionGLVN global. If not, put it there.
• method %GetMemberProvider() as %DeepSee.Query.member
Return the member provider object associated with this node.
• method %PreProcess(pIsSlicer As %Boolean = 0) as %Status
Execute the pre-processing logic for this node.
• method %ProcessAxes(pCube As %String, pKey As %String, ByRef pNodeNo As %Integer, Output pNewNodeNo As %Integer, pParent As %Integer, pVisible As %Boolean = 1) as %Status
Execute and build the axes output for this axis.
• method %ToString(Output pSC As %Status) as %String
Convert this node to its text representation.
• method FXAll(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute the special %All function on the given member and place results into pSet.
This cause all references to this level along other rows and columns to be ignored. The slicer is still applied.
• method FXAllMember(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute %AllMember function on the given member and place results into pSet.
This finds the All member for the current dimension (if present).
• method FXChangeAggregate(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List, pAggregate As %String) as %Status
Change the default aggregate to pAggregate on the current measure and place results into pSet.
• method FXChildren(pCube As %String, pKey As %String, ByRef pNodeNo As %Integer, pParent As %Integer, pMember As %DeepSee.Query.member, pReturnSelf As %Boolean = 0) as %Status
Execute the Children function on the given member and place results into pSet.
This will return all children of the current member node.
The work of getting the members is delegated to the member object pMember.
• method FXCurrentMember(pCube As %String, pParent As %Integer, Output pSet As %List) as %Status
Execute the CurrentMember function on the given member and place results into pSet.
• method FXFirstChild(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute the FirstChild function on the given member and place results into pSet.
This will return the first child of the current member node.
The work of getting the members is delegated to the member object pMember.
• method FXFirstSibling(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute FirstSibling function on the given member and place results into pSet.
• method FXLag(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List, ByRef pArgs As %DeepSee.Query.node) as %Status
Execute Lag function on the given member and place results into pSet.
• method FXLastChild(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute the LastChild function on the given member and place results into pSet.
This will return the last child of the current member node.
The work of getting the members is delegated to the member object pMember.
• method FXLastSibling(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute LastSibling function on the given member and place results into pSet.
• method FXLead(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List, ByRef pArgs As %DeepSee.Query.node) as %Status
Execute Lead function on the given member and place results into pSet.
pArgs contains the array of arguments for this function.
• method FXMembers(pCube As %String, pKey As %String, ByRef pNodeNo As %Integer, pParent As %Integer, pMember As %DeepSee.Query.member, pIncludeCalc As %Boolean = 0, pTopMembers As %Boolean = 0) as %Status
Execute the Members function on the given member and place results into the axis global.
This will return all members of the current node.
The work of getting the members is delegated to the member object pMember. If pIncludeCalc is true, return calculated members as well.
• method FXNextMember(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute NextMember function on the given member and place results into pSet.
• method FXNot(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute the special %NOT function on the given member and place results into pSet.
This adds a negation marker to the key for given member.
• method FXParent(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute Parent function on the given member and place results into pSet.
• method FXPrevMember(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List) as %Status
Execute PrevMember function on the given member and place results into pSet.
• method FXProperties(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List, ByRef pArgs As %DeepSee.Query.node) as %Status
Execute Properties function on the given member and place results into pSet.
pArgs contains the array of arguments for this function.
• method FXRank(pCube As %String, pParent As %Integer, pMember As %DeepSee.Query.member, Output pSet As %List, ByRef pArgs As %DeepSee.Query.node) as %Status
Execute the internal function %RANK on the given member and place results into pSet.
pArgs contains the array of arguments for this function.
This function is used when a RANK operation had to be run on a resolved CurrentMember.
• method FXSiblings(pCube As %String, pKey As %String, ByRef pNodeNo As %Integer, pParent As %Integer, pMember As %DeepSee.Query.member) as %Status
Execute the Siblings function on the given member and place results into pSet.
This will return all siblings of the current member node.
The work of getting the members is delegated to the member object pMember.