ds.granules.scheduler

Class ExecutableTask

java.lang.Object

ds.granules.scheduler.ExecutableTask

All Implemented Interfaces:

DatasetCollectionObserver, Runnable

public class ExecutableTask
extends Object
implements Runnable, DatasetCollectionObserver

This is an executable task, which manages the execution of the operation. It allows the registration of a taskLifeTimeObserver so that the observer can track the progress of the execution, and act upon it.

Author:

Shrideep Pallickara

Field Summary

Fields

Modifier and Type	Field and Description
boolean	executing

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExecutableTask(String taskIdentifier, Operation operation, TaskLifecycleObserver taskLifetimeObserver)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object anObject)
long	getExecutionInterval() For a task that needs to be executed periodically, this method is used to retrieve the interval at which the task needs to be executed periodically.
String	getIdentifier() Retrieve the identifier for the executable task
long	getInitialDelayForPeriodicTask() This method returns the time at which the periodic task will execute for the first time.
Operation	getOperation() Retrieve the operation that will be executed by this task
TaskLifecycleMetrics	getTaskLifecycleMetrics() Retrieve the TaskLifecyleMetrics associated with this task.
int	hashCode()
boolean	isExecutePeriodically() A check to see if the task in question needs to be executed periodically.
void	onDataAvailability() This method is invoked on the observers to reflect the availability of new data in the dataset collection.
void	onDatasetCollectionClosure() This method is invoked on the observers to reflect the closure of the dataset collection.
boolean	passesReadinessCheck() Checks to see if the task is ready for execution.
void	run()
void	setExecutionStatus(int executionStatus) Set the execution status for the lifecycle metrics.
void	setTaskCompletionInfo(String taskCompletionInfo) Include some information about the completion of the task.

Methods inherited from class java.lang.Object

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

Field Detail

executing

public boolean executing

Constructor Detail

ExecutableTask

protected ExecutableTask(String taskIdentifier,
              Operation operation,
              TaskLifecycleObserver taskLifetimeObserver)
                  throws ProcessingException,
                         DatasetException

Throws:

ProcessingException

DatasetException

Method Detail

getIdentifier

public String getIdentifier()

Retrieve the identifier for the executable task

Returns:

The identifier for the executable task

getTaskLifecycleMetrics

public TaskLifecycleMetrics getTaskLifecycleMetrics()

Retrieve the TaskLifecyleMetrics associated with this task.

Returns:

The lifecyle metrics for this task

setExecutionStatus

public void setExecutionStatus(int executionStatus)

Set the execution status for the lifecycle metrics.

Parameters:

executionStatus -

setTaskCompletionInfo

public void setTaskCompletionInfo(String taskCompletionInfo)

Include some information about the completion of the task. In the case of errors and aborts of executions this will include information about why a task was prematurely terminated.

Parameters:

taskCompletionInfo -

getOperation

public Operation getOperation()

Retrieve the operation that will be executed by this task

Returns:

The operation being executed

run

public void run()

Specified by:

run in interface Runnable

passesReadinessCheck

public boolean passesReadinessCheck()

Checks to see if the task is ready for execution. A check is first made to see if the operation is initialized properly. Next a check is made to see if the execution is predicated on data availability, and if it is, make sure that data is available before deciding to proceed

Returns:

true If the task is ready for execution

onDataAvailability

public void onDataAvailability()

Description copied from interface: DatasetCollectionObserver

This method is invoked on the observers to reflect the availability of new data in the dataset collection.

Specified by:

onDataAvailability in interface DatasetCollectionObserver

onDatasetCollectionClosure

public void onDatasetCollectionClosure()

Description copied from interface: DatasetCollectionObserver

This method is invoked on the observers to reflect the closure of the dataset collection.

Specified by:

onDatasetCollectionClosure in interface DatasetCollectionObserver

isExecutePeriodically

public boolean isExecutePeriodically()

A check to see if the task in question needs to be executed periodically.

Returns:

true if the task needs to be executed periodically, and false otherwise.

getExecutionInterval

public long getExecutionInterval()

For a task that needs to be executed periodically, this method is used to retrieve the interval at which the task needs to be executed periodically.

Returns:

The interval (in milliseconds) for periodic execution.

getInitialDelayForPeriodicTask

public long getInitialDelayForPeriodicTask()

This method returns the time at which the periodic task will execute for the first time.

Returns:

The delay for executing periodic task for the first time.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object anObject)

Overrides:

equals in class Object