Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%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.

Property Inventory

Method Inventory

Parameters

parameter XMLNAME = model;
Inherited description: 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 methods: dataFieldsBuildValueArray(), dataFieldsCollectionToDisplay(), dataFieldsCollectionToOdbc(), dataFieldsDisplayToCollection(), dataFieldsGet(), dataFieldsGetObject(), dataFieldsGetObjectId(), dataFieldsGetSwizzled(), dataFieldsIsValid(), dataFieldsOdbcToCollection(), dataFieldsSet(), dataFieldsSetObject(), dataFieldsSetObjectId()
property dataSource as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Name of the dataSource (class) that supplies data for this report.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property description as %String (MAXLEN = 5000, XMLPROJECTION = "attribute");
Optional description for this report.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property document as Document (XMLPROJECTION = "element");
document element
Property methods: documentGet(), documentGetSwizzled(), documentIsValid(), documentNewObject(), documentSet()
property groups as list of Group (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE");
Set of groups within this report.
Property methods: groupsBuildValueArray(), groupsCollectionToDisplay(), groupsCollectionToOdbc(), groupsDisplayToCollection(), groupsGet(), groupsGetObject(), groupsGetObjectId(), groupsGetSwizzled(), groupsIsValid(), groupsOdbcToCollection(), groupsSet(), groupsSetObject(), groupsSetObjectId()
page footer element
Property methods: pageFooterGet(), pageFooterGetSwizzled(), pageFooterIsValid(), pageFooterNewObject(), pageFooterSet()
page header element
Property methods: pageHeaderGet(), pageHeaderGetSwizzled(), pageHeaderIsValid(), pageHeaderNewObject(), pageHeaderSet()
property xpath as %String);
Property methods: xpathDisplayToLogical(), xpathGet(), xpathIsValid(), xpathLogicalToDisplay(), xpathLogicalToOdbc(), xpathNormalize(), xpathSet()

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab