oracle.apps.fnd.appltest.diagfwk.engine.impl
Class DiagJAXBXMLDocReport<T>

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagBObjImpl<T>
      oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagJAXBXMLDoc<T>
          oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagJAXBXMLDocReport<T>

All Implemented Interfaces:

DiagConstants, DiagBObj<T>

Direct Known Subclasses:

TestExecImpl, TestRunImpl

public abstract class DiagJAXBXMLDocReport<T>
extends DiagJAXBXMLDoc<T>

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/DiagJAXBXMLDocReport.java /main/12 2008/08/13 15:09:37 ilawler Exp $

Author:

ppradhan

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

protected TestReportExtn	mTestReport
protected java.lang.String	xmlSrcFile Metadata source file (this is set if the current object is loaded from a XML metadata file).

Fields inherited from class oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagJAXBXMLDoc

errMsgOnLoadXML, errMsgOnValXML

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

DiagJAXBXMLDocReport()

Method Summary

void	computeLinksInReport() Computes links within this report
protected abstract java.util.List<DiagJAXBXMLDocReport>	getChildList() Returns the list of nested entities
protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getErrorMsgOnLoadXmlErr() Returns an instance of the resource with the error message when there is an failure to load XML using JAXB
protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getErrorMsgOnXmlValErr(int pLine, int pCol, java.lang.String pMsg) Returns an instance of the resource with the error message when there is validation error in the source XML
protected java.lang.Object	getJAXBMetadataObj() Gets the top level JAXB object for the metadata
protected java.lang.String	getJAXBPkg() Gets the JAXB object package for this metadata
TestReportExtn	getReportObj()
protected abstract java.lang.Boolean	getViewReportAllowed() Returns a boolean representing whether the salient details of a report may be viewed.
protected abstract java.lang.String	getXmlSourceIdentifier() Returns an identifier for the current loaded XML source document
protected void	performPostLoad() Callback hook for performing any post-load operations after loading of a XML document.
protected java.lang.String	saveReportHTML(java.lang.String pOutDir) Saves the report to the specified directory in HTML format.
protected java.lang.String	saveReportHTML(java.lang.String pOutDir, java.lang.String pFileName) Saves the current report in HTML format to the given output directory and file.
protected java.lang.String	saveReportXML(java.lang.String pOutDir) Saves the report to the specified directory.
protected java.lang.String	saveReportXML(java.lang.String pOutDir, java.lang.String pFileName) Saves the report to the specified directory and filename.
protected void	setJAXBMetadataObj(java.lang.Object pMd) Sets the top level JAXB object for the metadata
void	setReportObj(TestReportExtn pReport)
protected static java.lang.String	stripExtn(java.lang.String pFileName)
void	translateReport() Translates the translatable contents of this report to user's session language.
java.lang.String	writeReport(java.lang.String pOutDir, boolean pWriteChildren, DiagConstants.Format pFormat) Writes the report to the output directory in the specified format.
java.lang.String	writeReport(java.lang.String pOutDir, DiagConstants.Format pFormat) Writes the report to the output directory in the specified format.
java.lang.String	writeReportHTML(java.lang.String pOutDir) Writes out the report content in HTML format to the given output directory.
java.lang.String	writeReportHTML(java.lang.String pOutDir, boolean pWriteChildren) Writes out the report content in HTML format to the given output directory.
java.lang.String	writeReportXML(java.lang.String pOutDir) Writes out the report content in XML format to the given output directory.
java.lang.String	writeReportXML(java.lang.String pOutDir, boolean pWriteChildren) Writes out the report content in XML format to the given output directory.

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagJAXBXMLDoc

getErrMsgOnLoadXML, getErrMsgOnValXML, load, reactToValidationEvents, saveJAXB, saveToFile, setErrMsgOnLoadXML, setErrMsgOnValXML, setJAXBMetadataStr

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagBObjImpl

copy, copyCommon, getCreatedBy, getCreationDate, getLastUpdateDate, getLastUpdatedBy, getLastUpdateLogin, isCreatedByOracle, setCreatedBy, setCreationDate, setLastUpdateDate, setLastUpdatedBy, setLastUpdateLogin

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.DiagBObj

copyT

Field Detail

xmlSrcFile

protected java.lang.String xmlSrcFile

Metadata source file (this is set if the current object is loaded from a XML metadata file).

mTestReport

protected TestReportExtn mTestReport

Constructor Detail

DiagJAXBXMLDocReport

public DiagJAXBXMLDocReport()

Method Detail

setJAXBMetadataObj

protected void setJAXBMetadataObj(java.lang.Object pMd)

Description copied from class: DiagJAXBXMLDoc

Sets the top level JAXB object for the metadata

Specified by:

setJAXBMetadataObj in class DiagJAXBXMLDoc<T>

Parameters:

pMd - the top level JAXB object for the metadata

getJAXBMetadataObj

protected java.lang.Object getJAXBMetadataObj()

Description copied from class: DiagJAXBXMLDoc

Gets the top level JAXB object for the metadata

Specified by:

getJAXBMetadataObj in class DiagJAXBXMLDoc<T>

Returns:

the top level JAXB object for the metadata

setReportObj

public void setReportObj(TestReportExtn pReport)

getReportObj

public TestReportExtn getReportObj()

getJAXBPkg

protected java.lang.String getJAXBPkg()

Description copied from class: DiagJAXBXMLDoc

Gets the JAXB object package for this metadata

Specified by:

getJAXBPkg in class DiagJAXBXMLDoc<T>

Returns:

the JAXB package name for this metadata

getErrorMsgOnLoadXmlErr

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef getErrorMsgOnLoadXmlErr()

Description copied from class: DiagJAXBXMLDoc

Returns an instance of the resource with the error message when there is an failure to load XML using JAXB

Specified by:

getErrorMsgOnLoadXmlErr in class DiagJAXBXMLDoc<T>

Returns:

an instance of the resource with the error message when there is an failure to load XML using JAXB

getErrorMsgOnXmlValErr

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef getErrorMsgOnXmlValErr(int pLine,
                                                                                int pCol,
                                                                                java.lang.String pMsg)

Description copied from class: DiagJAXBXMLDoc

Returns an instance of the resource with the error message when there is validation error in the source XML

Specified by:

getErrorMsgOnXmlValErr in class DiagJAXBXMLDoc<T>

Parameters:

pLine - line number where the error occurred

pCol - column number where the error occurred

pMsg - validation error message

Returns:

an instance of the resource with the error message when there is validation error in the source XML

getXmlSourceIdentifier

protected abstract java.lang.String getXmlSourceIdentifier()

Returns an identifier for the current loaded XML source document

Returns:

an identifier for the current loaded XML source document

performPostLoad

protected void performPostLoad()

Description copied from class: DiagJAXBXMLDoc

Callback hook for performing any post-load operations after loading of a XML document. Such operations may include, but are not limited to, performing further validations on the document.

Specified by:

performPostLoad in class DiagJAXBXMLDoc<T>

getViewReportAllowed

protected abstract java.lang.Boolean getViewReportAllowed()

Returns a boolean representing whether the salient details of a report may be viewed. For a run, all details are viewable but for an execution, step reports, summaries, etc are masked or hidden.

Returns:

true if viewing allowed for the current user

saveReportXML

protected java.lang.String saveReportXML(java.lang.String pOutDir)

Saves the report to the specified directory.

Parameters:

pOutDir - output directory.

Returns:

the full file path where the output was written to

saveReportXML

protected java.lang.String saveReportXML(java.lang.String pOutDir,
                                         java.lang.String pFileName)

Saves the report to the specified directory and filename.

Parameters:

pOutDir - output directory where the file should be saved.

pFileName - name of the file where the report should be saved.

Returns:

the full file path where the output was written to

saveReportHTML

protected java.lang.String saveReportHTML(java.lang.String pOutDir,
                                          java.lang.String pFileName)

Saves the current report in HTML format to the given output directory and file. Uses XSL transformation in order to conver the XML report content to HTML.

Parameters:

pOutDir - - output directory

pFileName - - output file name

saveReportHTML

protected java.lang.String saveReportHTML(java.lang.String pOutDir)

Saves the report to the specified directory in HTML format.

Parameters:

pOutDir - output directory.

Returns:

the full file path where the output was written to

stripExtn

protected static java.lang.String stripExtn(java.lang.String pFileName)

writeReportXML

public java.lang.String writeReportXML(java.lang.String pOutDir)

Writes out the report content in XML format to the given output directory. Also writes the report content for any child executions.

Parameters:

pOutDir - output directory

Returns:

full file path for the output file

See Also:

TestRun.writeReport(String), TestExec.writeReport(String)

writeReportXML

public java.lang.String writeReportXML(java.lang.String pOutDir,
                                       boolean pWriteChildren)

Writes out the report content in XML format to the given output directory. Also writes the report content for any child executions if pWriteChildren is set to true.

Parameters:

pOutDir - output directory

pWriteChildren - if true writes the report for children if any.

Returns:

full file path for the output file

See Also:

TestRun.writeReport(String, boolean), TestExec.writeReport(String, boolean)

writeReportHTML

public java.lang.String writeReportHTML(java.lang.String pOutDir)

Writes out the report content in HTML format to the given output directory. Also writes the report content for any child executions.

Parameters:

pOutDir - output directory

Returns:

full file path for the output file

See Also:

TestRun.writeReport(String), TestExec.writeReport(String)

writeReportHTML

public java.lang.String writeReportHTML(java.lang.String pOutDir,
                                        boolean pWriteChildren)

Writes out the report content in HTML format to the given output directory. Also writes the report content for any child executions if pWriteChildren is set to true.

Parameters:

pOutDir - output directory

pWriteChildren - if true writes the report for children if any.

Returns:

full file path for the output file

See Also:

TestRun.writeReport(String, boolean), TestExec.writeReport(String, boolean)

writeReport

public java.lang.String writeReport(java.lang.String pOutDir,
                                    DiagConstants.Format pFormat)

Writes the report to the output directory in the specified format. Additionally, also writes the report for children if there are any.

Parameters:

pOutDir - output direcotry

pFormat - format for the report

Returns:

full filepath for the output file.

writeReport

public java.lang.String writeReport(java.lang.String pOutDir,
                                    boolean pWriteChildren,
                                    DiagConstants.Format pFormat)

Writes the report to the output directory in the specified format. Additionally, if pWriteChildren is true, also writes the report for children if there are any.

Parameters:

pOutDir - output directory

pWriteChildren - if true, also writes the report for children (if any)

pFormat - format for the report

Returns:

full filepath for the output file.

getChildList

protected abstract java.util.List<DiagJAXBXMLDocReport> getChildList()

Returns the list of nested entities

translateReport

public void translateReport()

Translates the translatable contents of this report to user's session language.

computeLinksInReport

public void computeLinksInReport()

Computes links within this report