org.apache.hama.graph

Class GraphJobRunner<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.hama.bsp.BSP<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

org.apache.hama.graph.GraphJobRunner<V,E,M>

Type Parameters:

V - the id type of a vertex.

E - the value type of an edge.

M - the value type of a vertex.

All Implemented Interfaces:

BSPInterface<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

public final class GraphJobRunner<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>
extends BSP<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Fully generic graph job runner.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphJobRunner.GraphJobCounter

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.hadoop.io.Text	FLAG_MESSAGE_COUNTS
static String	GRAPH_REPAIR
static String	MESSAGE_COMBINER_CLASS
static String	S_FLAG_AGGREGATOR_INCREMENT
static String	S_FLAG_AGGREGATOR_VALUE
static String	S_FLAG_MESSAGE_COUNTS

Constructor Summary

Constructors

Constructor and Description
GraphJobRunner()

Method Summary

Methods

Modifier and Type	Method and Description
void	bsp(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)
void	cleanup(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer) Just write pair as a result.
org.apache.hadoop.io.Writable	getLastAggregatedValue(int index) Gets the last aggregated value at the given index.
static String	getMasterTask(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)
int	getMaxIteration()
long	getNumberIterations()
long	getNumberVertices()
org.apache.hadoop.io.IntWritable	getNumLastAggregatedVertices(int index) Gets the last aggregated number of vertices at the given index.
Partitioner<V,M>	getPartitioner()
BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>	getPeer()
static boolean	isMasterTask(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer) Checks if this is a master task.
static <V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> Vertex<V,E,M>	newVertexInstance(Class<?> vertexClass, org.apache.hadoop.conf.Configuration conf)
void	setup(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)

Methods inherited from class java.lang.Object

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

Field Detail

S_FLAG_MESSAGE_COUNTS

public static final String S_FLAG_MESSAGE_COUNTS

See Also:

Constant Field Values

S_FLAG_AGGREGATOR_VALUE

public static final String S_FLAG_AGGREGATOR_VALUE

See Also:

Constant Field Values

S_FLAG_AGGREGATOR_INCREMENT

public static final String S_FLAG_AGGREGATOR_INCREMENT

See Also:

Constant Field Values

FLAG_MESSAGE_COUNTS

public static final org.apache.hadoop.io.Text FLAG_MESSAGE_COUNTS

MESSAGE_COMBINER_CLASS

public static final String MESSAGE_COMBINER_CLASS

See Also:

Constant Field Values

GRAPH_REPAIR

public static final String GRAPH_REPAIR

See Also:

Constant Field Values

Constructor Detail

GraphJobRunner

public GraphJobRunner()

Method Detail

setup

public final void setup(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)
                 throws IOException,
                        SyncException,
                        InterruptedException

Specified by:

setup in interface BSPInterface<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Overrides:

setup in class BSP<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Throws:

IOException

SyncException

InterruptedException

bsp

public final void bsp(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)
               throws IOException,
                      SyncException,
                      InterruptedException

Specified by:

bsp in interface BSPInterface<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Specified by:

bsp in class BSP<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Throws:

IOException

SyncException

InterruptedException

cleanup

public final void cleanup(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)
                   throws IOException

Just write pair as a result. Note that this will also be executed when failure happened.

Specified by:

cleanup in interface BSPInterface<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Overrides:

cleanup in class BSP<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage>

Throws:

IOException

getNumberVertices

public final long getNumberVertices()

Returns:

the number of vertices, globally accumulated.

getNumberIterations

public final long getNumberIterations()

Returns:

the current number of iterations.

getMaxIteration

public final int getMaxIteration()

Returns:

the defined number of maximum iterations, -1 if not defined.

getPartitioner

public final Partitioner<V,M> getPartitioner()

Returns:

the defined partitioner instance.

getLastAggregatedValue

public final org.apache.hadoop.io.Writable getLastAggregatedValue(int index)

Gets the last aggregated value at the given index. The index is dependend on how the aggregators were configured during job setup phase.

Returns:

the value of the aggregator, or null if none was defined.

getNumLastAggregatedVertices

public final org.apache.hadoop.io.IntWritable getNumLastAggregatedVertices(int index)

Gets the last aggregated number of vertices at the given index. The index is dependend on how the aggregators were configured during job setup phase.

Returns:

the value of the aggregator, or null if none was defined.

getPeer

public final BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> getPeer()

Returns:

the peer instance.

isMasterTask

public static boolean isMasterTask(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)

Checks if this is a master task. The master task is the first peer in the peer array.

getMasterTask

public static String getMasterTask(BSPPeer<org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,org.apache.hadoop.io.Writable,GraphJobMessage> peer)

Returns:

the name of the master peer, the name at the first index of the peers.

newVertexInstance

public static <V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable> Vertex<V,E,M> newVertexInstance(Class<?> vertexClass,
                                                                                                                                                        org.apache.hadoop.conf.Configuration conf)

Returns:

a new vertex instance