public abstract class CustomReport
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
CustomReport.ReportConfigPanel
Configuration panel for a report.
|
class |
CustomReport.ReportException
The class ReportException indicates an error during report creation.
|
Constructor and Description |
---|
CustomReport() |
Modifier and Type | Method and Description |
---|---|
abstract java.io.File |
createReport(java.io.File rootDir)
Create a report within the context of a GUI.
|
abstract java.io.File |
createReport(java.lang.String args,
java.io.File rootDir,
InterviewParameters ip,
TestFilter filter)
Write a report without the context of a GUI.
|
void |
dispose()
Dispose of any data or components which this class may be
holding references to.
|
abstract java.lang.String |
getDescription()
Get a longer description about the purpose of this report type.
|
abstract java.lang.String |
getName()
Get a short name for this report type.
|
CustomReport.ReportConfigPanel[] |
getOptionPanes()
Get report options panes.
|
ReportSettings |
getReportEnviroment() |
abstract java.lang.String |
getReportId()
Get a short internal name for this report type.
|
java.io.InputStream |
getXmlReport()
Request the content of the standard XML report from the harness.
|
boolean |
needsXmlReport()
Will this report need the standard XML data report if it is run.
|
void |
setEnviroment(ReportSettings envir) |
abstract java.lang.String |
validateOptions()
Validate the options currently in the option panes.
|
public boolean needsXmlReport()
false
. Returning false does
not mean that the report cannot ask for the XML, but by correctly
answering, the harness may be able to apply some optimization based on
which other reports are being generated.getXmlReport()
public final java.io.InputStream getXmlReport() throws java.io.IOException, org.xml.sax.SAXException
createReport
methods.java.io.IOException
org.xml.sax.SAXException
needsXmlReport()
public abstract java.io.File createReport(java.io.File rootDir) throws CustomReport.ReportException
rootDir
- The directory to write the report to.CustomReport.ReportException
- - if the report creation was unsuccessful.
Harness can show Exception's textpublic abstract java.io.File createReport(java.lang.String args, java.io.File rootDir, InterviewParameters ip, TestFilter filter) throws CustomReport.ReportException
args
- Arguments given to this report format. It is encoded into
a single string, the format of which is defined by the
report implementation. In general though, the arg string
must be absent of spaces, and should not require any
characters which require escaping on common platforms
(semicolon, ampersand, exclamation, any quotation marks).rootDir
- The directory to write the report to.ip
- The interview which should be report on.filter
- The test filter that should be applied when iterating
over the results to place in the report. If the report
relies on the XML report, this parameter can usually be
ignored since the XML report itself will have been filtered
already.CustomReport.ReportException
- - if the report creation was unsuccessful.
Harness can show Exception's textPreferences
public abstract java.lang.String getReportId()
rootDir
parameter
of the createReport
methods.getName()
,
Character.isJavaIdentifierStart(char)
,
Character.isJavaIdentifierPart(char)
public abstract java.lang.String getName()
public abstract java.lang.String getDescription()
public ReportSettings getReportEnviroment()
public CustomReport.ReportConfigPanel[] getOptionPanes()
public abstract java.lang.String validateOptions()
getOptionPanes
.
It can be assumed that this method is called just before
createReport
to ensure that the user's settings are valid (in
GUI mode). It is not called in non-GUI mode.getOptionPanes()
,
CustomReport.ReportConfigPanel
public void dispose()
public void setEnviroment(ReportSettings envir)
Copyright (c) 1996, 2015, Oracle and/or its affiliates. All rights reserved.