aggregate Class Reference

Defines an aggregate element within a ZEN Report. More...

Inheritance diagram for aggregate:

Collaboration diagram for aggregate:

Public Attributes
	class
	More...
	escape
	escape can be nonspace in which case any text with line-feed or space characters is not XML spaced More...
	excelFormula
	In Excel mode, have ZEN Reports use this formula to calculate aggregate =formula(cellbeginnings:cellend) More...
	excelName
	More...
	excelNumberFormat
	if non-null is display number format of aggregate value, only effective when mode="xlsx" More...
	filter
	When filter is 0, element is skipped. More...
	format
	More...
	ignoreNLS
	Don't process NLS concerns in the aggregate (if null we pick up default from report parameter AGGREGATESIGNORENLS) More...
	postprocessResult
	More...
	preprocessValue
	More...
	runtimeMode
	internal property used to communicate with custom aggregates More...
	type
	Type of aggregate to calculate. More...
	uniqueId
	Unique id for aggregate. More...
Public Attributes inherited from valueNode
	accumIf
	Only accumulate if accumif is true. More...
	expression
	Optional ObjectScript expression that can either be applied. More...
	field
	Name of field (column) in the base query for this report that will. More...
	fields
	Name of fields (columns) in the base query for this report that will. More...
	name
	Name used for the XML representation of this node. More...

Additional Inherited Members
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...
Static Public Member Functions inherited from valueNode
_.Library.Status	fieldIsValid (_, val)
	Make sure field name is a valid identifier.
_.Library.Status	nameIsValid (_, val)
	Make sure name is a valid identifier.
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 reportNode
	NAMESPACE = None
	Base class for elements within a ZEN XML Report definition. 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 Report 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

Defines an aggregate element within a ZEN Report.

Member Data Documentation

class

class

 

 

escape

escape

escape can be nonspace in which case any text with line-feed or space characters is not XML spaced

or none in which case no characters are XML spaced but all are enclosed in CDATA or xml in which case the text is XML escaped this controls elements and attributes in groups  

excelFormula

excelFormula

In Excel mode, have ZEN Reports use this formula to calculate aggregate =formula(cellbeginnings:cellend)

 

excelName

excelName

 

 

excelNumberFormat

excelNumberFormat

if non-null is display number format of aggregate value, only effective when mode="xlsx"

 

filter

filter

When filter is 0, element is skipped.

 

format

format

 

 

ignoreNLS

ignoreNLS

Don't process NLS concerns in the aggregate (if null we pick up default from report parameter AGGREGATESIGNORENLS)

 

postprocessResult

postprocessResult

 

 

preprocessValue

preprocessValue

 

 

runtimeMode

runtimeMode

internal property used to communicate with custom aggregates

 

type

type

Type of aggregate to calculate.

 

uniqueId

uniqueId

Unique id for aggregate.

Doesn't matter what it is as long as it is unique

Doesn't need to be set unless one is using EXPRESSION aggregate that refers to other unique aggregates Other unique aggregates have values in agg(..uniqueId)