ManagementGraph (flink-runtime 0.6-hadoop2-incubating API)

java.lang.Object
- org.apache.flink.runtime.managementgraph.ManagementAttachment
- - org.apache.flink.runtime.managementgraph.ManagementGraph

All Implemented Interfaces:

IOReadableWritable
```
public final class ManagementGraph
extends ManagementAttachment
implements IOReadableWritable
```
A management graph is structurally equal to the graph Nephele uses internally for scheduling jobs. Management graphs are intended to provide more fine-grained information about a job at runtime than available through the regular client interface, however, without exposing Nephele's internal scheduling data structures.
This class is not thread-safe.

Constructor Summary

Constructors
Constructor and Description
`ManagementGraph()` Constructs a new management graph with a random job ID.
`ManagementGraph(JobID jobID)` Constructs a new management graph with the given job ID.

Method Summary

Methods
Modifier and Type	Method and Description
`ManagementGroupVertex`	`getGroupVertexByID(ManagementGroupVertexID id)` Returns the group vertex with the given ID from the graph's internal group vertex map.
`Collection<ManagementGroupVertex>`	`getGroupVertices()` Returns an unmodifiable collection of all group vertices with no guarantees on their order.
`List<ManagementGroupVertex>`	`getGroupVerticesInReverseTopologicalOrder()` Returns a list of group vertices sorted in reverse topological order.
`List<ManagementGroupVertex>`	`getGroupVerticesInTopologicalOrder()` Returns a list of group vertices sorted in topological order.
`ManagementGroupVertex`	`getInputGroupVertex(int stage, int index)` Returns the input group vertex at the given index in the given stage.
`ManagementVertex`	`getInputVertex(int stage, int index)` Returns the input vertex with the specified index for the given stage.
`JobID`	`getJobID()` Returns the ID of the job this graph describes.
`int`	`getNumberOfInputGroupVertices(int stage)` Returns the number of input group vertices in the management stage with the given index.
`int`	`getNumberOfInputVertices(int stage)` Returns the number of input vertices for the given stage.
`int`	`getNumberOfOutputGroupVertices(int stage)` Returns the number of output group vertices in the management stage with the given index.
`int`	`getNumberOfOutputVertices(int stage)` Returns the number of output vertices for the given stage.
`int`	`getNumberOfStages()` Returns the number of stages in this management graph.
`ManagementGroupVertex`	`getOutputGroupVertex(int stage, int index)` Returns the output group vertex at the given index in the given stage.
`ManagementVertex`	`getOutputVertex(int stage, int index)` Returns the output vertex with the specified index for the given stage.
`ManagementStage`	`getStage(int index)` Returns the management stage with the given index.
`ManagementVertex`	`getVertexByID(ManagementVertexID id)` Returns the vertex with the given ID from the graph's internal vertex map.
`void`	`read(DataInputView in)`
`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, toString, wait, wait, wait

- Constructor Detail
  - ManagementGraph
```
public ManagementGraph(JobID jobID)
```
    Constructs a new management graph with the given job ID.
    
    Parameters:
    jobID - the job ID of the graph.
  - ManagementGraph
```
public ManagementGraph()
```
    Constructs a new management graph with a random job ID.
- Method Detail
  - getJobID
```
public JobID getJobID()
```
    Returns the ID of the job this graph describes.
    
    Returns:
    the ID of the job this graph describes
  - getVertexByID
```
public ManagementVertex getVertexByID(ManagementVertexID id)
```
    Returns the vertex with the given ID from the graph's internal vertex map.
    
    Parameters:
    id - the ID of the vertex to be returned
    
    Returns:
    the vertex with the given ID or null if no such vertex exists
  - getGroupVertexByID
```
public ManagementGroupVertex getGroupVertexByID(ManagementGroupVertexID id)
```
    Returns the group vertex with the given ID from the graph's internal group vertex map.
    
    Parameters:
    id - the ID of the group vertex to be returned
    
    Returns:
    the group vertex with the given ID or null if no such group vertex exists
  - getNumberOfStages
```
public int getNumberOfStages()
```
    Returns the number of stages in this management graph.
    
    Returns:
    the number of stages in this management graph
  - getStage
```
public ManagementStage getStage(int index)
```
    Returns the management stage with the given index.
    
    Parameters:
    index - the index of the management stage to be returned
    
    Returns:
    the management stage with the given index or null if no such management stage exists
  - getNumberOfInputGroupVertices
```
public int getNumberOfInputGroupVertices(int stage)
```
    Returns the number of input group vertices in the management stage with the given index.
    
    Parameters:
    stage - the index to the management stage
    
    Returns:
    the number of input group vertices in this stage, possibly 0.
  - getNumberOfOutputGroupVertices
```
public int getNumberOfOutputGroupVertices(int stage)
```
    Returns the number of output group vertices in the management stage with the given index.
    
    Parameters:
    stage - the index to the management stage
    
    Returns:
    the number of output group vertices in this stage, possibly 0.
  - getInputGroupVertex
```
public ManagementGroupVertex getInputGroupVertex(int stage,
                                        int index)
```
    Returns the input group vertex at the given index in the given stage.
    
    Parameters:
    stage - the index to the management stage
    index - the index to the input group vertex
    
    Returns:
    the input group vertex at the given index in the given stage or null if either the stage does not exists or the given index is invalid in this stage
  - getOutputGroupVertex
```
public ManagementGroupVertex getOutputGroupVertex(int stage,
                                         int index)
```
    Returns the output group vertex at the given index in the given stage.
    
    Parameters:
    stage - the index to the management stage
    index - the index to the output group vertex
    
    Returns:
    the output group vertex at the given index in the given stage or null if either the stage does not exists or the given index is invalid in this stage
  - getNumberOfInputVertices
```
public int getNumberOfInputVertices(int stage)
```
    Returns the number of input vertices for the given stage.
    
    Parameters:
    stage - the index of the management stage
    
    Returns:
    the number of input vertices for the given stage
  - getNumberOfOutputVertices
```
public int getNumberOfOutputVertices(int stage)
```
    Returns the number of output vertices for the given stage.
    
    Parameters:
    stage - the index of the management stage
    
    Returns:
    the number of input vertices for the given stage
  - getInputVertex
```
public ManagementVertex getInputVertex(int stage,
                              int index)
```
    Returns the input vertex with the specified index for the given stage.
    
    Parameters:
    stage - the index of the stage
    index - the index of the input vertex to return
    
    Returns:
    the input vertex with the specified index or null if no input vertex with such an index exists in that stage
  - getOutputVertex
```
public ManagementVertex getOutputVertex(int stage,
                               int index)
```
    Returns the output vertex with the specified index for the given stage.
    
    Parameters:
    stage - the index of the stage
    index - the index of the output vertex to return
    
    Returns:
    the output vertex with the specified index or null if no output vertex with such an index exists in that stage
  - getGroupVertices
```
public Collection<ManagementGroupVertex> getGroupVertices()
```
    Returns an unmodifiable collection of all group vertices with no guarantees on their order.
    
    Returns:
    an unmodifiable collection of all group vertices with no guarantees on their order
  - getGroupVerticesInTopologicalOrder
```
public List<ManagementGroupVertex> getGroupVerticesInTopologicalOrder()
```
    Returns a list of group vertices sorted in topological order.
    
    Returns:
    a list of group vertices sorted in topological order
  - getGroupVerticesInReverseTopologicalOrder
```
public List<ManagementGroupVertex> getGroupVerticesInReverseTopologicalOrder()
```
    Returns a list of group vertices sorted in reverse topological order.
    
    Returns:
    a list of group vertices sorted in reverse topological order
  - 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

Class ManagementGraph

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ManagementGraph

ManagementGraph

Method Detail

getJobID

getVertexByID

getGroupVertexByID

getNumberOfStages

getStage

getNumberOfInputGroupVertices

getNumberOfOutputGroupVertices

getInputGroupVertex

getOutputGroupVertex

getNumberOfInputVertices

getNumberOfOutputVertices

getInputVertex

getOutputVertex

getGroupVertices

getGroupVerticesInTopologicalOrder

getGroupVerticesInReverseTopologicalOrder

read

write