Home > Class Reference > %SYS namespace > %DeepSee.Report.UI.reportModelServer

%DeepSee.Report.UI.reportModelServer

class %DeepSee.Report.UI.reportModelServer extends %ZEN.Component.component

Abstract Report Model File Utilities

Method Inventory

Parameters

parameter INCLUDEFILES = zenCSLM.js,zenESVG.js;
Inherited description: CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Methods

method %DrawHTML() [ Language = objectscript ]
The %DrawHTML method draws the initial HTML for this component.
classmethod DeleteTempFile(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Delete the given temp file
classmethod GetCSPDirectory() as %String [ Language = objectscript, ZenMethod ]
Get the normalized directory name of the CSP base folder used for serving up Zen Applications
classmethod GetDCR(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Load the DCR section of the given named file and return the underlying model
classmethod GetDPR(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Load the DPR section of the given named file and return the underlying model
classmethod GetDPRDSSClass(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Return the DSSClass upon which the current DPR is based
classmethod GetDPRDSSHome(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Return the DSS Home of the current DPR
classmethod GetDSS(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Load the DSS section of the given named file and return the underlying model
classmethod GetQueryInterface(fileName As %String) as %String [ Language = objectscript, ZenMethod ]
Load the Query Interface section of the given named file and return the underlying model
classmethod GetReportSuperClasses() as %String [ Language = objectscript, ZenMethod ]
classmethod GetSystemHomeDir() as %String [ Language = objectscript, ZenMethod ]
Return the system install directory of this instance
classmethod GetSystemTempDir() as %String [ Language = objectscript, ZenMethod ]
Return the temp directory for this system.
classmethod GetTimeStampInfo() as %String [ Language = objectscript, ZenMethod ]
Generate data for a time stamp as a string for file generation purposes
classmethod ImportXML(fileName) as %String [ Language = objectscript, ZenMethod ]
Load and compile the given temp file
classmethod MakeRandomFileName(ext As %String = "", directory As %String = "") as %String [ Language = objectscript, ZenMethod ]
Generate a random but legal and available file name for the creation of external temp files
classmethod ReceiveFragment(outputFile As %String, src As %ZEN.proxyObject) as %Status [ Language = objectscript, ZenMethod ]
Receive a chuck of a client text stream submission
clientmethod backupModel() [ Language = javascript ]
Copy the current (client-side) model to a json string for short term back-up purposes
clientmethod convertDCRToDSS(cls, node) [ Language = javascript ]
Given a valid DCR JSON object, generate a DSS
clientmethod convertRDNodeToDSS(cls, n) [ Language = javascript ]
clientmethod convertRDToDSS(cls, xData) [ Language = javascript ]
clientmethod createNewDCR(headerInfo) [ Language = javascript ]
Create a new DCR type report model
clientmethod createNewDPR(headerInfo) [ Language = javascript ]
Create a new DPR type report model
clientmethod createNewDSS(headerInfo) [ Language = javascript ]
Create a new DSS type report model
clientmethod createNewSQLDSS(headerInfo) [ Language = javascript ]
Create a new DSS type report model based on an external SQL Query
clientmethod decodeDSSNode(o) [ Language = javascript ]
clientmethod encodeDSSNode(o) [ Language = javascript ]
clientmethod exportAsXML(jsonOnly) [ Language = javascript ]
clientmethod exportDSS(node) [ Language = javascript ]
clientmethod exportReportDef(node) [ Language = javascript ]
clientmethod exportXMLtoFile(name) [ Language = javascript ]
clientmethod getCSPDir() [ Language = javascript ]
clientmethod getDCRDataTree() [ Language = javascript ]
Return the data tree section of the current model, if it is a DCR type report and null otherwise.
clientmethod getDCRMethodsSection() [ Language = javascript ]
Return the methods section of the current model, if it is a DCR type report and null otherwise.
clientmethod getDCRPropertiesSection() [ Language = javascript ]
Return the properties section of the current model, if it is a DCR type report and null otherwise.
clientmethod getDCRSQL() [ Language = javascript ]
Return the SQL section of the current model, if it is a DCR type report and null otherwise.
clientmethod getDSSObject() [ Language = javascript ]
Extract a javascript object represeting the Data Set Schema from the current abstract model, assuming the active model is a DSS type structure.
clientmethod getQueryInfo(clsName) [ Language = javascript ]
clientmethod getReportApplication() [ Language = javascript ]
Get the name of application associated with the current report.
clientmethod getReportClassName() [ Language = javascript ]
Get the class name of the current report (this value can only be set at the time of report creation via createNewDCR, createNewDSS, or createNewDPR)
clientmethod getReportDataSource() [ Language = javascript ]
Get the name of data source associated with the current report.
clientmethod getReportDescription() [ Language = javascript ]
Return the descriptor of the current report
clientmethod getReportName() [ Language = javascript ]
Return the semantic name of the current report
clientmethod getReportOutputMode() [ Language = javascript ]
Return the default processing mode based on the current model's type
clientmethod getReportPackageName() [ Language = javascript ]
Get the package name of the current report (this value can only be set at the time of report creation via createNewDCR, createNewDSS, or createNewDPR)
clientmethod getReportSuperClass() [ Language = javascript ]
Return the formal name(s) of the immediate superclass based on the current model's type definition
clientmethod getReportSystemName() [ Language = javascript ]
Get the full InterSystems IRIS name of the current report. This is a concatenation of the the package name and the class name and is read only.
clientmethod getServerFileDelimiter() [ Language = javascript ]
clientmethod getServerHomeDir() [ Language = javascript ]
clientmethod getServerTempDir() [ Language = javascript ]
clientmethod humanizeXMLString(origStr) [ Language = javascript ]
un-escape an XML string previously encoded with sanitize XMLString
clientmethod makeXMLFileName(name) [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod restoreBackupModel(jsonStr) [ Language = javascript ]
Reset the model based on a previously saved json back-up string.
clientmethod sanitizeXMLString(origStr) [ Language = javascript ]
Given a string to be exported as an XML attribute setting Replace all instances of '&' with '&' Replace all instances of '"' with '"' Replace all instances of "'" with ''' Replace all instances of '<' with '<' Replace all instances of '>' with '>'
clientmethod setDCRDataTree(tree) [ Language = javascript ]
Set the data tree section of the current model, assuming it is a DCR type report and no-op otherwise.
clientmethod setDCRMethodsSection(m) [ Language = javascript ]
Set the methods section of the current model, assuming it is a DCR type report and no-op otherwise.
clientmethod setDCRPropertiesSection(prop) [ Language = javascript ]
Set the properties section of the current model to the given array of property objects
clientmethod setDCRSQL(sqlObj) [ Language = javascript ]
Set the SQL section of the current model assuming it is a DCR type report and no-op otherwise.
clientmethod setDPRMethodsSection(m) [ Language = javascript ]
Set the methods section of the current model, assuming it is a DPR type report and no-op otherwise.
clientmethod setReportApplication(s) [ Language = javascript ]
Set the name of application associated with the current report.
clientmethod setReportDataSource(s) [ Language = javascript ]
Set the name of data source associated with the current report.
clientmethod setReportDescription(s) [ Language = javascript ]
Set the descriptor of the current report
clientmethod setReportName(n) [ Language = javascript ]
Set the semantic name of the current report. This is the human readable textual name, as opposed to the lexical class and system names.
clientmethod setReportSource(cls, reportType) [ Language = javascript ]
Set the reportSource for the report.
clientmethod setZRSBody(src) [ Language = javascript ]

Inherited Methods