class %DeepSee.Report.UI.reportModelServer
extends %ZEN.Component.component
Abstract Report Model File Utilities
parameter INCLUDEFILES = "zenCSLM.js,zenESVG.js";
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.
method %DrawHTML()
The %DrawHTML method draws the initial HTML for this component.
classmethod DeleteTempFile(fileName As %String)
as %String
[ ZenMethod ]
Delete the given temp file
classmethod GetCSPDirectory()
as %String
[ ZenMethod ]
Get the normalized directory name of the CSP base folder used for serving up Zen Applications
classmethod GetDCR(fileName As %String)
as %String
[ ZenMethod ]
Load the DCR section of the given named file and return the underlying model
classmethod GetDPR(fileName As %String)
as %String
[ ZenMethod ]
Load the DPR section of the given named file and return the underlying model
classmethod GetDPRDSSClass(fileName As %String)
as %String
[ ZenMethod ]
Return the DSSClass upon which the current DPR is based
classmethod GetDPRDSSHome(fileName As %String)
as %String
[ ZenMethod ]
Return the DSS Home of the current DPR
classmethod GetDSS(fileName As %String)
as %String
[ ZenMethod ]
Load the DSS section of the given named file and return the underlying model
classmethod GetQueryInterface(fileName As %String)
as %String
[ ZenMethod ]
Load the Query Interface section of the given named file and return the underlying model
classmethod GetSystemHomeDir()
as %String
[ ZenMethod ]
Return the system install directory of this instance
classmethod GetSystemTempDir()
as %String
[ ZenMethod ]
Return the temp directory for this system.
classmethod GetTimeStampInfo()
as %String
[ ZenMethod ]
Generate data for a time stamp as a string for file generation purposes
classmethod ImportXML(fileName)
as %Status
[ ZenMethod ]
Load and compile the given temp file
classmethod MakeRandomFileName(ext As %String = "", directory As %String = "")
as %String
[ 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
[ ZenMethod ]
Receive a chuck of a client text stream submission
classmethod ServerCommand(cmd)
as %Status
[ ZenMethod ]
method backupModel()
[ Language = javascript ]
Copy the current (client-side) model to a json string for short term back-up purposes
method convertDCRToDSS(cls, node)
[ Language = javascript ]
Given a valid DCR JSON object, generate a DSS
method convertRDNodeToDSS(cls, n)
[ Language = javascript ]
method convertRDToDSS(cls, xData)
[ Language = javascript ]
method createNewDCR(headerInfo)
[ Language = javascript ]
Create a new DCR type report model
method createNewDPR(headerInfo)
[ Language = javascript ]
Create a new DPR type report model
method createNewDSS(headerInfo)
[ Language = javascript ]
Create a new DSS type report model
method createNewSQLDSS(headerInfo)
[ Language = javascript ]
Create a new DSS type report model based on an external SQL Query
method decodeDSSNode(o)
[ Language = javascript ]
method encodeDSSNode(o)
[ Language = javascript ]
method exportAsXML(jsonOnly)
[ Language = javascript ]
method exportDSS(node)
[ Language = javascript ]
method exportReportDef(node)
[ Language = javascript ]
method exportXMLtoFile(name)
[ Language = javascript ]
method getCSPDir()
[ Language = javascript ]
method getDCRDataTree()
[ Language = javascript ]
Return the data tree section of the current model, if it is a
DCR type report and null otherwise.
method getDCRMethodsSection()
[ Language = javascript ]
Return the methods section of the current model, if it is a
DCR type report and null otherwise.
method getDCRPropertiesSection()
[ Language = javascript ]
Return the properties section of the current model, if it is a
DCR type report and null otherwise.
method getDCRSQL()
[ Language = javascript ]
Return the SQL section of the current model, if it is a
DCR type report and null otherwise.
method 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.
method getQueryInfo(clsName)
[ Language = javascript ]
method getReportApplication()
[ Language = javascript ]
Get the name of application associated with the current report.
method getReportClassName()
[ Language = javascript ]
Get the Cache class name of the current report (this value can only be set at the
time of report creation via createNewDCR, createNewDSS, or createNewDPR)
method getReportDataSource()
[ Language = javascript ]
Get the name of data source associated with the current report.
method getReportDescription()
[ Language = javascript ]
Return the descriptor of the current report
method getReportName()
[ Language = javascript ]
Return the semantic name of the current report
method getReportOutputMode()
[ Language = javascript ]
Return the default processing mode based on the current model's type
method 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)
method getReportSuperClass()
[ Language = javascript ]
Return the formal name(s) of the immediate superclass based on the current model's
type definition
method getReportSystemName()
[ Language = javascript ]
Get the full Cache name of the current report. This is a concatenation of the
the package name and the class name and is read only.
method getServerFileDelimiter()
[ Language = javascript ]
method getServerHomeDir()
[ Language = javascript ]
method getServerTempDir()
[ Language = javascript ]
method makeXMLFileName(name)
[ Language = javascript ]
method onloadHandler()
[ Language = javascript ]
This client event, if present, is fired when the page is loaded.
method restoreBackupModel(jsonStr)
[ Language = javascript ]
Reset the model based on a previously saved json back-up string.
method setDCRDataTree(tree)
[ Language = javascript ]
Set the data tree section of the current model, assuming it is a
DCR type report and no-op otherwise.
method setDCRMethodsSection(m)
[ Language = javascript ]
Set the methods section of the current model, assuming it is a
DCR type report and no-op otherwise.
method setDCRPropertiesSection(prop)
[ Language = javascript ]
Set the properties section of the current model to the given array of
property objects
method setDCRSQL(sqlObj)
[ Language = javascript ]
Set the SQL section of the current model assuming it is a
DCR type report and no-op otherwise.
method setReportApplication(s)
[ Language = javascript ]
Set the name of application associated with the current report.
method setReportDataSource(s)
[ Language = javascript ]
Set the name of data source associated with the current report.
method setReportDescription(s)
[ Language = javascript ]
Set the descriptor of the current report
method 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.
method setReportSource(cls, reportType)
[ Language = javascript ]
Set the reportSource for the report.
method setZRSBody(src)
[ Language = javascript ]