Home > Class Reference > %SYS namespace > %DeepSee.Query.node

%DeepSee.Query.node

abstract class %DeepSee.Query.node extends %Library.RegisteredObject, %XML.Adaptor

Base class for DeepSee RunTime objects.

Parameters

parameter NAMESPACE = http://www.intersystems.com/deepsee/query;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLIGNOREINVALIDATTRIBUTE = 0;
Inherited description: The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected attributes in the XML input. By default (XMLIGNOREINVALIDATTRIBUTE = 1), will ignore unexpected attributes. If XMLIGNOREINVALIDATTRIBUTE is set = 0, then an unexpected attribute will be treated as an error.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

relationship parent as %DeepSee.Query.group (XMLPROJECTION = "none") [ Inverse = children , Cardinality = one ];
Parent of this node.
The type of the parent depends on context.
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentUnRelate()
property value as %DeepSee.Datatype.string (MAXLEN = 32000, XMLPROJECTION = "attribute");
Value of this node. This is used by nodes that provide values.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Methods

method %GetMemberProvider() as %DeepSee.Query.member [ Language = objectscript ]
Return the member provider object associated with this node, if any.
method %GetType() as %String [ Language = objectscript ]
Return the type of this node.
The type can be one of the $$$dst macros.
This is implemented by subclasses.
method %GetValue() as %String [ Language = objectscript ]
Return the current value of this node.
This is called when a literal value is needed during query processing. This is implemented by subclasses.
method %IsEnabled(pCube As %String = "", Output pStatus As %Status = $$$OK, Output pReason As %String = "") as %Boolean [ Language = objectscript ]
Test this node to make sure all data references are currently marked enabled in the cube.
method %PreProcess(pIsSlicer As %Boolean = 0) as %Status [ Language = objectscript ]
Execute the pre-processing logic for this node.
pIsSlicer is true if this node is part of the slicer (WHERE) clause.
method %PrintNode(pLevel As %Integer = 0) [ Language = objectscript ]
Diagnostic. Print value of this node to the console.
method %ToString(Output pSC As %Status) as %String [ Language = objectscript ]
Convert this node to its text representation.

Inherited Methods

%AddToSaveSet() %Extends() %SetModified()
%ClassIsLatestVersion() %GetParameter() %ValidateObject()
%ClassName() %IsA() XMLDTD()
%ConstructClone() %IsModified() XMLExport()
%DispatchClassMethod() %New() XMLExportToStream()
%DispatchGetModified() %NormalizeObject() XMLExportToString()
%DispatchGetProperty() %ObjectModified() XMLNew()
%DispatchMethod() %OriginalNamespace() XMLSchema()
%DispatchSetModified() %PackageName() XMLSchemaNamespace()
%DispatchSetMultidimProperty() %RemoveFromSaveSet() XMLSchemaType()
%DispatchSetProperty() %SerializeObject()

Subclasses

%DeepSee.Query.constant %DeepSee.Query.group %DeepSee.Query.range
%DeepSee.Query.flag %DeepSee.Query.query