%ZEN.Report.Aggregate.PercentileRank

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

Aggregate for the percentile rank of a set of numerical data.

Property Inventory

Method Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/zen/report/definition;
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.
parameter XMLIGNOREINVALIDATTRIBUTE = 0;
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 = percentilerank;
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

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 value as %ZEN.Datatype.float;
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Methods

method GetResult() as %String [ Language = objectscript ]
Returns the percentile rank. Returns 100% for an empty data set.
method ProcessValue(pValue As %Float) as %Status [ Language = objectscript ]
Processes each new Values.

Inherited Members

Inherited Properties

Inherited Methods

Feedback