Home > Articles > Data

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

Understanding the event handler execution sequence

This section explains the order of execution of the BIRT event handlers.

About event firing sequence dependency

The event firing sequence for ReportItem and ReportDesign events depends on whether the report is run in the BIRT Report Designer previewer or elsewhere, such as in the Web Viewer. When a report runs outside the previewer, the generation phase always completes before the presentation phase begins. When a report runs in the previewer, the generation and presentation phases are not distinctly separated. The onCreate event is a generation-time event and the onRender is a presentation-time event.

About the onCreate and onRender firing sequence dependencies

When a report runs in the BIRT Report Designer previewer, all ReportItem onRender events fire immediately after their corresponding onCreate events. When a report runs outside the previewer, all onCreate events fire as a part of the generation process, while the onRender events fire as a part of the presentation process.

About the ReportDesign firing sequence dependencies

When a report runs in the previewer, the ReportDesign initialize event fires only once, and is always the first event fired. When a report runs outside the previewer, the initialize event is fired twice, once at the beginning of the generation phase and once at the beginning of the presentation phase.

The ReportDesign beforeRender and afterRender events also fire at different times, depending on whether the report runs in the previewer. When a report runs in the previewer, beforeRender fires once near the start of the report, just after beforeFactory fires. The ReportDesign afterRender event fires once, near the completion of the report, just before the afterFactory event fires.

When the report runs outside the previewer, the ReportDesign beforeRender event fires once, immediately after the firing of the initialize event in the presentation phase. When the report runs outside the previewer, the ReportDesign afterRender event is the last event fired.

About the pageBreak event

Table and Text objects have event handlers for handling page break events. The pageBreak event is fired in the presentation phase whenever a page break occurs.

Analysis of the execution sequence phases

The following diagrams present a more detailed view of the event handler execution sequence. The diagrams reflect the processing sequence when a report is run inside the previewer. When the presentation phase is separate from the generation phase, as it is when a report is run outside the previewer, an additional rendering sequence occurs. The rendering sequence is identical to the generation sequence with the following exceptions:

  • There are no onPrepare events.
  • There are no onCreate events.
  • There are no data source or data set events because data is retrieved from the report document rather than the database.
  • There are no beforeFactory and afterFactory events.

Overview of the report execution process

Figure 8-1 shows an overview of the report execution process. Each box in the diagram refers to another diagram that appears later in the chapter.

Figure 8-1

Figure 8-1 Method execution phases

Preparation phase

The preparation phase includes initialization and master page creation, followed by opening the data source. The preparation phase is identical for all reports. Figure 8-2 illustrates the method execution sequence for the preparation phase.

Figure 8-2

Figure 8-2 Preparation phase

In Figure 8-2, the master page processing sequence depends on the structure of the report. A master page typically consists of one or more header and footer grids with rows, their cells, and the cell contents. The execution sequence for a master page parallels that for creating an ungrouped table, except that the master page contains no detail rows.

Report body processing phase

BIRT processes a report body by processing all the report items that are not contained in other report items. BIRT processes the items, going from left to right and proceeding a row at a time toward the bottom right. A report item that is not contained in another report item is called a top-level report item. Every report has at least one top-level report item, usually a grid, a list, or a table. If a report has more than one top-level report item, BIRT processes the top-level items in order, from left to right and top to bottom.

For each top-level item, BIRT processes all the second-level items before proceeding to the next top-level item. A second-level report item is a report item that is contained within a top-level item. For example, a table contained in a grid is a second-level report item.

There can be any number of levels of report items. To see the level of a particular report item, examine the structure of the report design in Outline, as shown in Figure 8-3.

Figure 8-3

Figure 8-3 The Outline window, showing the level of a report item

BIRT processes all items at all levels in an iterative fashion, following the same process at each level as it does for the top-level items.

Figure 8-4 illustrates the general report body processing phase.

Figure 8-4

Figure 8-4 Report body processing phase

Clean-up processing phase

The clean-up phase consists of two methods that execute upon closing the data source, followed by a final method that executes after the generation phase. Figure 8-5 illustrates the method execution sequence for the clean-up phase.

Figure 8-5

Figure 8-5 Clean-up phase

Row execution sequence

There are three kinds of rows: header, detail, and footer. Tables, lists, and groups have rows. BIRT processes all rows identically. Figure 8-6 illustrates the method execution sequence for a row.

Figure 8-6

Figure 8-6 Row execution sequence

Table and list method execution sequence

A list is the same as a table, except it only has a single cell in every row. BIRT processes tables and lists identically except that for a list, BIRT does not iterate through multiple cells. BIRT processes tables in three phases, the setup phase, the detail processing phase, and the wrap-up processing phase, as shown in Figure 8-7.

Figure 8-7

Figure 8-7 Table and list execution sequence

The following sections describe each of the three table and list execution sequence sections.

Table and list setup phase

The pre-table processing phase is the same for all tables, both grouped and ungrouped.

Figure 8-8 illustrates the method execution sequence for the pre-table processing phase.

Figure 8-8

Figure 8-8 Table and list setup execution sequence

Table and list processing phase

The sequence for the table and list processing phase depends on whether the table or list is grouped. The diagram for an ungrouped table or list is shown in "Ungrouped table or list detail execution sequence," later in this chapter. The diagram for a grouped table or list is shown in "Grouped table or list execution sequence," later in this chapter.

Table and list wrap-up phase

The post-table processing phase is the same for all tables, both grouped and ungrouped. Figure 8-9 illustrates the method execution sequence for the post-table processing phase.

Figure 8-9

Figure 8-9 Table and list wrap-up execution sequence

Ungrouped table or list detail execution sequence

A table or list with no grouping has a different sequence than one with grouping.

Figure 8-10 illustrates the execution sequence for a table or list without grouping.

Figure 8-10

Figure 8-10 Ungrouped table or list detail execution sequence

Grouped table or list execution sequence

One of the differences between the processing sequence for a table or list with grouping and a table or list without grouping is that for a table with grouping, BIRT creates one ListingGroup item per group.

The ListingGroup element has three methods, onCreate, onRow, and onFinish, all of which are called one or more times when processing a grouped table or list. A ListingGroup is very similar to a table because it has one or more header rows, one or more detail rows, and one or more footer rows. BIRT processes grouping rows in the same way that it processes a table row.

Figure 8-11 illustrates the method execution sequence for a table that has groups.

Figure 8-11

Figure 8-11 Grouped table execution sequence

If you need to verify the execution sequence of event handlers for a specific report, you can add logging code to your event handlers. For information about adding logging code, see the section on determining method execution sequence in the chapter on using JavaScript.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020