org.apache.giraph.partition

Interface Partition<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Type Parameters:

I - Vertex id

V - Vertex data

E - Edge data

All Superinterfaces:

GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>, Iterable<Vertex<I,V,E>>, org.apache.hadoop.io.Writable

All Known Subinterfaces:

ReusesObjectsPartition<I,V,E>

All Known Implementing Classes:

BasicPartition, ByteArrayPartition, SimplePartition

public interface Partition<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends org.apache.hadoop.io.Writable, ImmutableClassesGiraphConfigurable<I,V,E>, Iterable<Vertex<I,V,E>>

A generic container that stores vertices. Vertex ids will map to exactly one partition.

Method Summary

Modifier and Type	Method and Description
void	addPartition(Partition<I,V,E> partition) Add a partition's vertices.
void	addPartitionVertices(VertexIterator<I,V,E> vertexIterator) Add vertices to a partition.
long	getEdgeCount() Get the number of edges in this partition.
int	getId() Get the partition id.
Vertex<I,V,E>	getVertex(I vertexIndex) Get the vertex for this vertex index.
long	getVertexCount() Get the number of vertices in this partition
void	initialize(int partitionId, org.apache.hadoop.util.Progressable progressable) Initialize the partition.
void	progress() Report progress.
boolean	putOrCombine(Vertex<I,V,E> vertex) Put this vertex or combine it
Vertex<I,V,E>	putVertex(Vertex<I,V,E> vertex) Put a vertex into the Partition
Vertex<I,V,E>	removeVertex(I vertexIndex) Remove a vertex from the Partition
void	saveVertex(Vertex<I,V,E> vertex) Save potentially modified vertex back to the partition.
void	setId(int id) Set the partition id.
void	setProgressable(org.apache.hadoop.util.Progressable progressable) Set the context.

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

readFields, write

Methods inherited from interface org.apache.giraph.conf.ImmutableClassesGiraphConfigurable

getConf

Methods inherited from interface org.apache.giraph.conf.GiraphConfigurationSettable

setConf

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

initialize

void initialize(int partitionId,
                org.apache.hadoop.util.Progressable progressable)

Initialize the partition. Guaranteed to be called before used.

Parameters:

partitionId - Partition id

progressable - Progressable to call progress

getVertex

Vertex<I,V,E> getVertex(I vertexIndex)

Get the vertex for this vertex index.

Parameters:

vertexIndex - Vertex index to search for

Returns:

Vertex if it exists, null otherwise

putVertex

Vertex<I,V,E> putVertex(Vertex<I,V,E> vertex)

Put a vertex into the Partition

Parameters:

vertex - Vertex to put in the Partition

Returns:

old vertex value (i.e. null if none existed prior)

removeVertex

Vertex<I,V,E> removeVertex(I vertexIndex)

Remove a vertex from the Partition

Parameters:

vertexIndex - Vertex index to remove

Returns:

The removed vertex.

addPartition

void addPartition(Partition<I,V,E> partition)

Add a partition's vertices. If a vertex to be added doesn't exist, add it. If the vertex already exists, use the VertexValueCombiner to combine them.

Parameters:

partition - Partition to add

putOrCombine

boolean putOrCombine(Vertex<I,V,E> vertex)

Put this vertex or combine it

Parameters:

vertex - Vertex to put or combine

Returns:

True if the vertex was put (hint to release object)

addPartitionVertices

void addPartitionVertices(VertexIterator<I,V,E> vertexIterator)

Add vertices to a partition. If a vertex to be added doesn't exist, add it. If the vertex already exists, use the VertexValueCombiner to combine them.

Parameters:

vertexIterator - Vertices to add

getVertexCount

long getVertexCount()

Get the number of vertices in this partition

Returns:

Number of vertices

getEdgeCount

long getEdgeCount()

Get the number of edges in this partition.

Returns:

Number of edges.

getId

int getId()

Get the partition id.

Returns:

Id of this partition.

setId

void setId(int id)

Set the partition id.

Parameters:

id - Id of this partition

progress

void progress()

Report progress.

setProgressable

void setProgressable(org.apache.hadoop.util.Progressable progressable)

Set the context.

Parameters:

progressable - Progressable

saveVertex

void saveVertex(Vertex<I,V,E> vertex)

Save potentially modified vertex back to the partition.

Parameters:

vertex - Vertex to save