org.kepler.provenance

Interface Queryable

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

DefaultQuery, ProvQuery, SQLQueryV8

public interface Queryable
extends java.io.Closeable

An interface for querying provenance stores.

Author:

Ilkay Altintas, Derik Barseghian, Daniel Crawl

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnect from 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>	getActorFiringIds(java.lang.String actorName, java.lang.Integer wfExecId) Get actor fire ids based on its full name and workflow exec ID.
java.util.List<java.lang.Integer>	getActorFirings(int wfExecId) Get all actor fire ids for a workflow exec ID.
java.lang.String	getActorName(int fireId) Get an actor's name for a firing id.
java.lang.String	getActorType(int fireId) Get an actor's type for a firing id.
java.util.List<byte[]>	getAssociatedDataForExecution(int execId, java.util.Map<java.lang.String,java.lang.String> metadataMap, boolean matchAny) Get a file associated with an execution.
java.util.Map<java.lang.String,java.lang.String>	getAssociatedKeysValuesForExecution(int execId) Get any associated keys-values for an execution.
java.lang.Integer	getChannelForToken(int tokenId, boolean read, java.lang.Integer fireId) Get the channel that a token was read or written on.
java.lang.Integer	getEntityId(java.lang.String entityName, KeplerLSID lsid) Get the id of entity.
java.lang.Integer	getEntityId(java.lang.String entityName, java.lang.String workflowName) Get the id of entity.
java.lang.String	getEntityType(java.lang.Integer entityId) Get the type of entity.
java.lang.Integer	getEntityWorkflowId(java.lang.Integer entityId) Get the workflow id of entity.
java.lang.String	getErrorForExecution(KeplerLSID lsid) Get the error for an execution.
java.lang.Integer	getExecutionForExecutionLSID(KeplerLSID runLSID) Get the execution for a specific run LSID.
java.lang.Integer	getExecutionForExecutionLSIDWithoutRevision(java.lang.String execLSIDWithoutRevision) Get execution id for an execution LSID without revision.
java.lang.Integer	getExecutionForOldestReferralExecutionLSIDWithoutRevision(java.lang.String stringWithoutRevision) Get execution id for execution that has the given LSID as its oldest referral.
java.util.List<java.lang.Integer>	getExecutionIdsForTags(java.lang.String tagsSearchString) Get execution ids for %tagsSearchString% (case insensitive)
KeplerLSID	getExecutionLSIDForExecution(java.lang.Integer execId) Get the execution LSID for a specific execution id.
java.util.List<KeplerLSID>	getExecutionLSIDs() Get a list of all execution LSIDs.
java.util.List<KeplerLSID>	getExecutionLSIDsForWorkflowRuns(java.lang.String workflowName, java.lang.String userName, java.util.Date after, java.util.Date before, int execIdAfter, int execIdBefore)
java.util.List<java.lang.Integer>	getExecutions() Get a list of all executions.
java.util.List<java.lang.Integer>	getExecutionsForAnnotation(java.lang.String annotation) Get a list of executions for a specific execution annotation.
java.util.List<java.lang.Integer>	getExecutionsForTimespan(java.util.Date start, java.util.Date end) Get executions within a timespan.
java.util.List<KeplerLSID>	getExecutionsForType(WorkflowRun.type type) Get a list of executions corresponding to a specific type.
java.util.List<java.lang.Integer>	getExecutionsForWorkflow(java.lang.String workflow) Get a list of executions for a specific workflow.
java.util.List<java.lang.Integer>	getExecutionsForWorkflowRuns(java.lang.String workflowName, java.lang.String userName) Get executions that have %workflowName% and %userName%.
java.util.List<java.lang.Integer>	getExecutionsForWorkflowRuns(java.lang.String workflowName, java.lang.String userName, java.util.Date after, java.util.Date before, int execIdAfter, int execIdBefore) Get executions that have %workflowName% and %userName%. and startTime >= after and startTime <= before.
java.util.List<java.lang.Integer>	getExecutionsForWorkflowRunsAfter(java.lang.String workflowName, java.lang.String userName, java.util.Date after) Get executions that have %workflowName% and %userName%. and startTime > after.
java.util.List<java.lang.Integer>	getExecutionsForWorkflowRunsBefore(java.lang.String workflowName, java.lang.String userName, java.util.Date before) Get exections that have %workflowName% and %userName%, and startTime < before.
java.util.Map<java.lang.String,java.lang.Long>	getExecutionTimesForActor(KeplerLSID workflow, KeplerLSID execLSID, java.lang.String actor) Get the execution times for an actor.
java.lang.String	getHostIdForExecution(java.lang.Integer execId) Get the host id for a specific execution id.
java.util.List<java.lang.Integer>	getImmediateDependencies(int tokenId) Get the token(s) that generated a token.
java.lang.String	getInputRoleForTokenAndFireId(int tokenId, int fireId) Get the input role (port name) of a token.
java.util.Map<java.lang.Integer,java.lang.Integer>	getIOBytesForPort(KeplerLSID workflow, java.lang.Integer execId, java.lang.String port, boolean read) Get the number of bytes read or written by a port.
java.lang.Integer	getLastExecutionForWorkflow(KeplerLSID lsid) Get the last execution for a workflow.
java.lang.Integer	getLastExecutionForWorkflow(java.lang.String workflow) Get the last execution for a workflow.
KeplerLSID	getLastExecutionLSIDForWorkflow(KeplerLSID lsid) Get the last execution LSID for a workflow.
KeplerLSID	getLastExecutionLSIDForWorkflow(java.lang.String workflow) Get the last execution LSID for a workflow.
java.lang.String	getMoMLForExecution(int execId) Get workflow MoML for an execution.
java.lang.String	getMoMLForExecution(KeplerLSID lsid) Get workflow MoML for an execution LSID
java.util.List<java.lang.String>	getMoMLForExecutionLSIDs(java.util.List<KeplerLSID> lsids) Get workflow MoMLs for a list of execution lsids.
java.lang.String	getOutputRoleToken(int tokenId) Get the output role (port name) of a token.
java.util.Map<java.lang.String,java.lang.String>	getParameterAndPortParameterNameValuesForFiring(int fireId) Get an actor's parameter and port parameter name value pairs for a firing id.
java.util.Map<java.lang.String,java.lang.String>	getParameterNameValuesForExecution(int execId) Get the parameter name value pairs for an execution.
java.util.Map<java.lang.String,java.lang.String>	getParameterNameValuesForFiring(int fireId) Get an actor's parameter name value pairs for a firing id.
java.util.Map<java.lang.String,java.lang.String>	getParameterNameValuesOfSpecificTypeForExecution(int execId) Get the parameter name value pairs for an execution, whose parameter type is either '.Parameter' or '.StringParameter'
java.lang.String	getParameterValueAtTime(java.util.Date timestamp, java.lang.String parameter, KeplerLSID lsid) Get the value of a parameter at a specific time.
java.lang.String	getParameterValueLatest(java.lang.String parameter, KeplerLSID lsid) Get the latest value of a parameter.
java.util.List<java.lang.String>	getPortsForActor(KeplerLSID workflow, java.lang.String actor) Get the ports for an actor.
java.util.Map<NamedOntClass,java.lang.String>	getTagClassesForExecutionId(int execId) Get a map of tags and their types (context, or tagee, currently "run" or "workflow") for an executionLSID
java.util.List<java.lang.String>	getTagsForExecutionId(int execId) Get tags for an execution LSID
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 end timestamps of an execution.
java.util.Date[]	getTimestampsForTokenRead(java.lang.Integer tokenId) Get the timestamp(s) when a token was read.
Token	getToken(int tokenId) Get the Token.
java.util.List<java.lang.Integer>	getTokensForExecution(int execId, boolean last) Get an sequence of tokens for an execution.
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.
long	getTotalExecutionTimeForActor(KeplerLSID workflow, KeplerLSID execLSID, java.lang.String actor) Get the total execution time for an actor.
java.lang.Integer	getTotalIOBytesForActor(KeplerLSID workflow, java.lang.Integer execId, java.lang.String actor, boolean read) Get the total number of bytes read or or written by an actor over all its ports.
java.lang.String	getTypeForTag(java.lang.String conceptId) Get the type of a tag, null if none
java.lang.String	getUserForExecution(java.lang.Integer execId) Get the user for a specific execution id.
java.lang.String	getUserForExecution(KeplerLSID execLSID) Get the user for a specific execution LSID.
NamedObj	getWorkflowForExecution(java.lang.Integer execId) Get the workflow object for a execution id.
java.lang.String	getWorkflowName(KeplerLSID lsid) Get a workflow name.
java.lang.String	getWorkflowNameForExecution(KeplerLSID lsid) Get a workflow name for an execution LSID.
java.util.Map<KeplerLSID,WorkflowRun>	getWorkflowRunsForExecutionLSIDs(java.util.List<KeplerLSID> executions) Get "workflow runs" for a list of execution LSIDs.
java.util.List<WorkflowRun>	getWorkflowRunsForUser(java.lang.String user) Get workflow runs for a user.
java.util.List<java.lang.String>	getWorkflows() Get a list of workflow names.
boolean	isErrorForExecution(KeplerLSID executionLSID) Returns true if the execution had an error.
boolean	isImportedExecution(KeplerLSID executionLSID) See if an execution appears to be imported.

Methods inherited from interface java.io.Closeable

close

Method Detail

disconnect

void disconnect()
         throws QueryException

Disconnect from provenance store.

Throws:

QueryException

getWorkflows

java.util.List<java.lang.String> getWorkflows()
                                       throws QueryException

Get a list of workflow names.

Throws:

QueryException

getWorkflowName

java.lang.String getWorkflowName(KeplerLSID lsid)
                          throws QueryException

Get a workflow name.

Parameters:

lsid - the workflow's LSID.

Returns:

the workflow name if found, otherwise null.

Throws:

QueryException

getWorkflowNameForExecution

java.lang.String getWorkflowNameForExecution(KeplerLSID lsid)
                                      throws QueryException

Get a workflow name for an execution LSID.

Parameters:

lsid - the execution LSID.

Returns:

the workflow name if found, otherwise null.

Throws:

QueryException

getExecutions

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

Get a list of all executions.

Throws:

QueryException

getExecutionLSIDs

java.util.List<KeplerLSID> getExecutionLSIDs()
                                      throws QueryException

Get a list of all execution LSIDs.

Throws:

QueryException

getExecutionsForWorkflow

java.util.List<java.lang.Integer> getExecutionsForWorkflow(java.lang.String workflow)
                                                    throws QueryException

Get a list of executions for a specific workflow.

Throws:

QueryException

getExecutionForExecutionLSID

java.lang.Integer getExecutionForExecutionLSID(KeplerLSID runLSID)
                                        throws QueryException

Get the execution for a specific run LSID. If no execution exists, returns null.

Throws:

QueryException

getExecutionLSIDForExecution

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

Get the execution LSID for a specific execution id. If no execution exists, returns null.

Throws:

QueryException

getExecutionsForAnnotation

java.util.List<java.lang.Integer> getExecutionsForAnnotation(java.lang.String annotation)
                                                      throws QueryException

Get a list of executions for a specific execution annotation.

Throws:

QueryException

getTimestampsForExecution

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

Get the start and end timestamps of an execution.

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

getMoMLForExecution

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

Get workflow MoML for an execution.

Throws:

QueryException

getMoMLForExecution

java.lang.String getMoMLForExecution(KeplerLSID lsid)
                              throws QueryException

Get workflow MoML for an execution LSID

Throws:

QueryException

getMoMLForExecutionLSIDs

java.util.List<java.lang.String> getMoMLForExecutionLSIDs(java.util.List<KeplerLSID> lsids)
                                                   throws QueryException

Get workflow MoMLs for a list of execution lsids. Only returns one copy of any duplicates.

Throws:

QueryException

getWorkflowForExecution

NamedObj getWorkflowForExecution(java.lang.Integer execId)
                          throws QueryException

Get the workflow object for a execution id.

Throws:

QueryException

getExecutionsForTimespan

java.util.List<java.lang.Integer> getExecutionsForTimespan(java.util.Date start,
                                                           java.util.Date end)
                                                    throws QueryException

Get executions within a timespan.

Throws:

QueryException

getExecutionsForWorkflowRuns

java.util.List<java.lang.Integer> getExecutionsForWorkflowRuns(java.lang.String workflowName,
                                                               java.lang.String userName)
                                                        throws QueryException

Get executions that have %workflowName% and %userName%.

Throws:

QueryException

getExecutionsForWorkflowRunsAfter

java.util.List<java.lang.Integer> getExecutionsForWorkflowRunsAfter(java.lang.String workflowName,
                                                                    java.lang.String userName,
                                                                    java.util.Date after)
                                                             throws QueryException

Get executions that have %workflowName% and %userName%. and startTime > after.

Throws:

QueryException

getExecutionsForWorkflowRuns

java.util.List<java.lang.Integer> getExecutionsForWorkflowRuns(java.lang.String workflowName,
                                                               java.lang.String userName,
                                                               java.util.Date after,
                                                               java.util.Date before,
                                                               int execIdAfter,
                                                               int execIdBefore)
                                                        throws QueryException

Get executions that have %workflowName% and %userName%. and startTime >= after and startTime <= before.

Throws:

QueryException

getExecutionLSIDsForWorkflowRuns

java.util.List<KeplerLSID> getExecutionLSIDsForWorkflowRuns(java.lang.String workflowName,
                                                            java.lang.String userName,
                                                            java.util.Date after,
                                                            java.util.Date before,
                                                            int execIdAfter,
                                                            int execIdBefore)
                                                     throws QueryException

Throws:

QueryException

getExecutionsForWorkflowRunsBefore

java.util.List<java.lang.Integer> getExecutionsForWorkflowRunsBefore(java.lang.String workflowName,
                                                                     java.lang.String userName,
                                                                     java.util.Date before)
                                                              throws QueryException

Get exections that have %workflowName% and %userName%, and startTime < before.

Throws:

QueryException

getLastExecutionForWorkflow

java.lang.Integer getLastExecutionForWorkflow(KeplerLSID lsid)
                                       throws QueryException

Get the last execution for a workflow. NOTE: the LSID revision is ignored.

Parameters:

lsid - the workflow lsid.

Returns:

if workflow has been executed, the last execution id. otherwise, returns null.

Throws:

QueryException

getLastExecutionForWorkflow

java.lang.Integer getLastExecutionForWorkflow(java.lang.String workflow)
                                       throws QueryException

Get the last execution for a workflow.

Parameters:

workflow - the workflow name

Returns:

if workflow has been executed, the last execution id. otherwise, returns null.

Throws:

QueryException

getLastExecutionLSIDForWorkflow

KeplerLSID getLastExecutionLSIDForWorkflow(java.lang.String workflow)
                                    throws QueryException

Get the last execution LSID for a workflow.

Parameters:

workflow - the workflow name.

Returns:

execution lsid

Throws:

QueryException

getLastExecutionLSIDForWorkflow

KeplerLSID getLastExecutionLSIDForWorkflow(KeplerLSID lsid)
                                    throws QueryException

Get the last execution LSID for a workflow.

Parameters:

lsid - the workflow LSID.

Returns:

execution lsid

Throws:

QueryException

getErrorForExecution

java.lang.String getErrorForExecution(KeplerLSID lsid)
                               throws QueryException

Get the error for an execution. Returns null if no error message was found. NOTE: returning null is not an indication if the execution had an error.

Parameters:

lsid - the workflow execution lsid.

Throws:

QueryException

See Also:

isErrorForExecution

isErrorForExecution

boolean isErrorForExecution(KeplerLSID executionLSID)
                     throws QueryException

Returns true if the execution had an error.

Throws:

QueryException

getTokensForExecution

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

Get an sequence of tokens for an execution.

Parameters:

execId - the execution id

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

Throws:

QueryException

getTokensForExecution

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.

Parameters:

execId - the execution id

portId - the port id. If null, returns 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

getActorFiringForToken

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.

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

getTokensForFiring

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

Get tokens for a firing.

Parameters:

fireId - the firing id

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

Throws:

QueryException

getToken

Token getToken(int tokenId)
        throws QueryException

Get the Token.

Throws:

QueryException

getTokenValue

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

Get the value of a token.

Throws:

QueryException

getTokenType

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

Get the type of a token.

Throws:

QueryException

getChannelForToken

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.

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

getActorName

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

Get an actor's name for a firing id.

Throws:

QueryException

getActorType

java.lang.String getActorType(int fireId)
                       throws QueryException

Get an actor's type for a firing id.

Throws:

QueryException

getEntityId

java.lang.Integer getEntityId(java.lang.String entityName,
                              KeplerLSID lsid)
                       throws QueryException

Get the id of entity. If entity is not found, returns null.

Parameters:

entityName - name of entity.

lsid - the workflow LSID. NOTE: the revision is ignored.

Throws:

QueryException

getEntityId

java.lang.Integer getEntityId(java.lang.String entityName,
                              java.lang.String workflowName)
                       throws QueryException

Get the id of entity. If workflow or entity is not found, returns null.

Parameters:

entityName - the name of the entity.

workflowName - the name of the workflow.

Throws:

QueryException

getEntityType

java.lang.String getEntityType(java.lang.Integer entityId)
                        throws QueryException

Get the type of entity.

Throws:

QueryException

getEntityWorkflowId

java.lang.Integer getEntityWorkflowId(java.lang.Integer entityId)
                               throws QueryException

Get the workflow id of entity.

Throws:

QueryException

getParameterNameValuesForFiring

java.util.Map<java.lang.String,java.lang.String> getParameterNameValuesForFiring(int fireId)
                                                                          throws QueryException

Get an actor's parameter name value pairs for a firing id. NOTE: Parameter values may change during a firing; this method returns the values at the start of the firing.

Throws:

QueryException

getParameterNameValuesForExecution

java.util.Map<java.lang.String,java.lang.String> getParameterNameValuesForExecution(int execId)
                                                                             throws QueryException

Get the parameter name value pairs for an execution. NOTE: Parameter values may change during an execution; this method returns the values at the start of the execution.

Throws:

QueryException

getParameterValueLatest

java.lang.String getParameterValueLatest(java.lang.String parameter,
                                         KeplerLSID lsid)
                                  throws QueryException

Get the latest value of a parameter.

Parameters:

parameter - the parameter name.

lsid - the workflow lsid

Returns:

the latest value of the parameter. If the workflow LSID or parameter name cannot be found, returns null.

Throws:

QueryException

getParameterValueAtTime

java.lang.String getParameterValueAtTime(java.util.Date timestamp,
                                         java.lang.String parameter,
                                         KeplerLSID lsid)
                                  throws QueryException

Get the value of a parameter at a specific time.

Parameters:

timestamp - the time

parameter - the parameter name

lsid - the workflow lsid

Returns:

the value of the parameter at the specified time. If the workflow LSID or parameter name cannot be found, returns null.

Throws:

QueryException

getImmediateDependencies

java.util.List<java.lang.Integer> getImmediateDependencies(int tokenId)
                                                    throws QueryException

Get the token(s) that generated a token.

Throws:

QueryException

getAssociatedDataForExecution

java.util.List<byte[]> getAssociatedDataForExecution(int execId,
                                                     java.util.Map<java.lang.String,java.lang.String> metadataMap,
                                                     boolean matchAny)
                                              throws QueryException

Get a file associated with an execution.

Throws:

QueryException

getAssociatedKeysValuesForExecution

java.util.Map<java.lang.String,java.lang.String> getAssociatedKeysValuesForExecution(int execId)
                                                                              throws QueryException

Get any associated keys-values for an execution.

Throws:

QueryException

getWorkflowRunsForExecutionLSIDs

java.util.Map<KeplerLSID,WorkflowRun> getWorkflowRunsForExecutionLSIDs(java.util.List<KeplerLSID> executions)
                                                                throws QueryException

Get "workflow runs" for a list of execution LSIDs. A 'workflow run' is a group of useful information related to an execution.

Throws:

QueryException

getWorkflowRunsForUser

java.util.List<WorkflowRun> getWorkflowRunsForUser(java.lang.String user)
                                            throws QueryException

Get workflow runs for a user.

Throws:

QueryException

getExecutionIdsForTags

java.util.List<java.lang.Integer> getExecutionIdsForTags(java.lang.String tagsSearchString)
                                                  throws QueryException

Get execution ids for %tagsSearchString% (case insensitive)

Throws:

QueryException

getTagsForExecutionId

java.util.List<java.lang.String> getTagsForExecutionId(int execId)
                                                throws QueryException

Get tags for an execution LSID

Throws:

QueryException

getTypeForTag

java.lang.String getTypeForTag(java.lang.String conceptId)

Get the type of a tag, null if none

getTagClassesForExecutionId

java.util.Map<NamedOntClass,java.lang.String> getTagClassesForExecutionId(int execId)
                                                                   throws QueryException

Get a map of tags and their types (context, or tagee, currently "run" or "workflow") for an executionLSID

Throws:

QueryException

getExecutionForExecutionLSIDWithoutRevision

java.lang.Integer getExecutionForExecutionLSIDWithoutRevision(java.lang.String execLSIDWithoutRevision)
                                                       throws QueryException

Get execution id for an execution LSID without revision.

Throws:

QueryException

getExecutionForOldestReferralExecutionLSIDWithoutRevision

java.lang.Integer getExecutionForOldestReferralExecutionLSIDWithoutRevision(java.lang.String stringWithoutRevision)
                                                                     throws QueryException

Get execution id for execution that has the given LSID as its oldest referral.

Throws:

QueryException

getExecutionsForType

java.util.List<KeplerLSID> getExecutionsForType(WorkflowRun.type type)
                                         throws QueryException

Get a list of executions corresponding to a specific type.

Throws:

QueryException

isImportedExecution

boolean isImportedExecution(KeplerLSID executionLSID)
                     throws QueryException

See if an execution appears to be imported.

Throws:

QueryException

getPortsForActor

java.util.List<java.lang.String> getPortsForActor(KeplerLSID workflow,
                                                  java.lang.String actor)
                                           throws QueryException

Get the ports for an actor.

Parameters:

workflow - the LSID of the workflow

actor - the fully-qualified name of the actor

Returns:

a list of fully-qualified names of ports of the actor

Throws:

QueryException

getUserForExecution

java.lang.String getUserForExecution(KeplerLSID execLSID)
                              throws QueryException

Get the user for a specific execution LSID.

Throws:

QueryException

getUserForExecution

java.lang.String getUserForExecution(java.lang.Integer execId)
                              throws QueryException

Get the user for a specific execution id.

Throws:

QueryException

getHostIdForExecution

java.lang.String getHostIdForExecution(java.lang.Integer execId)
                                throws QueryException

Get the host id for a specific execution id.

Throws:

QueryException

getOutputRoleToken

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

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

Throws:

QueryException

getInputRoleForTokenAndFireId

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

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

Throws:

QueryException

getParameterNameValuesOfSpecificTypeForExecution

java.util.Map<java.lang.String,java.lang.String> getParameterNameValuesOfSpecificTypeForExecution(int execId)
                                                                                           throws QueryException

Get the parameter name value pairs for an execution, whose parameter type is either '.Parameter' or '.StringParameter'

Throws:

QueryException

getTimestampsForActorFiring

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

Get the start and end timestamps of an actor firing.

Throws:

QueryException

getActorFiringIds

java.util.List<java.lang.Integer> getActorFiringIds(java.lang.String actorName,
                                                    java.lang.Integer wfExecId)
                                             throws QueryException

Get actor fire ids based on its full name and workflow exec ID.

Throws:

QueryException

getParameterAndPortParameterNameValuesForFiring

java.util.Map<java.lang.String,java.lang.String> getParameterAndPortParameterNameValuesForFiring(int fireId)
                                                                                          throws QueryException

Get an actor's parameter and port parameter name value pairs for a firing id. NOTE: Parameter values may change during a firing; this method returns the values at the start of the firing.

Throws:

QueryException

getActorFirings

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

Get all actor fire ids for a workflow exec ID.

Throws:

QueryException

getTimestampsForTokenRead

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.

Throws:

QueryException

getTimestampForTokenWrite

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

Get the timestamp when a token was written.

Throws:

QueryException

getTotalExecutionTimeForActor

long getTotalExecutionTimeForActor(KeplerLSID workflow,
                                   KeplerLSID execLSID,
                                   java.lang.String actor)
                            throws QueryException

Get the total execution time for an actor.

Parameters:

workflow - the workflow LSID. If null, must specify execution id.

execLSID - the execution id. If null, use the last execution of the workflow.

actor - the full actor name.

Returns:

the total time execution time of the actor, in milliseconds.

Throws:

QueryException

getExecutionTimesForActor

java.util.Map<java.lang.String,java.lang.Long> getExecutionTimesForActor(KeplerLSID workflow,
                                                                         KeplerLSID execLSID,
                                                                         java.lang.String actor)
                                                                  throws QueryException

Get the execution times for an actor.

Parameters:

workflow - the workflow LSID. If null, must specify execution id.

execLSID - the execution LSID. If null, the last execution of the workflow is used.

actor - the full actor name.

Returns:

a map of actor fire id to execution time pairs. if a firing does not have a valid start or stop time, the firing is not included in the result.

Throws:

QueryException

getTotalIOBytesForActor

java.lang.Integer getTotalIOBytesForActor(KeplerLSID workflow,
                                          java.lang.Integer execId,
                                          java.lang.String actor,
                                          boolean read)
                                   throws QueryException

Get the total number of bytes read or or written by an actor over all its ports.

Parameters:

workflow - the workflow LSID. If null, specify the execution id.

execId - the execution id. If null, the last execution of the workflow is used.

actor - the full actor name.

read - If true, get the bytes read. Otherwise, get the bytes written.

Throws:

QueryException

getIOBytesForPort

java.util.Map<java.lang.Integer,java.lang.Integer> getIOBytesForPort(KeplerLSID workflow,
                                                                     java.lang.Integer execId,
                                                                     java.lang.String port,
                                                                     boolean read)
                                                              throws QueryException

Get the number of bytes read or written by a port.

Parameters:

workflow - the workflow LSID. If null, must specify execution id.

execId - the execution id. If null, the last execution of the workflow is used.

port - the full port name.

read - If true, get the bytes read. Otherwise, get the bytes written.

Returns:

a map of port event id to bytes read/written.

Throws:

QueryException