org.kepler.workflowrunmanager

Class WorkflowRunManager

java.lang.Object

org.kepler.workflowrunmanager.WorkflowRunManager

All Implemented Interfaces:

java.util.EventListener, WorkflowRunManagerEventListener

public class WorkflowRunManager
extends java.lang.Object
implements WorkflowRunManagerEventListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkflowRunManager(ProvenanceStore provenanceStore) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addRunsLocally(java.util.List<WorkflowRun> runs) add runs to local list, and put in ObjectManager
void	addRunToSelectedRuns(KeplerLSID runLSID)
void	addWorkflowRunManagerEventListener(WorkflowRunManagerEventListener l)
void	clearSelectedRuns()
void	connect() connect to provenance store via setting queryable to new SQLQueryV8
int	deleteRuns(Recording recording, java.util.List<KeplerLSID> lsids, boolean authenticate) Delete runs in provenance and from local list.
int	deleteRunsLocally(java.util.List<KeplerLSID> execLSIDs) Delete runs from local list, CacheManager, and ObjectManager, but not from provenance.
void	disconnect()
void	dispose(WorkflowRunManagerEventListener l)
boolean	downloadRunKAR(KeplerLSID previewRunLSID, boolean authenticate) Download run KAR using the LSID of the preview run stand-in.
java.util.ArrayList<WorkflowRun>	filterRuns(java.lang.String workflowNameSearchString, java.lang.String userNameSearchString, java.lang.String startTimeSearchString, java.lang.String durationSearchString, java.lang.String execIdSearchString, java.lang.String tagSearchString) Return ArrayList of WorkflowRuns that match given filters.
void	fireWorkflowRunManagerEvent(java.lang.String eventName, KeplerLSID lsid, boolean isLastEvent)
void	fireWorkflowRunManagerEvent(java.lang.String eventName, java.util.List<KeplerLSID> lsids, boolean isLastEvent, java.lang.Object eventData)
ComponentEntity	getAssociatedWorkflowForWorkflowRun(KeplerLSID runLSID) Return the ComponenteEntity that was run to create the WorkflowRun that is identified by the given LSID.
ProvenanceRecorder	getProvenanceRecorder()
ProvenanceStore	getProvenanceStore()
Queryable	getQueryable()
WorkflowRun	getRun(KeplerLSID execLSID)
WorkflowRun	getRun(java.lang.String lsidWithoutRev)
java.util.Vector<KeplerLSID>	getSelectedRunsForSave()
WorkflowRunManagerRecording	getWorkflowRunManagerRecording()
java.util.ArrayList<WorkflowRun>	getWorkflowRuns()
java.util.Vector<WorkflowRun>	getWorkflowRunsForWorkflow(KeplerLSID workflowLSID) Return runs from the list in memory that are associated with particular workflow.
boolean	isConnected()
void	programticFilter(java.util.Map<java.lang.String,java.lang.String> columnsAndFilters) fire a programatic filter event for the benefit of any listeners.
java.util.ArrayList<WorkflowRun>	queryForAndSetRuns(java.lang.String workflowNameSearchString, java.lang.String userNameSearchString, java.lang.String startTimeSearchString, java.lang.String durationSearchString, java.lang.String execIdSearchString, java.lang.String tagSearchString, boolean authenticate)
void	removeWorkflowRunManagerEventListener(WorkflowRunManagerEventListener l)
void	setWorkflowRuns(java.util.ArrayList<WorkflowRun> runs)
boolean	usingSupportedRecordingType()
void	workflowRunManagerEventOccurred(WorkflowRunManagerEvent evt)
java.util.ArrayList<WorkflowRun>	wrmQuery(java.lang.String workflowName, java.lang.String userName, java.lang.String startTimeSearchString, java.lang.String durationSearchString, java.lang.String execIdSearchString, java.lang.String tagsSearchString) Query provenance and create and return WorkflowRuns that match given query terms.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowRunManager

protected WorkflowRunManager(ProvenanceStore provenanceStore)

Constructor.

Parameters:

provenanceStore -

Method Detail

connect

public void connect()

connect to provenance store via setting queryable to new SQLQueryV8

isConnected

public boolean isConnected()

disconnect

public void disconnect()
                throws IllegalActionException,
                       QueryException

Throws:

IllegalActionException

QueryException

usingSupportedRecordingType

public boolean usingSupportedRecordingType()

deleteRuns

public int deleteRuns(Recording recording,
                      java.util.List<KeplerLSID> lsids,
                      boolean authenticate)
               throws RecordingException,
                      AuthenticationException

Delete runs in provenance and from local list. Also if this WRM is connected to a remote store, delete runs from tracker file *if* they have been imported (not simply a preview run) then call updatePreviewRuns to put the preview run(s) back in the system. Calls fireWorkflowRunManagerEvent to notify listeners.

Parameters:

recording -

lsids -

authenticate -

Returns:

int numRowsDeleted

Throws:

RecordingException

AuthenticationException

deleteRunsLocally

public int deleteRunsLocally(java.util.List<KeplerLSID> execLSIDs)

Delete runs from local list, CacheManager, and ObjectManager, but not from provenance. Do this e.g. when removing an older version of a run, e.g. during the change of a run from running to complete.

Parameters:

execLSIDs -

Returns:

numDeleted

getRun

public WorkflowRun getRun(java.lang.String lsidWithoutRev)

getRun

public WorkflowRun getRun(KeplerLSID execLSID)

addRunsLocally

public void addRunsLocally(java.util.List<WorkflowRun> runs)

add runs to local list, and put in ObjectManager

getWorkflowRuns

public java.util.ArrayList<WorkflowRun> getWorkflowRuns()

setWorkflowRuns

public void setWorkflowRuns(java.util.ArrayList<WorkflowRun> runs)

queryForAndSetRuns

public java.util.ArrayList<WorkflowRun> queryForAndSetRuns(java.lang.String workflowNameSearchString,
                                                           java.lang.String userNameSearchString,
                                                           java.lang.String startTimeSearchString,
                                                           java.lang.String durationSearchString,
                                                           java.lang.String execIdSearchString,
                                                           java.lang.String tagSearchString,
                                                           boolean authenticate)
                                                    throws AuthenticationException

Parameters:

workflowNameSearchString -

userNameSearchString -

startTimeSearchString -

durationSearchString -

execIdSearchString -

tagSearchString -

Returns:

Throws:

AuthenticationException

programticFilter

public void programticFilter(java.util.Map<java.lang.String,java.lang.String> columnsAndFilters)

fire a programatic filter event for the benefit of any listeners.

Parameters:

columnsAndFilters -

filterRuns

public java.util.ArrayList<WorkflowRun> filterRuns(java.lang.String workflowNameSearchString,
                                                   java.lang.String userNameSearchString,
                                                   java.lang.String startTimeSearchString,
                                                   java.lang.String durationSearchString,
                                                   java.lang.String execIdSearchString,
                                                   java.lang.String tagSearchString)

Return ArrayList of WorkflowRuns that match given filters.

Parameters:

workflowNameSearchString -

userNameSearchString -

startTimeSearchString -

durationSearchString -

execIdSearchString -

tagSearchString -

Returns:

getAssociatedWorkflowForWorkflowRun

public ComponentEntity getAssociatedWorkflowForWorkflowRun(KeplerLSID runLSID)

Return the ComponenteEntity that was run to create the WorkflowRun that is identified by the given LSID. This method first checks to see if there is an existing object in the ObjectManager (which also checks the CacheManager if no object is found in the ObjectManager). If no object is found in the ObjectManager and no new object is created from the CacheManager then this method checks the provenance database for the workflow and parses a new NamedObj from the moml string stored there.

Parameters:

runLSID -

Returns:

getWorkflowRunsForWorkflow

public java.util.Vector<WorkflowRun> getWorkflowRunsForWorkflow(KeplerLSID workflowLSID)

Return runs from the list in memory that are associated with particular workflow.

Parameters:

workflowLSID -

Returns:

getQueryable

public Queryable getQueryable()

getWorkflowRunManagerRecording

public WorkflowRunManagerRecording getWorkflowRunManagerRecording()

wrmQuery

public java.util.ArrayList<WorkflowRun> wrmQuery(java.lang.String workflowName,
                                                 java.lang.String userName,
                                                 java.lang.String startTimeSearchString,
                                                 java.lang.String durationSearchString,
                                                 java.lang.String execIdSearchString,
                                                 java.lang.String tagsSearchString)

Query provenance and create and return WorkflowRuns that match given query terms. Note: this is currently no longer utilized with user-entered search terms, we're just using it to get *all* runs now.

Parameters:

workflowName -

userName -

startTimeSearchString -

durationSearchString -

execIdSearchString -

tagsSearchString -

Returns:

clearSelectedRuns

public void clearSelectedRuns()

addRunToSelectedRuns

public void addRunToSelectedRuns(KeplerLSID runLSID)

getSelectedRunsForSave

public java.util.Vector<KeplerLSID> getSelectedRunsForSave()

addWorkflowRunManagerEventListener

public void addWorkflowRunManagerEventListener(WorkflowRunManagerEventListener l)

removeWorkflowRunManagerEventListener

public void removeWorkflowRunManagerEventListener(WorkflowRunManagerEventListener l)

dispose

public void dispose(WorkflowRunManagerEventListener l)

downloadRunKAR

public boolean downloadRunKAR(KeplerLSID previewRunLSID,
                              boolean authenticate)
                       throws AuthenticationException

Download run KAR using the LSID of the preview run stand-in. Replace preview run by removing it, and then importing run KAR.

Parameters:

previewRunLSID -

Returns:

Throws:

AuthenticationException

fireWorkflowRunManagerEvent

public void fireWorkflowRunManagerEvent(java.lang.String eventName,
                                        KeplerLSID lsid,
                                        boolean isLastEvent)

fireWorkflowRunManagerEvent

public void fireWorkflowRunManagerEvent(java.lang.String eventName,
                                        java.util.List<KeplerLSID> lsids,
                                        boolean isLastEvent,
                                        java.lang.Object eventData)

workflowRunManagerEventOccurred

public void workflowRunManagerEventOccurred(WorkflowRunManagerEvent evt)

Specified by:

workflowRunManagerEventOccurred in interface WorkflowRunManagerEventListener

getProvenanceStore

public ProvenanceStore getProvenanceStore()

getProvenanceRecorder

public ProvenanceRecorder getProvenanceRecorder()