org.apache.giraph.block_app.framework

Class BlockUtils

java.lang.Object

org.apache.giraph.block_app.framework.BlockUtils

public class BlockUtils
extends Object

Utility functions for block applications

Field Summary

Fields

Modifier and Type	Field and Description
static ClassConfOption<BlockFactory>	BLOCK_FACTORY_CLASS Property describing BlockFactory to use for current application run
static ClassConfOption<Object>	BLOCK_WORKER_CONTEXT_VALUE_CLASS Property describing block worker context value class to use
static BooleanConfOption	LOG_EXECUTION_STATUS Property describing whether to log execution status as application runs

Method Summary

Modifier and Type	Method and Description
static void	checkBlockTypes(Block executionBlock, Object executionStage, ImmutableClassesGiraphConfiguration conf)
static <S> BlockFactory<S>	createBlockFactory(org.apache.hadoop.conf.Configuration conf) Create new BlockFactory that is specified in the configuration.
static void	initAndCheckConfig(GiraphConfiguration conf) Initializes configuration, such that running it executes block application.
static void	setAndInitBlockFactoryClass(GiraphConfiguration conf, Class<? extends BlockFactory<?>> clazz) Set block factory, and initialize configs with it.
static void	setBlockFactoryClass(org.apache.hadoop.conf.Configuration conf, Class<? extends BlockFactory<?>> clazz) Set which BlockFactory class to be used for the application.

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK_FACTORY_CLASS

public static final ClassConfOption<BlockFactory> BLOCK_FACTORY_CLASS

Property describing BlockFactory to use for current application run

BLOCK_WORKER_CONTEXT_VALUE_CLASS

public static final ClassConfOption<Object> BLOCK_WORKER_CONTEXT_VALUE_CLASS

Property describing block worker context value class to use

LOG_EXECUTION_STATUS

public static final BooleanConfOption LOG_EXECUTION_STATUS

Property describing whether to log execution status as application runs

Method Detail

createBlockFactory

public static <S> BlockFactory<S> createBlockFactory(org.apache.hadoop.conf.Configuration conf)

Create new BlockFactory that is specified in the configuration.

setBlockFactoryClass

public static void setBlockFactoryClass(org.apache.hadoop.conf.Configuration conf,
                                        Class<? extends BlockFactory<?>> clazz)

Set which BlockFactory class to be used for the application. (generally useful within tests only)

setAndInitBlockFactoryClass

public static void setAndInitBlockFactoryClass(GiraphConfiguration conf,
                                               Class<? extends BlockFactory<?>> clazz)

Set block factory, and initialize configs with it. Should be used only if there are no configuration options set after this method call.

initAndCheckConfig

public static void initAndCheckConfig(GiraphConfiguration conf)

Initializes configuration, such that running it executes block application. Additionally, checks types of all pieces with a block application.

checkBlockTypes

public static void checkBlockTypes(Block executionBlock,
                                   Object executionStage,
                                   ImmutableClassesGiraphConfiguration conf)