org.apache.giraph.utils

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

java.lang.Object

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

Type Parameters:

I - vertexId type

M - message type

All Implemented Interfaces:

VertexIdDataIterator<I,M>, VertexIdIterator<I>, VertexIdMessageIterator<I,M>

public class OneMessageToManyIdsIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>
extends Object
implements VertexIdMessageIterator<I,M>

VertexIdData iterator for ByteArrayOneMessageToManyIds

Constructor Summary

Constructors

Constructor and Description
OneMessageToManyIdsIterator(ByteArrayOneMessageToManyIds<I,M> vertexIdMessages) Constructor

Method Summary

Modifier and Type	Method and Description
M	getCurrentData() Get the current data.
int	getCurrentDataSize() Get serialized size of current data
M	getCurrentMessage() Get the current message.
int	getCurrentMessageSize() Get the serialized size of current message
I	getCurrentVertexId() Get the current vertex id.
boolean	hasNext() Returns true if the iteration has more elements.
boolean	isNewMessage() Return true of current message is new
void	next() Moves to the next element in the iteration.
M	releaseCurrentData() Release the current data object.
I	releaseCurrentVertexId() The backing store of the current vertex id is now released.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OneMessageToManyIdsIterator

public OneMessageToManyIdsIterator(ByteArrayOneMessageToManyIds<I,M> vertexIdMessages)

Constructor

Parameters:

vertexIdMessages - vertexId messages object to iterate over

Method Detail

getCurrentVertexId

public I getCurrentVertexId()

Description copied from interface: VertexIdIterator

Get the current vertex id. Ihis object's contents are only guaranteed until next() is called. To take ownership of this object call releaseCurrentVertexId() after getting a reference to this object.

Specified by:

getCurrentVertexId in interface VertexIdIterator<I extends org.apache.hadoop.io.WritableComparable>

Returns:

Current vertex id

getCurrentMessage

public M getCurrentMessage()

Description copied from interface: VertexIdMessageIterator

Get the current message.

Specified by:

getCurrentMessage in interface VertexIdMessageIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

Current message

getCurrentData

public M getCurrentData()

Description copied from interface: VertexIdDataIterator

Get the current data.

Specified by:

getCurrentData in interface VertexIdDataIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

Current data

releaseCurrentData

public M releaseCurrentData()

Description copied from interface: VertexIdDataIterator

Release the current data object.

Specified by:

releaseCurrentData in interface VertexIdDataIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

Released data object

releaseCurrentVertexId

public I releaseCurrentVertexId()

Description copied from interface: VertexIdIterator

The backing store of the current vertex id is now released. Further calls to getCurrentVertexId () without calling next() will return null.

Specified by:

releaseCurrentVertexId in interface VertexIdIterator<I extends org.apache.hadoop.io.WritableComparable>

Returns:

Current vertex id that was released

hasNext

public boolean hasNext()

Description copied from interface: VertexIdIterator

Returns true if the iteration has more elements.

Specified by:

hasNext in interface VertexIdIterator<I extends org.apache.hadoop.io.WritableComparable>

Returns:

True if the iteration has more elements.

next

public void next()

Description copied from interface: VertexIdIterator

Moves to the next element in the iteration.

Specified by:

next in interface VertexIdIterator<I extends org.apache.hadoop.io.WritableComparable>

getCurrentMessageSize

public int getCurrentMessageSize()

Description copied from interface: VertexIdMessageIterator

Get the serialized size of current message

Specified by:

getCurrentMessageSize in interface VertexIdMessageIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

serialized size of current message

getCurrentDataSize

public int getCurrentDataSize()

Description copied from interface: VertexIdDataIterator

Get serialized size of current data

Specified by:

getCurrentDataSize in interface VertexIdDataIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

serialized size of data

isNewMessage

public boolean isNewMessage()

Description copied from interface: VertexIdMessageIterator

Return true of current message is new

Specified by:

isNewMessage in interface VertexIdMessageIterator<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

true if current message is new