ProvenanceReporter Class Reference

Provenance reporting singleton.

#include <Workspace/Provenance/provenancereporter.h>

Inherits QObject.

Classes
class	Activity
	Complete provenance record for an activity. More...
class	Reporter
	Allows support to be added for custom reporters. More...

Public Member Functions
QString	generateAndSubmitReport (const DataExecution::Workspace &workspace, const QString &reportingLevel="external", bool executionCompleted=true)
QString	getLocalReportingDir () const
bool	isEnabled () const
bool	reportCustomEvent (const QString &description, const QUrl &url)
bool	reportExternalInput (const QString &description, const QUrl &url)
bool	reportExternalOutput (const QString &description, const QUrl &url)
bool	reportInternalResult (const QString &description, const QString &result)
bool	reportOperationExecute (const DataExecution::Operation &op)
bool	setCustomReporter (const Reporter &reporter)
bool	setReportHeader (const Activity::Header &header)
void	setWorkflowUrl (const QUrl &url)
bool	startRecording (const QUrl &workflowUrl)
bool	stopRecording ()

Static Public Member Functions
static ProvenanceReporter &	getInstance ()

Member Function Documentation

generateAndSubmitReport()

QString generateAndSubmitReport	(	const DataExecution::Workspace &	workspace,
		const QString &	reportingLevel = "external",
		bool	executionCompleted = true
	)

Returns

The location or the generated report or empty string if the report failed

Parameters

workspace	The root workspace
reportingLevel	The report level to generate and submit - the default reporter supports "basic", "external" and "internal" but other reporters may use other names
executionCompleted	Is this report for a workspace execution that completed successfully.

getInstance()

ProvenanceReporter & getInstance ( )

static

getLocalReportingDir()

QString getLocalReportingDir

(

)

const

isEnabled()

bool isEnabled

(

)

const

reportCustomEvent()

bool reportCustomEvent	(	const QString &	description,
		const QUrl &	url
	)

Returns

true if the event was added to the report or false if reporting is disabled

Parameters

description	A description of the custom event
url	A url related to the custom event

The default reporter will ignore custom events (Activity::Event::Custom) but custom reporters may use the description and url for anything they like

reportExternalInput()

bool reportExternalInput	(	const QString &	description,
		const QUrl &	url
	)

Returns

true if the event was added to the report or false if reporting is disabled

Parameters

description	A description of the entity used by the workflow
url	The url of the entity used by the workflow

reportExternalOutput()

bool reportExternalOutput	(	const QString &	description,
		const QUrl &	url
	)

Returns

true if the event was added to the report or false if reporting is disabled

Parameters

description	A description of the entity generated by the workflow
url	The url of the entity generated by the workflow

reportInternalResult()

bool reportInternalResult	(	const QString &	description,
		const QString &	result
	)

Returns

true if the event was added to the report or false if reporting is disabled

Parameters

description	A description of the internal result produced by the workflow
result	The internal result

reportOperationExecute()

bool reportOperationExecute

(

const DataExecution::Operation &

op

)

Returns

true if the event was added to the report or false if reporting is disabled

Parameters

op	The operation about to be executed

setCustomReporter()

bool setCustomReporter

(

const Reporter &

reporter

)

setReportHeader()

bool setReportHeader

(

const Activity::Header &

header

)

setWorkflowUrl()

void setWorkflowUrl

(

const QUrl &

url

)

startRecording()

bool startRecording

(

const QUrl &

workflowUrl

)

stopRecording()

bool stopRecording

(

)