public interface CyJobMonitor
Apps are expected to implement this interface to receive notifications about job completions. To be informed about the status of a particular job, CyJobMonitors should be registered as services so that jobs can be reassociated with their handlers on session restore. Note that classes should implement the
method. This method will
be called by the
CyJobManager when a job transitions to status
FINISHED and the user has indicated that they
are ready to load the data. This will be done as part of a
to avoid potential synchronization issues.
Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>jobs-api</artifactId> </dependency>
Method SummaryModifier and TypeMethodDescription
default voidThis method is called whenever the status of a job changes.
voidThis method is called when when the job status transitions to
FINISHEDand the user has indicated that they are ready to load the data from the task.
jobStatusChangedThis method is called whenever the status of a job changes.
loadDataThis method is called when when the job status transitions to
FINISHEDand the user has indicated that they are ready to load the data from the task. Typically, this will result in the
fetchResultsmethod being called, but if the data package is large, implementers might want to call
fetchResultsin a separate thread spawned from
jobStatusChanged, then when the user indicates they are ready to process the data, the call to loadData can merge the resulting data into Cytoscape.