Home > Class Reference > %SYS namespace > %DeepSee.Report.DataView


persistent class %DeepSee.Report.DataView extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %DeepSee_Report.DataView

This class represents an instance of a DeepSee DataView.
A DataView provides a set of data fields that can then be used by a DeepSee report. N.B. the storage for this class *must* be set to a non-% global. !!! deprecated

Property Inventory

Method Inventory


property caption as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
Display name used for this data view.
Property methods: captionDisplayToLogical(), captionGet(), captionGetStored(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property category as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
Category name for this data view. A category name is used to provide a grouping for data views.
Property methods: categoryDisplayToLogical(), categoryGet(), categoryGetStored(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()
property description as %String (MAXLEN = 500, XMLPROJECTION = "attribute");
Optional. Description of this data view.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionGetStored(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
relationship fields as array of DataViewField (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%DeepSee.Report.DataViewField","dataView",+$this,"children",1,1) , Transient , Inverse = dataView , Cardinality = children ];
Set of fields within this data view.
Property methods: fieldsGet(), fieldsGetObject(), fieldsGetObjectId(), fieldsGetSwizzled(), fieldsIsEmpty(), fieldsIsValid(), fieldsNewObject(), fieldsRClose(), fieldsRExec(), fieldsRFetch(), fieldsRelate(), fieldsSQLCompute(), fieldsSet(), fieldsUnRelate()
property name as %String (MAXLEN = 500, XMLPROJECTION = "attribute") [ Required ];
Logical name of this data view.
This is used to identify the dataview and must be unique.
By convention names take the form:
Property methods: nameDisplayToLogical(), nameGet(), nameGetStored(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property passThrough as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, then this data view is in "pass through" mode; the set of public properties in the sourceClass are automatically treated as members of the data view.
Property methods: passThroughDisplayToLogical(), passThroughGet(), passThroughGetStored(), passThroughIsValid(), passThroughLogicalToDisplay(), passThroughLogicalToXSD(), passThroughNormalize(), passThroughSet(), passThroughXSDToLogical()
property resource as %String (MAXLEN = 100, XMLPROJECTION = "attribute");
Optional. Name of the resource for which a user must have USE privilege in order to use this data view.
Property methods: resourceDisplayToLogical(), resourceGet(), resourceGetStored(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
property sourceClass as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Name of the persistent class that supplies data for this data view.
Property methods: sourceClassDisplayToLogical(), sourceClassGet(), sourceClassGetStored(), sourceClassIsValid(), sourceClassLogicalToDisplay(), sourceClassLogicalToOdbc(), sourceClassNormalize(), sourceClassSet()


method %GetFields(Output pFields As %List) as %Status [ Language = objectscript ]
Return an array of fields defined by this data view.
This array takes the form:
pFields(n) = $LB(name,caption,string|integer|number|date|reference,refClass)
method %GetSQLForField(pField As %String, Output pExpr As %String) as %Status [ Language = objectscript ]
Given a field name, return the SQL expression needed to fetch it.
method %GetSQLTableName(Output pTable As %String) as %Status [ Language = objectscript ]
Return the SQL table that supplies data for this dataView.


index (Category on category);
Index methods: CategoryExists()
index (NameKey on name) [IdKey, Type = key];
Main key for this class.
Index methods: NameKeyCheck(), NameKeyDelete(), NameKeyExists(), NameKeyOpen(), NameKeySQLCheckUnique(), NameKeySQLExists(), NameKeySQLFindPKeyByConstraint(), NameKeySQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (%DeepSee.Report.DataView)

FeedbackOpens in a new window