%ZEN.Auxiliary.dataSet
class %ZEN.Auxiliary.dataSet extends %ZEN.Component.object
This class provides a way to assemble data that can be conveniently passed between the web client and the server. A dataSet object can contain 0-dimensional (scalar) data, 1-dimensional (list), 2-dimensional, or 3-dimensional data, as specified by its dimensions property.Property Inventory (Including Private)
Method Inventory (Including Private)
- %Clear()
- %GetArray()
- %GetDimSize()
- %GetDimensions()
- %GetLabel()
- %GetValue()
- %OnDrawObjectProperties()
- %OnNew()
- %OnObjectSynch()
- %OnZENDeserialize()
- %Print()
- %SerializeData()
- %SetArray()
- %SetDimensions()
- %SetLabel()
- %SetValue()
- clear()
- getData()
- getDimSize()
- getDimensions()
- getLabel()
- insert()
- redim()
- remove()
- setData()
- setLabel()
- swap()
Properties
property %data as %ZEN.Datatype.string (XMLPROJECTION = "NONE") [ Private , MultiDimensional ];
Array of data values within the dataSet.
Property methods: %dataDisplayToLogical(), %dataGet(), %dataIsValid(), %dataLogicalToDisplay(), %dataLogicalToOdbc(), %dataNormalize(), %dataSet()
property %labels as %ZEN.Datatype.string (XMLPROJECTION = "NONE") [ Private , MultiDimensional ];
Set of captions used as labels along the various
dimensions of the dataSet.
The array of labels is indexed by dimension number and position within the dimension.
The array of labels is indexed by dimension number and position within the dimension.
Property methods: %labelsDisplayToLogical(), %labelsGet(), %labelsIsValid(), %labelsLogicalToDisplay(), %labelsLogicalToOdbc(), %labelsNormalize(), %labelsSet()
property %size as %ZEN.Datatype.integer (MINVAL = 1, XMLPROJECTION = "NONE") [ Private , MultiDimensional ];
Size, indexed by dimension number, of each dimension.
Property methods: %sizeDisplayToLogical(), %sizeGet(), %sizeIsValid(), %sizeLogicalToDisplay(), %sizeLogicalToOdbc(), %sizeNormalize(), %sizeSet()
property clientData as %ZEN.Datatype.list (XMLPROJECTION = "NONE", ZENSETTING = 0);
Array of serialized data values going to and coming from the client.
Property methods: clientDataDisplayToLogical(), clientDataGet(), clientDataIsValid(), clientDataLogicalToDisplay(), clientDataLogicalToOdbc(), clientDataNormalize(), clientDataSet()
property clientLabels as %ZEN.Datatype.list (XMLPROJECTION = "NONE", ZENSETTING = 0);
Array of serialized label values going to and coming from the client.
Property methods: clientLabelsDisplayToLogical(), clientLabelsGet(), clientLabelsIsValid(), clientLabelsLogicalToDisplay(), clientLabelsLogicalToOdbc(), clientLabelsNormalize(), clientLabelsSet()
property clientSize as %ZEN.Datatype.list (XMLPROJECTION = "NONE", ZENSETTING = 0);
Array of serialized dimension size values going to and coming from the client.
Property methods: clientSizeDisplayToLogical(), clientSizeGet(), clientSizeIsValid(), clientSizeLogicalToDisplay(), clientSizeLogicalToOdbc(), clientSizeNormalize(), clientSizeSet()
property dimensions as %ZEN.Datatype.integer (MAXVAL = 3, MINVAL = 0, XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Number of dimensions within the dataSet.
Property methods: dimensionsDisplayToLogical(), dimensionsGet(), dimensionsIsValid(), dimensionsLogicalToDisplay(), dimensionsLogicalToOdbc(), dimensionsNormalize(), dimensionsSet()
Methods
method %Clear()
Delete data currently in the dataSet.
method %GetArray(Output pArray)
Copy the contents of this dataSet into a local
array.
Return current size of a dimension.
method %GetDimensions() as %Integer
Get the number of dimensions within the dataSet.
Get the value of a label at position n
in dimension dim within the dataSet.
Get the value of a cell within the dataSet.
method %OnDrawObjectProperties() as %Status
Called just before we serve property values to the client.
private method %OnNew(initvalue As %CacheString) as %Status
Inherited description: Constructor for Zen objects.
If subclasses override %OnNew, they should make sure to invoke this using #super.
If subclasses override %OnNew, they should make sure to invoke this using #super.
method %OnObjectSynch() as %Status
Make sure client data is prepared.
method %OnZENDeserialize() as %Status
Deserialize additional values from the client.
method %Print()
Print out contents of this dataSet to the current device.
Convert internal arrays to a serialized strings for use on the client.
Set the contents of this dataSet from a local
array. The local array must have the same dimensionality
as the dataSet and must have the correct number and
type of subscripts.
The caller is also responsible for supplying the sizes of each dimension.
The caller is also responsible for supplying the sizes of each dimension.
method %SetDimensions(dims As %Integer)
Set the number of dimensions within the dataSet.
Changing the number of dimensions deletes the contents of the
dataSet.
Set the value of a label at position n
in dimension dim within the dataSet.
Set the value of a cell within the dataSet.
Updates dimension size as needed.
clientmethod clear() [ Language = javascript ]
Clear contents of this dataSet.
clientmethod getData(d1, d2, d3) [ Language = javascript ]
Return the data contained in the specified location.
Location is 0-based;
clientmethod getDimSize(dim) [ Language = javascript ]
Return the number of items in the specified dimension
(dim is 1,2, or 3).
clientmethod getDimensions() [ Language = javascript ]
Return the number of dimensions in the dataSet.
clientmethod getLabel(n, dim) [ Language = javascript ]
Get the label at position n (0-based) in the given
dimension (1,2, or 3).
clientmethod insert(dim, index) [ Language = javascript ]
Insert a new "slice" into the dataSet within
the specified dimension just before item index (0-based).
If index is -1, then insert at the end.
If index is -1, then insert at the end.
clientmethod redim(dims, sz1, sz2, sz3) [ Language = javascript ]
Update size of dataSet to new dimensions and size.
clientmethod remove(dim, index) [ Language = javascript ]
Remove a "slice" from the dataSet within
the specified dimension at position index (0-based).
clientmethod setData(value, d1, d2, d3) [ Language = javascript ]
Set the data contained in the specified location.
Location is 0-based;
clientmethod setLabel(label, n, dim) [ Language = javascript ]
Set the value of the label at position n (0-based) in the given
dimension (1,2, or 3).
clientmethod swap(dim, item1, item2, labels) [ Language = javascript ]
Swap the contents of 2 "slices" of the dataSet within
the specified dimension.
For example, swap the contents of 2 rows within a 2D dataSet. If labels is true, then swap labels as well.
For example, swap the contents of 2 rows within a 2D dataSet. If labels is true, then swap labels as well.
Inherited Members
Inherited Properties (Including Private)
- %condition
- %import
- %includeFiles
- %page
- %resource
- aux
- composite
- id
- index
- name
- onupdate
- parent
- tuple
- visible
- window
Inherited Methods (Including Private)
- %AddToSaveSet()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawHTML()
- %DrawJSStrings()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetEventHandlers()
- %GetParameter()
- %GetXMLName()
- %IsA()
- %IsModified()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnAddToSaveSet()
- %OnClose()
- %OnConstructClone()
- %OnValidateObject()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveFromSaveSet()
- %Self()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLImportAttributes()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- findElement()
- fireOnUpdateEvent()
- getProperty()
- getSettings()
- getType()
- invokeSuper()
- isOfType()
- makeId()
- onCreate()
- onDelete()
- onSerialize()
- onloadHandler()
- onunloadHandler()
- onupdateHandler()
- render()
- renderContents()
- renderSVG()
- setProperty()