Package de.tracetronic.jenkins.plugins.ecutest.wrapper.com

Class AnalysisEnvironment

java.lang.Object

com.jacob.com.JacobObject

com.jacob.com.Dispatch

de.tracetronic.jenkins.plugins.ecutest.wrapper.com.ETComDispatch

de.tracetronic.jenkins.plugins.ecutest.wrapper.com.AnalysisEnvironment

All Implemented Interfaces:

ComAnalysisEnvironment, AutoCloseable

public class AnalysisEnvironment
extends ETComDispatch
implements ComAnalysisEnvironment

COM object representing the currently started analysis environment. This environment supports operations to run analysis jobs.

Field Summary

Fields inherited from class com.jacob.com.Dispatch

fdexNameCaseSensitive, Get, LOCALE_SYSTEM_DEFAULT, m_pDispatch, Method, Put, PutRef

Constructor Summary

Constructors

Constructor	Description
AnalysisEnvironment(com.jacob.com.Dispatch dispatch, boolean useTimeout)	Instantiates a new AnalysisEnvironment.

Method Summary

Modifier and Type	Method	Description
ComAnalysisExecutionInfo	executeJob(String jobFile)	Same as executeJob(String, boolean) but with default parameters.
ComAnalysisExecutionInfo	executeJob(String jobFile, boolean createReportDir)	Starts the execution of an analysis job.
ComAnalysisExecutionInfo	getAnalysisExecutionInfo()	Gets the current analysis execution info.
boolean	mergeJobReports(String mainReportFilename, List<String> jobReports)	Merges reports of analysis job executions into a main report.

Methods inherited from class de.tracetronic.jenkins.plugins.ecutest.wrapper.com.ETComDispatch

close, finalize, isAttached, performDirectRequest, performDirectRequest, performRequest, performRequest, performRequest, performRequest, useTimeout

Methods inherited from class com.jacob.com.Dispatch

call, call, call, call, callN, callN, callN_CaseSensitive, callSub, callSub, callSub, callSub, callSubN, callSubN, coCreateInstance, get, get, get_CaseSensitive, getActiveInstance, getIDOfName, getIDsOfNames, getIDsOfNames, getProgramId, hasExited, hasExited, invoke, invoke, invoke, invokeSub, invokeSub, invokeSub, invokeSubv, invokeSubv, invokeSubv, invokev, invokev, invokev, invokev, put, put, put_Casesensitive, putRef, putRef, QueryInterface, safeRelease

Methods inherited from class com.jacob.com.JacobObject

debug, getBuildDate, getBuildVersion, isDebugEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisEnvironment

public AnalysisEnvironment(com.jacob.com.Dispatch dispatch,
                           boolean useTimeout)

Instantiates a new AnalysisEnvironment.

This constructor is used instead of a case operation to turn a Dispatch object into a wider object - it must exist in every wrapper class whose instances may be returned from method calls wrapped in VT_DISPATCH Variants.

Parameters:

dispatch - the dispatch

useTimeout - specifies whether to apply timeout

Method Detail

getAnalysisExecutionInfo

public ComAnalysisExecutionInfo getAnalysisExecutionInfo()
                                                  throws ETComException

Description copied from interface: ComAnalysisEnvironment

Gets the current analysis execution info.

Specified by:

getAnalysisExecutionInfo in interface ComAnalysisEnvironment

Returns:

the ComAnalysisExecutionInfo dispatch

Throws:

ETComException - in case of a COM exception

executeJob

public ComAnalysisExecutionInfo executeJob(String jobFile)
                                    throws ETComException

Same as executeJob(String, boolean) but with default parameters.

Parameters:

jobFile - the full path name of the analysis job file

Returns:

the ComAnalysisExecutionInfo dispatch

Throws:

ETComException - in case of a COM exception

executeJob

public ComAnalysisExecutionInfo executeJob(String jobFile,
                                           boolean createReportDir)
                                    throws ETComException

Description copied from interface: ComAnalysisEnvironment

Starts the execution of an analysis job.

Specified by:

executeJob in interface ComAnalysisEnvironment

Parameters:

jobFile - the full path name of the analysis job file

createReportDir - specifies whether a new report directory is created or whether the report should be stored next to the job

Returns:

the ComAnalysisExecutionInfo dispatch

Throws:

ETComException - in case of a COM exception

mergeJobReports

public boolean mergeJobReports(String mainReportFilename,
                               List<String> jobReports)
                        throws ETComException

Description copied from interface: ComAnalysisEnvironment

Merges reports of analysis job executions into a main report.

Specified by:

mergeJobReports in interface ComAnalysisEnvironment

Parameters:

mainReportFilename - the full path of the main report

jobReports - the list of file names to reports of analysis job executions

Returns:

true if merge was successful, false otherwise

Throws:

ETComException - in case of a COM exception