org.apache.giraph.utils

Class ByteArrayVertexIdMessages<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.giraph.utils.AbstractVertexIdData<I,T>

org.apache.giraph.utils.ByteArrayVertexIdData<I,M>

org.apache.giraph.utils.ByteArrayVertexIdMessages<I,M>

Type Parameters:

I - Vertex id

M - Message data

All Implemented Interfaces:

GiraphConfigurationSettable, ImmutableClassesGiraphConfigurable, VertexIdData<I,M>, VertexIdMessages<I,M>, org.apache.hadoop.io.Writable

public class ByteArrayVertexIdMessages<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>
extends ByteArrayVertexIdData<I,M>
implements VertexIdMessages<I,M>

Stores vertex id and message pairs in a single byte array.

Field Summary

Fields inherited from class org.apache.giraph.utils.AbstractVertexIdData

extendedDataOutput

Constructor Summary

Constructors

Constructor and Description
ByteArrayVertexIdMessages(MessageValueFactory<M> messageValueFactory) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(byte[] serializedId, int idPos, M message) Add a serialized vertex id and data.
void	add(I vertexId, M message) Add a vertex id and data pair to the collection.
M	createData() Create a new data object.
ByteStructVertexIdMessageBytesIterator<I,M>	getVertexIdMessageBytesIterator() Get specialized iterator that will instantiate the vertex id and message of this object.
ByteStructVertexIdMessageIterator<I,M>	getVertexIdMessageIterator() Get specialized iterator that will instiantiate the vertex id and message of this object.
void	initialize() Initialize the inner state.
void	initialize(int expectedSize) Initialize the inner state, with a known size.
void	readData(ExtendedDataInput in, M message) Read a data object's fields from an ExtendedDataInput.
void	readFields(DataInput dataInput)
void	write(DataOutput dataOutput)
void	writeData(ExtendedDataOutput out, M message) Write a data object to an ExtendedDataOutput.

Methods inherited from class org.apache.giraph.utils.ByteArrayVertexIdData

getByteArray

Methods inherited from class org.apache.giraph.utils.AbstractVertexIdData

clear, getConf, getSerializedSize, getSize, getVertexIdDataIterator, isEmpty, setConf

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.utils.VertexIdData

clear, getSerializedSize, getSize, getVertexIdDataIterator, isEmpty

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

getConf

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

setConf

Constructor Detail

ByteArrayVertexIdMessages

public ByteArrayVertexIdMessages(MessageValueFactory<M> messageValueFactory)

Constructor

Parameters:

messageValueFactory - Class for messages

Method Detail

createData

public M createData()

Description copied from interface: VertexIdData

Create a new data object.

Specified by:

createData in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

Newly-created data object.

writeData

public void writeData(ExtendedDataOutput out,
                      M message)
               throws IOException

Description copied from interface: VertexIdData

Write a data object to an ExtendedDataOutput.

Specified by:

writeData in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

out - ExtendedDataOutput

message - Data object to write

Throws:

IOException

readData

public void readData(ExtendedDataInput in,
                     M message)
              throws IOException

Description copied from interface: VertexIdData

Read a data object's fields from an ExtendedDataInput.

Specified by:

readData in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

in - ExtendedDataInput

message - Data object to fill in-place

Throws:

IOException

initialize

public void initialize()

Description copied from interface: VertexIdData

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

Specified by:

initialize in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Overrides:

initialize in class AbstractVertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

initialize

public void initialize(int expectedSize)

Description copied from interface: VertexIdData

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

Specified by:

initialize in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Overrides:

initialize in class AbstractVertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

expectedSize - Number of bytes to be expected

getVertexIdMessageIterator

public ByteStructVertexIdMessageIterator<I,M> getVertexIdMessageIterator()

Description copied from interface: VertexIdMessages

Get specialized iterator that will instiantiate the vertex id and message of this object.

Specified by:

getVertexIdMessageIterator in interface VertexIdMessages<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

Special iterator that reuses vertex ids and messages unless specified

add

public void add(I vertexId,
                M message)

Description copied from interface: VertexIdData

Add a vertex id and data pair to the collection.

Specified by:

add in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Overrides:

add in class AbstractVertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

vertexId - Vertex id

message - Data

add

public void add(byte[] serializedId,
                int idPos,
                M message)

Description copied from interface: VertexIdData

Add a serialized vertex id and data.

Specified by:

add in interface VertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Overrides:

add in class AbstractVertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

serializedId - The bye array which holds the serialized id.

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

message - Data

getVertexIdMessageBytesIterator

public ByteStructVertexIdMessageBytesIterator<I,M> getVertexIdMessageBytesIterator()

Description copied from interface: VertexIdMessages

Get specialized iterator that will instantiate the vertex id and message of this object. It will only produce message bytes, not actual messages and expects a different encoding.

Specified by:

getVertexIdMessageBytesIterator in interface VertexIdMessages<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

Special iterator that reuses vertex ids (unless released) and copies message bytes

write

public void write(DataOutput dataOutput)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Overrides:

write in class ByteArrayVertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Throws:

IOException

readFields

public void readFields(DataInput dataInput)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Overrides:

readFields in class ByteArrayVertexIdData<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Throws:

IOException