oracle.apps.fnd.appltest.diagfwk.engine.impl.report.plsql
Class PLSQLReportProcessor

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.impl.report.plsql.PLSQLReportProcessor

public class PLSQLReportProcessor
extends java.lang.Object

A class to handle PL/SQL Report processing. The report classes that are available to Java diagnostic test developers, are not available to the PL/SQL test developers in their native form. In their code the PL/SQL developers will make calls to a quasi reporting api that will defer the report implementation to the Java report api, via this class, after the completion of a PL/SQL test.

A PL/SQL report api call generates a report instruction that is put on a "queue" (instruction array). Additionally, related instruction values (parameters) are put on a value "queue". After the PL/SQL diagnostic test completes, the instruction/value arrays are passed to a PL/SQL report processor (this class) to process the instructions and generate a report. There are report instuctions available to mimic Java report capabilities in addition to a few that are PL/SQL specific. For instance, instructions are available to instruct adding a report section (START_REPORT_SECTION), or add a report message (REPORT_MSG), to end a report section (END_REPORT_SECTION), pop a report section (POP_REPORT_SECTION), etc.

Constructor Summary

PLSQLReportProcessor()

Method Summary

void	process(DiagContextExtn context, java.lang.String[] instructions, java.lang.String[] values) Processes the PL/SQL report instructions along with their associated values to generate a step report.
void	processDebugMessages(StepReport stepReport, java.lang.String[] debugMessages) Processes debug messages by displaying them in a separate section of the report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PLSQLReportProcessor

public PLSQLReportProcessor()

Method Detail

processDebugMessages

public void processDebugMessages(StepReport stepReport,
                                 java.lang.String[] debugMessages)

Processes debug messages by displaying them in a separate section of the report. Display of debug messages are to be used during development time only and not for production purposes.

Parameters:

stepReport - a StepReport object to which a report Section will be added. This Section will contain debug messages.

debugMessages - an array of debug messages.

process

public void process(DiagContextExtn context,
                    java.lang.String[] instructions,
                    java.lang.String[] values)

Processes the PL/SQL report instructions along with their associated values to generate a step report. The report sections and other report elements are added to the StepReport of the passed in Context object. The instructions (usually passed in from a PL/SQL program) are iterated and corresponding report elements are generated in the step report. For instance the PL/SQL instructions START_REPORT_SECTION_1 and END_REPORT_SECTION will instruct the PLSQLREportProcessor to add a section to the step report.

Parameters:

context - a diagnostic context object.

instructions - a String array containing valid PL/SQL instructions. All instructions are in upper case.

values - a String array containing values that correspond to the passed in instructions.