org.kepler.provenance.sql

Class SQLRecordingV7

java.lang.Object

org.kepler.provenance.Recording

org.kepler.provenance.sql.SQLRecording

org.kepler.provenance.sql.SQLRecordingV7

Direct Known Subclasses:

SQLRecordingV8

public class SQLRecordingV7
extends SQLRecording

SQL Implementation of Recording using SDM SPA schema. This uses version 7 of the schema. The difference between the previous version is tracking changes in the workflow structure.

Author:

Daniel Crawl

Nested Class Summary

Nested classes/interfaces inherited from class org.kepler.provenance.sql.SQLRecording

SQLRecording.PortDirection

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_evolId ID of current change to workflow structure.
protected java.sql.PreparedStatement	_psParameterValueQuery
protected java.sql.PreparedStatement	_psWorkflowChangeInsert
protected java.util.Stack<java.sql.Timestamp>	_workflowChangeTimeStack Timestamp of current change to workflow structure.

Fields inherited from class org.kepler.provenance.sql.SQLRecording

_dbParams, _dbType, _entityCacheTable, _fireStateTable, _maxDataSize, _maxParameterValueSize, _needReconnectDB, _needReconnectWF, _params, _psActionInsert, _psActorFireStart, _psActorFireStop, _psActorInsert, _psDirectorInsert, _psEntityInsert, _psEntityQuery, _psLinkInsert, _psParameterInsert, _psPortInsert, _psRelationInsert, _psTokenFlowInsert, _psWorkflowExecStart, _psWorkflowExecStop, _psWorkflowInsert, _psWorkflowQuery, _schema, _wfExecId, _wfId, _wfNameStr, _wfUserStr, DATA_NONE, DATA_TRUNCATED, DATA_VALID, SUCCESS, WORKFLOW_ALREADY_EXISTS, WORKFLOW_DOES_NOT_EXIST

Fields inherited from class org.kepler.provenance.Recording

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

Constructor Summary

Constructors

Constructor and Description
SQLRecordingV7()

Method Summary

Modifier and Type	Method and Description
protected org.kepler.provenance.sql.RegEntity	_addEntity(int containerId, RegEntity.EntityType type, java.lang.String fullName, java.lang.String displayName, int prevId) Add a new row to the entity table.
protected void	_addWorkflow() Add a new row to the workflow table.
protected void	_addWorkflowChange() Create a new row in the workflow_change table.
protected void	_createPreparedStatements() Initialize the prepared statements.
protected Schema	_createSchema() Create a Schema to reflect the v7 schema.
protected void	_errorReset() Reset when we encounter an error.
protected void	_nullPreparedStatements() Set our prepared statements to null.
protected void	_possibleWorkflowChangeStart() A workflow change may be starting.
protected void	_possibleWorkflowChangeStop() A possible workflow change is stopping.
protected void	_wfReset() Reset when we use a different workflow.
void	evolutionStart() Start an evolution.
void	evolutionStop() Stop an evolution.
boolean	regParameter(NamedObj parameter) Register a parameter.
void	specificationStart() Called before registering workflow contents.
void	specificationStop() Called when finished registering workflow contents.

Methods inherited from class org.kepler.provenance.sql.SQLRecording

_changeEntityFullName, _checkConnection, _checkEntity, _checkParameters, _checkWorkflowName, _dbReset, _getContainerId, _getMaxParameterValueSize, _getMaxTokenDataSize, _getWorkflowId, _getWorkflowId, _reconnectDatabase, _reconnectWorkflow, _recordFiringEvent, _recordPortEvent, _regActorDirector, _regParameterReal, _regPortReal, _updateWorkflowID, actorFire, attributeChanged, disconnect, executionImported, executionStart, executionStop, generateParameters, portEvent, regActor, regDirector, regLink, regPort, regRelation

Methods inherited from class org.kepler.provenance.Recording

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

Methods inherited from class java.lang.Object

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

Field Detail

_psWorkflowChangeInsert

protected java.sql.PreparedStatement _psWorkflowChangeInsert

_psParameterValueQuery

protected java.sql.PreparedStatement _psParameterValueQuery

_workflowChangeTimeStack

protected java.util.Stack<java.sql.Timestamp> _workflowChangeTimeStack

Timestamp of current change to workflow structure.

_evolId

protected int _evolId

ID of current change to workflow structure.

Constructor Detail

SQLRecordingV7

public SQLRecordingV7()
               throws RecordingException

Throws:

RecordingException

Method Detail

specificationStart

public void specificationStart()
                        throws RecordingException

Called before registering workflow contents.

Overrides:

specificationStart in class SQLRecording

Throws:

RecordingException

specificationStop

public void specificationStop()
                       throws RecordingException

Called when finished registering workflow contents.

Overrides:

specificationStop in class Recording

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 SQLRecording

Returns:

if true, register contents of parameter.

Throws:

RecordingException

evolutionStart

public void evolutionStart()
                    throws RecordingException

Start an evolution.

Overrides:

evolutionStart in class Recording

Throws:

RecordingException

evolutionStop

public void evolutionStop()
                   throws RecordingException

Stop an evolution.

Overrides:

evolutionStop in class Recording

Throws:

RecordingException

_addEntity

protected org.kepler.provenance.sql.RegEntity _addEntity(int containerId,
                                                         RegEntity.EntityType type,
                                                         java.lang.String fullName,
                                                         java.lang.String displayName,
                                                         int prevId)
                                                  throws RecordingException,
                                                         java.sql.SQLException

Add a new row to the entity table.

Overrides:

_addEntity in class SQLRecording

Throws:

RecordingException

java.sql.SQLException

_addWorkflow

protected void _addWorkflow()
                     throws RecordingException

Add a new row to the workflow table.

Overrides:

_addWorkflow in class SQLRecording

Throws:

RecordingException

_addWorkflowChange

protected void _addWorkflowChange()
                           throws RecordingException

Create a new row in the workflow_change table.

Throws:

RecordingException

_createPreparedStatements

protected void _createPreparedStatements()
                                  throws java.sql.SQLException

Initialize the prepared statements.

Overrides:

_createPreparedStatements in class SQLRecording

Throws:

java.sql.SQLException

_createSchema

protected Schema _createSchema()

Create a Schema to reflect the v7 schema.

Overrides:

_createSchema in class SQLRecording

_errorReset

protected void _errorReset()
                    throws RecordingException

Reset when we encounter an error.

Overrides:

_errorReset in class SQLRecording

Throws:

RecordingException

_nullPreparedStatements

protected void _nullPreparedStatements()

Set our prepared statements to null.

Overrides:

_nullPreparedStatements in class SQLRecording

_wfReset

protected void _wfReset()

Reset when we use a different workflow.

Overrides:

_wfReset in class SQLRecording

_possibleWorkflowChangeStart

protected void _possibleWorkflowChangeStart()
                                     throws RecordingException

A workflow change may be starting.

Throws:

RecordingException

_possibleWorkflowChangeStop

protected void _possibleWorkflowChangeStop()
                                    throws RecordingException

A possible workflow change is stopping.

Throws:

RecordingException