org.apache.hama.graph

Class Vertex<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.graph.Vertex<V,E,M>

All Implemented Interfaces:

VertexInterface<V,E,M>

public abstract class Vertex<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>
extends Object
implements VertexInterface<V,E,M>

Field Summary

Fields

Modifier and Type	Field and Description
protected GraphJobRunner<V,E,M>	runner

Constructor Summary

Constructors

Constructor and Description
Vertex()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdge(Edge<V,E> edge)
boolean	equals(Object obj)
org.apache.hadoop.conf.Configuration	getConf()
List<Edge<V,E>>	getEdges()
M	getLastAggregatedValue(int index) Get the last aggregated value of the defined aggregator, null if nothing was configured or not returned a result.
int	getMaxIteration()
org.apache.hadoop.io.IntWritable	getNumLastAggregatedVertices(int index) Get the number of aggregated vertices in the last superstep.
int	getNumPeers()
long	getNumVertices()
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() Gives access to the BSP primitives and additional features by a peer.
long	getSuperstepCount()
M	getValue() Gets the vertex value
V	getVertexID()
int	hashCode()
boolean	isHalted()
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	setEdges(List<Edge<V,E>> list)
void	setup(org.apache.hadoop.conf.Configuration conf) Used to setup a vertex.
void	setValue(M value) Sets the vertex value
void	setVertexID(V vertexID)
String	toString()
void	voteToHalt() Vote to halt.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hama.graph.VertexInterface

compute

Field Detail

runner

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

Constructor Detail

Vertex

public Vertex()

Method Detail

getConf

public org.apache.hadoop.conf.Configuration getConf()

getVertexID

public V getVertexID()

Specified by:

getVertexID in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Returns:

the unique identification for the vertex.

setup

public void setup(org.apache.hadoop.conf.Configuration conf)

Description copied from interface: VertexInterface

Used to setup a vertex.

Specified by:

setup in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

sendMessage

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

Description copied from interface: VertexInterface

Sends a message to another vertex.

Specified by:

sendMessage in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Throws:

IOException

sendMessageToNeighbors

public void sendMessageToNeighbors(M msg)
                            throws IOException

Description copied from interface: VertexInterface

Sends a message to neighbors

Specified by:

sendMessageToNeighbors in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Throws:

IOException

sendMessage

public void sendMessage(V destinationVertexID,
               M msg)
                 throws IOException

Description copied from interface: VertexInterface

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

Specified by:

sendMessage in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Throws:

IOException

getSuperstepCount

public long getSuperstepCount()

Specified by:

getSuperstepCount in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Returns:

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

setEdges

public void setEdges(List<Edge<V,E>> list)

addEdge

public void addEdge(Edge<V,E> edge)

getEdges

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

Specified by:

getEdges in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Returns:

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

getValue

public M getValue()

Description copied from interface: VertexInterface

Gets the vertex value

Specified by:

getValue in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

setValue

public void setValue(M value)

Description copied from interface: VertexInterface

Sets the vertex value

Specified by:

setValue in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

setVertexID

public void setVertexID(V vertexID)

getMaxIteration

public int getMaxIteration()

getLastAggregatedValue

public M getLastAggregatedValue(int index)

Get the last aggregated value of the defined aggregator, null if nothing was configured or not returned a result. You have to supply an index, the index is defined by the order you set the aggregator classes in GraphJob.setAggregatorClass(Class...). Index is starting at zero, so if you have a single aggregator you can retrieve it via getLastAggregatedValue(int)(0).

getNumLastAggregatedVertices

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

Get the number of aggregated vertices in the last superstep. Or null if no aggregator is available.You have to supply an index, the index is defined by the order you set the aggregator classes in GraphJob.setAggregatorClass(Class...). Index is starting at zero, so if you have a single aggregator you can retrieve it via getNumLastAggregatedVertices(int)(0).

getNumPeers

public int getNumPeers()

getPeer

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

Gives access to the BSP primitives and additional features by a peer.

getPartitioner

public Partitioner<V,M> getPartitioner()

getNumVertices

public long getNumVertices()

Specified by:

getNumVertices in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

Returns:

the number of vertices in the input graph.

voteToHalt

public void voteToHalt()

Description copied from interface: VertexInterface

Vote to halt.

Specified by:

voteToHalt in interface VertexInterface<V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,M extends org.apache.hadoop.io.Writable>

isHalted

public boolean isHalted()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object