Package org.cytoscape.jobs
Class AbstractCyJob
java.lang.Object
org.cytoscape.jobs.AbstractCyJob
- All Implemented Interfaces:
CyJob
This can be used as a base class for custom implementations of
CyJob
Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
Module: jobs-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>jobs-api</artifactId> </dependency>
-
Field Summary
Modifier and TypeFieldDescriptionprotected CyJobDataService
protected CyJobExecutionService
protected String
protected CyJobMonitor
protected String
protected String
protected int
-
Constructor Summary
ConstructorDescriptionAbstractCyJob(String name, String basePath, CyJobExecutionService executionService, CyJobDataService dataService, CyJobMonitor jobMonitor)
-
Method Summary
Modifier and TypeMethodDescriptionReturn theCyJobDataService
that was used to create this job.Return theCyJobExecutionService
that created this job.getJobId()
Return the ID for this job.Return the service that handles status changes for this job.Return the name for this jobgetPath()
Return the base path for communicating with the remote service for this jobint
Return the time in seconds between calls to checkJobStatus.void
setJobMonitor(CyJobMonitor monitor)
Set the service that handles status changes for this job.void
setPollInterval(int pollInterval)
Set the time in seconds between calls to checkJobStatus.
-
Field Details
-
jobMonitor
-
pollInterval
protected int pollInterval -
dataService
-
execService
-
jobName
-
path
-
jobId
-
-
Constructor Details
-
AbstractCyJob
public AbstractCyJob(String name, String basePath, CyJobExecutionService executionService, CyJobDataService dataService, CyJobMonitor jobMonitor)
-
-
Method Details
-
getJobDataService
Description copied from interface:CyJob
Return theCyJobDataService
that was used to create this job.- Specified by:
getJobDataService
in interfaceCyJob
-
getJobExecutionService
Description copied from interface:CyJob
Return theCyJobExecutionService
that created this job. Most of the methods for interacting with the backend service are through theCyJobExecutionService
- Specified by:
getJobExecutionService
in interfaceCyJob
-
getJobName
Description copied from interface:CyJob
Return the name for this job- Specified by:
getJobName
in interfaceCyJob
- Returns:
- the job name
-
getPath
Description copied from interface:CyJob
Return the base path for communicating with the remote service for this job -
getJobMonitor
Description copied from interface:CyJob
Return the service that handles status changes for this job.- Specified by:
getJobMonitor
in interfaceCyJob
- Returns:
- the status change monitor for this job
-
setJobMonitor
Description copied from interface:CyJob
Set the service that handles status changes for this job.- Specified by:
setJobMonitor
in interfaceCyJob
- Parameters:
monitor
- the status change handler for this job
-
getPollInterval
public int getPollInterval()Description copied from interface:CyJob
Return the time in seconds between calls to checkJobStatus.- Specified by:
getPollInterval
in interfaceCyJob
- Returns:
- the poll interval for this job
-
setPollInterval
public void setPollInterval(int pollInterval)Description copied from interface:CyJob
Set the time in seconds between calls to checkJobStatus.- Specified by:
setPollInterval
in interfaceCyJob
- Parameters:
pollInterval
- the poll interval for this job
-
getJobId
Description copied from interface:CyJob
Return the ID for this job. The job ID is most often used to uniquely identify this job to a remote execution environment.
-