-SyncExecutor -

X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fengine%2FSyncExecutor.html;fp=website%2Ffull_javadoc%2Fcompbio%2Fengine%2FSyncExecutor.html;h=0000000000000000000000000000000000000000;hb=0bbebf27d045b1345bc042bdf24ef2e6808df251;hp=b96838fb95bf27432bbeb7557c5dabac55628b5a;hpb=5be600c3985aa7bcb8d8b51d77d773c76e6802bb;p=jabaws.git diff --git a/website/full_javadoc/compbio/engine/SyncExecutor.html b/website/full_javadoc/compbio/engine/SyncExecutor.html deleted file mode 100644 index b96838f..0000000 --- a/website/full_javadoc/compbio/engine/SyncExecutor.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - -SyncExecutor - - - - - - - - - - - - -

- - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - -

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

- -

- PREV CLASS - NEXT CLASS

- FRAMES - NO FRAMES - - - - -

- SUMMARY: NESTED | FIELD | CONSTR | METHOD

-DETAIL: FIELD | CONSTR | METHOD

- - - -

- -

- -compbio.engine -
-Interface SyncExecutor

All Known Implementing Classes:: JobRunner, LocalRunner

public interface SyncExecutor

- - -

-Synchronous executor, is an engine to run the Executable synchronously. -

- -

Author:: pvtroshin - Date October 2009

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- boolean cancelJob() - -
-          Stops running job.
- boolean cleanup() - -
-          Clean up after the job
- void executeJob() - -
-          Execute the job
- JobStatus getJobStatus() - -
-          Query the status of the job by its id.
- String getWorkDirectory() - -
-
- ConfiguredExecutable<?> waitForResult() - -
-          Call to this method block for as long as it is required for an executable to finish its job.
- -

-Method Summary
- `boolean`	`cancelJob()` - - - Stops running job.
- `boolean`	`cleanup()` - - - Clean up after the job
- `void`	`executeJob()` - - - Execute the job
- `JobStatus`	`getJobStatus()` - - - Query the status of the job by its id.
- `String`	`getWorkDirectory()` - - -
- `ConfiguredExecutable<?>`	`waitForResult()` - - - Call to this method block for as long as it is required for an executable to finish its job.

- - - - - - - - -
-Method Detail
- -

-executeJob

-void executeJob()
-                throws JobSubmissionException

Execute the job -

Throws: -: JobSubmissionException - if submission fails

- -

-cleanup

-boolean cleanup()

Clean up after the job -

Returns:: true if all the files created by this job have been removed successfully, false otherwise

- -

-waitForResult

-ConfiguredExecutable<?> waitForResult()
-                                      throws JobExecutionException

Call to this method block for as long as it is required for an executable to finish its job. - If the calculation has been completed already, the this method returns results immediately. - This could return the result directly, but that would be type unsafe -

Returns:: object from wich the result can be obtained -
Throws: -: JobExecutionException

- -

-getWorkDirectory

-String getWorkDirectory()

Returns:: working directory if the task

- -

-cancelJob

-boolean cancelJob()

Stops running job. - Clean up is not performed. -

Returns:: true if job was cancelled successfully, false otherwise

- -

-getJobStatus

-JobStatus getJobStatus()

Query the status of the job by its id. -

Returns:: - JobStatus

- -