org.apache.giraph.graph

Class VertexMutations<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.giraph.graph.VertexMutations<I,V,E>

Type Parameters:

I - Vertex index value

V - Vertex value

E - Edge value

All Implemented Interfaces:

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

public class VertexMutations<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends Object
implements VertexChanges<I,V,E>, org.apache.hadoop.io.Writable, ImmutableClassesGiraphConfigurable

Structure to hold all the possible graph mutations that can occur during a superstep.

Constructor Summary

Constructors

Constructor and Description
VertexMutations()

Method Summary

Modifier and Type	Method and Description
void	addEdge(Edge<I,E> edge) Add an edge to this vertex
void	addVertex(Vertex<I,V,E> vertex) Add a vertex mutation
void	addVertexMutations(VertexMutations<I,V,E> vertexMutations) Add one vertex mutations to another
VertexMutations<I,V,E>	copy() Copy the vertex mutations.
List<Edge<I,E>>	getAddedEdgeList() Get the added edges for this particular vertex index from the previous superstep
List<Vertex<I,V,E>>	getAddedVertexList() Get the added vertices for this particular vertex index from the previous superstep.
ImmutableClassesGiraphConfiguration	getConf() Return the configuration used by this object.
List<I>	getRemovedEdgeList() Get the removed edges by their destination vertex index.
int	getRemovedVertexCount() Get the number of times this vertex was removed in the previous superstep.
void	readFields(DataInput input)
void	removeEdge(I destinationVertexId) Remove an edge on this vertex
void	removeVertex() Removed a vertex mutation (increments a count)
void	setConf(ImmutableClassesGiraphConfiguration conf) Set the configuration to be used by this object.
String	toString()
void	write(DataOutput output)

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexMutations

public VertexMutations()

Method Detail

copy

public VertexMutations<I,V,E> copy()

Copy the vertex mutations.

Returns:

Copied vertex mutations

getAddedVertexList

public List<Vertex<I,V,E>> getAddedVertexList()

Description copied from interface: VertexChanges

Get the added vertices for this particular vertex index from the previous superstep.

Specified by:

getAddedVertexList in interface VertexChanges<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

List of vertices for this vertex index.

readFields

public void readFields(DataInput input)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

write

public void write(DataOutput output)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

addVertex

public void addVertex(Vertex<I,V,E> vertex)

Add a vertex mutation

Parameters:

vertex - Vertex to be added

getRemovedVertexCount

public int getRemovedVertexCount()

Description copied from interface: VertexChanges

Get the number of times this vertex was removed in the previous superstep.

Specified by:

getRemovedVertexCount in interface VertexChanges<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

Count of time this vertex was removed in the previous superstep

removeVertex

public void removeVertex()

Removed a vertex mutation (increments a count)

getAddedEdgeList

public List<Edge<I,E>> getAddedEdgeList()

Description copied from interface: VertexChanges

Get the added edges for this particular vertex index from the previous superstep

Specified by:

getAddedEdgeList in interface VertexChanges<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

List of added edges for this vertex index

addEdge

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

Add an edge to this vertex

Parameters:

edge - Edge to be added

getRemovedEdgeList

public List<I> getRemovedEdgeList()

Description copied from interface: VertexChanges

Get the removed edges by their destination vertex index.

Specified by:

getRemovedEdgeList in interface VertexChanges<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

List of destination edges for removal from this vertex index

removeEdge

public void removeEdge(I destinationVertexId)

Remove an edge on this vertex

Parameters:

destinationVertexId - Vertex index of the destination of the edge

addVertexMutations

public void addVertexMutations(VertexMutations<I,V,E> vertexMutations)

Add one vertex mutations to another

Parameters:

vertexMutations - Object to be added

toString

public String toString()

Overrides:

toString in class Object

getConf

public ImmutableClassesGiraphConfiguration getConf()

Description copied from interface: ImmutableClassesGiraphConfigurable

Return the configuration used by this object.

Specified by:

getConf in interface ImmutableClassesGiraphConfigurable

Returns:

Set configuration

setConf

public void setConf(ImmutableClassesGiraphConfiguration conf)

Description copied from interface: GiraphConfigurationSettable

Set the configuration to be used by this object.

Specified by:

setConf in interface GiraphConfigurationSettable

Parameters:

conf - Set configuration