MutableEdgesWrapper (Apache Giraph Parent 1.4.0-SNAPSHOT API)

java.lang.Object
- org.apache.giraph.edge.MutableEdgesWrapper<I,E>

Type Parameters:

I - Vertex id

E - Edge value

All Implemented Interfaces:

Iterable<Edge<I,E>>, OutEdges<I,E>, org.apache.hadoop.io.Writable
```
public class MutableEdgesWrapper
extends Object
implements OutEdges<I,E>
```
Helper class that wraps the current out-edges and inserts them into a new data structure as they are iterated over. Used by Vertex to provide a mutable iterator when the chosen OutEdges doesn't offer a specialized one. The edges are "unwrapped" back to the chosen OutEdges data structure as soon as possible: either when the iterator is exhausted, or after compute() if iteration has been terminated early.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Edge<I,E> edge)` Add an edge.
`void`	`decrementEdges()` Decrement the number of edges (to account for a deletion from the mutable iterator).
`MutableEdge<I,E>`	`getCurrentEdge()` Get the last edge returned by the mutable iterator.
`OutEdges<I,E>`	`getNewEdges()` Get the new `OutEdges` data structure.
`Iterator<Edge<I,E>>`	`getOldEdgesIterator()` Get the iterator over the old edges data structure.
`void`	`initialize()` Initialize the data structure with the default initial capacity.
`void`	`initialize(int capacity)` Initialize the data structure with the specified initial capacity.
`void`	`initialize(Iterable<Edge<I,E>> edges)` Initialize the data structure and set the edges from an iterable.
`Iterator<Edge<I,E>>`	`iterator()`
`void`	`readFields(DataInput in)`
`void`	`remove(I targetVertexId)` Remove all edges to the given target vertex.
`void`	`setCurrentEdge(MutableEdge<I,E> edge)` Set the last edge returned by the mutable iterator.
`int`	`size()` Return the number of edges.
`OutEdges<I,E>`	`unwrap()` Moves all the remaining edges to the new data structure, and returns it.
`static <I extends org.apache.hadoop.io.WritableComparable,E extends org.apache.hadoop.io.Writable> MutableEdgesWrapper<I,E>`	`wrap(OutEdges<I,E> edges, ImmutableClassesGiraphConfiguration<I,?,E> conf)` Factory method to create a new wrapper over the existing out-edges.
`void`	`write(DataOutput out)`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
 - wrap
```
public static  MutableEdgesWrapper<I,E> wrap(OutEdges<I,E> edges,
 ImmutableClassesGiraphConfiguration<I,?,E> conf)
```
 Factory method to create a new wrapper over the existing out-edges.
 
 Type Parameters:
 
 I - Vertex id
 
 E - Edge value
 
 Parameters:
 
 edges - Current out-edges
 
 conf - Configuration
 
 Returns:
 
 The wrapped edges
 - unwrap
```
public OutEdges<I,E> unwrap()
```
 Moves all the remaining edges to the new data structure, and returns it.
 
 Returns:
 
 The new OutEdges data structure.
 - getNewEdges
```
public OutEdges<I,E> getNewEdges()
```
 Get the new OutEdges data structure.
 
 Returns:
 
 New edges
 - getOldEdgesIterator
```
public Iterator<Edge<I,E>> getOldEdgesIterator()
```
 Get the iterator over the old edges data structure.
 
 Returns:
 
 Old edges iterator
 - getCurrentEdge
```
public MutableEdge<I,E> getCurrentEdge()
```
 Get the last edge returned by the mutable iterator.
 
 Returns:
 
 Last edge iterated on
 - setCurrentEdge
```
public void setCurrentEdge(MutableEdge<I,E> edge)
```
 Set the last edge returned by the mutable iterator.
 
 Parameters:
 
 edge - Last edge iterated on
 - decrementEdges
```
public void decrementEdges()
```
 Decrement the number of edges (to account for a deletion from the mutable iterator).
 - initialize
```
public void initialize(Iterable<Edge<I,E>> edges)
```
 Description copied from interface: OutEdges
 
 Initialize the data structure and set the edges from an iterable. This method (or one of the two alternatives) must be called after instantiation, unless readFields() is called. Note: whether parallel edges are allowed or not depends on the implementation.
 
 Specified by:
 
 initialize in interface OutEdges
 
 Parameters:
 
 edges - Iterable of edges
 - initialize
```
public void initialize(int capacity)
```
 Description copied from interface: OutEdges
 
 Initialize the data structure with the specified initial capacity. This method (or one of the two alternatives) must be called after instantiation, unless readFields() is called.
 
 Specified by:
 
 initialize in interface OutEdges
 
 Parameters:
 
 capacity - Initial capacity
 - initialize
```
public void initialize()
```
 Description copied from interface: OutEdges
 
 Initialize the data structure with the default initial capacity. This method (or one of the two alternatives) must be called after instantiation, unless readFields() is called.
 
 Specified by:
 
 initialize in interface OutEdges
 - add
```
public void add(Edge<I,E> edge)
```
 Description copied from interface: OutEdges
 
 Add an edge. Note: whether parallel edges are allowed or not depends on the implementation.
 
 Specified by:
 
 add in interface OutEdges
 
 Parameters:
 
 edge - Edge to add
 - remove
```
public void remove(I targetVertexId)
```
 Description copied from interface: OutEdges
 
 Remove all edges to the given target vertex. Note: the implementation will vary depending on whether parallel edges are allowed or not.
 
 Specified by:
 
 remove in interface OutEdges
 
 Parameters:
 
 targetVertexId - Target vertex id
 - size
```
public int size()
```
 Description copied from interface: OutEdges
 
 Return the number of edges.
 
 Specified by:
 
 size in interface OutEdges
 
 Returns:
 
 Number of edges
 - iterator
```
public Iterator<Edge<I,E>> iterator()
```
 Specified by:
 
 iterator in interface Iterable<Edge>
 - write
```
public void write(DataOutput out)
 throws IOException
```
 Specified by:
 
 write in interface org.apache.hadoop.io.Writable
 
 Throws:
 
 IOException
 - readFields
```
public void readFields(DataInput in)
 throws IOException
```
 Specified by:
 
 readFields in interface org.apache.hadoop.io.Writable
 
 Throws:
 
 IOException

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

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

wrap

unwrap

getNewEdges

getOldEdgesIterator

getCurrentEdge

setCurrentEdge

decrementEdges

initialize

initialize

initialize

add

remove

size

iterator

write

readFields