org.kepler.provenance

Class TextFileRecording

java.lang.Object

org.kepler.provenance.Recording

org.kepler.provenance.TextFileRecording

public class TextFileRecording
extends Recording

A provenance Recording that writes to a text file.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextFileRecording.TextFileRecordingParameters Configuration Parameters for TextFileRecording.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_addTimestampVal If true, add timestamp to output.
protected boolean	_alwaysFlushVal If true, flush after writing to output.
protected java.text.SimpleDateFormat	_dFormat Format timestamps.
protected java.lang.String	_outputName Output name.
protected TextFileRecording.TextFileRecordingParameters	_params Parameters for TextFileRecording
protected boolean	_recordSpecVal Whether to record workflow specification.
protected java.io.PrintStream	_textWriter Output writer.

Fields inherited from class org.kepler.provenance.Recording

_containerFullName, _containerLSID, _containerName, _debugPrint, _debugWriter, _machineStr, _recorder, _recorderContainer, _stateSerializer

Constructor Summary

Constructors

Constructor and Description
TextFileRecording() Create a new provenance recording.

Method Summary

Modifier and Type	Method and Description
protected void	_write(java.lang.String str) Output a string.
protected void	_write(java.lang.String str, boolean outputDebug) Output a string.
protected void	_writeOutput(java.lang.String str) Output a string, optionally adding a timestamp.
protected void	_writeOutput(java.lang.String str, boolean outputDebug) Output a string, optionally adding a timestamp.
protected void	_writeOutput(java.lang.String str, boolean outputDebug, java.util.Date timestamp) Output a string, optionally adding a timestamp.
protected void	_writeOutput(java.lang.String str, java.util.Date timestamp) Output a string, optionally adding a timestamp.
void	actorFire(FiringEvent event, java.util.Date timestamp) Record starting an actor fire event.
void	attributeChanged(Attribute attribute) React to a change in an attribute.
void	customProvEvent(ProvenanceEvent event) Record a custom provenance event.
void	disconnect() Stop recording.
void	evolutionStart() Start an evolution.
void	evolutionStop() Stop an evolution.
void	executionError(Nameable source, java.lang.Throwable throwable) An actor threw an exception.
void	executionStart() Record the starting of workflow execution.
void	executionStop() Record the stopping of workflow execution.
RecordingParameters	generateParameters(NamedObj no) Add Parameters for ProvenanceListener.
void	portEvent(IOPortEvent event, java.util.Date timestamp) Record a port event.
boolean	regActor(Actor actor) Register an actor.
boolean	regDirector(Director director) Register a director.
boolean	regLink(NamedObj endPoint1, NamedObj endPoint2) Register a link between two endpoints.
boolean	regParameter(NamedObj parameter) Register a parameter.
boolean	regPort(TypedIOPort port) Register a port or portparameter.
boolean	regRelation(IORelation relation) Register a relation.
void	remove(java.lang.String name) A NamedObj was removed.
void	removeLink(java.lang.String endPoint1, java.lang.String endPoint2) Remove a link between two endpoints.
void	rename(java.lang.String oldName, java.lang.String newName) A NamedObj was renamed.
void	setAddTimestamp(boolean addTimestamp) Set if the output should have a timestamp.
void	specificationStart() Called before registering workflow contents.
void	specificationStop() Called when finished registering workflow contents.
void	tagAdded(TagEvent event) A tag was added.
void	tagRemoved(TagEvent event) A tag was removed.

Methods inherited from class org.kepler.provenance.Recording

_debug, _debug, _debugWrite, _debugWrite, _error, _getExceptionMessage, _getNameableFullName, _needWorkflowContents, _updateContainerName, _warn, actorFire, addFileForLastExecution, changeExecutionLSID, executionError, executionImported, executionImported, executionStart, executionStart, executionStart, executionStop, executionStop, executionStop, getContainer, getQueryable, portEvent, refillPortEvent, regContents, removeStateSerializer, renamedWorkflow, setContainer, setContainerLSID, setContainerName, setDebugWriter, setStateSerializer

Methods inherited from class java.lang.Object

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

Field Detail

_recordSpecVal

protected boolean _recordSpecVal

Whether to record workflow specification.

_textWriter

protected java.io.PrintStream _textWriter

Output writer.

_alwaysFlushVal

protected boolean _alwaysFlushVal

If true, flush after writing to output.

_addTimestampVal

protected boolean _addTimestampVal

If true, add timestamp to output.

_dFormat

protected java.text.SimpleDateFormat _dFormat

Format timestamps.

_params

protected TextFileRecording.TextFileRecordingParameters _params

Parameters for TextFileRecording

_outputName

protected java.lang.String _outputName

Output name.

Constructor Detail

TextFileRecording

public TextFileRecording()
                  throws RecordingException

Create a new provenance recording.

Throws:

RecordingException

Method Detail

disconnect

public void disconnect()
                throws RecordingException

Stop recording. This is the last method called to a Recording instance.

Overrides:

disconnect in class Recording

Throws:

RecordingException

specificationStart

public void specificationStart()
                        throws RecordingException

Called before registering workflow contents.

Overrides:

specificationStart in class Recording

Throws:

RecordingException

specificationStop

public void specificationStop()
                       throws RecordingException

Called when finished registering workflow contents.

Overrides:

specificationStop in class Recording

Throws:

RecordingException

regActor

public boolean regActor(Actor actor)
                 throws RecordingException

Register an actor.

Overrides:

regActor in class Recording

Returns:

if true, register contents of actor.

Throws:

RecordingException

regDirector

public boolean regDirector(Director director)
                    throws RecordingException

Register a director.

Overrides:

regDirector in class Recording

Returns:

if true, register contents of director.

Throws:

RecordingException

regParameter

public boolean regParameter(NamedObj parameter)
                     throws RecordingException

Register a parameter. A parameter can be any entity stored in the MoML that does not have its own regNNN() method. This can be user-level parameters (e.g., Parameter, StringParameter, etc.) or internal to Kepler (e.g., _location, semanticType000, etc.). (A "parameter" corresponds to a property in the MoML).

Overrides:

regParameter in class Recording

Returns:

if true, register contents of parameter.

Throws:

RecordingException

regLink

public boolean regLink(NamedObj endPoint1,
                       NamedObj endPoint2)
                throws RecordingException

Register a link between two endpoints.

Overrides:

regLink in class Recording

Parameters:

endPoint1 - first endpoint.

endPoint2 - second endpoint.

Returns:

if true, register contents of link.

Throws:

RecordingException

regPort

public boolean regPort(TypedIOPort port)
                throws RecordingException

Register a port or portparameter.

Overrides:

regPort in class Recording

Returns:

if true, register contents of port.

Throws:

RecordingException

regRelation

public boolean regRelation(IORelation relation)
                    throws RecordingException

Register a relation.

Overrides:

regRelation in class Recording

Returns:

if true, register contents of relation.

Throws:

RecordingException

evolutionStart

public void evolutionStart()
                    throws RecordingException

Description copied from class: Recording

Start an evolution.

Overrides:

evolutionStart in class Recording

Throws:

RecordingException

evolutionStop

public void evolutionStop()
                   throws RecordingException

Description copied from class: Recording

Stop an evolution.

Overrides:

evolutionStop in class Recording

Throws:

RecordingException

remove

public void remove(java.lang.String name)
            throws RecordingException

Description copied from class: Recording

A NamedObj was removed.

Overrides:

remove in class Recording

Throws:

RecordingException

removeLink

public void removeLink(java.lang.String endPoint1,
                       java.lang.String endPoint2)
                throws RecordingException

Description copied from class: Recording

Remove a link between two endpoints. Links do not have names (they are not NamedObjs, so remove() cannot be used.

Overrides:

removeLink in class Recording

Throws:

RecordingException

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws RecordingException

A NamedObj was renamed.

Overrides:

rename in class Recording

Throws:

RecordingException

executionStart

public void executionStart()
                    throws RecordingException

Record the starting of workflow execution.

Overrides:

executionStart in class Recording

Throws:

RecordingException

executionStop

public void executionStop()
                   throws RecordingException

Record the stopping of workflow execution.

Overrides:

executionStop in class Recording

Throws:

RecordingException

executionError

public void executionError(Nameable source,
                           java.lang.Throwable throwable)
                    throws RecordingException

An actor threw an exception.

Overrides:

executionError in class Recording

Parameters:

source - the source of the error. This may be null.

throwable - the error.

Throws:

RecordingException

actorFire

public void actorFire(FiringEvent event,
                      java.util.Date timestamp)
               throws RecordingException

Record starting an actor fire event.

Overrides:

actorFire in class Recording

Throws:

RecordingException

portEvent

public void portEvent(IOPortEvent event,
                      java.util.Date timestamp)
               throws RecordingException

Record a port event.

Overrides:

portEvent in class Recording

Throws:

RecordingException

customProvEvent

public void customProvEvent(ProvenanceEvent event)
                     throws RecordingException

Record a custom provenance event.

Overrides:

customProvEvent in class Recording

Throws:

RecordingException

generateParameters

public RecordingParameters generateParameters(NamedObj no)
                                       throws IllegalActionException,
                                              NameDuplicationException

Add Parameters for ProvenanceListener.

Overrides:

generateParameters in class Recording

Throws:

IllegalActionException

NameDuplicationException

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute.

Overrides:

attributeChanged in class Recording

Throws:

IllegalActionException

tagAdded

public void tagAdded(TagEvent event)
              throws RecordingException

A tag was added.

Overrides:

tagAdded in class Recording

Throws:

RecordingException

tagRemoved

public void tagRemoved(TagEvent event)
                throws RecordingException

A tag was removed.

Overrides:

tagRemoved in class Recording

Throws:

RecordingException

setAddTimestamp

public void setAddTimestamp(boolean addTimestamp)

Set if the output should have a timestamp.

_write

protected void _write(java.lang.String str)
               throws RecordingException

Output a string.

Throws:

RecordingException

_write

protected void _write(java.lang.String str,
                      boolean outputDebug)
               throws RecordingException

Output a string.

Throws:

RecordingException

_writeOutput

protected void _writeOutput(java.lang.String str)
                     throws RecordingException

Output a string, optionally adding a timestamp.

Throws:

RecordingException

_writeOutput

protected void _writeOutput(java.lang.String str,
                            java.util.Date timestamp)
                     throws RecordingException

Output a string, optionally adding a timestamp.

Throws:

RecordingException

_writeOutput

protected void _writeOutput(java.lang.String str,
                            boolean outputDebug)
                     throws RecordingException

Output a string, optionally adding a timestamp.

Throws:

RecordingException

_writeOutput

protected void _writeOutput(java.lang.String str,
                            boolean outputDebug,
                            java.util.Date timestamp)
                     throws RecordingException

Output a string, optionally adding a timestamp.

Throws:

RecordingException