DefaultVertex (Apache Giraph Parent 1.4.0-SNAPSHOT API)

java.lang.Object
- org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable<I,V,E>
- - org.apache.giraph.graph.DefaultVertex<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>, Vertex<I,V,E>, Trimmable

Direct Known Subclasses:

ByteValueVertex
```
public class DefaultVertex
extends DefaultImmutableClassesGiraphConfigurable<I,V,E>
implements Vertex<I,V,E>, Trimmable
```
Class which holds vertex id, data and edges.

Constructor Summary

Constructors
Constructor and Description

DefaultVertex()

Constructors
Constructor and Description
`DefaultVertex()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEdge(Edge<I,E> edge)` Add an edge for this vertex (happens immediately)
`Iterable<E>`	`getAllEdgeValues(I targetVertexId)` Get an iterable over the values of all edges with the given target vertex id.
`Iterable<Edge<I,E>>`	`getEdges()` Get a read-only view of the out-edges of this vertex.
`E`	`getEdgeValue(I targetVertexId)` Return the value of the first edge with the given target vertex id, or null if there is no such edge.
`I`	`getId()` Get the vertex id.
`Iterable<MutableEdge<I,E>>`	`getMutableEdges()` Get an iterable of out-edges that can be modified in-place.
`int`	`getNumEdges()` Get the number of outgoing edges on this vertex.
`V`	`getValue()` Get the vertex value (data stored with vertex)
`void`	`initialize(I id, V value)` Initialize id and value.
`void`	`initialize(I id, V value, Iterable<Edge<I,E>> edges)` Initialize id, value, and edges.
`boolean`	`isHalted()` Is this vertex done?
`void`	`removeEdges(I targetVertexId)` Removes all edges pointing to the given vertex id.
`void`	`setEdges(Iterable<Edge<I,E>> edges)` Set the outgoing edges for this vertex.
`void`	`setEdgeValue(I targetVertexId, E edgeValue)` If an edge to the target vertex exists, set it to the given edge value.
`void`	`setValue(V value)` Set the vertex data (immediately visible in the computation)
`String`	`toString()`
`void`	`trim()` Compacts all recent updates to this object.
`void`	`unwrapMutableEdges()` If a `MutableEdgesWrapper` was used to provide a mutable iterator, copy any remaining edges to the new `OutEdges` data structure and keep a direct reference to it (thus discarding the wrapper).
`void`	`voteToHalt()` After this is called, the compute() code will no longer be called for this vertex unless a message is sent to it.
`void`	`wakeUp()` Re-activate vertex if halted.

Methods inherited from class org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable
getConf, setConf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

- Constructor Detail
 - DefaultVertex
```
public DefaultVertex()
```
- Method Detail
 - initialize
```
public void initialize(I id,
 V value,
 Iterable<Edge<I,E>> edges)
```
 Description copied from interface: Vertex
 
 Initialize id, value, and edges. This method (or the alternative form initialize(id, value)) must be called after instantiation, unless readFields() is called.
 
 Specified by:
 
 initialize in interface Vertex
 
 Parameters:
 
 id - Vertex id
 
 value - Vertex value
 
 edges - Iterable of edges
 - initialize
```
public void initialize(I id,
 V value)
```
 Description copied from interface: Vertex
 
 Initialize id and value. Vertex edges will be empty. This method (or the alternative form initialize(id, value, edges)) must be called after instantiation, unless readFields() is called.
 
 Specified by:
 
 initialize in interface Vertex
 
 Parameters:
 
 id - Vertex id
 
 value - Vertex value
 - setEdges
```
public void setEdges(Iterable<Edge<I,E>> edges)
```
 Description copied from interface: Vertex
 
 Set the outgoing edges for this vertex.
 
 Specified by:
 
 setEdges in interface Vertex
 
 Parameters:
 
 edges - Iterable of edges
 - getId
```
public I getId()
```
 Description copied from interface: Vertex
 
 Get the vertex id.
 
 Specified by:
 
 getId in interface Vertex
 
 Returns:
 
 My vertex id.
 - getValue
```
public V getValue()
```
 Description copied from interface: Vertex
 
 Get the vertex value (data stored with vertex)
 
 Specified by:
 
 getValue in interface Vertex
 
 Returns:
 
 Vertex value
 - setValue
```
public void setValue(V value)
```
 Description copied from interface: Vertex
 
 Set the vertex data (immediately visible in the computation)
 
 Specified by:
 
 setValue in interface Vertex
 
 Parameters:
 
 value - Vertex data to be set
 - getEdges
```
public Iterable<Edge<I,E>> getEdges()
```
 Description copied from interface: Vertex
 
 Get a read-only view of the out-edges of this vertex. Note: edge objects returned by this iterable may be invalidated as soon as the next element is requested. Thus, keeping a reference to an edge almost always leads to undesired behavior. Accessing the edges with other methods (e.g., addEdge()) during iteration leads to undefined behavior.
 
 Specified by:
 
 getEdges in interface Vertex
 
 Returns:
 
 the out edges (sort order determined by subclass implementation).
 - getMutableEdges
```
public Iterable<MutableEdge<I,E>> getMutableEdges()
```
 Description copied from interface: Vertex
 
 Get an iterable of out-edges that can be modified in-place. This can mean changing the current edge value or removing the current edge (by using the iterator version). Note: accessing the edges with other methods (e.g., addEdge()) during iteration leads to undefined behavior.
 
 Specified by:
 
 getMutableEdges in interface Vertex
 
 Returns:
 
 An iterable of mutable out-edges
 - unwrapMutableEdges
```
public void unwrapMutableEdges()
```
 Description copied from interface: Vertex
 
 If a MutableEdgesWrapper was used to provide a mutable iterator, copy any remaining edges to the new OutEdges data structure and keep a direct reference to it (thus discarding the wrapper). Called by the Giraph infrastructure after computation.
 
 Specified by:
 
 unwrapMutableEdges in interface Vertex
 - getNumEdges
```
public int getNumEdges()
```
 Description copied from interface: Vertex
 
 Get the number of outgoing edges on this vertex.
 
 Specified by:
 
 getNumEdges in interface Vertex
 
 Returns:
 
 the total number of outbound edges from this vertex
 - getEdgeValue
```
public E getEdgeValue(I targetVertexId)
```
 Description copied from interface: Vertex
 
 Return the value of the first edge with the given target vertex id, or null if there is no such edge. Note: edge value objects returned by this method may be invalidated by the next call. Thus, keeping a reference to an edge value almost always leads to undesired behavior.
 
 Specified by:
 
 getEdgeValue in interface Vertex
 
 Parameters:
 
 targetVertexId - Target vertex id
 
 Returns:
 
 Edge value (or null if missing)
 - setEdgeValue
```
public void setEdgeValue(I targetVertexId,
 E edgeValue)
```
 Description copied from interface: Vertex
 
 If an edge to the target vertex exists, set it to the given edge value. This only makes sense with strict graphs.
 
 Specified by:
 
 setEdgeValue in interface Vertex
 
 Parameters:
 
 targetVertexId - Target vertex id
 
 edgeValue - Edge value
 - getAllEdgeValues
```
public Iterable<E> getAllEdgeValues(I targetVertexId)
```
 Description copied from interface: Vertex
 
 Get an iterable over the values of all edges with the given target vertex id. This only makes sense for multigraphs (i.e. graphs with parallel edges). Note: edge value objects returned by this method may be invalidated as soon as the next element is requested. Thus, keeping a reference to an edge value almost always leads to undesired behavior.
 
 Specified by:
 
 getAllEdgeValues in interface Vertex
 
 Parameters:
 
 targetVertexId - Target vertex id
 
 Returns:
 
 Iterable of edge values
 - voteToHalt
```
public void voteToHalt()
```
 Description copied from interface: Vertex
 
 After this is called, the compute() code will no longer be called for this vertex unless a message is sent to it. Then the compute() code will be called once again until this function is called. The application finishes only when all vertices vote to halt.
 
 Specified by:
 
 voteToHalt in interface Vertex
 - wakeUp
```
public void wakeUp()
```
 Description copied from interface: Vertex
 
 Re-activate vertex if halted.
 
 Specified by:
 
 wakeUp in interface Vertex
 - isHalted
```
public boolean isHalted()
```
 Description copied from interface: Vertex
 
 Is this vertex done?
 
 Specified by:
 
 isHalted in interface Vertex
 
 Returns:
 
 True if halted, false otherwise.
 - trim
```
public void trim()
```
 Description copied from interface: Trimmable
 
 Compacts all recent updates to this object.
 
 Specified by:
 
 trim in interface Trimmable
 - addEdge
```
public void addEdge(Edge<I,E> edge)
```
 Description copied from interface: Vertex
 
 Add an edge for this vertex (happens immediately)
 
 Specified by:
 
 addEdge in interface Vertex
 
 Parameters:
 
 edge - Edge to add
 - removeEdges
```
public void removeEdges(I targetVertexId)
```
 Description copied from interface: Vertex
 
 Removes all edges pointing to the given vertex id.
 
 Specified by:
 
 removeEdges in interface Vertex
 
 Parameters:
 
 targetVertexId - the target vertex id
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DefaultVertex

Method Detail

initialize

initialize

setEdges

getId

getValue

setValue

getEdges

getMutableEdges

unwrapMutableEdges

getNumEdges

getEdgeValue

setEdgeValue

getAllEdgeValues

voteToHalt

wakeUp

isHalted

trim

addEdge

removeEdges

toString