org.apache.flink.runtime.jobgraph

Class AbstractJobVertex

java.lang.Object

org.apache.flink.runtime.jobgraph.AbstractJobVertex

All Implemented Interfaces:

IOReadableWritable

Direct Known Subclasses:

AbstractJobInputVertex, AbstractJobOutputVertex, JobTaskVertex

public abstract class AbstractJobVertex
extends Object
implements IOReadableWritable

An abstract base class for a job vertex.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends AbstractInvokable>	invokableClass The class of the invokable.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJobVertex(String name, JobGraph jobGraph) Constructs a new job vertex and assigns it with the given name.
protected	AbstractJobVertex(String name, JobVertexID id, JobGraph jobGraph) Constructs a new job vertex and assigns it with the given name.

Method Summary

Methods

Modifier and Type	Method and Description
void	connectTo(AbstractJobVertex vertex) Connects the job vertex to the specified job vertex.
void	connectTo(AbstractJobVertex vertex, ChannelType channelType) Connects the job vertex to the specified job vertex.
void	connectTo(AbstractJobVertex vertex, ChannelType channelType, DistributionPattern distributionPattern) Connects the job vertex to the specified job vertex.
void	connectTo(AbstractJobVertex vertex, ChannelType channelType, int indexOfOutputGate, int indexOfInputGate, DistributionPattern distributionPattern) Connects the job vertex to the specified job vertex.
void	connectTo(AbstractJobVertex vertex, int indexOfOutputGate, int indexOfInputGate) Connects the job vertex to the specified job vertex.
JobEdge	getBackwardConnection(int index) Returns the backward edge with index index.
Configuration	getConfiguration() Returns the vertex's configuration object which can be used to pass custom settings to the task at runtime.
protected int	getFirstFreeInputGateIndex() Returns the index of this vertex's first free input gate.
protected int	getFirstFreeOutputGateIndex() Returns the index of this vertex's first free output gate.
JobEdge	getForwardConnection(int index) Returns the forward edge with index index.
JobVertexID	getID() Returns the ID of this job vertex.
Class<? extends AbstractInvokable>	getInvokableClass() Returns the invokable class which represents the task of this vertex
JobGraph	getJobGraph() Returns the job graph this job vertex belongs to.
String	getName() Returns the name of the vertex.
int	getNumberOfBackwardConnections() Returns the number of backward connections.
int	getNumberOfExecutionRetries() Returns the number of retries in case of an error before the task represented by this vertex is considered as failed.
int	getNumberOfForwardConnections() Returns the number of forward connections.
int	getNumberOfSubtasks() Returns the number of subtasks the task this vertex represents should be split into at runtime.
AbstractJobVertex	getVertexToShareInstancesWith() Returns the vertex this vertex should share its instance with at runtime.
void	read(DataInputView in)
void	setInvokableClass(Class<? extends AbstractInvokable> invokable)
void	setName(String name) Sets the name of the vertex.
void	setNumberOfExecutionRetries(int numberOfExecutionRetries) Sets the number of retries in case of an error before the task represented by this vertex is considered as failed.
void	setNumberOfSubtasks(int numberOfSubtasks) Sets the number of subtasks the task this vertex represents should be split into at runtime.
void	setVertexToShareInstancesWith(AbstractJobVertex vertex) Sets the vertex this vertex should share its instances with at runtime.
String	toString()
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

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

Field Detail

invokableClass

protected Class<? extends AbstractInvokable> invokableClass

The class of the invokable.

Constructor Detail

AbstractJobVertex

protected AbstractJobVertex(String name,
                 JobGraph jobGraph)

Constructs a new job vertex and assigns it with the given name.

Parameters:

name - the name of the new job vertex

jobGraph - the job graph this vertex belongs to

AbstractJobVertex

protected AbstractJobVertex(String name,
                 JobVertexID id,
                 JobGraph jobGraph)

Constructs a new job vertex and assigns it with the given name.

Parameters:

name - the name of the new job vertex

jobGraph - the job graph this vertex belongs to

Method Detail

connectTo

public void connectTo(AbstractJobVertex vertex)
               throws JobGraphDefinitionException

Connects the job vertex to the specified job vertex.

Parameters:

vertex - the vertex this vertex should connect to

Throws:

JobGraphDefinitionException - thrown if the given vertex cannot be connected to vertex in the requested manner

connectTo

public void connectTo(AbstractJobVertex vertex,
             int indexOfOutputGate,
             int indexOfInputGate)
               throws JobGraphDefinitionException

Connects the job vertex to the specified job vertex.

Parameters:

vertex - the vertex this vertex should connect to

indexOfOutputGate - index of the producing task's output gate to be used, -1 will determine the next free index number

indexOfInputGate - index of the consuming task's input gate to be used, -1 will determine the next free index number

Throws:

JobGraphDefinitionException - thrown if the given vertex cannot be connected to vertex in the requested manner

connectTo

public void connectTo(AbstractJobVertex vertex,
             ChannelType channelType)
               throws JobGraphDefinitionException

Connects the job vertex to the specified job vertex.

Parameters:

vertex - the vertex this vertex should connect to

channelType - the channel type the two vertices should be connected by at runtime

Throws:

JobGraphDefinitionException - thrown if the given vertex cannot be connected to vertex in the requested manner

connectTo

public void connectTo(AbstractJobVertex vertex,
             ChannelType channelType,
             DistributionPattern distributionPattern)
               throws JobGraphDefinitionException

Connects the job vertex to the specified job vertex.

Parameters:

vertex - the vertex this vertex should connect to

channelType - the channel type the two vertices should be connected by at runtime

distributionPattern - the distribution pattern between the two job vertices

Throws:

JobGraphDefinitionException - thrown if the given vertex cannot be connected to vertex in the requested manner

connectTo

public void connectTo(AbstractJobVertex vertex,
             ChannelType channelType,
             int indexOfOutputGate,
             int indexOfInputGate,
             DistributionPattern distributionPattern)
               throws JobGraphDefinitionException

Connects the job vertex to the specified job vertex.

Parameters:

vertex - the vertex this vertex should connect to

channelType - the channel type the two vertices should be connected by at runtime

indexOfOutputGate - index of the producing task's output gate to be used, -1 will determine the next free index number

indexOfInputGate - index of the consuming task's input gate to be used, -1 will determine the next free index number

distributionPattern - the distribution pattern between the two job vertices

Throws:

JobGraphDefinitionException - thrown if the given vertex cannot be connected to vertex in the requested manner

getFirstFreeOutputGateIndex

protected int getFirstFreeOutputGateIndex()

Returns the index of this vertex's first free output gate.

Returns:

the index of the first free output gate

getFirstFreeInputGateIndex

protected int getFirstFreeInputGateIndex()

Returns the index of this vertex's first free input gate.

Returns:

the index of the first free input gate

setName

public void setName(String name)

Sets the name of the vertex.

Parameters:

name - The name of the vertex.

getName

public String getName()

Returns the name of the vertex.

Returns:

the name of the vertex or null if no name is set.

getNumberOfForwardConnections

public int getNumberOfForwardConnections()

Returns the number of forward connections.

Returns:

the number of forward connections

getNumberOfBackwardConnections

public int getNumberOfBackwardConnections()

Returns the number of backward connections.

Returns:

the number of backward connections

getForwardConnection

public JobEdge getForwardConnection(int index)

Returns the forward edge with index index.

Parameters:

index - the index of the edge

Returns:

the forward edge or null if no edge exists at the specified index.

getBackwardConnection

public JobEdge getBackwardConnection(int index)

Returns the backward edge with index index.

Parameters:

index - the index of the edge

Returns:

the backward edge or null if no edge exists at the specified index

getID

public JobVertexID getID()

Returns the ID of this job vertex.

Returns:

the ID of this job vertex

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

getJobGraph

public JobGraph getJobGraph()

Returns the job graph this job vertex belongs to.

Returns:

the job graph this job vertex belongs to or null if no job graph has been set yet

setNumberOfSubtasks

public void setNumberOfSubtasks(int numberOfSubtasks)

Sets the number of subtasks the task this vertex represents should be split into at runtime.

Parameters:

numberOfSubtasks - the number of subtasks this vertex represents should be split into at runtime

getNumberOfSubtasks

public int getNumberOfSubtasks()

Returns the number of subtasks the task this vertex represents should be split into at runtime.

Returns:

the number of subtasks this vertex represents should be split into at runtime, -1 if unspecified

setNumberOfExecutionRetries

public void setNumberOfExecutionRetries(int numberOfExecutionRetries)

Sets the number of retries in case of an error before the task represented by this vertex is considered as failed.

Parameters:

numberOfExecutionRetries - the number of retries in case of an error before the task represented by this vertex is considered as failed

getNumberOfExecutionRetries

public int getNumberOfExecutionRetries()

Returns the number of retries in case of an error before the task represented by this vertex is considered as failed.

Returns:

the number of retries in case of an error before the task represented by this vertex is considered as failed or -1 if unspecified

setVertexToShareInstancesWith

public void setVertexToShareInstancesWith(AbstractJobVertex vertex)

Sets the vertex this vertex should share its instances with at runtime.

Parameters:

vertex - the vertex this vertex should share its instances with at runtime

getVertexToShareInstancesWith

public AbstractJobVertex getVertexToShareInstancesWith()

Returns the vertex this vertex should share its instance with at runtime.

Returns:

the vertex this vertex should share its instance with at runtime, null if undefined

getConfiguration

public Configuration getConfiguration()

Returns the vertex's configuration object which can be used to pass custom settings to the task at runtime.

Returns:

the vertex's configuration object

setInvokableClass

public void setInvokableClass(Class<? extends AbstractInvokable> invokable)

getInvokableClass

public Class<? extends AbstractInvokable> getInvokableClass()

Returns the invokable class which represents the task of this vertex

Returns:

the invokable class, null if it is not set

toString

public String toString()

Overrides:

toString in class Object