org.ensembl.hive.Job Class Reference

Public Member Functions
	Job (Map< String, Object > jobParams)
	Job (ParamContainer parameters, int retryCount, int dbID, String inputId)
int	getDbID ()
String	getInputId ()
ParamContainer	getParameters ()
int	getRetryCount ()
boolean	isAutoflow ()
void	setAutoflow (boolean autoflow)
boolean	isLethalForWorker ()
void	setLethalForWorker (boolean lethalForWorker)
boolean	isTransientError ()
void	setTransientError (boolean transientError)
String	toString ()
boolean	isComplete ()
void	setComplete (boolean complete)
Object	paramRequired (String paramName)

Detailed Description

Bean wrapping information about a job

Author

dstaines

Definition at line 34 of file Job.java.

Constructor & Destructor Documentation

Job() [1/2]

org.ensembl.hive.Job.Job ( Map< String, Object >  jobParams )

inline

Definition at line 58 of file Job.java.

Job() [2/2]

org.ensembl.hive.Job.Job ( ParamContainer  parameters, int  retryCount, int  dbID, String  inputId  )

inline

Definition at line 69 of file Job.java.

Member Function Documentation

getDbID()

int org.ensembl.hive.Job.getDbID ( )

inline

Definition at line 78 of file Job.java.

Here is the caller graph for this function:

getInputId()

String org.ensembl.hive.Job.getInputId ( )

inline

Definition at line 82 of file Job.java.

getParameters()

ParamContainer org.ensembl.hive.Job.getParameters ( )

inline

Definition at line 86 of file Job.java.

Here is the caller graph for this function:

getRetryCount()

int org.ensembl.hive.Job.getRetryCount ( )

inline

Definition at line 90 of file Job.java.

Here is the caller graph for this function:

isAutoflow()

boolean org.ensembl.hive.Job.isAutoflow ( )

inline

Definition at line 94 of file Job.java.

Here is the caller graph for this function:

isComplete()

boolean org.ensembl.hive.Job.isComplete ( )

inline

Definition at line 126 of file Job.java.

Here is the caller graph for this function:

isLethalForWorker()

boolean org.ensembl.hive.Job.isLethalForWorker ( )

inline

Definition at line 102 of file Job.java.

Here is the caller graph for this function:

isTransientError()

boolean org.ensembl.hive.Job.isTransientError ( )

inline

Definition at line 110 of file Job.java.

Here is the caller graph for this function:

paramRequired()

Object org.ensembl.hive.Job.paramRequired ( String  paramName )

inline

Returns the value of the parameter "param_name" or raises an exception if anything wrong happens. The exception is marked as non-transient.

Parameters

paramName

The name of the parameter

Returns

The value of the parameter

Definition at line 141 of file Job.java.

Here is the call graph for this function:

Here is the caller graph for this function:

setAutoflow()

void org.ensembl.hive.Job.setAutoflow ( boolean  autoflow )

inline

Definition at line 98 of file Job.java.

setComplete()

void org.ensembl.hive.Job.setComplete ( boolean  complete )

inline

Definition at line 130 of file Job.java.

Here is the caller graph for this function:

setLethalForWorker()

void org.ensembl.hive.Job.setLethalForWorker ( boolean  lethalForWorker )

inline

Definition at line 106 of file Job.java.

setTransientError()

void org.ensembl.hive.Job.setTransientError ( boolean  transientError )

inline

Definition at line 114 of file Job.java.

Here is the caller graph for this function:

toString()

String org.ensembl.hive.Job.toString ( )

inline

Definition at line 118 of file Job.java.

---

The documentation for this class was generated from the following file:

• src/main/java/org/ensembl/hive/Job.java