Class AbstractCyJob

java.lang.Object
org.cytoscape.jobs.AbstractCyJob
All Implemented Interfaces:
CyJob

public class AbstractCyJob extends Object implements 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 Details

  • Constructor Details

  • Method Details

    • getJobDataService

      public CyJobDataService getJobDataService()
      Description copied from interface: CyJob
      Return the CyJobDataService that was used to create this job.
      Specified by:
      getJobDataService in interface CyJob
    • getJobExecutionService

      public CyJobExecutionService getJobExecutionService()
      Description copied from interface: CyJob
      Return the CyJobExecutionService that created this job. Most of the methods for interacting with the backend service are through the CyJobExecutionService
      Specified by:
      getJobExecutionService in interface CyJob
    • getJobName

      public String getJobName()
      Description copied from interface: CyJob
      Return the name for this job
      Specified by:
      getJobName in interface CyJob
      Returns:
      the job name
    • getPath

      public String getPath()
      Description copied from interface: CyJob
      Return the base path for communicating with the remote service for this job
      Specified by:
      getPath in interface CyJob
      Returns:
      the path
    • getJobMonitor

      public CyJobMonitor getJobMonitor()
      Description copied from interface: CyJob
      Return the service that handles status changes for this job.
      Specified by:
      getJobMonitor in interface CyJob
      Returns:
      the status change monitor for this job
    • setJobMonitor

      public void setJobMonitor(CyJobMonitor monitor)
      Description copied from interface: CyJob
      Set the service that handles status changes for this job.
      Specified by:
      setJobMonitor in interface CyJob
      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 interface CyJob
      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 interface CyJob
      Parameters:
      pollInterval - the poll interval for this job
    • getJobId

      public String 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.
      Specified by:
      getJobId in interface CyJob
      Returns:
      the job id