Home > Class Reference > ENSLIB namespace > %DeepSee.Report.UI.reportModelServer
Private  Storage   

%DeepSee.Report.UI.reportModelServer


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

Abstract Report Model File Utilities

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 65


Summary


Properties
%condition %import %includeFiles %page
%resource align aux composite
containerStyle dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle name onafterdrag onbeforedrag
ondrag ondrop onhide onrefresh
onshow onupdate parent showLabel
slice title tuple valign
visible width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject DeleteTempFile GetCSPDirectory GetDCR
GetDPR GetDPRDSSClass GetDPRDSSHome GetDSS
GetQueryInterface GetReportSuperClasses GetSystemHomeDir GetSystemTempDir
GetTimeStampInfo ImportXML MakeRandomFileName ReceiveFragment
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
backupModel convertDCRToDSS convertRDNodeToDSS convertRDToDSS
createNewDCR createNewDPR createNewDSS createNewSQLDSS
decodeDSSNode dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler encodeDSSNode
exportAsXML exportDSS exportReportDef exportXMLtoFile
exposeComponent findElement fireOnUpdateEvent getCSPDir
getDCRDataTree getDCRMethodsSection getDCRPropertiesSection getDCRSQL
getDSSObject getEnclosingDiv getHidden getHintElement
getLabelElement getProperty getQueryInfo getReportApplication
getReportClassName getReportDataSource getReportDescription getReportName
getReportOutputMode getReportPackageName getReportSuperClass getReportSystemName
getServerFileDelimiter getServerHomeDir getServerTempDir getSettings
getType humanizeXMLString invokeSuper isOfType
makeId makeXMLFileName onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onloadHandler onunloadHandler
onupdateHandler refreshContents render renderContents
renderSVG restoreBackupModel sanitizeXMLString setDCRDataTree
setDCRMethodsSection setDCRPropertiesSection setDCRSQL setDPRMethodsSection
setHidden setOverlayMode setProperty setReportApplication
setReportDataSource setReportDescription setReportName setReportSource
setZRSBody startProgressBar stopProgressBar


Parameters


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

Methods


• 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 GetReportSuperClasses() as %String [ ZenMethod ]
• 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 %String [ 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
• 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 humanizeXMLString(origStr) [ Language = javascript ]
un-escape an XML string previously encoded with sanitize XMLString
• 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 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 '>'
• 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 setDPRMethodsSection(m) [ Language = javascript ]
Set the methods section of the current model, assuming it is a DPR 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 ]