org.apache.giraph.utils

Interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,T>

Type Parameters:

I - vertexId type parameter

T - vertexData type parameter

All Superinterfaces:

GiraphConfigurationSettable, ImmutableClassesGiraphConfigurable, org.apache.hadoop.io.Writable

All Known Subinterfaces:

VertexIdEdges<I,E>, VertexIdMessages<I,M>

All Known Implementing Classes:

AbstractVertexIdData, ByteArrayOneMessageToManyIds, ByteArrayVertexIdData, ByteArrayVertexIdEdges, ByteArrayVertexIdMessages

public interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,T>
extends ImmutableClassesGiraphConfigurable, org.apache.hadoop.io.Writable

Stores vertex ids and data associated with a vertex

Method Summary

Modifier and Type	Method and Description
void	add(byte[] serializedId, int idPos, T data) Add a serialized vertex id and data.
void	add(I vertexId, T data) Add a vertex id and data pair to the collection.
void	clear() Clear the list.
T	createData() Create a new data object.
int	getSerializedSize() Get the size of this object in serialized form.
int	getSize() Get the number of bytes used.
VertexIdDataIterator<I,T>	getVertexIdDataIterator() Get an iterator over the pairs.
void	initialize() Initialize the inner state.
void	initialize(int expectedSize) Initialize the inner state, with a known size.
boolean	isEmpty() Check if the list is empty.
void	readData(ExtendedDataInput in, T data) Read a data object's fields from an ExtendedDataInput.
void	writeData(ExtendedDataOutput out, T data) Write a data object to an ExtendedDataOutput.

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

getConf

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

setConf

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Method Detail

createData

T createData()

Create a new data object.

Returns:

Newly-created data object.

writeData

void writeData(ExtendedDataOutput out,
               T data)
        throws IOException

Write a data object to an ExtendedDataOutput.

Parameters:

out - ExtendedDataOutput

data - Data object to write

Throws:

IOException

readData

void readData(ExtendedDataInput in,
              T data)
       throws IOException

Read a data object's fields from an ExtendedDataInput.

Parameters:

in - ExtendedDataInput

data - Data object to fill in-place

Throws:

IOException

initialize

void initialize()

Initialize the inner state. Must be called before add() is called.

initialize

void initialize(int expectedSize)

Initialize the inner state, with a known size. Must be called before add() is called.

Parameters:

expectedSize - Number of bytes to be expected

add

void add(I vertexId,
         T data)

Add a vertex id and data pair to the collection.

Parameters:

vertexId - Vertex id

data - Data

add

void add(byte[] serializedId,
         int idPos,
         T data)

Add a serialized vertex id and data.

Parameters:

serializedId - The bye array which holds the serialized id.

idPos - The end position of the serialized id in the byte array.

data - Data

getSize

int getSize()

Get the number of bytes used.

Returns:

Bytes used

getSerializedSize

int getSerializedSize()

Get the size of this object in serialized form.

Returns:

The size (in bytes) of the serialized object

isEmpty

boolean isEmpty()

Check if the list is empty.

Returns:

Whether the list is empty

clear

void clear()

Clear the list.

getVertexIdDataIterator

VertexIdDataIterator<I,T> getVertexIdDataIterator()

Get an iterator over the pairs.

Returns:

Iterator