org.apache.giraph.block_app.framework.piece.messages

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

java.lang.Object

org.apache.giraph.writable.kryo.KryoWritable

org.apache.giraph.block_app.framework.piece.messages.ObjectMessageClasses<I,M>

Type Parameters:

I - Vertex id type

M - Message type

All Implemented Interfaces:

MessageClasses<I,M>, KryoIgnoreWritable, org.apache.hadoop.io.Writable

public class ObjectMessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>
extends KryoWritable
implements MessageClasses<I,M>

MessageClasses implementation that provides factory and combiner instances through a provided supplier.

Constructor Summary

Constructors

Constructor and Description
ObjectMessageClasses()
ObjectMessageClasses(Class<M> messageClass, SupplierFromConf<MessageValueFactory<M>> messageValueFactorySupplier, SupplierFromConf<? extends MessageCombiner<? super I,M>> messageCombinerSupplier, MessageEncodeAndStoreType messageEncodeAndStoreType, boolean ignoreExistingVertices)

Method Summary

Modifier and Type	Method and Description
MessageClasses<I,M>	createCopyForNewSuperstep() Creates a fresh copy of this object, to be used and changed for new superstep.
MessageCombiner<? super I,M>	createMessageCombiner(ImmutableClassesGiraphConfiguration<I,? extends org.apache.hadoop.io.Writable,? extends org.apache.hadoop.io.Writable> conf) Create new instance of MessageCombiner
MessageValueFactory<M>	createMessageValueFactory(ImmutableClassesGiraphConfiguration conf) Create new instance of MessageValueFactory
Class<M>	getMessageClass() Get message class
MessageEncodeAndStoreType	getMessageEncodeAndStoreType() Get MessageEncodeAndStoreType
boolean	ignoreExistingVertices() Whether to completely ignore existing vertices, and just process messages
boolean	useMessageCombiner() Has message combiner been specified
void	verifyConsistent(ImmutableClassesGiraphConfiguration conf) Verify if types are internally consistent

Methods inherited from class org.apache.giraph.writable.kryo.KryoWritable

readFields, write

Methods inherited from class java.lang.Object

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

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

readFields, write

Constructor Detail

ObjectMessageClasses

public ObjectMessageClasses()

ObjectMessageClasses

public ObjectMessageClasses(Class<M> messageClass,
                            SupplierFromConf<MessageValueFactory<M>> messageValueFactorySupplier,
                            SupplierFromConf<? extends MessageCombiner<? super I,M>> messageCombinerSupplier,
                            MessageEncodeAndStoreType messageEncodeAndStoreType,
                            boolean ignoreExistingVertices)

Method Detail

getMessageClass

public Class<M> getMessageClass()

Description copied from interface: MessageClasses

Get message class

Specified by:

getMessageClass in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

message class

createMessageValueFactory

public MessageValueFactory<M> createMessageValueFactory(ImmutableClassesGiraphConfiguration conf)

Description copied from interface: MessageClasses

Create new instance of MessageValueFactory

Specified by:

createMessageValueFactory in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

conf - Configuration

Returns:

message value factory

createMessageCombiner

public MessageCombiner<? super I,M> createMessageCombiner(ImmutableClassesGiraphConfiguration<I,? extends org.apache.hadoop.io.Writable,? extends org.apache.hadoop.io.Writable> conf)

Description copied from interface: MessageClasses

Create new instance of MessageCombiner

Specified by:

createMessageCombiner in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

conf - Configuration

Returns:

message combiner

useMessageCombiner

public boolean useMessageCombiner()

Description copied from interface: MessageClasses

Has message combiner been specified

Specified by:

useMessageCombiner in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

has message combiner been specified

ignoreExistingVertices

public boolean ignoreExistingVertices()

Description copied from interface: MessageClasses

Whether to completely ignore existing vertices, and just process messages

Specified by:

ignoreExistingVertices in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

ignoreExistingVertices

getMessageEncodeAndStoreType

public MessageEncodeAndStoreType getMessageEncodeAndStoreType()

Description copied from interface: MessageClasses

Get MessageEncodeAndStoreType

Specified by:

getMessageEncodeAndStoreType in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

message encode and store type

createCopyForNewSuperstep

public MessageClasses<I,M> createCopyForNewSuperstep()

Description copied from interface: MessageClasses

Creates a fresh copy of this object, to be used and changed for new superstep. (that should be independent from the previous one)

Specified by:

createCopyForNewSuperstep in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Returns:

message classes

verifyConsistent

public void verifyConsistent(ImmutableClassesGiraphConfiguration conf)

Description copied from interface: MessageClasses

Verify if types are internally consistent

Specified by:

verifyConsistent in interface MessageClasses<I extends org.apache.hadoop.io.WritableComparable,M extends org.apache.hadoop.io.Writable>

Parameters:

conf - Configuration