com.ibm.are.plugin
Class BasePlugin.ReporterCollection

java.lang.Object
  extended by com.ibm.are.plugin.BasePlugin.ReporterCollection
All Implemented Interfaces:
ReporterReporting, Reporting, StatusReporting
Enclosing class:
BasePlugin

public final class BasePlugin.ReporterCollection
extends java.lang.Object
implements ReporterReporting


Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
protected  ReporterReporting[] reporters
          List of objects used for reporting.
 
Fields inherited from interface com.ibm.are.report.Reporting
FORMAT_BINARY, FORMAT_HTML, FORMAT_PLAIN_TEXT, FORMAT_SERIALIZED, FORMAT_USER_DEFINED, FORMAT_XML, LEVEL_ERROR, LEVEL_INFO, LEVEL_NONE, LEVEL_WARNING, MAX_REPORT_DEPTH, MIN_REPORT_DEPTH
 
Constructor Summary
protected BasePlugin.ReporterCollection()
          Constructs a new ReporterCollection object
 
Method Summary
 void addReporter(ReporterReporting reporter)
          Add a reporter to this group
 java.lang.Object getContents()
          Retrieves the entire contents of the report.
 int getOutputFormat()
          Retrieves the output format used for reporting
 com.ibm.are.report.Publisher publisher()
          The Publisher that is to be used when publishing this report.
protected  void pushReportsToCollector()
          Pushes all reports out to the global report collector.
 void removeAllReporters()
          Removes all reporters
 void removeReporter(java.lang.String className)
          Removes all reporters whose class name matches the given class name
 void report(java.lang.String msg, int depth)
          Report a message at the given level in the reporting hierarchy.
 void report(java.lang.String msg, java.lang.String errorLevel)
          Report a message at the given error level during the runtime processing.
 void report(java.lang.String msg, java.lang.String errorLevel, com.ibm.are.autofix.FixAction fixAction)
          Report a message at the given error level during the runtime processing, with info about how to fix the problem.
 void reportDetail(ProblemContext problemCtx, java.lang.String msg, java.lang.String errorLevel)
          Report details for a problem at the given error level during the runtime processing.
 void reportError(java.lang.String msg)
          Report an error message during the runtime processing.
 void reportError(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
          Report an error message during the runtime processing, with info about how to fix the problem.
 void reportErrorDetail(ProblemContext problemCtx, java.lang.String msg)
          Report details of an error message during the runtime processing.
 void reportFinish(com.ibm.are.core.Element elem, ResultInfo result)
          Reports the result of the runtime processing for a plugin.
 void reportInfo(java.lang.String msg)
          Report an informational message during the runtime processing.
 void reportInfo(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
          Report an informational message during the runtime processing, with info about how to fix the problem.
 void reportInfoDetail(ProblemContext problemCtx, java.lang.String msg)
          Report details for an informational message during the runtime processing.
 void reportStart(com.ibm.are.core.Element elem)
          Reports the start of a plugin
 void reportStatistic(java.lang.String description, java.lang.Object value, int depth)
          Reports an interesting or very important statistic.
 void reportStep(java.lang.String msg)
          Reports a new step in the runtime processing.
 void reportStepDetail(java.lang.String msg)
          Reports a new step detail in the runtime processing.
 void reportSubStep(java.lang.String msg)
          Reports a new sub step in the runtime processing.
 void reportSubStepDetail(java.lang.String msg)
          Reports a new sub step detail in the runtime processing.
 void reportWarning(java.lang.String msg)
          Report a warning message during the runtime processing.
 void reportWarning(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
          Report a warning message during the runtime processing, with info about how to fix the problem.
 void reportWarningDetail(ProblemContext problemCtx, java.lang.String msg)
          Report details for a warning message during the runtime processing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values

reporters

protected ReporterReporting[] reporters
List of objects used for reporting. All objects in this list implement the ReporterReporting interface.

Constructor Detail

BasePlugin.ReporterCollection

protected BasePlugin.ReporterCollection()
Constructs a new ReporterCollection object

Method Detail

pushReportsToCollector

protected void pushReportsToCollector()
Pushes all reports out to the global report collector.

See Also:
ReportCollector

reportStatistic

public final void reportStatistic(java.lang.String description,
                                  java.lang.Object value,
                                  int depth)
Reports an interesting or very important statistic.

Specified by:
reportStatistic in interface StatusReporting
Parameters:
description - A description of the statistic being reported
value - The (statistic) value to report
depth - The depth in the status reporting hierarchy where the statistic will be reported

reportInfo

public final void reportInfo(java.lang.String msg)
Report an informational message during the runtime processing.

Specified by:
reportInfo in interface ReporterReporting
Parameters:
msg - The message to print

reportInfo

public final void reportInfo(java.lang.String msg,
                             com.ibm.are.autofix.FixAction fixAction)
Report an informational message during the runtime processing, with info about how to fix the problem.

Specified by:
reportInfo in interface ReporterReporting
Parameters:
msg - The message to print
fixAction - The info about how to fix the problem.

reportWarning

public final void reportWarning(java.lang.String msg)
Report a warning message during the runtime processing.

Specified by:
reportWarning in interface ReporterReporting
Parameters:
msg - The message to print

reportWarning

public final void reportWarning(java.lang.String msg,
                                com.ibm.are.autofix.FixAction fixAction)
Report a warning message during the runtime processing, with info about how to fix the problem.

Specified by:
reportWarning in interface ReporterReporting
Parameters:
msg - The message to print
fixAction - The info about how to fix the problem.

reportError

public final void reportError(java.lang.String msg)
Report an error message during the runtime processing.

Specified by:
reportError in interface ReporterReporting
Parameters:
msg - The message to print

reportError

public final void reportError(java.lang.String msg,
                              com.ibm.are.autofix.FixAction fixAction)
Report an error message during the runtime processing, with info about how to fix the problem.

Specified by:
reportError in interface ReporterReporting
Parameters:
msg - The message to print
fixAction - The info about how to fix the problem.

report

public final void report(java.lang.String msg,
                         java.lang.String errorLevel)
Report a message at the given error level during the runtime processing.

Specified by:
report in interface ReporterReporting
Parameters:
msg - The message to print
errorLevel - The error level to use when reporting

report

public final void report(java.lang.String msg,
                         java.lang.String errorLevel,
                         com.ibm.are.autofix.FixAction fixAction)
Report a message at the given error level during the runtime processing, with info about how to fix the problem.

Specified by:
report in interface ReporterReporting
Parameters:
msg - The message to print
errorLevel - The error level to use when reporting
fixAction - The info about how to fix the problem.

reportStep

public final void reportStep(java.lang.String msg)
Reports a new step in the runtime processing. A step is the topmost node in the status reporting hierarchy.

Specified by:
reportStep in interface StatusReporting
Parameters:
msg - The message to report

reportStepDetail

public final void reportStepDetail(java.lang.String msg)
Reports a new step detail in the runtime processing. A 'step detail' is the direct child of a 'step' in the reporting status hierarchy.

Specified by:
reportStepDetail in interface StatusReporting
Parameters:
msg - The message to report

reportSubStep

public final void reportSubStep(java.lang.String msg)
Reports a new sub step in the runtime processing. A 'sub step' is the direct child of a 'step detail' in the reporting status hierarchy.

Specified by:
reportSubStep in interface StatusReporting
Parameters:
msg - The message to report

reportSubStepDetail

public final void reportSubStepDetail(java.lang.String msg)
Reports a new sub step detail in the runtime processing. A 'sub step detail' is the direct child of a 'sub step' in the reporting status hierarchy.

Specified by:
reportSubStepDetail in interface StatusReporting
Parameters:
msg - The message to report

addReporter

public void addReporter(ReporterReporting reporter)
Add a reporter to this group

Parameters:
reporter - The reporter to be added

removeReporter

public void removeReporter(java.lang.String className)
Removes all reporters whose class name matches the given class name

Parameters:
className - The package and class name of the reporter to remove

removeAllReporters

public void removeAllReporters()
Removes all reporters


getOutputFormat

public final int getOutputFormat()
Retrieves the output format used for reporting

Specified by:
getOutputFormat in interface ReporterReporting
Returns:
The output format

report

public final void report(java.lang.String msg,
                         int depth)
Report a message at the given level in the reporting hierarchy.

Specified by:
report in interface StatusReporting
Parameters:
msg - The message to print
depth - The level within the reporting hierarchy. If this parameter were set to 1 it would be equivalent to invoking the StatusReporting.reportStep(String) method. The valid value ranges from MIN_REPORT_DEPTH (include) to MAN_REPORT_DEPTH (include).

reportStart

public final void reportStart(com.ibm.are.core.Element elem)
Reports the start of a plugin

Specified by:
reportStart in interface StatusReporting
Parameters:
elem - The plugin that is starting

reportFinish

public final void reportFinish(com.ibm.are.core.Element elem,
                               ResultInfo result)
Reports the result of the runtime processing for a plugin.

Specified by:
reportFinish in interface StatusReporting
result - The result

reportDetail

public void reportDetail(ProblemContext problemCtx,
                         java.lang.String msg,
                         java.lang.String errorLevel)
Report details for a problem at the given error level during the runtime processing.

Specified by:
reportDetail in interface ReporterReporting
Parameters:
problemCtx - The context of the problem for which the details are being reported.
msg - The message to print
errorLevel - The error level to use when reporting

reportErrorDetail

public void reportErrorDetail(ProblemContext problemCtx,
                              java.lang.String msg)
Report details of an error message during the runtime processing.

Specified by:
reportErrorDetail in interface ReporterReporting
Parameters:
problemCtx - The context of the problem for which the details are being reported.
msg - The message to print

reportInfoDetail

public void reportInfoDetail(ProblemContext problemCtx,
                             java.lang.String msg)
Report details for an informational message during the runtime processing.

Specified by:
reportInfoDetail in interface ReporterReporting
Parameters:
problemCtx - The context of the problem for which the details are being reported.
msg - The message to print

reportWarningDetail

public void reportWarningDetail(ProblemContext problemCtx,
                                java.lang.String msg)
Report details for a warning message during the runtime processing.

Specified by:
reportWarningDetail in interface ReporterReporting
Parameters:
problemCtx - The context of the problem for which the details are being reported.
msg - The message to print

getContents

public java.lang.Object getContents()
Retrieves the entire contents of the report. The object that represents the contents can be anything; a String, a Document, etc. It is the responsibility of the invoker of this method to properly determine the type of object returned before performing any operations against it.

Specified by:
getContents in interface ReporterReporting
Returns:
The entire contents of the report

publisher

public com.ibm.are.report.Publisher publisher()
The Publisher that is to be used when publishing this report.

Specified by:
publisher in interface ReporterReporting
Returns:
The publisher to use