org.apache.flink.runtime.managementgraph

Class ManagementGroupVertex

java.lang.Object

org.apache.flink.runtime.managementgraph.ManagementAttachment

org.apache.flink.runtime.managementgraph.ManagementGroupVertex

All Implemented Interfaces:

IOReadableWritable

public final class ManagementGroupVertex
extends ManagementAttachment
implements IOReadableWritable

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

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ManagementGroupVertex(ManagementStage stage, ManagementGroupVertexID id, String name) Constructs a new management group vertex.
ManagementGroupVertex(ManagementStage stage, String name) Constructs a new management group vertex.

Method Summary

Methods

Modifier and Type	Method and Description
ManagementGroupEdge	getBackwardEdge(int index) Returns the group edge which arrives at this group vertex at the given index.
ManagementGroupEdge	getForwardEdge(int index) Returns the group edge which leaves this group vertex at the given index.
ManagementGraph	getGraph() Returns the management graph this group vertex is part of.
ManagementVertex	getGroupMember(int index) Returns the management vertex with the given index.
List<ManagementVertex>	getGroupMembers() Returns alle management vertices containted in this group
ManagementGroupVertexID	getID() Returns the ID of this management group vertex.
String	getName() Returns the name of this management group vertex.
int	getNumberOfBackwardEdges() Returns the number of edges arriving at this group vertex.
int	getNumberOfForwardEdges() Returns the number of edges originating at this group vertex.
int	getNumberOfGroupMembers() Returns the number of management vertices included in this group vertex.
List<ManagementGroupVertex>	getPredecessors() Returns the list of predecessors of this group vertex.
ManagementStage	getStage() Returns the stage this management group vertex belongs to.
int	getStageNumber() Returns the number of the management stage this group vertex belongs to.
List<ManagementGroupVertex>	getSuccessors() Returns the list of successors of this group vertex.
boolean	isInputVertex() Checks if this vertex is an input vertex in its stage, i.e.
boolean	isOutputVertex() Checks if this vertex is an output vertex in its stage, i.e.
void	read(DataInputView in)
String	toJson() Returns Json representation of this ManagementGroupVertex
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

ManagementGroupVertex

public ManagementGroupVertex(ManagementStage stage,
                     String name)

Constructs a new management group vertex.

Parameters:

stage - the stage this group vertex belongs to

name - the name of the new management group vertex

ManagementGroupVertex

public ManagementGroupVertex(ManagementStage stage,
                     ManagementGroupVertexID id,
                     String name)

Constructs a new management group vertex.

Parameters:

stage - the stage this group vertex belongs to

id - the ID of the management group vertex

name - the name of the new management group vertex

Method Detail

getID

public ManagementGroupVertexID getID()

Returns the ID of this management group vertex.

Returns:

the ID of this management group vertex

getName

public String getName()

Returns the name of this management group vertex.

Returns:

the anme of this management group vertex, possibly null

getNumberOfForwardEdges

public int getNumberOfForwardEdges()

Returns the number of edges originating at this group vertex.

Returns:

the number of edges originating at this group vertex

getNumberOfBackwardEdges

public int getNumberOfBackwardEdges()

Returns the number of edges arriving at this group vertex.

Returns:

the number of edges arriving at this group vertex

getForwardEdge

public ManagementGroupEdge getForwardEdge(int index)

Returns the group edge which leaves this group vertex at the given index.

Parameters:

index - the index of the group edge

Returns:

the group edge which leaves this group vertex at the given index or null if no such group edge exists

getBackwardEdge

public ManagementGroupEdge getBackwardEdge(int index)

Returns the group edge which arrives at this group vertex at the given index.

Parameters:

index - the index of the group edge

Returns:

the group edge which arrives at this group vertex at the given index or null if no such group edge exists

getStage

public ManagementStage getStage()

Returns the stage this management group vertex belongs to.

Returns:

the stage this management group vertex belongs to

getGraph

public ManagementGraph getGraph()

Returns the management graph this group vertex is part of.

Returns:

the management graph this group vertex is part of

getNumberOfGroupMembers

public int getNumberOfGroupMembers()

Returns the number of management vertices included in this group vertex.

Returns:

the number of management vertices included in this group vertex

getGroupMember

public ManagementVertex getGroupMember(int index)

Returns the management vertex with the given index.

Parameters:

index - the index of the management vertex to be returned

Returns:

the management vertex with the given index or null if no such vertex exists

getGroupMembers

public List<ManagementVertex> getGroupMembers()

Returns alle management vertices containted in this group

Returns:

the management vertex with the given index or null if no such vertex exists

isInputVertex

public boolean isInputVertex()

Checks if this vertex is an input vertex in its stage, i.e. has either no incoming connections or only incoming connections to group vertices in a lower stage.

Returns:

true if this vertex is an input vertex, false otherwise

isOutputVertex

public boolean isOutputVertex()

Checks if this vertex is an output vertex in its stage, i.e. has either no outgoing connections or only outgoing connections to group vertices in a higher stage.

Returns:

true if this vertex is an output vertex, false otherwise

getStageNumber

public int getStageNumber()

Returns the number of the management stage this group vertex belongs to.

Returns:

the number of the management stage this group vertex belongs to

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

getSuccessors

public List<ManagementGroupVertex> getSuccessors()

Returns the list of successors of this group vertex. A successor is a group vertex which can be reached via a group edge originating at this group vertex.

Returns:

the list of successors of this group vertex.

getPredecessors

public List<ManagementGroupVertex> getPredecessors()

Returns the list of predecessors of this group vertex. A predecessors is a group vertex which can be reached via a group edge arriving at this group vertex.

Returns:

the list of predecessors of this group vertex.

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

Returns Json representation of this ManagementGroupVertex

Returns: