JobGraph (flink-runtime 0.6.1-hadoop2-incubating API)

java.lang.Object
- org.apache.flink.runtime.jobgraph.JobGraph

All Implemented Interfaces:

IOReadableWritable
```
public class JobGraph
extends Object
implements IOReadableWritable
```
A job graph represents an entire job in Nephele. A job graph must consists at least of one job vertex and must be acyclic.

Constructor Summary

Constructors
Constructor and Description
`JobGraph()` Constructs a new job graph with a random job ID.
`JobGraph(String jobName)` Constructs a new job graph with the given name and a random job ID.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addJar(Path jar)` Adds the path of a JAR file required to run the job on a task manager.
`void`	`addVertex(AbstractJobInputVertex inputVertex)` Adds a new input vertex to the job graph if it is not already included.
`void`	`addVertex(AbstractJobOutputVertex outputVertex)` Adds a new output vertex to the job graph if it is not already included.
`void`	`addVertex(JobTaskVertex taskVertex)` Adds a new task vertex to the job graph if it is not already included.
`AbstractJobVertex`	`areVertexDegreesCorrect()` Checks for all registered job vertices if their in-/out-degree is correct.
`AbstractJobVertex`	`findVertexByID(JobVertexID id)` Searches for a vertex with a matching ID and returns it.
`AbstractJobVertex`	`findVertexWithNullEdges()` Checks if any vertex of this job graph has an outgoing edge which is set to `null`.
`AbstractJobVertex[]`	`getAllJobVertices()` Returns an array of all job vertices that are registered with the job graph.
`AbstractJobVertex[]`	`getAllReachableJobVertices()` Returns an array of all job vertices than can be reached when traversing the job graph from the input vertices.
`Iterator<AbstractJobInputVertex>`	`getInputVertices()` Returns an iterator to iterate all input vertices registered with the job graph.
`Path[]`	`getJars()` Returns a (possibly empty) array of paths to JAR files which are required to run the job on a task manager.
`Configuration`	`getJobConfiguration()` Returns the configuration object for this job if it is set.
`JobID`	`getJobID()` Returns the ID of the job.
`String`	`getName()` Returns the name assigned to the job graph.
`int`	`getNumberOfInputVertices()` Returns the number of input vertices registered with the job graph.
`int`	`getNumberOfOutputVertices()` Returns the number of output vertices registered with the job graph.
`int`	`getNumberOfTaskVertices()` Returns the number of task vertices registered with the job graph.
`int`	`getNumberOfVertices()` Returns the number of all job vertices registered with this job graph.
`Iterator<AbstractJobOutputVertex>`	`getOutputVertices()` Returns an iterator to iterate all output vertices registered with the job graph.
`Iterator<JobTaskVertex>`	`getTaskVertices()` Returns an iterator to iterate all task vertices registered with the job graph.
`boolean`	`isAcyclic()` Checks if the job graph is acyclic.
`boolean`	`isInstanceDependencyChainAcyclic()` Checks if the instance dependency chain created with the `setVertexToShareInstancesWith` method is acyclic.
`boolean`	`isWeaklyConnected()` Checks if the job graph is weakly connected.
`void`	`read(DataInputView in)`
`void`	`write(DataOutputView out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JobGraph
```
public JobGraph()
```
    Constructs a new job graph with a random job ID.
  - JobGraph
```
public JobGraph(String jobName)
```
    Constructs a new job graph with the given name and a random job ID.
    
    Parameters:
    jobName - the name for this job graph
- Method Detail
  - getName
```
public String getName()
```
    Returns the name assigned to the job graph.
    
    Returns:
    the name assigned to the job graph
  - getJobConfiguration
```
public Configuration getJobConfiguration()
```
    Returns the configuration object for this job if it is set.
    
    Returns:
    the configuration object for this job, or null if it is not set
  - addVertex
```
public void addVertex(AbstractJobInputVertex inputVertex)
```
    Adds a new input vertex to the job graph if it is not already included.
    
    Parameters:
    inputVertex - the new input vertex to be added
  - addVertex
```
public void addVertex(JobTaskVertex taskVertex)
```
    Adds a new task vertex to the job graph if it is not already included.
    
    Parameters:
    taskVertex - the new task vertex to be added
  - addVertex
```
public void addVertex(AbstractJobOutputVertex outputVertex)
```
    Adds a new output vertex to the job graph if it is not already included.
    
    Parameters:
    outputVertex - the new output vertex to be added
  - getNumberOfInputVertices
```
public int getNumberOfInputVertices()
```
    Returns the number of input vertices registered with the job graph.
    
    Returns:
    the number of input vertices registered with the job graph
  - getNumberOfOutputVertices
```
public int getNumberOfOutputVertices()
```
    Returns the number of output vertices registered with the job graph.
    
    Returns:
    the number of output vertices registered with the job graph
  - getNumberOfTaskVertices
```
public int getNumberOfTaskVertices()
```
    Returns the number of task vertices registered with the job graph.
    
    Returns:
    the number of task vertices registered with the job graph
  - getInputVertices
```
public Iterator<AbstractJobInputVertex> getInputVertices()
```
    Returns an iterator to iterate all input vertices registered with the job graph.
    
    Returns:
    an iterator to iterate all input vertices registered with the job graph
  - getOutputVertices
```
public Iterator<AbstractJobOutputVertex> getOutputVertices()
```
    Returns an iterator to iterate all output vertices registered with the job graph.
    
    Returns:
    an iterator to iterate all output vertices registered with the job graph
  - getTaskVertices
```
public Iterator<JobTaskVertex> getTaskVertices()
```
    Returns an iterator to iterate all task vertices registered with the job graph.
    
    Returns:
    an iterator to iterate all task vertices registered with the job graph
  - getNumberOfVertices
```
public int getNumberOfVertices()
```
    Returns the number of all job vertices registered with this job graph.
    
    Returns:
    the number of all job vertices registered with this job graph
  - getAllReachableJobVertices
```
public AbstractJobVertex[] getAllReachableJobVertices()
```
    Returns an array of all job vertices than can be reached when traversing the job graph from the input vertices. Each job vertex is contained only one time.
    
    Returns:
    an array of all job vertices than can be reached when traversing the job graph from the input vertices
  - getAllJobVertices
```
public AbstractJobVertex[] getAllJobVertices()
```
    Returns an array of all job vertices that are registered with the job graph. The order in which the vertices appear in the list is not defined.
    
    Returns:
    an array of all job vertices that are registered with the job graph
  - getJobID
```
public JobID getJobID()
```
    Returns the ID of the job.
    
    Returns:
    the ID of the job
  - findVertexByID
```
public AbstractJobVertex findVertexByID(JobVertexID id)
```
    Searches for a vertex with a matching ID and returns it.
    
    Parameters:
    id - the ID of the vertex to search for
    
    Returns:
    the vertex with the matching ID or null if no vertex with such ID could be found
  - isWeaklyConnected
```
public boolean isWeaklyConnected()
```
    Checks if the job graph is weakly connected.
    
    Returns:
    true if the job graph is weakly connected, otherwise false
  - isAcyclic
```
public boolean isAcyclic()
```
    Checks if the job graph is acyclic.
    
    Returns:
    true if the job graph is acyclic, false otherwise
  - areVertexDegreesCorrect
```
public AbstractJobVertex areVertexDegreesCorrect()
```
    Checks for all registered job vertices if their in-/out-degree is correct.
    
    Returns:
    null if the in-/out-degree of all vertices is correct or the first job vertex whose in-/out-degree is incorrect.
  - 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
  - addJar
```
public void addJar(Path jar)
```
    Adds the path of a JAR file required to run the job on a task manager.
    
    Parameters:
    jar - path of the JAR file required to run the job on a task manager
  - getJars
```
public Path[] getJars()
```
    Returns a (possibly empty) array of paths to JAR files which are required to run the job on a task manager.
    
    Returns:
    a (possibly empty) array of paths to JAR files which are required to run the job on a task manager
  - findVertexWithNullEdges
```
public AbstractJobVertex findVertexWithNullEdges()
```
    Checks if any vertex of this job graph has an outgoing edge which is set to null. If this is the case the respective vertex is returned.
    
    Returns:
    the vertex which has an outgoing edge set to null or null if no such vertex exists
  - isInstanceDependencyChainAcyclic
```
public boolean isInstanceDependencyChainAcyclic()
```
    Checks if the instance dependency chain created with the setVertexToShareInstancesWith method is acyclic.
    
    Returns:
    true if the dependency chain is acyclic, false otherwise

Class JobGraph

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobGraph

JobGraph

Method Detail

getName

getJobConfiguration

addVertex

addVertex

addVertex

getNumberOfInputVertices

getNumberOfOutputVertices

getNumberOfTaskVertices

getInputVertices

getOutputVertices

getTaskVertices

getNumberOfVertices

getAllReachableJobVertices

getAllJobVertices

getJobID

findVertexByID

isWeaklyConnected

isAcyclic

areVertexDegreesCorrect

read

write

addJar

getJars

findVertexWithNullEdges

isInstanceDependencyChainAcyclic