org.apache.giraph.master

Class SuperstepClasses

java.lang.Object

org.apache.giraph.master.SuperstepClasses

All Implemented Interfaces:

org.apache.hadoop.io.Writable

public class SuperstepClasses
extends Object
implements org.apache.hadoop.io.Writable

Holds Computation and MessageCombiner class.

Constructor Summary

Constructors

Constructor and Description
SuperstepClasses(ImmutableClassesGiraphConfiguration conf, Class<? extends Computation> computationClass, MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> incomingMessageClasses, MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> outgoingMessageClasses) Constructor

Method Summary

Modifier and Type	Method and Description
static SuperstepClasses	createAndExtractTypes(ImmutableClassesGiraphConfiguration conf) Create superstep classes by initiazling from current state in configuration
static SuperstepClasses	createToRead(ImmutableClassesGiraphConfiguration conf) Create empty superstep classes, readFields needs to be called afterwards
Class<? extends Computation>	getComputationClass()
Class<? extends MessageCombiner>	getMessageCombinerClass() Get message combiner class
MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable>	getOutgoingMessageClasses()
void	readFields(DataInput input)
void	setComputationClass(Class<? extends Computation> computationClass) Set computation class
void	setIncomingMessageClass(Class<? extends org.apache.hadoop.io.Writable> incomingMessageClass) Deprecated.
void	setMessageCombinerClass(Class<? extends MessageCombiner> messageCombinerClass) Set message combiner class.
void	setOutgoingMessageClass(Class<? extends org.apache.hadoop.io.Writable> outgoingMessageClass) Set outgoing message class.
void	setOutgoingMessageClasses(MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> outgoingMessageClasses) Set's outgoing MessageClasses for next superstep.
String	toString()
void	updateGiraphClasses(GiraphClasses classes) Update GiraphClasses with updated types
void	verifyTypesMatch(boolean checkMatchingMesssageTypes) Verify that types of current Computation and MessageCombiner are valid.
void	write(DataOutput output)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperstepClasses

public SuperstepClasses(ImmutableClassesGiraphConfiguration conf,
                        Class<? extends Computation> computationClass,
                        MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> incomingMessageClasses,
                        MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> outgoingMessageClasses)

Constructor

Parameters:

conf - Configuration

computationClass - computation class

incomingMessageClasses - incoming message classes

outgoingMessageClasses - outgoing message classes

Method Detail

createToRead

public static SuperstepClasses createToRead(ImmutableClassesGiraphConfiguration conf)

Create empty superstep classes, readFields needs to be called afterwards

Parameters:

conf - Configuration

Returns:

Superstep classes

createAndExtractTypes

public static SuperstepClasses createAndExtractTypes(ImmutableClassesGiraphConfiguration conf)

Create superstep classes by initiazling from current state in configuration

Parameters:

conf - Configuration

Returns:

Superstep classes

getComputationClass

public Class<? extends Computation> getComputationClass()

getOutgoingMessageClasses

public MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> getOutgoingMessageClasses()

setOutgoingMessageClasses

public void setOutgoingMessageClasses(MessageClasses<? extends org.apache.hadoop.io.WritableComparable,? extends org.apache.hadoop.io.Writable> outgoingMessageClasses)

Set's outgoing MessageClasses for next superstep. Should not be used together with setMessageCombinerClass/setOutgoingMessageClass methods.

Parameters:

outgoingMessageClasses - outgoing message classes

setComputationClass

public void setComputationClass(Class<? extends Computation> computationClass)

Set computation class

Parameters:

computationClass - computation class

setMessageCombinerClass

public void setMessageCombinerClass(Class<? extends MessageCombiner> messageCombinerClass)

Set message combiner class. Should not be used together setOutgoingMessageClasses (throws exception if called with it), as it is unnecessary to do so.

Parameters:

messageCombinerClass - message combiner class

setIncomingMessageClass

@Deprecated
public void setIncomingMessageClass(Class<? extends org.apache.hadoop.io.Writable> incomingMessageClass)

Deprecated.

Set incoming message class

Parameters:

incomingMessageClass - incoming message class

setOutgoingMessageClass

public void setOutgoingMessageClass(Class<? extends org.apache.hadoop.io.Writable> outgoingMessageClass)

Set outgoing message class. Should not be used together setOutgoingMessageClasses (throws exception if called with it), as it is unnecessary to do so.

Parameters:

outgoingMessageClass - outgoing message class

getMessageCombinerClass

public Class<? extends MessageCombiner> getMessageCombinerClass()

Get message combiner class

Returns:

message combiner class

verifyTypesMatch

public void verifyTypesMatch(boolean checkMatchingMesssageTypes)

Verify that types of current Computation and MessageCombiner are valid. If types don't match an IllegalStateException will be thrown.

Parameters:

checkMatchingMesssageTypes - Check that the incoming/outgoing message types match

updateGiraphClasses

public void updateGiraphClasses(GiraphClasses classes)

Update GiraphClasses with updated types

Parameters:

classes - Giraph classes

write

public void write(DataOutput output)
           throws IOException

Specified by:

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

Throws:

IOException

readFields

public void readFields(DataInput input)
                throws IOException

Specified by:

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

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object