Home > Class Reference > %SYS namespace > %DeepSee.Report.Model.Report
Private  

%DeepSee.Report.Model.Report

class %DeepSee.Report.Model.Report extends %DeepSee.Report.Model.Node

This class is used by the DeepSee Report Generator.
It contains the report-level information about the report to be generated.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8 3

Summary

Properties
dataFields dataSource description document groups
name pageFooter pageHeader xpath
Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %GetSQLForField %GetSQLTableName %IsA
%IsModified %New %NormalizeObject %ObjectModified
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject ImportFile XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType

Parameters

parameter XMLNAME = "model";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

property dataFields as list of DataField(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE");
Set of data fields defined for this report.
property dataSource as %String(MAXLEN=255,XMLPROJECTION="attribute");
Name of the dataSource (class) that supplies data for this report.
property description as %String(MAXLEN=5000,XMLPROJECTION="attribute");
Optional description for this report.
property document as Document(XMLPROJECTION="element");
document element
property groups as list of Group(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE");
Set of groups within this report.
property pageFooter as PageFooter(XMLNAME="pagefooter",XMLPROJECTION="element");
page footer element
property pageHeader as PageHeader(XMLNAME="pageheader",XMLPROJECTION="element");
page header element
property xpath as %String(MAXLEN="",XMLPROJECTION="none");

Methods

method %GetSQLForField(pField As %String, Output pExpr As %String) as %Status
Given a field name, return the SQL expression needed to fetch it.
method %GetSQLTableName(Output pTable As %String) as %Status
Return the SQL table that supplies data for this report.
classmethod ImportFile(filename As %String) as Report