org.apache.giraph.conf

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

java.lang.Object

org.apache.giraph.conf.DefaultMessageClasses<I,M>

Type Parameters:

I - Vertex id type

M - Message type

All Implemented Interfaces:

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

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

Default implementation of MessageClasses

Constructor Summary

Constructors

Constructor and Description
DefaultMessageClasses() Constructor
DefaultMessageClasses(Class<M> messageClass, Class<? extends MessageValueFactory<M>> messageValueFactoryClass, Class<? extends MessageCombiner<? super I,M>> messageCombinerClass, MessageEncodeAndStoreType messageEncodeAndStoreType) Constructor

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 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
void	readFields(DataInput in)
void	setIfNotModifiedMessageClass(Class<M> messageClass) Set message class if not set already in this superstep
void	setMessageClass(Class<M> messageClass) Set message class
void	setMessageCombinerClass(Class<? extends MessageCombiner<? super I,M>> messageCombinerClass)
void	setMessageEncodeAndStoreType(MessageEncodeAndStoreType messageEncodeAndStoreType)
void	setMessageValueFactoryClass(Class<? extends MessageValueFactory<M>> messageValueFactoryClass)
boolean	useMessageCombiner() Has message combiner been specified
void	verifyConsistent(ImmutableClassesGiraphConfiguration conf) Verify if types are internally consistent
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMessageClasses

public DefaultMessageClasses()

Constructor

DefaultMessageClasses

public DefaultMessageClasses(Class<M> messageClass,
                             Class<? extends MessageValueFactory<M>> messageValueFactoryClass,
                             Class<? extends MessageCombiner<? super I,M>> messageCombinerClass,
                             MessageEncodeAndStoreType messageEncodeAndStoreType)

Constructor

Parameters:

messageClass - message class

messageValueFactoryClass - message value factory class

messageCombinerClass - message combiner class

messageEncodeAndStoreType - message encode and store type

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

setMessageClass

public void setMessageClass(Class<M> messageClass)

Set message class

Parameters:

messageClass - message classs

setIfNotModifiedMessageClass

public void setIfNotModifiedMessageClass(Class<M> messageClass)

Set message class if not set already in this superstep

Parameters:

messageClass - message class

setMessageCombinerClass

public void setMessageCombinerClass(Class<? extends MessageCombiner<? super I,M>> messageCombinerClass)

setMessageValueFactoryClass

public void setMessageValueFactoryClass(Class<? extends MessageValueFactory<M>> messageValueFactoryClass)

setMessageEncodeAndStoreType

public void setMessageEncodeAndStoreType(MessageEncodeAndStoreType messageEncodeAndStoreType)

write

public void write(DataOutput out)
           throws IOException

Specified by:

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

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

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

Throws:

IOException