This class provides a way to assemble data that can be. More...

Inheritance diagram for dataBag:

[legend]

Collaboration diagram for dataBag:

[legend]

Public Member Functions
	clear ()
	Clear contents of this dataBag.

	getDimSize (dim)
	dataSet API More...

	getPropertyCount ()
	Return the number of properties within this dataBag.

	getPropertyLabel (n)
	Return the label of a property within this dataBag given its ordinal. More...

	getPropertyName (n)
	Return the name of a property within this dataBag given its ordinal. More...

	getPropertyType (n)
	Return the type code of a property within this dataBag given its ordinal. More...

	getSeriesCount ()
	Return the number of data series within this dataBag.

	getSeriesLabel (n)
	Return the label of a dataSeries within this dataBag given its ordinal. More...

	getValue (property, series)
	Return the data value associated with a given property name. More...

	getValueByPosition (n, series)
	Return the data value at the given ordinal position. More...

	getValuesAsArrays ()
	This is a specialized variant of <method>getValueByPosition</method> that. More...

	getValuesAsObject (series)
	Return the values in this dataBag as a zenProxy object. More...

	setProperty (property, value, value2)
	Set the value of a named property.

	setValue (property, value, series)
	Set the data value for the given property. More...

	setValueByPosition (value, n, series)
	Set the data value at the given ordinal position. More...

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

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

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

	seriesCount
	Number of data series held within the dataBag. 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 dataBag.

_.Library.Status	CopyFromModel (_.ZEN.DataModel.DataModel pModel)
	Fill the contents of this dataBag from the given DataModel.

_.Library.Status	CopyToModel (_.ZEN.DataModel.DataModel pModel)
	Copy the contents of this dataBag into the given DataModel.

	GetArray (pArray)
	Copy the contents of this dataBag into a local array.

_.Library.String	GetLabel (_.Library.String pProperty)
	Get the label for a property within the dataBag. More...

_.Library.String	GetType (_.Library.String pProperty)
	Get the type of a property within the dataBag. More...

_.Library.String	GetValue (_.Library.String pProperty, _.Library.Integer pSeries)
	Get the value of a property within the dataBag. More...

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

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

	SetValue (_.Library.String pProperty, _.Library.String pValue)
	Set the value of a property within the dataBag.

Private Attributes
	__labelList
	List of property labels (if different than property name) contained within this dataBag. More...

	__propertyList
	List of property names contained within this dataBag. More...

	__propertyTypes
	List of types of the properties contained within this dataBag. More...

	__seriesNames
	List of data series names contained within this dataBag. 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>dataBag</class> object contains a set of name-value pairs.

This is used internally by the MVC classes.

Member Function Documentation

◆ GetLabel()

_.Library.String GetLabel ( _.Library.String pProperty )

private

Get the label for a property within the dataBag.

◆ GetType()

_.Library.String GetType ( _.Library.String pProperty )

private

Get the type of a property within the dataBag.

◆ GetValue()

_.Library.String GetValue	(	_.Library.String	pProperty,
		_.Library.Integer	pSeries
	)

private

Get the value of a property within the dataBag.

Note that this can return a literal value,

an object value (oref), or $$$ZENMISSING if the given

property is not in the model.

◆ getDimSize()

getDimSize ( dim )

dataSet API

Return the number of items in the specified dimension.

(dim is 1,2, or 3).

The size of the first dimension is defined by the number of properties in the dataBag.

The size of the second dimension is defined by number of data series in the dataBag.

The dataBag does not support a third dimension.

◆ getPropertyLabel()

getPropertyLabel ( n )

Return the label of a property within this dataBag given its ordinal.

(0-based) position.

◆ getPropertyName()

getPropertyName ( n )

Return the name of a property within this dataBag given its ordinal.

(0-based) position.

◆ getPropertyType()

getPropertyType ( n )

Return the type code of a property within this dataBag given its ordinal.

(0-based) position.

◆ getSeriesLabel()

getSeriesLabel ( n )

Return the label of a dataSeries within this dataBag given its ordinal.

(0-based) position.

◆ getValue()

getValue	(	property,
		series
	)

Return the data value associated with a given property name.

If there is no property with the name, property, return null.

◆ getValueByPosition()

getValueByPosition	(	n,
		series
	)

Return the data value at the given ordinal position.

If n is out of range, return null.

series is 0-based.

◆ getValuesAsArrays()

getValuesAsArrays ( )

This is a specialized variant of <method>getValueByPosition</method> that.

return the data in this bag as an array of arrays (used

by charts).

◆ getValuesAsObject()

getValuesAsObject ( series )

Return the values in this dataBag as a zenProxy object.

If there is more than one data series, series

specifies which one to use.

Return null if there are no properties in the dataBag.

◆ setValue()

setValue	(	property,
		value,
		series
	)

Set the data value for the given property.

series is 0-based.

◆ setValueByPosition()

setValueByPosition	(	value,
		n,
		series
	)

Set the data value at the given ordinal position.

series is 0-based.

Member Data Documentation

◆ clientData

clientData

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

◆ __labelList

__labelList

private

List of property labels (if different than property name) contained within this dataBag.

◆ __propertyList

__propertyList

private

List of property names contained within this dataBag.

◆ __propertyTypes

__propertyTypes

private

List of types of the properties contained within this dataBag.

◆ seriesCount

seriesCount

Number of data series held within the dataBag.

◆ __seriesNames

__seriesNames

private

List of data series names contained within this dataBag.

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetLabel()

◆ GetType()

◆ GetValue()

◆ getDimSize()

◆ getPropertyLabel()

◆ getPropertyName()

◆ getPropertyType()

◆ getSeriesLabel()

◆ getValue()

◆ getValueByPosition()

◆ getValuesAsArrays()

◆ getValuesAsObject()

◆ setValue()

◆ setValueByPosition()

Member Data Documentation

◆ clientData

◆ __labelList

◆ __propertyList

◆ __propertyTypes

◆ seriesCount

◆ __seriesNames