This class provides a way to assemble data that can be conveniently passed between the web client and the server. More...

Inheritance diagram for dataSet:

[legend]

Collaboration diagram for dataSet:

[legend]

Public Member Functions
_.Library.Status	OnNew (_.Library.RawString initvalue)
	Constructor for Zen objects. More...

	clear ()
	Clear contents of this dataSet.

	getData (d1, d2, d3)
	Return the data contained in the specified location. More...

	getDimSize (dim)
	Return the number of items in the specified dimension. More...

	getDimensions ()
	Return the number of dimensions in the dataSet.

	getLabel (n, dim)
	Get the label at position n (0-based) in the given. More...

	insert (dim, index)
	Insert a new "slice" into the dataSet within. More...

	redim (dims, sz1, sz2, sz3)
	Update size of dataSet to new dimensions and size.

	remove (dim, index)
	Remove a "slice" from the dataSet within. More...

	setData (value, d1, d2, d3)
	Set the data contained in the specified location. More...

	setLabel (label, n, dim)
	Set the value of the label at position n (0-based) in the given. More...

	swap (dim, item1, item2, labels)
	Swap the contents of 2 "slices" of the dataSet within. More...

Public Member Functions inherited from object
	findElement (subid)
	Client-side utility method that finds an HTML element with a. More...

	fireOnUpdateEvent ()
	This is called when an object is updated from the server. More...

_.Library.String	getProperty (property, key)
	Return the value of a named property (i.e. More...

	getSettings (settings)
	Client-side method that returns a list of this component's. More...

	getType ()
	Returns the component type of this object. More...

	invokeSuper (method, args)
	Invoke the superclass method method of the current. More...

	isOfType (type)
	Returns true if this object is of the given component type. More...

	makeId (subid)
	client-side utility method that constructs a component-specific id More...

	onCreate ()
	This client method, if present, is called when this component is. More...

	onDelete ()
	This client method, if present, is called when this component is. More...

	onSerialize ()
	This client event, if present, is fired before a component. More...

	onloadHandler ()
	This client event, if present, is fired when the page is loaded.

	onunloadHandler ()
	This client event, if present, is fired when the page is unloaded. More...

	onupdateHandler ()
	This client method, if present, is fired when the object is updated from the server.

	render ()
	This causes a component that draws its contents dynamically. More...

	renderContents ()
	This method, if present, is called when this component. More...

	renderSVG (document, parent)
	This method is only needed for SVG components. More...

	setProperty (property, value, value2)
	Set the value of a named property (i.e., a setting). More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Attributes
	clientData
	Array of serialized data values going to and coming from the client. More...

	clientLabels
	Array of serialized label values going to and coming from the client. More...

	clientSize
	Array of serialized dimension size values going to and coming from the client. More...

	dimensions
	Number of dimensions within the dataSet. More...

Public Attributes inherited from object
	aux
	@qualifier final This is an auxiliary property that is provided More...

	composite
	@qualifier final For components that are created as part of a composite component, More...

	id
	@qualifier final This is a unique identifier that is used to distinguish this object More...

	index
	@qualifier final System-assigned index number used internally to identify this component. More...

	name
	@qualifier final Name of this object. More...

	onupdate
	onupdate event handler: More...

	parent
	@qualifier final Link to the component that contains this object More...

	tuple
	@qualifier final Special property indicating which tuple of a More...

	visible
	This property indicates whether a component is visible and thus layed out. More...

	window
	@qualifier final This is a client-only property that refers to the JavaScript More...

Private Member Functions
	Clear ()
	Delete data currently in the dataSet.

	GetArray (pArray)
	Copy the contents of this dataSet into a local. More...

_.Library.Integer	GetDimSize (_.Library.Integer dim)
	Return current size of a dimension.

_.Library.Integer	GetDimensions ()
	Get the number of dimensions within the dataSet.

_.Library.String	GetLabel (_.Library.Integer n, _.Library.Integer dim)
	Get the value of a label at position n More...

_.Library.String	GetValue (_.Library.Integer d1, _.Library.Integer d2, _.Library.Integer d3)
	Get the value of a cell within the dataSet.

_.Library.Status	OnDrawObjectProperties ()
	Called just before we serve property values to the client.

_.Library.Status	OnObjectSynch ()
	Make sure client data is prepared.

_.Library.Status	OnZENDeserialize ()
	Deserialize additional values from the client.

	Print ()
	Print out contents of this dataSet to the current device.

_.Library.Status	SerializeData (_.Library.String pDelim)
	Convert internal arrays to a serialized strings for use on the client.

	SetArray (pArray, _.Library.Integer s1, _.Library.Integer s2, _.Library.Integer s3)
	Set the contents of this dataSet from a local. More...

	SetDimensions (_.Library.Integer dims)
	Set the number of dimensions within the dataSet. More...

	SetLabel (_.Library.String pLabel, _.Library.Integer n, _.Library.Integer dim)
	Set the value of a label at position n More...

	SetValue (_.Library.String pValue, _.Library.Integer d1, _.Library.Integer d2, _.Library.Integer d3)
	Set the value of a cell within the dataSet. More...

Additional Inherited Members
Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from object
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	INCLUDEFILES = None
	CSV list of additional include files (either .js or .css) that. More...

	MODULE = None
	If set, this indicates that this system component should be. More...

	NAMESPACE = None
	This is the XML namespace used for library components.

	POSTCOMPILEACTIONS = None
	This is a comma-delimited list of which post-compile actions this component. More...

	USECOMMONDIRECTORY = None
	If true, then the include files generated for this component, are placed in the. More...

	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

This class provides a way to assemble data that can be conveniently passed between the web client and the server.

A <class>dataSet</class> object can contain 0-dimensional (scalar) data, 1-dimensional (list), 2-dimensional, or 3-dimensional data, as specified by its <property>dimensions</property> property.

Member Function Documentation

◆ GetArray()

GetArray ( pArray )

private

Copy the contents of this dataSet into a local.

array.

◆ GetLabel()

_.Library.String GetLabel	(	_.Library.Integer	n,
		_.Library.Integer	dim
	)

private

Get the value of a label at position n

in dimension dim within the dataSet.

◆ OnNew()

_.Library.Status OnNew ( _.Library.RawString initvalue )

Constructor for Zen objects.

If subclasses override OnNew, they should make sure to invoke this using #super.

Reimplemented from object.

◆ SetArray()

SetArray	(		pArray,
		_.Library.Integer	s1,
		_.Library.Integer	s2,
		_.Library.Integer	s3
	)

private

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.

◆ SetDimensions()

SetDimensions ( _.Library.Integer dims )

private

Set the number of dimensions within the dataSet.

Changing the number of dimensions deletes the contents of the dataSet.

◆ SetLabel()

SetLabel	(	_.Library.String	pLabel,
		_.Library.Integer	n,
		_.Library.Integer	dim
	)

private

Set the value of a label at position n

in dimension dim within the dataSet.

◆ SetValue()

SetValue	(	_.Library.String	pValue,
		_.Library.Integer	d1,
		_.Library.Integer	d2,
		_.Library.Integer	d3
	)

private

Set the value of a cell within the dataSet.

Updates dimension size as needed.

◆ getData()

getData	(	d1,
		d2,
		d3
	)

Return the data contained in the specified location.

Location is 0-based;

◆ getDimSize()

getDimSize ( dim )

Return the number of items in the specified dimension.

(dim is 1,2, or 3).

◆ getLabel()

getLabel	(	n,
		dim
	)

Get the label at position n (0-based) in the given.

dimension (1,2, or 3).

◆ insert()

insert	(	dim,
		index
	)

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.

◆ remove()

remove	(	dim,
		index
	)

Remove a "slice" from the dataSet within.

the specified dimension at position index (0-based).

◆ setData()

setData	(	value,
		d1,
		d2,
		d3
	)

Set the data contained in the specified location.

Location is 0-based;

◆ setLabel()

setLabel	(	label,
		n,
		dim
	)

Set the value of the label at position n (0-based) in the given.

dimension (1,2, or 3).

◆ swap()

swap	(	dim,
		item1,
		item2,
		labels
	)

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.

Member Data Documentation

◆ clientData

clientData

Array of serialized data values going to and coming from the client.

◆ clientLabels

clientLabels

Array of serialized label values going to and coming from the client.

◆ clientSize

clientSize

Array of serialized dimension size values going to and coming from the client.

◆ dimensions

dimensions

Number of dimensions within the dataSet.

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetArray()

◆ GetLabel()

◆ OnNew()

◆ SetArray()

◆ SetDimensions()

◆ SetLabel()

◆ SetValue()

◆ getData()

◆ getDimSize()

◆ getLabel()

◆ insert()

◆ remove()

◆ setData()

◆ setLabel()

◆ swap()

Member Data Documentation

◆ clientData

◆ clientLabels

◆ clientSize

◆ dimensions