org.apache.hama.graph

Interface VertexInterface<V extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Type Parameters:

V - this type must be writable and should also implement equals and hashcode.

E - the type used for storing edge values, usually the value of an edge.

M - the type used for messaging, usually the value of a vertex.

All Superinterfaces:

Comparable<VertexInterface<V,E,M>>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<VertexInterface<V,E,M>>

All Known Implementing Classes:

Vertex

public interface VertexInterface<V extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>
extends org.apache.hadoop.io.WritableComparable<VertexInterface<V,E,M>>

The vertex interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addVertex(V vertexID, List<Edge<V,E>> edges, M value) Sends a message to add a new vertex through the partitioner to the appropriate BSP peer
void	aggregate(int index, M value) Provides a value to the specified aggregator.
void	compute(Iterable<M> messages) The user-defined function
org.apache.hadoop.io.Writable	getAggregatedValue(int index) Returns the value of the specified aggregator.
List<Edge<V,E>>	getEdges()
long	getNumVertices()
long	getSuperstepCount()
M	getValue() Gets the vertex value
V	getVertexID()
void	remove() Removes current Vertex from local peer.
void	sendMessage(Edge<V,E> e, M msg) Sends a message to another vertex.
void	sendMessage(V destinationVertexID, M msg) Sends a message to the given destination vertex by ID and the message value
void	sendMessageToNeighbors(M msg) Sends a message to neighbors
void	setup(HamaConfiguration conf) This method is called once before the Vertex computation begins.
void	setValue(M value) Sets the vertex value
void	voteToHalt() Vote to halt.

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setup

void setup(HamaConfiguration conf)

This method is called once before the Vertex computation begins. Since the Vertex object is serializable, variables in your Vertex program always should be declared a s static.

getVertexID

V getVertexID()

Returns:

the unique identification for the vertex.

getNumVertices

long getNumVertices()

Returns:

the number of vertices in the input graph.

compute

void compute(Iterable<M> messages)
             throws IOException

The user-defined function

Throws:

IOException

getEdges

List<Edge<V,E>> getEdges()

Returns:

a list of outgoing edges of this vertex in the input graph.

sendMessage

void sendMessage(Edge<V,E> e,
               M msg)
                 throws IOException

Sends a message to another vertex.

Throws:

IOException

sendMessageToNeighbors

void sendMessageToNeighbors(M msg)
                            throws IOException

Sends a message to neighbors

Throws:

IOException

sendMessage

void sendMessage(V destinationVertexID,
               M msg)
                 throws IOException

Sends a message to the given destination vertex by ID and the message value

Throws:

IOException

addVertex

void addVertex(V vertexID,
             List<Edge<V,E>> edges,
             M value)
               throws IOException

Sends a message to add a new vertex through the partitioner to the appropriate BSP peer

Throws:

IOException

remove

void remove()
            throws IOException

Removes current Vertex from local peer.

Throws:

IOException

getSuperstepCount

long getSuperstepCount()

Returns:

the superstep number of the current superstep (starting from 0).

voteToHalt

void voteToHalt()

Vote to halt.

setValue

void setValue(M value)

Sets the vertex value

getValue

M getValue()

Gets the vertex value

aggregate

void aggregate(int index,
             M value)
               throws IOException

Provides a value to the specified aggregator.

Parameters:

name - identifies a aggregator

value - value to be aggregated

Throws:

IOException

getAggregatedValue

org.apache.hadoop.io.Writable getAggregatedValue(int index)

Returns the value of the specified aggregator.