org.kepler.provenance.sql

Class SQLRecording

java.lang.Object

org.kepler.provenance.Recording

org.kepler.provenance.sql.SQLRecording

Direct Known Subclasses:

SQLRecordingV7

public class SQLRecording
extends Recording

SQL Implementation of Recording using SDM SPA schema.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLRecording.PortDirection

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	_dbParams The follow hold values from DatabaseFactory.Parameters.
protected DatabaseType	_dbType Connection to the database.
protected java.util.Map<Nameable,org.kepler.provenance.sql.RegEntity>	_entityCacheTable A table to cache RegEntity objects.
protected java.util.Map<Actor,FireState<java.lang.Integer>>	_fireStateTable A table to map actor to its firing state object.
protected int	_maxDataSize The maximum size in the SQL table for data values.
protected int	_maxParameterValueSize The maximum size in the SQL table for parameter values.
protected boolean	_needReconnectDB True when we need to reconnect to the database.
protected boolean	_needReconnectWF True when we need to load workflow id from database.
protected SQLRecordingParameters	_params The sql parameters object.
protected java.sql.PreparedStatement	_psActionInsert
protected java.sql.PreparedStatement	_psActorFireStart
protected java.sql.PreparedStatement	_psActorFireStop
protected java.sql.PreparedStatement	_psActorInsert
protected java.sql.PreparedStatement	_psDirectorInsert
protected java.sql.PreparedStatement	_psEntityInsert
protected java.sql.PreparedStatement	_psEntityQuery
protected java.sql.PreparedStatement	_psLinkInsert
protected java.sql.PreparedStatement	_psParameterInsert
protected java.sql.PreparedStatement	_psPortInsert
protected java.sql.PreparedStatement	_psRelationInsert
protected java.sql.PreparedStatement	_psTokenFlowInsert
protected java.sql.PreparedStatement	_psWorkflowExecStart
protected java.sql.PreparedStatement	_psWorkflowExecStop
protected java.sql.PreparedStatement	_psWorkflowInsert
protected java.sql.PreparedStatement	_psWorkflowQuery
protected Schema	_schema The schema containing table and column definitions.
protected int	_wfExecId The current workflow execution id.
protected int	_wfId The current workflow id.
protected java.lang.String	_wfNameStr
protected java.lang.String	_wfUserStr
static int	DATA_NONE The token data was not recorded.
static int	DATA_TRUNCATED The token data was too large to completely store.
static int	DATA_VALID The token data is valid.
protected static int	SUCCESS
protected static int	WORKFLOW_ALREADY_EXISTS
protected static int	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
SQLRecording() Construct a new SQLRecording.

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 java.lang.String	_changeEntityFullName(java.lang.String name) Modify a NamedObj's full name.
protected void	_checkConnection(boolean allowReconnectWF) This method opens the database connection if necessary.
protected org.kepler.provenance.sql.RegEntity	_checkEntity(Nameable namedObj, RegEntity.EntityType type) Check if a NamedObj has been inserted into the entity table.
protected void	_checkParameters() Check parameters before (re)connecting to database or workflow.
protected void	_checkWorkflowName() Check validity of workflow name parameter.
protected void	_createPreparedStatements() Initialize the prepared statements.
protected Schema	_createSchema() Create a Schema to reflect the v6 schema.
protected void	_dbReset() Reset when we use a different db connection.
protected void	_errorReset() Reset when we encounter an error.
protected int	_getContainerId(Nameable namedObj) Find the container id of an entity.
protected int	_getMaxParameterValueSize() Get the maximum size of a parameter value that can be stored in the database.
protected int	_getMaxTokenDataSize() Get the maximum size of token data that can be stored in the database.
protected int	_getWorkflowId() Get the internal workflow id.
protected int	_getWorkflowId(java.lang.String idStr) Get the internal workflow id given a id string.
protected void	_nullPreparedStatements() Set our prepared statements to null.
protected void	_reconnectDatabase(boolean resetDB) Reconnect to the database.
protected void	_reconnectWorkflow() Re-acquire the current workflow id.
protected void	_recordFiringEvent(Actor actor, FiringEvent.FiringEventType type, java.util.Date timestamp) Record a specific type of firing for an actor.
protected void	_recordPortEvent(IOPort port, int fireId, int rwfireId, boolean isRead, int channel, Token token, IOPort destPort, java.util.Date timestamp) Record a port read or write to the token_flow table.
protected int	_regActorDirector(NamedObj namedObj, boolean actor) Convenience routine that regActor and regDirector can use since the schema for actors and directors only differs by "actor" vs "director".
protected void	_regParameterReal(NamedObj parameter, org.kepler.provenance.sql.RegEntity re) Add an entity to the parameter table.
protected void	_regPortReal(TypedIOPort port, org.kepler.provenance.sql.RegEntity re) Add a port to the port table.
protected int	_updateWorkflowID(boolean isNew) Update workflow ID either by retrieving the id from an existing workflow in the database or creating a new one.
protected void	_wfReset() Reset when we use a different workflow.
void	actorFire(FiringEvent event, java.util.Date timestamp) Record an actor fire event.
void	attributeChanged(Attribute attribute) React to a change in an attribute.
void	disconnect() Stop recording.
void	executionImported() An execution was imported.
void	executionStart(java.util.Date timestamp) Record the starting of workflow execution.
void	executionStop(java.util.Date timestamp) 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	specificationStart() Called before registering workflow contents.

Methods inherited from class org.kepler.provenance.Recording

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

Methods inherited from class java.lang.Object

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

Field Detail

DATA_VALID

public static final int DATA_VALID

The token data is valid.

See Also:

Constant Field Values

DATA_NONE

public static final int DATA_NONE

The token data was not recorded.

See Also:

Constant Field Values

DATA_TRUNCATED

public static final int DATA_TRUNCATED

The token data was too large to completely store.

See Also:

Constant Field Values

_schema

protected Schema _schema

The schema containing table and column definitions.

_wfId

protected int _wfId

The current workflow id.

_wfExecId

protected int _wfExecId

The current workflow execution id.

_maxDataSize

protected int _maxDataSize

The maximum size in the SQL table for data values.

_maxParameterValueSize

protected int _maxParameterValueSize

The maximum size in the SQL table for parameter values.

_fireStateTable

protected java.util.Map<Actor,FireState<java.lang.Integer>> _fireStateTable

A table to map actor to its firing state object.

_entityCacheTable

protected java.util.Map<Nameable,org.kepler.provenance.sql.RegEntity> _entityCacheTable

A table to cache RegEntity objects.

_psWorkflowInsert

protected java.sql.PreparedStatement _psWorkflowInsert

_psWorkflowQuery

protected java.sql.PreparedStatement _psWorkflowQuery

_psActionInsert

protected java.sql.PreparedStatement _psActionInsert

_psEntityInsert

protected java.sql.PreparedStatement _psEntityInsert

_psEntityQuery

protected java.sql.PreparedStatement _psEntityQuery

_psActorInsert

protected java.sql.PreparedStatement _psActorInsert

_psDirectorInsert

protected java.sql.PreparedStatement _psDirectorInsert

_psParameterInsert

protected java.sql.PreparedStatement _psParameterInsert

_psLinkInsert

protected java.sql.PreparedStatement _psLinkInsert

_psPortInsert

protected java.sql.PreparedStatement _psPortInsert

_psRelationInsert

protected java.sql.PreparedStatement _psRelationInsert

_psWorkflowExecStart

protected java.sql.PreparedStatement _psWorkflowExecStart

_psWorkflowExecStop

protected java.sql.PreparedStatement _psWorkflowExecStop

_psActorFireStart

protected java.sql.PreparedStatement _psActorFireStart

_psActorFireStop

protected java.sql.PreparedStatement _psActorFireStop

_psTokenFlowInsert

protected java.sql.PreparedStatement _psTokenFlowInsert

_wfNameStr

protected java.lang.String _wfNameStr

_wfUserStr

protected java.lang.String _wfUserStr

_dbParams

protected java.util.Map<java.lang.String,java.lang.String> _dbParams

The follow hold values from DatabaseFactory.Parameters. NOTE: use a LinkedHashMap for predictable iteration order.

_dbType

protected DatabaseType _dbType

Connection to the database.

SUCCESS

protected static final int SUCCESS

See Also:

Constant Field Values

WORKFLOW_ALREADY_EXISTS

protected static final int WORKFLOW_ALREADY_EXISTS

See Also:

Constant Field Values

WORKFLOW_DOES_NOT_EXIST

protected static final int WORKFLOW_DOES_NOT_EXIST

See Also:

Constant Field Values

_params

protected SQLRecordingParameters _params

The sql parameters object.

_needReconnectDB

protected boolean _needReconnectDB

True when we need to reconnect to the database.

_needReconnectWF

protected boolean _needReconnectWF

True when we need to load workflow id from database.

Constructor Detail

SQLRecording

public SQLRecording()
             throws RecordingException

Construct a new SQLRecording.

Throws:

RecordingException

Method Detail

disconnect

public void disconnect()
                throws RecordingException

Stop recording. Called when the Recording type changes or ProvenanceListener removed from canvas. NOTE: this is NOT called when the GUI exits or when the workflow runs from the command line. This is the last method called to a Recording instance.

Overrides:

disconnect 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

specificationStart

public void specificationStart()
                        throws RecordingException

Called before registering workflow contents.

Overrides:

specificationStart in class Recording

Throws:

RecordingException

executionStart

public void executionStart(java.util.Date timestamp)
                    throws RecordingException

Record the starting of workflow execution.

Overrides:

executionStart in class Recording

Throws:

RecordingException

executionStop

public void executionStop(java.util.Date timestamp)
                   throws RecordingException

Record the stopping of workflow execution.

Overrides:

executionStop in class Recording

Throws:

RecordingException

executionImported

public void executionImported()

An execution was imported.

Overrides:

executionImported in class Recording

actorFire

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

Record 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

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

_checkParameters

protected void _checkParameters()
                         throws IllegalActionException,
                                RecordingException

Check parameters before (re)connecting to database or workflow.

Throws:

IllegalActionException

RecordingException

_checkWorkflowName

protected void _checkWorkflowName()
                           throws RecordingException

Check validity of workflow name parameter.

Throws:

RecordingException

_createSchema

protected Schema _createSchema()

Create a Schema to reflect the v6 schema.

_reconnectDatabase

protected void _reconnectDatabase(boolean resetDB)
                           throws RecordingException

Reconnect to the database.

Throws:

RecordingException

_getMaxParameterValueSize

protected int _getMaxParameterValueSize()
                                 throws java.sql.SQLException

Get the maximum size of a parameter value that can be stored in the database.

Throws:

java.sql.SQLException

_getMaxTokenDataSize

protected int _getMaxTokenDataSize()
                            throws java.sql.SQLException

Get the maximum size of token data that can be stored in the database.

Throws:

java.sql.SQLException

_reconnectWorkflow

protected void _reconnectWorkflow()
                           throws RecordingException

Re-acquire the current workflow id.

Throws:

RecordingException

_createPreparedStatements

protected void _createPreparedStatements()
                                  throws java.sql.SQLException

Initialize the prepared statements.

Throws:

java.sql.SQLException

_nullPreparedStatements

protected void _nullPreparedStatements()

Set our prepared statements to null.

_updateWorkflowID

protected int _updateWorkflowID(boolean isNew)
                         throws RecordingException

Update workflow ID either by retrieving the id from an existing workflow in the database or creating a new one.

Parameters:

isNew -

Returns:

Throws:

RecordingException

_getWorkflowId

protected int _getWorkflowId()
                      throws RecordingException

Get the internal workflow id.

Throws:

RecordingException

_getWorkflowId

protected int _getWorkflowId(java.lang.String idStr)
                      throws RecordingException

Get the internal workflow id given a id string. If no workflow has the id string, returns RegEntity.UNKNOWN_ID.

Throws:

RecordingException

_dbReset

protected void _dbReset()
                 throws RecordingException

Reset when we use a different db connection.

Throws:

RecordingException

_wfReset

protected void _wfReset()

Reset when we use a different workflow.

_errorReset

protected void _errorReset()
                    throws RecordingException

Reset when we encounter an error.

Throws:

RecordingException

_checkConnection

protected void _checkConnection(boolean allowReconnectWF)
                         throws RecordingException

This method opens the database connection if necessary.

Parameters:

allowReconnectWF - - default true, only false if you want to force no _reconnectWF, e.g for non-write events like delete

Throws:

RecordingException

_changeEntityFullName

protected java.lang.String _changeEntityFullName(java.lang.String name)

Modify a NamedObj's full name.

_checkEntity

protected org.kepler.provenance.sql.RegEntity _checkEntity(Nameable namedObj,
                                                           RegEntity.EntityType type)
                                                    throws RecordingException

Check if a NamedObj has been inserted into the entity table.

Parameters:

fullName - fully qualified name of NamedObj.

displayName - display name (NOTE: can be null)

type - type of NamedObj. (NOTE: can be null)

Returns:

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.

Throws:

RecordingException

java.sql.SQLException

_addWorkflow

protected void _addWorkflow()
                     throws RecordingException

Add a new row to the workflow table.

Throws:

RecordingException

_getContainerId

protected int _getContainerId(Nameable namedObj)
                       throws RecordingException

Find the container id of an entity. If entity has no container, i.e., is the top-level object, returns 0. Otherwise if the container could not be found, returns RegEntity.UNKNOWN_ID.

Throws:

RecordingException

_regActorDirector

protected int _regActorDirector(NamedObj namedObj,
                                boolean actor)
                         throws RecordingException

Convenience routine that regActor and regDirector can use since the schema for actors and directors only differs by "actor" vs "director".

Throws:

RecordingException

_regPortReal

protected void _regPortReal(TypedIOPort port,
                            org.kepler.provenance.sql.RegEntity re)
                     throws RecordingException

Add a port to the port table.

Throws:

RecordingException

_regParameterReal

protected void _regParameterReal(NamedObj parameter,
                                 org.kepler.provenance.sql.RegEntity re)
                          throws RecordingException

Add an entity to the parameter table.

Throws:

RecordingException

_recordFiringEvent

protected void _recordFiringEvent(Actor actor,
                                  FiringEvent.FiringEventType type,
                                  java.util.Date timestamp)
                           throws RecordingException

Record a specific type of firing for an actor.

Throws:

RecordingException

_recordPortEvent

protected void _recordPortEvent(IOPort port,
                                int fireId,
                                int rwfireId,
                                boolean isRead,
                                int channel,
                                Token token,
                                IOPort destPort,
                                java.util.Date timestamp)
                         throws RecordingException

Record a port read or write to the token_flow table.

Throws:

RecordingException