Uses of Interface
org.cytoscape.jobs.CyJob
Package
Description
This package provides a mechanism for executing remote jobs from within Cytoscape.
-
Uses of CyJob in org.cytoscape.jobs
Modifier and TypeClassDescriptionclass
This can be used as a base class for custom implementations ofCyJob
Modifier and TypeMethodDescriptionCyJobExecutionService.createCyJob(String name)
Create an empty (unsubmitted)CyJob
CyJobExecutionService.restoreJobFromSession(CySession session, File sessionFile)
This is method is called by theCyJobManager
to restore the job and reestablish the job with the remote service.Modifier and TypeMethodDescriptionCyJobManager.getJobs()
Return the list ofCyJob
s currently managed by the CyJobManager.Modifier and TypeMethodDescriptionvoid
CyJobManager.addJob(CyJob job, CyJobMonitor jobMonitor, int pollInterval)
Add a job to be managed by the job manager.void
CyJobManager.associateMonitor(CyJob job, String jobMonitorName, int pollInterval)
Associate a handler with a job.void
CyJobManager.associateMonitor(CyJob job, CyJobMonitor jobMonitor, int pollInterval)
Associate a monitor with a job.Cancel a running job.Cancel the specified jobCyJobExecutionService.checkJobStatus(CyJob job)
Check on the status of a running job.CyJobExecutionService.executeJob(CyJob job, String basePath, Map<String,Object> configuration, CyJobData inputData)
Submit aCyJob
for remote execution.CyJobExecutionService.fetchResults(CyJob job, CyJobData data)
After aCyJob
status returnsCyJobStatus.Status.FINISHED
, this method is used to fetch the results from the job execution.default void
CyJobMonitor.jobStatusChanged(CyJob job, CyJobStatus status)
This method is called whenever the status of a job changes.void
CyJobMonitor.loadData(CyJob job, TaskMonitor taskMonitor)
This method is called when when the job status transitions toFINISHED
and the user has indicated that they are ready to load the data from the task.void
Remove a job from being managed by the job manager.static CyNetwork
SUIDUtil.restoreNetwork(CyJob job, CyNetworkManager netManager, Long networkSUID, boolean clear)
This method is used to restore a saved network based on the network SUID.static Map<Long,CyIdentifiable>
SUIDUtil.restoreSUIDs(CyJob job, CyNetwork network, List<Long> oldIds, boolean clear)
Method to restore Cytoscape objects based on a list of SUIDs that were sent to the remote service as saved in the hidden table.void
CyJobExecutionService.saveJobInSession(CyJob job, File sessionFile)
This is method is called by theCyJobManager
to save sufficient information as part of the session to be able to restore and reestablish the job with the remote service.static void
SUIDUtil.saveSUIDs(CyJob job, CyNetwork network, List<? extends CyIdentifiable> objs)
This method may be used to save a list of SUIDs that have been sent to a remote service so that they may be restored later