This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %ZEN.Report.Aggregate.Percentile


class %ZEN.Report.Aggregate.Percentile extends %ZEN.Report.CustomAggregate

Aggregate for the percentile of a set of numerical data.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter NAMESPACE =;
Algorithm taken from Head First Statistics by Dawn Griffiths, page 99 XML namespace used for Zen Report definitions.
parameter XMLFORMAT = Literal;
If XMLFORMAT="Literal", then only support for literal format import and export is generated.
By setting this to 0, we disallow use of invalid attribute names in Zen Report XML documents.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
parameter XMLNAME = percentile;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property Count as %Integer [ InitialExpression = 0 ];
Number of values processed
Property methods: CountDisplayToLogical(), CountGet(), CountIsValid(), CountLogicalToDisplay(), CountNormalize(), CountSet(), CountXSDToLogical()
property RawValues [ MultiDimensional ];
Array of processed values
Property methods: RawValuesDisplayToLogical(), RawValuesGet(), RawValuesIsValid(), RawValuesLogicalToDisplay(), RawValuesLogicalToOdbc(), RawValuesNormalize(), RawValuesSet()
property Values as array of %Integer;
Property methods: ValuesBuildValueArray(), ValuesCollectionToDisplay(), ValuesCollectionToOdbc(), ValuesDisplayToCollection(), ValuesDisplayToLogical(), ValuesGet(), ValuesGetObject(), ValuesGetObjectId(), ValuesGetSwizzled(), ValuesIsValid(), ValuesLogicalToDisplay(), ValuesNormalize(), ValuesOdbcToCollection(), ValuesSet(), ValuesSetObject(), ValuesSetObjectId(), ValuesXSDToLogical()
property percentile as %ZEN.Datatype.float;
Property methods: percentileDisplayToLogical(), percentileGet(), percentileIsValid(), percentileLogicalToDisplay(), percentileLogicalToOdbc(), percentileNormalize(), percentileSet()

Methods (Including Private)

method GetResult() as %String
Returns the percentile. Returns "" for an empty data set.
method ProcessValue(pValue As %Float) as %Status
Processes each new Values.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window