org.apache.hama.graph

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

Type Parameters:

V - Vertex ID object type

E - Edge cost object type

M - Vertex value object type

All Known Implementing Classes:

DiskVerticesInfo, ListVerticesInfo, OffHeapVerticesInfo

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

VerticesInfo interface encapsulates the storage of vertices in a BSP Task.

Method Summary

Methods

Modifier and Type	Method and Description
void	addVertex(Vertex<V,E,M> vertex) Add a vertex to the underlying structure.
void	cleanup(org.apache.hadoop.conf.Configuration conf, TaskAttemptID attempt) Cleanup of internal structures.
void	finishAdditions() Finish the additions, from this point on the implementations should close the adds and throw exceptions in case something is added after this call.
void	finishRemovals() Finish the removals, from this point on the implementations should close the removes and throw exceptions in case something is removed after this call.
void	finishSuperstep() Called once completed a superstep.
void	finishVertexComputation(Vertex<V,E,M> vertex) Must be called once a vertex is guaranteed not to change any more and can safely be persisted to a secondary storage.
void	init(GraphJobRunner<V,E,M> runner, org.apache.hadoop.conf.Configuration conf, TaskAttemptID attempt) Initialization of internal structures.
void	removeVertex(V vertexID) Remove a vertex to the underlying structure.
int	size()
IDSkippingIterator<V,E,M>	skippingIterator()
void	startSuperstep() Called once a superstep starts.

Method Detail

init

void init(GraphJobRunner<V,E,M> runner,
        org.apache.hadoop.conf.Configuration conf,
        TaskAttemptID attempt)
          throws IOException

Initialization of internal structures.

Throws:

IOException

cleanup

void cleanup(org.apache.hadoop.conf.Configuration conf,
           TaskAttemptID attempt)
             throws IOException

Cleanup of internal structures.

Throws:

IOException

addVertex

void addVertex(Vertex<V,E,M> vertex)
               throws IOException

Add a vertex to the underlying structure.

Throws:

IOException

removeVertex

void removeVertex(V vertexID)
                  throws UnsupportedOperationException

Remove a vertex to the underlying structure.

Throws:

UnsupportedOperationException

finishAdditions

void finishAdditions()

Finish the additions, from this point on the implementations should close the adds and throw exceptions in case something is added after this call.

finishRemovals

void finishRemovals()

Finish the removals, from this point on the implementations should close the removes and throw exceptions in case something is removed after this call.

startSuperstep

void startSuperstep()
                    throws IOException

Called once a superstep starts.

Throws:

IOException

finishSuperstep

void finishSuperstep()
                     throws IOException

Called once completed a superstep.

Throws:

IOException

finishVertexComputation

void finishVertexComputation(Vertex<V,E,M> vertex)
                             throws IOException

Must be called once a vertex is guaranteed not to change any more and can safely be persisted to a secondary storage.

Throws:

IOException

size

int size()

Returns:

the number of vertices added to the underlying structure. Implementations should take care this is a constant time operation.

skippingIterator

IDSkippingIterator<V,E,M> skippingIterator()