org.apache.giraph.utils

Class ByteArrayOneMessageToManyIds<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.ByteArrayOneMessageToManyIds<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 ByteArrayOneMessageToManyIds<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>
extends ByteArrayVertexIdData<I,M>
implements VertexIdMessages<I,M>

Stores a message and a list of target vertex ids.

Field Summary

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

extendedDataOutput

Constructor Summary

Constructors

Constructor and Description
ByteArrayOneMessageToManyIds(MessageValueFactory<M> messageValueFactory) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(byte[] ids, int idPos, int count, M msg) Add a message.
void	add(byte[] serializedId, int idPos, M data) Add a serialized vertex id and data.
void	add(I vertexId, M data) Add a vertex id and data pair to the collection.
M	createData() Create a new data object.
VertexIdMessageBytesIterator<I,M>	getVertexIdMessageBytesIterator() Get specialized iterator that will instantiate the vertex id and message of this object.
VertexIdMessageIterator<I,M>	getVertexIdMessageIterator() Get specialized iterator that will instiantiate the vertex id and message of this object.
void	readData(ExtendedDataInput in, M message) Read a data object's fields from an ExtendedDataInput.
void	writeData(ExtendedDataOutput out, M message) Write a data object to an ExtendedDataOutput.

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

getByteArray, readFields, write

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

clear, getConf, getSerializedSize, getSize, getVertexIdDataIterator, initialize, initialize, 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, initialize, initialize, isEmpty

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

Constructor Detail

ByteArrayOneMessageToManyIds

public ByteArrayOneMessageToManyIds(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

add

public void add(byte[] ids,
                int idPos,
                int count,
                M msg)

Add a message. The order is: the message > id count > ids .

Parameters:

ids - The byte array which holds target ids of this message on the worker

idPos - The end position of the ids information in the byte array above.

count - The number of ids

msg - The message sent

add

public void add(I vertexId,
                M data)

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

data - Data

add

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

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.

data - Data

getVertexIdMessageBytesIterator

public VertexIdMessageBytesIterator<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

getVertexIdMessageIterator

public VertexIdMessageIterator<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