org.apache.flink.runtime.jobgraph.tasks

Class AbstractInvokable

java.lang.Object

org.apache.flink.runtime.jobgraph.tasks.AbstractInvokable

Direct Known Subclasses:

DataSinkTask, DataSourceTask, FakeOutputTask, IterationSynchronizationSinkTask, RegularPactTask

public abstract class AbstractInvokable
extends Object

Abstract base class for every task class in Nephele.

Constructor Summary

Constructors

Constructor and Description
AbstractInvokable()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() This method is called when a task is canceled either as a result of a user abort or an execution failure.
int	getCurrentNumberOfSubtasks() Returns the current number of subtasks the respective task is split into.
Environment	getEnvironment() Returns the environment of this task.
int	getIndexInSubtaskGroup() Returns the index of this subtask in the subtask group.
Configuration	getJobConfiguration() Returns the job configuration object which was attached to the original JobGraph.
Configuration	getTaskConfiguration() Returns the task configuration object which was attached to the original JobVertex.
abstract void	invoke() Must be overwritten by the concrete task.
abstract void	registerInputOutput() Must be overwritten by the concrete task to instantiate the required record reader and record writer.
void	setEnvironment(Environment environment) Sets the environment of this task.
void	userThreadFinished(Thread userThread) This method should be called by the user code if a custom user thread has finished.
void	userThreadStarted(Thread userThread) This method should be called by the user code if a custom user thread has been started.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInvokable

public AbstractInvokable()

Method Detail

registerInputOutput

public abstract void registerInputOutput()

Must be overwritten by the concrete task to instantiate the required record reader and record writer.

invoke

public abstract void invoke()
                     throws Exception

Must be overwritten by the concrete task. This method is called by the task manager when the actual execution of the task starts.

Throws:

Execution - thrown if any exception occurs during the execution of the tasks

Exception

setEnvironment

public final void setEnvironment(Environment environment)

Sets the environment of this task.

Parameters:

environment - the environment of this task

getEnvironment

public Environment getEnvironment()

Returns the environment of this task.

Returns:

the environment of this task or null if the environment has not yet been set

getCurrentNumberOfSubtasks

public final int getCurrentNumberOfSubtasks()

Returns the current number of subtasks the respective task is split into.

Returns:

the current number of subtasks the respective task is split into

getIndexInSubtaskGroup

public final int getIndexInSubtaskGroup()

Returns the index of this subtask in the subtask group.

Returns:

the index of this subtask in the subtask group

getTaskConfiguration

public final Configuration getTaskConfiguration()

Returns the task configuration object which was attached to the original JobVertex.

Returns:

the task configuration object which was attached to the original JobVertex

getJobConfiguration

public final Configuration getJobConfiguration()

Returns the job configuration object which was attached to the original JobGraph.

Returns:

the job configuration object which was attached to the original JobGraph

userThreadStarted

public final void userThreadStarted(Thread userThread)

This method should be called by the user code if a custom user thread has been started.

Parameters:

userThread - the user thread which has been started

userThreadFinished

public final void userThreadFinished(Thread userThread)

This method should be called by the user code if a custom user thread has finished.

Parameters:

userThread - the user thread which has finished

cancel

public void cancel()
            throws Exception

This method is called when a task is canceled either as a result of a user abort or an execution failure. It can be overwritten to respond to shut down the user code properly.

Throws:

Exception - thrown if any exception occurs during the execution of the user code