IRISLIB database
reportGenerator Class Reference
Inheritance diagram for reportGenerator:
Collaboration diagram for reportGenerator:

Static Public Member Functions

_.Library.Status Generate (_.Library.String className, _.Library.String reportName, _.Library.String queryClass, _.Library.String queryName, _.Library.Boolean sortandgroup, _.Library.String GroupOption, _.Library.String SortOption, _.Library.String SortBy, UniqueId)
 Generate a ZEN Report
More...
 
_.Library.Status GenerateForSQL (_.Library.String className, _.Library.String reportName, _.Library.String sql, _.Library.Boolean sortandgroup, _.Library.String GroupOption, _.Library.String SortOption, _.Library.String SortBy, UniqueId)
 Generate a ZEN Report
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...
 
- 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...
 

Member Function Documentation

◆ Generate()

_.Library.Status Generate ( _.Library.String  className,
_.Library.String  reportName,
_.Library.String  queryClass,
_.Library.String  queryName,
_.Library.Boolean  sortandgroup,
_.Library.String  GroupOption,
_.Library.String  SortOption,
_.Library.String  SortBy,
  UniqueId 
)
static

Generate a ZEN Report

className - name that generated ZEN Report will have, for instance pkgname.GeneratedReport
reportName - name of ZEN Report, root element of generated XML
queryClass - name of class for which report is generated
queryName - name of query for which report is generated
sortandgroup - if 1, we sort and group and next four parameters used, otherwise we don't sort and group
GroupOption - name of option that determines grouping

  • GroupOption's value determines the name of the GroupOption Property in the report. A good name for this is "GroupOption".
  • If the GroupOption property is set to a non-null value this is used in OnBeforeReport to set the "group".
  • A non-null "group" causes detail records to be placed under a value for the "group" in the report. Each value for "group" will print on its own line. Under "group" will be the other values in the report for which the group has a constant value.

SortOption - name of option that determines sorting of detail records.

  • SortOption's value determines the name of the SortOption property in the report. A good name for this is "SortOption".
  • The value of the property named in SortOption determines is used in OnBeforeReport to select what field will sort the values that appear in the report.
  • By default UniqueId is used for sorting.

SortBy - name of support internal - set by SortOption, a good value for this is "SortBy" if no column in query named "SortBy"
UniqueId - default sorting field of query, one can set this outside query, will be used to sort report columns if one group in report/columns within group if several groups within report

◆ GenerateForSQL()

_.Library.Status GenerateForSQL ( _.Library.String  className,
_.Library.String  reportName,
_.Library.String  sql,
_.Library.Boolean  sortandgroup,
_.Library.String  GroupOption,
_.Library.String  SortOption,
_.Library.String  SortBy,
  UniqueId 
)
static

Generate a ZEN Report

className - name that generated ZEN Report will have, for instance pkgname.GeneratedReport
reportName - name of ZEN Report, root element of generated XML
sql - sql used in report generation
sortandgroup - if 1, we sort and group and next four parameters used, otherwise we don't sort and group
GroupOption - name of option that determines grouping

  • GroupOption's value determines the name of the GroupOption Property in the report. A good name for this is "GroupOption".
  • If the GroupOption property is set to a non-null value this is used in OnBeforeReport to set the "group".
  • A non-null "group" causes detail records to be placed under a value for the "group" in the report. Each value for "group" will print on its own line. Under "group" will be the other values in the report for which the group has a constant value.

SortOption - name of option that determines sorting of detail records.

  • SortOption's value determines the name of the SortOption property in the report. A good name for this is "SortOption".
  • The value of the property named in SortOption determines is used in OnBeforeReport to select what field will sort the values that appear in the report.
  • By default UniqueId is used for sorting.

SortBy - name of support internal - set by SortOption, a good value for this is "SortBy" if no column in query named "SortBy"
UniqueId - default sorting field of query, one can set this outside query, will be used to sort report columns if one group in report/columns within group if several groups within report