ByteArrayPartition (Apache Giraph Parent 1.4.0-SNAPSHOT API)

java.lang.Object
- org.apache.giraph.partition.BasicPartition<I,V,E>
- - org.apache.giraph.partition.ByteArrayPartition<I,V,E>

Type Parameters:

I - Vertex index value

V - Vertex value

E - Edge value

All Implemented Interfaces:

Iterable<Vertex<I,V,E>>, GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>, Partition<I,V,E>, ReusesObjectsPartition<I,V,E>, org.apache.hadoop.io.Writable
```
@NotThreadSafe
public class ByteArrayPartition
extends BasicPartition<I,V,E>
implements ReusesObjectsPartition<I,V,E>
```
Byte array based partition. Should reduce the amount of memory used since the entire graph is compressed into byte arrays. Must guarantee, however, that only one thread at a time will call getVertex since it is a singleton.

Constructor Summary

Constructors
Constructor and Description

ByteArrayPartition()
Constructor for reflection.

Constructors
Constructor and Description
`ByteArrayPartition()` Constructor for reflection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPartition(Partition<I,V,E> partition)` Add a partition's vertices.
`long`	`getEdgeCount()` Get the number of edges in this partition.
`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.
`Iterator<Vertex<I,V,E>>`	`iterator()`
`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
`void`	`readFields(DataInput input)`
`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`	`write(DataOutput output)`

Methods inherited from class org.apache.giraph.partition.BasicPartition
addPartitionVertices, getConf, getId, getVertexValueCombiner, progress, setConf, setId, setProgressable

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

Methods inherited from interface org.apache.giraph.partition.Partition
addPartitionVertices, getId, progress, setId, setProgressable

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, spliterator

- Constructor Detail
 - ByteArrayPartition
```
public ByteArrayPartition()
```
 Constructor for reflection.
- Method Detail
 - initialize
```
public void initialize(int partitionId,
 org.apache.hadoop.util.Progressable progressable)
```
 Description copied from interface: Partition
 
 Initialize the partition. Guaranteed to be called before used.
 
 Specified by:
 
 initialize in interface Partition
 
 Overrides:
 
 initialize in class BasicPartition
 
 Parameters:
 
 partitionId - Partition id
 
 progressable - Progressable to call progress
 - getVertex
```
public Vertex<I,V,E> getVertex(I vertexIndex)
```
 Description copied from interface: Partition
 
 Get the vertex for this vertex index.
 
 Specified by:
 
 getVertex in interface Partition
 
 Parameters:
 
 vertexIndex - Vertex index to search for
 
 Returns:
 
 Vertex if it exists, null otherwise
 - putVertex
```
public Vertex<I,V,E> putVertex(Vertex<I,V,E> vertex)
```
 Description copied from interface: Partition
 
 Put a vertex into the Partition
 
 Specified by:
 
 putVertex in interface Partition
 
 Parameters:
 
 vertex - Vertex to put in the Partition
 
 Returns:
 
 old vertex value (i.e. null if none existed prior)
 - removeVertex
```
public Vertex<I,V,E> removeVertex(I vertexIndex)
```
 Description copied from interface: Partition
 
 Remove a vertex from the Partition
 
 Specified by:
 
 removeVertex in interface Partition
 
 Parameters:
 
 vertexIndex - Vertex index to remove
 
 Returns:
 
 The removed vertex.
 - addPartition
```
public void addPartition(Partition<I,V,E> partition)
```
 Description copied from interface: 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.
 
 Specified by:
 
 addPartition in interface Partition
 
 Parameters:
 
 partition - Partition to add
 - putOrCombine
```
public boolean putOrCombine(Vertex<I,V,E> vertex)
```
 Description copied from interface: Partition
 
 Put this vertex or combine it
 
 Specified by:
 
 putOrCombine in interface Partition
 
 Parameters:
 
 vertex - Vertex to put or combine
 
 Returns:
 
 True if the vertex was put (hint to release object)
 - getVertexCount
```
public long getVertexCount()
```
 Description copied from interface: Partition
 
 Get the number of vertices in this partition
 
 Specified by:
 
 getVertexCount in interface Partition
 
 Returns:
 
 Number of vertices
 - getEdgeCount
```
public long getEdgeCount()
```
 Description copied from interface: Partition
 
 Get the number of edges in this partition.
 
 Specified by:
 
 getEdgeCount in interface Partition
 
 Returns:
 
 Number of edges.
 - saveVertex
```
public void saveVertex(Vertex<I,V,E> vertex)
```
 Description copied from interface: Partition
 
 Save potentially modified vertex back to the partition.
 
 Specified by:
 
 saveVertex in interface Partition
 
 Parameters:
 
 vertex - Vertex to save
 - write
```
public void write(DataOutput output)
 throws IOException
```
 Specified by:
 
 write in interface org.apache.hadoop.io.Writable
 
 Overrides:
 
 write in class BasicPartition
 
 Throws:
 
 IOException
 - readFields
```
public void readFields(DataInput input)
 throws IOException
```
 Specified by:
 
 readFields in interface org.apache.hadoop.io.Writable
 
 Overrides:
 
 readFields in class BasicPartition
 
 Throws:
 
 IOException
 - iterator
```
public Iterator<Vertex<I,V,E>> iterator()
```
 Specified by:
 
 iterator in interface Iterable<Vertex>

Class ByteArrayPartition<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.partition.BasicPartition

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.giraph.partition.Partition

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

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

Methods inherited from interface java.lang.Iterable

Constructor Detail

ByteArrayPartition

Method Detail

initialize

getVertex

putVertex

removeVertex

addPartition

putOrCombine

getVertexCount

getEdgeCount

saveVertex

write

readFields

iterator