Package uk.ac.warwick.dcs.sherlock.engine.executor

Class BaseExecutor

java.lang.Object

uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

All Implemented Interfaces:

IExecutor, IPriorityWorkSchedulerWrapper

public class BaseExecutor
extends java.lang.Object
implements IExecutor, IPriorityWorkSchedulerWrapper

Basic executor implementation

Constructor Summary

Constructors

Constructor	Description
BaseExecutor()

Method Summary

Modifier and Type	Method	Description
boolean	cancelJob(IJob job)	Cancels the execution of a job
boolean	cancelJob(IJobStatus jobStatus)	Cancels the execution of a job
boolean	dismissJob(IJob job)	removes a finished job from the list of statuses
boolean	dismissJob(IJobStatus jobStatus)	removes a finished job from the list of statuses
java.util.List<IJobStatus>	getAllJobStatuses()	Returns a list of all active, queued or recently finished job statuses
IJob	getJob(IJobStatus jobStatus)	Gets the job from a job status
IJobStatus	getJobStatus(IJob job)	Gets the job status for a specific job
java.util.List<IJob>	getWaitingJobs()	Returns a list of queued jobs
void	invokeWork(java.util.concurrent.ForkJoinTask topAction, Priority priority)	Blocking execution of the work, returns when work is complete
void	shutdown()	shutsdown the executor
boolean	submitJob(IJob job)	submits a job to this executor
void	submitWork(PriorityWorkTask work)	Non-blocking, submit the task to the work executor

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseExecutor

public BaseExecutor()

Method Detail

getAllJobStatuses

public java.util.List<IJobStatus> getAllJobStatuses()

Description copied from interface: IExecutor

Returns a list of all active, queued or recently finished job statuses

Specified by:

getAllJobStatuses in interface IExecutor

Returns:

list of statuses

getJob

public IJob getJob(IJobStatus jobStatus)

Description copied from interface: IExecutor

Gets the job from a job status

Specified by:

getJob in interface IExecutor

Parameters:

jobStatus - job status instance

Returns:

corresponding job

getJobStatus

public IJobStatus getJobStatus(IJob job)

Description copied from interface: IExecutor

Gets the job status for a specific job

Specified by:

getJobStatus in interface IExecutor

Parameters:

job - job to get status of

Returns:

status

getWaitingJobs

public java.util.List<IJob> getWaitingJobs()

Description copied from interface: IExecutor

Returns a list of queued jobs

Specified by:

getWaitingJobs in interface IExecutor

Returns:

list of jobs

invokeWork

public void invokeWork(java.util.concurrent.ForkJoinTask topAction,
                       Priority priority)

Description copied from interface: IPriorityWorkSchedulerWrapper

Blocking execution of the work, returns when work is complete

Specified by:

invokeWork in interface IPriorityWorkSchedulerWrapper

Parameters:

topAction - top level recursive action to fork

priority - work priority level

shutdown

public void shutdown()

Description copied from interface: IExecutor

shutsdown the executor

Specified by:

shutdown in interface IExecutor

submitJob

public boolean submitJob(IJob job)

Description copied from interface: IExecutor

submits a job to this executor

Specified by:

submitJob in interface IExecutor

Parameters:

job - job to submit

Returns:

was successful?

dismissJob

public boolean dismissJob(IJobStatus jobStatus)

Description copied from interface: IExecutor

removes a finished job from the list of statuses

Specified by:

dismissJob in interface IExecutor

Parameters:

jobStatus - status of finished job to remove from list

Returns:

successful

dismissJob

public boolean dismissJob(IJob job)

Description copied from interface: IExecutor

removes a finished job from the list of statuses

Specified by:

dismissJob in interface IExecutor

Parameters:

job - job instance of finished job to remove from list

Returns:

successful

cancelJob

public boolean cancelJob(IJobStatus jobStatus)

Description copied from interface: IExecutor

Cancels the execution of a job

Specified by:

cancelJob in interface IExecutor

Parameters:

jobStatus - job status of job to cancel

Returns:

successful

cancelJob

public boolean cancelJob(IJob job)

Description copied from interface: IExecutor

Cancels the execution of a job

Specified by:

cancelJob in interface IExecutor

Parameters:

job - job instance to cancel

Returns:

successful

submitWork

public void submitWork(PriorityWorkTask work)

Description copied from interface: IPriorityWorkSchedulerWrapper

Non-blocking, submit the task to the work executor

Specified by:

submitWork in interface IPriorityWorkSchedulerWrapper

Parameters:

work - task object to execute