org.apache.giraph.graph

Class DefaultVertexResolver<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.conf.DefaultImmutableClassesGiraphConfigurable<I,V,E>

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

Type Parameters:

I - Vertex id

V - Vertex data

E - Edge data

All Implemented Interfaces:

GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>, VertexResolver<I,V,E>

public class DefaultVertexResolver<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends DefaultImmutableClassesGiraphConfigurable<I,V,E>
implements VertexResolver<I,V,E>

Default implementation of how to resolve vertex creation/removal, messages to nonexistent vertices, etc.

Constructor Summary

Constructors

Constructor and Description
DefaultVertexResolver()

Method Summary

Modifier and Type	Method and Description
protected void	addEdges(Vertex<I,V,E> vertex, VertexChanges<I,V,E> vertexChanges) Add edges to the Vertex.
protected Vertex<I,V,E>	addVertexIfDesired(I vertexId, Vertex<I,V,E> vertex, VertexChanges<I,V,E> vertexChanges, boolean hasMessages) Add the Vertex if desired.
protected boolean	hasEdgeAdditions(VertexChanges<I,V,E> changes) Check if changes contain edge addition requests
protected boolean	hasEdgeRemovals(VertexChanges<I,V,E> changes) Check if changes contain edge removal requests
protected boolean	hasVertexAdditions(VertexChanges<I,V,E> changes) Check if changes contain vertex addition requests
protected boolean	hasVertexRemovals(VertexChanges<I,V,E> changes) Check if changes contain vertex removal requests
protected void	removeEdges(Vertex<I,V,E> vertex, VertexChanges<I,V,E> vertexChanges) Remove edges as specifed in changes given.
protected Vertex<I,V,E>	removeVertexIfDesired(Vertex<I,V,E> vertex, VertexChanges<I,V,E> vertexChanges) Remove the vertex itself if the changes desire it.
Vertex<I,V,E>	resolve(I vertexId, Vertex<I,V,E> vertex, VertexChanges<I,V,E> vertexChanges, boolean hasMessages) A vertex may have been removed, created zero or more times and had zero or more messages sent to it.
void	setConf(ImmutableClassesGiraphConfiguration<I,V,E> conf) Set the configuration to be used by this object.

Methods inherited from class org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable

getConf

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVertexResolver

public DefaultVertexResolver()

Method Detail

resolve

public Vertex<I,V,E> resolve(I vertexId,
                             Vertex<I,V,E> vertex,
                             VertexChanges<I,V,E> vertexChanges,
                             boolean hasMessages)

Description copied from interface: VertexResolver

A vertex may have been removed, created zero or more times and had zero or more messages sent to it. This method will handle all situations excluding the normal case (a vertex already exists and has zero or more messages sent it to).

Specified by:

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

Parameters:

vertexId - Vertex id (can be used for Vertex's initialize())

vertex - Original vertex or null if none

vertexChanges - Changes that happened to this vertex or null if none

hasMessages - True iff vertex received messages in the last superstep

Returns:

Vertex to be returned, if null, and a vertex currently exists it will be removed

removeEdges

protected void removeEdges(Vertex<I,V,E> vertex,
                           VertexChanges<I,V,E> vertexChanges)

Remove edges as specifed in changes given.

Parameters:

vertex - Vertex to remove edges from

vertexChanges - contains list of edges to remove.

removeVertexIfDesired

protected Vertex<I,V,E> removeVertexIfDesired(Vertex<I,V,E> vertex,
                                              VertexChanges<I,V,E> vertexChanges)

Remove the vertex itself if the changes desire it. The actual removal is notified by returning null. That is, this method does not do the actual removal but rather returns null if it should be done.

Parameters:

vertex - Vertex to remove.

vertexChanges - specifies if we should remove vertex

Returns:

null if vertex should be removed, otherwise the vertex itself.

addVertexIfDesired

protected Vertex<I,V,E> addVertexIfDesired(I vertexId,
                                           Vertex<I,V,E> vertex,
                                           VertexChanges<I,V,E> vertexChanges,
                                           boolean hasMessages)

Add the Vertex if desired. Returns the vertex itself, or null if no vertex added.

Parameters:

vertexId - ID of vertex

vertex - Vertex, if not null just returns it as vertex already exists

vertexChanges - specifies if we should add the vertex

hasMessages - true if this vertex received any messages

Returns:

Vertex created or passed in, or null if no vertex should be added

addEdges

protected void addEdges(Vertex<I,V,E> vertex,
                        VertexChanges<I,V,E> vertexChanges)

Add edges to the Vertex.

Parameters:

vertex - Vertex to add edges to

vertexChanges - contains edges to add

hasVertexRemovals

protected boolean hasVertexRemovals(VertexChanges<I,V,E> changes)

Check if changes contain vertex removal requests

Parameters:

changes - VertexChanges to check

Returns:

true if changes contains vertex removal requests

hasVertexAdditions

protected boolean hasVertexAdditions(VertexChanges<I,V,E> changes)

Check if changes contain vertex addition requests

Parameters:

changes - VertexChanges to check

Returns:

true if changes contains vertex addition requests

hasEdgeAdditions

protected boolean hasEdgeAdditions(VertexChanges<I,V,E> changes)

Check if changes contain edge addition requests

Parameters:

changes - VertexChanges to check

Returns:

true if changes contains edge addition requests

hasEdgeRemovals

protected boolean hasEdgeRemovals(VertexChanges<I,V,E> changes)

Check if changes contain edge removal requests

Parameters:

changes - VertexChanges to check

Returns:

true if changes contains edge removal requests

setConf

public void setConf(ImmutableClassesGiraphConfiguration<I,V,E> conf)

Description copied from interface: GiraphConfigurationSettable

Set the configuration to be used by this object.

Specified by:

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

Overrides:

setConf in class DefaultImmutableClassesGiraphConfigurable<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

conf - Set configuration