oracle.apps.fnd.appltest.diagfwk.engine.impl.report
Class ReportVisitor

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

Direct Known Subclasses:

ErrorFindingVisitor, TestReportExtnImpl.LinkComputingVisitor, TestReportExtnImpl.TranslatingVisitor

public class ReportVisitor
extends java.lang.Object

Base class for visitor class that need to perform specific operations on the TestReport by traversing each node in the report. This class provides the callback APIs that the visitor classes can implement for performing their operations.

Entry point for visitor traversal is through the visitAll(ReportVisitor) method in TestReportExtn. During the traversal the visitor class's callback methods would be invoked as follows:

• visitBegin() - this method is invoked once at the beginning of the traversal
• visitContainer(Container) - this method is invoked once for each element in the report. Visitor classes can override this method to perform operations on specific elements.
• visitEnd() - this method is invoked once at the end of the traversal.

The ReportVisitor class provides stub implemnetations of these APIs. Implementors must extend this class and override any one or more of these methods to interject their operations during the traversal.

The traversal will happen top-bottom (depth first) on the report elements as they were created in the report.

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/engine/impl/report/ReportVisitor.java /main/2 2009/06/05 14:18:09 ppradhan Exp $

Author:

ppradhan

Constructor Summary

ReportVisitor()

Method Summary

void	visitBegin() Visitor classes can override this method for any processing that needs to happen at the beginning of the traversal.
void	visitContainer(Container c) This method is called for each container element in the report that is visited during the traversal.
void	visitEnd() Visitor classes can override this method for any processing that needs to happen at the end of the traversal.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportVisitor

public ReportVisitor()

Method Detail

visitBegin

public void visitBegin()

Visitor classes can override this method for any processing that needs to happen at the beginning of the traversal.

visitContainer

public void visitContainer(Container c)

This method is called for each container element in the report that is visited during the traversal. Visitor classes can override this method for any processing that is specific for a particular element.

Parameters:

c - the currently visited container element in the report

visitEnd

public void visitEnd()

Visitor classes can override this method for any processing that needs to happen at the end of the traversal.