org.apache.giraph.master

Interface MasterAggregatorUsage

All Superinterfaces:

AggregatorUsage

All Known Subinterfaces:

BlockMasterApi

All Known Implementing Classes:

AggregatorsBenchmark.AggregatorsBenchmarkMasterCompute, AggregatorsTestComputation.AggregatorsTestMasterCompute, AggregatorToGlobalCommTranslation, BlockMasterCompute, DefaultMasterCompute, MasterCompute, PageRankWithKryoSimpleWritable.PageRankWithKryoMasterCompute, RandomMessageBenchmark.RandomMessageBenchmarkMasterCompute, RandomWalkVertexMasterCompute, ReducersBenchmark.ReducersBenchmarkMasterCompute, SccPhaseMasterCompute, SimpleCheckpoint.SimpleCheckpointVertexMasterCompute, SimpleMasterComputeComputation.SimpleMasterCompute, SimplePageRankComputation.SimplePageRankMasterCompute, VerifyMessage.VerifyMessageMasterCompute

public interface MasterAggregatorUsage
extends AggregatorUsage

Master compute can access and change aggregators through this interface

Method Summary

Modifier and Type	Method and Description
<A extends org.apache.hadoop.io.Writable> boolean	registerAggregator(String name, Class<? extends Aggregator<A>> aggregatorClass) Register an aggregator in preSuperstep() and/or preApplication().
<A extends org.apache.hadoop.io.Writable> boolean	registerPersistentAggregator(String name, Class<? extends Aggregator<A>> aggregatorClass) Register persistent aggregator in preSuperstep() and/or preApplication().
<A extends org.apache.hadoop.io.Writable> void	setAggregatedValue(String name, A value) Sets value of an aggregator.

Methods inherited from interface org.apache.giraph.aggregators.AggregatorUsage

getAggregatedValue

Method Detail

registerAggregator

<A extends org.apache.hadoop.io.Writable> boolean registerAggregator(String name,
                                                                     Class<? extends Aggregator<A>> aggregatorClass)
                                                              throws InstantiationException,
                                                                     IllegalAccessException

Register an aggregator in preSuperstep() and/or preApplication(). This aggregator will have its value reset at the end of each super step.

Type Parameters:

A - Aggregator type

Parameters:

name - of aggregator

aggregatorClass - Class type of the aggregator

Returns:

True iff aggregator wasn't already registered

Throws:

InstantiationException

IllegalAccessException

registerPersistentAggregator

<A extends org.apache.hadoop.io.Writable> boolean registerPersistentAggregator(String name,
                                                                               Class<? extends Aggregator<A>> aggregatorClass)
                                                                        throws InstantiationException,
                                                                               IllegalAccessException

Register persistent aggregator in preSuperstep() and/or preApplication(). This aggregator will not reset value at the end of super step.

Type Parameters:

A - Aggregator type

Parameters:

name - of aggregator

aggregatorClass - Class type of the aggregator

Returns:

True iff aggregator wasn't already registered

Throws:

InstantiationException

IllegalAccessException

setAggregatedValue

<A extends org.apache.hadoop.io.Writable> void setAggregatedValue(String name,
                                                                  A value)

Sets value of an aggregator.

Type Parameters:

A - Aggregated value

Parameters:

name - Name of aggregator

value - Value to set