org.apache.giraph.block_app.framework

Class AbstractBlockFactory<S>

java.lang.Object

org.apache.giraph.block_app.framework.AbstractBlockFactory<S>

Type Parameters:

S - Execution stage type

All Implemented Interfaces:

BlockFactory<S>

Direct Known Subclasses:

MigrationFullBlockFactory

public abstract class AbstractBlockFactory<S>
extends Object
implements BlockFactory<S>

Default block factory abstract class, providing default methods that need to be/can be overridden for specifying required/most common parameters, to simplify setting properties.

Field Summary

Fields

Modifier and Type	Field and Description
static StrConfOption	CONFIGURATORS Comma separated list of BulkConfigurators, that are going to be called to simplify specifying of large number of properties.

Constructor Summary

Constructors

Constructor and Description
AbstractBlockFactory()

Method Summary

Modifier and Type	Method and Description
protected void	additionalInitConfig(GiraphConfiguration conf) Additional configuration initialization, other then overriding class specification.
protected String[]	getConvenienceConfiguratorPackages() Provide list of strings representing packages where configurators will be searched for, allowing that full path is not required for CONFIGURATORS option.
protected abstract Class<? extends org.apache.hadoop.io.Writable>	getEdgeValueClass(GiraphConfiguration conf) Concrete edge value class application will use.
List<String>	getGcJavaOpts(org.apache.hadoop.conf.Configuration conf) Get special GC Java options.
protected abstract Class<? extends org.apache.hadoop.io.WritableComparable>	getVertexIDClass(GiraphConfiguration conf) Concrete vertex id class application will use.
protected abstract Class<? extends org.apache.hadoop.io.Writable>	getVertexValueClass(GiraphConfiguration conf) Concrete vertex value class application will use.
protected Class<?>	getWorkerContextValueClass(GiraphConfiguration conf) Concrete worker context value class application will use, if overridden.
void	initConfig(GiraphConfiguration conf) Based on provided configuration, updates it, such that all necessary properties are initialized.
void	registerOutputs(GiraphConfiguration conf) Register outputs to use during the application (vs output at the end of the application), based on provided configuration.
protected boolean	shouldCreateVertexOnMsgs(GiraphConfiguration conf) Override if vertices shouldn't be created by default, if message is sent to a vertex that doesn't exist.
protected boolean	shouldSendOneMessageToAll(GiraphConfiguration conf)

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.block_app.framework.BlockFactory

createBlock, createExecutionStage

Field Detail

CONFIGURATORS

public static final StrConfOption CONFIGURATORS

Comma separated list of BulkConfigurators, that are going to be called to simplify specifying of large number of properties.

Constructor Detail

AbstractBlockFactory

public AbstractBlockFactory()

Method Detail

getGcJavaOpts

public List<String> getGcJavaOpts(org.apache.hadoop.conf.Configuration conf)

Description copied from interface: BlockFactory

Get special GC Java options. If returns null, default options are used.

Specified by:

getGcJavaOpts in interface BlockFactory<S>

initConfig

public final void initConfig(GiraphConfiguration conf)

Description copied from interface: BlockFactory

Based on provided configuration, updates it, such that all necessary properties are initialized.

Specified by:

initConfig in interface BlockFactory<S>

registerOutputs

public void registerOutputs(GiraphConfiguration conf)

Description copied from interface: BlockFactory

Register outputs to use during the application (vs output at the end of the application), based on provided configuration.

Specified by:

registerOutputs in interface BlockFactory<S>

additionalInitConfig

protected void additionalInitConfig(GiraphConfiguration conf)

Additional configuration initialization, other then overriding class specification.

getVertexIDClass

protected abstract Class<? extends org.apache.hadoop.io.WritableComparable> getVertexIDClass(GiraphConfiguration conf)

Concrete vertex id class application will use.

getVertexValueClass

protected abstract Class<? extends org.apache.hadoop.io.Writable> getVertexValueClass(GiraphConfiguration conf)

Concrete vertex value class application will use.

getEdgeValueClass

protected abstract Class<? extends org.apache.hadoop.io.Writable> getEdgeValueClass(GiraphConfiguration conf)

Concrete edge value class application will use.

getWorkerContextValueClass

protected Class<?> getWorkerContextValueClass(GiraphConfiguration conf)

Concrete worker context value class application will use, if overridden.

shouldCreateVertexOnMsgs

protected boolean shouldCreateVertexOnMsgs(GiraphConfiguration conf)

Override if vertices shouldn't be created by default, if message is sent to a vertex that doesn't exist.

shouldSendOneMessageToAll

protected boolean shouldSendOneMessageToAll(GiraphConfiguration conf)

getConvenienceConfiguratorPackages

protected String[] getConvenienceConfiguratorPackages()

Provide list of strings representing packages where configurators will be searched for, allowing that full path is not required for CONFIGURATORS option.