org.kepler.provenance.prov

Class ProvQuery

java.lang.Object

org.kepler.provenance.DefaultQuery

org.kepler.provenance.prov.ProvQuery

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Queryable

public class ProvQuery
extends DefaultQuery

A class to query provenance in PROV serializations.

Author:

Daniel Crawl

Constructor Summary

Constructors

Constructor and Description
ProvQuery(java.io.InputStream stream, org.openprovenance.prov.interop.InteropFramework.ProvFormat format) Create a new ProvQuery from an input stream using a specific format.
ProvQuery(java.lang.String filename) Create a new ProvQuery for a PROV serialization in the specified file.

Method Summary

Modifier and Type	Method and Description
protected boolean	_stringTokenValuesHaveSurroundingQuotes() Returns false since ProvRecording saves StringToken values using StringToken.stringValue(), which does not add surrounding double-quotes.
void	disconnect() Disconnect from the underlying provenance store.
java.util.List<java.lang.Integer>	getActorFiringForToken(int tokenId, boolean read) Get the firing id(s) of the actor(s) that read or wrote a token.
java.util.List<java.lang.Integer>	getActorFirings(int execId) Get the actor firing ids for a workflow execution id.
java.lang.String	getActorName(int fireId) Get the actor name for a firing id.
java.lang.Integer	getChannelForToken(int tokenId, boolean read, java.lang.Integer fireId) Get the channel that a token was read or written on.
KeplerLSID	getExecutionLSIDForExecution(java.lang.Integer execId) Get the execution LSID for a workflow execution id.
java.util.List<java.lang.Integer>	getExecutions() Get execution ids.
java.lang.String	getInputRoleForTokenAndFireId(int tokenId, int fireId) Get the input role (port name) of a token.
java.lang.String	getMoMLForExecution(int execId) Get the MoML for an execution.
java.lang.String	getOutputRoleToken(int tokenId) Get the output role (port name) of a token.
java.util.Date	getTimestampForTokenWrite(java.lang.Integer tokenId) Get the timestamp when a token was written.
java.util.Date[]	getTimestampsForActorFiring(int fireId) Get the start and end timestamps of an actor firing.
java.util.Date[]	getTimestampsForExecution(int execId) Get the start and stop timestampes for a workflow execution id.
java.util.Date[]	getTimestampsForTokenRead(java.lang.Integer tokenId) Get the timestamp(s) when a token was read.
java.util.List<java.lang.Integer>	getTokensForExecution(int execId, java.lang.Integer portId, boolean last) Get an sequence of tokens for an execution.
java.util.List<java.lang.Integer>	getTokensForFiring(int fireId, boolean read) Get tokens for a firing.
java.lang.String	getTokenType(int tokenId) Get the type of a token.
java.lang.String	getTokenValue(int tokenId) Get the value of a token.
static void	main(java.lang.String[] args) For testing.

Methods inherited from class org.kepler.provenance.DefaultQuery

_getLastExecutionId, close, getActorFiringIds, getActorType, getAssociatedDataForExecution, getAssociatedKeysValuesForExecution, getEntityId, getEntityId, getEntityType, getEntityWorkflowId, getErrorForExecution, getExecutionForExecutionLSID, getExecutionForExecutionLSIDWithoutRevision, getExecutionForOldestReferralExecutionLSIDWithoutRevision, getExecutionIdsForTags, getExecutionLSIDs, getExecutionLSIDsForWorkflowRuns, getExecutionsForAnnotation, getExecutionsForTimespan, getExecutionsForType, getExecutionsForWorkflow, getExecutionsForWorkflowRuns, getExecutionsForWorkflowRuns, getExecutionsForWorkflowRunsAfter, getExecutionsForWorkflowRunsBefore, getExecutionTimesForActor, getHostIdForExecution, getImmediateDependencies, getIOBytesForPort, getLastExecutionForWorkflow, getLastExecutionForWorkflow, getLastExecutionLSIDForWorkflow, getLastExecutionLSIDForWorkflow, getMoMLForExecution, getMoMLForExecutionLSIDs, getParameterAndPortParameterNameValuesForFiring, getParameterNameValuesForExecution, getParameterNameValuesForFiring, getParameterNameValuesOfSpecificTypeForExecution, getParameterValueAtTime, getParameterValueLatest, getPortsForActor, getTagClassesForExecutionId, getTagsForExecutionId, getToken, getTokensForExecution, getTotalExecutionTimeForActor, getTotalIOBytesForActor, getTypeForTag, getUserForExecution, getUserForExecution, getWorkflowForExecution, getWorkflowName, getWorkflowNameForExecution, getWorkflowRunsForExecutionLSIDs, getWorkflowRunsForUser, getWorkflows, isErrorForExecution, isImportedExecution

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvQuery

public ProvQuery(java.io.InputStream stream,
                 org.openprovenance.prov.interop.InteropFramework.ProvFormat format)
          throws QueryException

Create a new ProvQuery from an input stream using a specific format. The stream is not closed by this method.

Throws:

QueryException

ProvQuery

public ProvQuery(java.lang.String filename)
          throws QueryException

Create a new ProvQuery for a PROV serialization in the specified file.

Throws:

QueryException

Method Detail

disconnect

public void disconnect()
                throws QueryException

Disconnect from the underlying provenance store. Once this method is called, no further methods may be called on this object.

Specified by:

disconnect in interface Queryable

Overrides:

disconnect in class DefaultQuery

Throws:

QueryException

getActorFirings

public java.util.List<java.lang.Integer> getActorFirings(int execId)
                                                  throws QueryException

Get the actor firing ids for a workflow execution id.

Specified by:

getActorFirings in interface Queryable

Overrides:

getActorFirings in class DefaultQuery

Throws:

QueryException

getActorFiringForToken

public java.util.List<java.lang.Integer> getActorFiringForToken(int tokenId,
                                                                boolean read)
                                                         throws QueryException

Get the firing id(s) of the actor(s) that read or wrote a token.

Specified by:

getActorFiringForToken in interface Queryable

Overrides:

getActorFiringForToken in class DefaultQuery

Parameters:

tokenId - the token id

read - If true, return the actor(s) firing id(s) that read the token. Otherwise, return the actor firing that wrote the token.

Throws:

QueryException

getActorName

public java.lang.String getActorName(int fireId)
                              throws QueryException

Get the actor name for a firing id.

Specified by:

getActorName in interface Queryable

Overrides:

getActorName in class DefaultQuery

Throws:

QueryException

getExecutionLSIDForExecution

public KeplerLSID getExecutionLSIDForExecution(java.lang.Integer execId)
                                        throws QueryException

Get the execution LSID for a workflow execution id.

Specified by:

getExecutionLSIDForExecution in interface Queryable

Overrides:

getExecutionLSIDForExecution in class DefaultQuery

Throws:

QueryException

getExecutions

public java.util.List<java.lang.Integer> getExecutions()
                                                throws QueryException

Get execution ids. For Prov, there is only one execution per file.

Specified by:

getExecutions in interface Queryable

Overrides:

getExecutions in class DefaultQuery

Throws:

QueryException

getMoMLForExecution

public java.lang.String getMoMLForExecution(int execId)
                                     throws QueryException

Get the MoML for an execution.

Specified by:

getMoMLForExecution in interface Queryable

Overrides:

getMoMLForExecution in class DefaultQuery

Throws:

QueryException

getOutputRoleToken

public java.lang.String getOutputRoleToken(int tokenId)
                                    throws QueryException

Get the output role (port name) of a token.

Specified by:

getOutputRoleToken in interface Queryable

Overrides:

getOutputRoleToken in class DefaultQuery

Throws:

QueryException

getInputRoleForTokenAndFireId

public java.lang.String getInputRoleForTokenAndFireId(int tokenId,
                                                      int fireId)
                                               throws QueryException

Get the input role (port name) of a token.

Specified by:

getInputRoleForTokenAndFireId in interface Queryable

Overrides:

getInputRoleForTokenAndFireId in class DefaultQuery

Throws:

QueryException

getTimestampsForActorFiring

public java.util.Date[] getTimestampsForActorFiring(int fireId)
                                             throws QueryException

Get the start and end timestamps of an actor firing.

Specified by:

getTimestampsForActorFiring in interface Queryable

Overrides:

getTimestampsForActorFiring in class DefaultQuery

Throws:

QueryException

getTimestampsForExecution

public java.util.Date[] getTimestampsForExecution(int execId)
                                           throws QueryException

Get the start and stop timestampes for a workflow execution id.

Specified by:

getTimestampsForExecution in interface Queryable

Overrides:

getTimestampsForExecution in class DefaultQuery

Parameters:

execId - the execution id

Returns:

a two-element array: the first entry is the start timestamp, and the second is the end timestamp. If the execution id is not found, returns null.

Throws:

QueryException

getTimestampsForTokenRead

public java.util.Date[] getTimestampsForTokenRead(java.lang.Integer tokenId)
                                           throws QueryException

Get the timestamp(s) when a token was read. If a token was never read, this can return null or an empty array.

Specified by:

getTimestampsForTokenRead in interface Queryable

Overrides:

getTimestampsForTokenRead in class DefaultQuery

Throws:

QueryException

getTimestampForTokenWrite

public java.util.Date getTimestampForTokenWrite(java.lang.Integer tokenId)
                                         throws QueryException

Get the timestamp when a token was written.

Specified by:

getTimestampForTokenWrite in interface Queryable

Overrides:

getTimestampForTokenWrite in class DefaultQuery

Throws:

QueryException

getTokensForExecution

public java.util.List<java.lang.Integer> getTokensForExecution(int execId,
                                                               java.lang.Integer portId,
                                                               boolean last)
                                                        throws QueryException

Get an sequence of tokens for an execution.

Specified by:

getTokensForExecution in interface Queryable

Overrides:

getTokensForExecution in class DefaultQuery

Parameters:

execId - the execution id

portId - the port id. If null, returns a the ids of tokens read in entire execution.

last - if true, the sequence starts at the last token created and goes backwards to the first; otherwise the sequence starts at the first.

Throws:

QueryException

getTokensForFiring

public java.util.List<java.lang.Integer> getTokensForFiring(int fireId,
                                                            boolean read)
                                                     throws QueryException

Get tokens for a firing.

Specified by:

getTokensForFiring in interface Queryable

Overrides:

getTokensForFiring in class DefaultQuery

Parameters:

fireId - the firing id

read - if true, get the tokens read; otherwise get the tokens written.

Throws:

QueryException

getTokenValue

public java.lang.String getTokenValue(int tokenId)
                               throws QueryException

Get the value of a token.

Specified by:

getTokenValue in interface Queryable

Overrides:

getTokenValue in class DefaultQuery

Throws:

QueryException

getTokenType

public java.lang.String getTokenType(int tokenId)
                              throws QueryException

Get the type of a token.

Specified by:

getTokenType in interface Queryable

Overrides:

getTokenType in class DefaultQuery

Throws:

QueryException

getChannelForToken

public java.lang.Integer getChannelForToken(int tokenId,
                                            boolean read,
                                            java.lang.Integer fireId)
                                     throws QueryException

Get the channel that a token was read or written on.

Specified by:

getChannelForToken in interface Queryable

Overrides:

getChannelForToken in class DefaultQuery

Parameters:

tokenId - the token id

read - if true, return the channel the token was read on. otherwise, return the channel the token was written on.

fireId - the actor firing id. can be null for writes, but must be specified for reads.

Returns:

the channel the token was read or written on.

Throws:

QueryException

_stringTokenValuesHaveSurroundingQuotes

protected boolean _stringTokenValuesHaveSurroundingQuotes()

Returns false since ProvRecording saves StringToken values using StringToken.stringValue(), which does not add surrounding double-quotes.

Specified by:

_stringTokenValuesHaveSurroundingQuotes in class DefaultQuery

main

public static void main(java.lang.String[] args)

For testing.