org.apache.flink.runtime.managementgraph

Class ManagementVertex

java.lang.Object

org.apache.flink.runtime.managementgraph.ManagementAttachment

org.apache.flink.runtime.managementgraph.ManagementVertex

All Implemented Interfaces:

IOReadableWritable

public final class ManagementVertex
extends ManagementAttachment
implements IOReadableWritable

This class implements a management vertex of a ManagementGraph. A management vertex is derived from the type of vertices Nephele uses in its internal scheduling structures.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ManagementVertex(ManagementGroupVertex groupVertex, ManagementVertexID id, String instanceName, int indexInGroup) Constructs a new management vertex.

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionState	getExecutionState() Returns the current execution state of this management vertex.
ManagementGraph	getGraph() The management graph this management vertex belongs to.
ManagementGroupVertex	getGroupVertex() Returns the group vertex this management vertex belongs to.
ManagementVertexID	getID() Returns the ID of this management vertex.
int	getIndexInGroup() Returns the index at which this vertex is stored inside its corresponding group vertex.
ManagementGate	getInputGate(int index) Returns the input gate at the given index.
String	getInstanceName() Returns the name of the instance the vertex represented by this management vertex currently runs on.
String	getName() Returns the name of this management vertex.
int	getNumberOfInputGates() Returns the number of input gates this management vertex contains.
int	getNumberOfOutputGates() Returns the number of output gates this management vertex contains.
int	getNumberOfVerticesInGroup() Returns the number of vertices which belong to the same group vertex as this management vertex.
String	getOptMessage()
ManagementGate	getOutputGate(int index) Returns the output gate at the given index.
void	read(DataInputView in)
void	setExecutionState(ExecutionState executionState) Sets the current execution state of this management vertex.
void	setInstanceName(String instanceName) Sets the name of the instance this vertex currently runs on.
void	setOptMessage(String optMessage)
String	toJson() Returns Json representation of this ManagementVertex
String	toString()
void	write(DataOutputView out)

Methods inherited from class org.apache.flink.runtime.managementgraph.ManagementAttachment

getAttachment, setAttachment

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagementVertex

public ManagementVertex(ManagementGroupVertex groupVertex,
                ManagementVertexID id,
                String instanceName,
                int indexInGroup)

Constructs a new management vertex.

Parameters:

groupVertex - the management group vertex the new vertex belongs to

id - the ID of the new management vertex

instanceName - the name of the instance the vertex represented by this new management vertex currently runs on

indexInGroup - the index of this vertex in the management group vertex it belongs to

Method Detail

getInstanceName

public String getInstanceName()

Returns the name of the instance the vertex represented by this management vertex currently runs on.

Returns:

the name of the instance the vertex represented by this management vertex currently runs on

getNumberOfInputGates

public int getNumberOfInputGates()

Returns the number of input gates this management vertex contains.

Returns:

the number of input gates this management vertex contains

getNumberOfOutputGates

public int getNumberOfOutputGates()

Returns the number of output gates this management vertex contains.

Returns:

the number of output gates this management vertex contains

getInputGate

public ManagementGate getInputGate(int index)

Returns the input gate at the given index.

Parameters:

index - the index of the input gate to be returned

Returns:

the input gate at the given index or null if no such input gate exists

getOutputGate

public ManagementGate getOutputGate(int index)

Returns the output gate at the given index.

Parameters:

index - the index of the output gate to be returned

Returns:

the output gate at the given index or null if no such output gate exists

getGroupVertex

public ManagementGroupVertex getGroupVertex()

Returns the group vertex this management vertex belongs to.

Returns:

the group vertex this management vertex belongs to

getGraph

public ManagementGraph getGraph()

The management graph this management vertex belongs to.

Returns:

the management graph this management vertex belongs to

getID

public ManagementVertexID getID()

Returns the ID of this management vertex.

Returns:

the ID of this management vertex

getName

public String getName()

Returns the name of this management vertex.

Returns:

the name of this management vertex, possibly null

getNumberOfVerticesInGroup

public int getNumberOfVerticesInGroup()

Returns the number of vertices which belong to the same group vertex as this management vertex.

Returns:

the number of vertices which belong to the same group vertex as this management vertex

getIndexInGroup

public int getIndexInGroup()

Returns the index at which this vertex is stored inside its corresponding group vertex.

Returns:

the index at which this vertex is stored inside its corresponding group vertex

setExecutionState

public void setExecutionState(ExecutionState executionState)

Sets the current execution state of this management vertex.

Parameters:

executionState - the current execution state of this vertex

getExecutionState

public ExecutionState getExecutionState()

Returns the current execution state of this management vertex.

Returns:

the current execution state of this management vertex

setInstanceName

public void setInstanceName(String instanceName)

Sets the name of the instance this vertex currently runs on.

Parameters:

instanceName - the name of the instance this vertex currently runs on

setOptMessage

public void setOptMessage(String optMessage)

getOptMessage

public String getOptMessage()

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

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

Returns Json representation of this ManagementVertex

Returns: