org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect

Class TreeSideEffectStep.TreeSideEffectMapReduce

java.lang.Object

org.apache.tinkerpop.gremlin.process.computer.util.StaticMapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TreeSideEffectStep.TreeSideEffectMapReduce

All Implemented Interfaces:

Cloneable, MapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree>

Enclosing class:

TreeSideEffectStep<S>

public static final class TreeSideEffectStep.TreeSideEffectMapReduce
extends StaticMapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.computer.MapReduce

MapReduce.MapEmitter<K,V>, MapReduce.NullObject, MapReduce.ReduceEmitter<OK,OV>, MapReduce.Stage

Field Summary

Fields

Modifier and Type	Field and Description
static String	TREE_SIDE_EFFECT_STEP_SIDE_EFFECT_KEY

Fields inherited from interface org.apache.tinkerpop.gremlin.process.computer.MapReduce

MAP_REDUCE

Constructor Summary

Constructors

Constructor and Description
TreeSideEffectMapReduce(TreeSideEffectStep step)

Method Summary

Modifier and Type	Method and Description
void	combine(MapReduce.NullObject key, Iterator<Tree> values, MapReduce.ReduceEmitter<MapReduce.NullObject,Tree> emitter) The combine() method is logically executed at all "machines" in parallel.
boolean	doStage(MapReduce.Stage stage) A MapReduce job can be map-only, map-reduce-only, or map-combine-reduce.
Tree	generateFinalResult(Iterator<KeyValue<MapReduce.NullObject,Tree>> keyValues) The key/value pairs emitted by reduce() (or map() in a map-only job) can be iterated to generate a local JVM Java object.
String	getMemoryKey() The results of the MapReduce job are associated with a memory-key to ultimately be stored in Memory.
void	loadState(Graph graph, Configuration configuration) When it is necessary to load the state of a MapReduce job, this method is called.
void	map(Vertex vertex, MapReduce.MapEmitter<MapReduce.NullObject,Tree> emitter) The map() method is logically executed at all vertices in the graph in parallel.
void	reduce(MapReduce.NullObject key, Iterator<Tree> values, MapReduce.ReduceEmitter<MapReduce.NullObject,Tree> emitter) The reduce() method is logically on the "machine" the respective key hashes to.
void	storeState(Configuration configuration) When it is necessary to store the state of a MapReduce job, this method is called.

Methods inherited from class org.apache.tinkerpop.gremlin.process.computer.util.StaticMapReduce

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.process.computer.MapReduce

addResultToMemory, createMapReduce, getMapKeySort, getReduceKeySort, workerEnd, workerStart

Field Detail

TREE_SIDE_EFFECT_STEP_SIDE_EFFECT_KEY

public static final String TREE_SIDE_EFFECT_STEP_SIDE_EFFECT_KEY

See Also:

Constant Field Values

Constructor Detail

TreeSideEffectMapReduce

public TreeSideEffectMapReduce(TreeSideEffectStep step)

Method Detail

storeState

public void storeState(Configuration configuration)

Description copied from interface: MapReduce

When it is necessary to store the state of a MapReduce job, this method is called. This is typically required when the MapReduce job needs to be serialized to another machine. Note that what is stored is simply the instance state, not any processed data.

Specified by:

storeState in interface MapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree>

Overrides:

storeState in class StaticMapReduce<MapReduce.NullObject,Tree,MapReduce.NullObject,Tree,Tree>

Parameters:

configuration - the configuration to store the state of the MapReduce job in.

loadState

public void loadState(Graph graph,
                      Configuration configuration)

Description copied from interface: MapReduce

When it is necessary to load the state of a MapReduce job, this method is called. This is typically required when the MapReduce job needs to be serialized to another machine. Note that what is loaded is simply the instance state, not any processed data.

It is important that the state loaded from loadState() is identical to any state created from a constructor. For those GraphComputers that do not need to use Configurations to migrate state between JVMs, the constructor will only be used.

Parameters:

graph - the graph the MapReduce job will run against

configuration - the configuration to load the state of the MapReduce job from.

doStage

public boolean doStage(MapReduce.Stage stage)

Description copied from interface: MapReduce

A MapReduce job can be map-only, map-reduce-only, or map-combine-reduce. Before executing the particular stage, this method is called to determine if the respective stage is defined. This method should return true if the respective stage as a non-default method implementation.

Parameters:

stage - the stage to check for definition.

Returns:

whether that stage should be executed.

map

public void map(Vertex vertex,
                MapReduce.MapEmitter<MapReduce.NullObject,Tree> emitter)

Description copied from interface: MapReduce

The map() method is logically executed at all vertices in the graph in parallel. The map() method emits key/value pairs given some analysis of the data in the vertices (and/or its incident edges).

Parameters:

vertex - the current vertex being map() processed.

emitter - the component that allows for key/value pairs to be emitted to the next stage.

combine

public void combine(MapReduce.NullObject key,
                    Iterator<Tree> values,
                    MapReduce.ReduceEmitter<MapReduce.NullObject,Tree> emitter)

Description copied from interface: MapReduce

The combine() method is logically executed at all "machines" in parallel. The combine() method pre-combines the values for a key prior to propagation over the wire. The combine() method must emit the same key/value pairs as the reduce() method. If there is a combine() implementation, there must be a reduce() implementation. If the MapReduce implementation is single machine, it can skip executing this method as reduce() is sufficient.

Parameters:

key - the key that has aggregated values

values - the aggregated values associated with the key

emitter - the component that allows for key/value pairs to be emitted to the reduce stage.

reduce

public void reduce(MapReduce.NullObject key,
                   Iterator<Tree> values,
                   MapReduce.ReduceEmitter<MapReduce.NullObject,Tree> emitter)

Description copied from interface: MapReduce

The reduce() method is logically on the "machine" the respective key hashes to. The reduce() method combines all the values associated with the key and emits key/value pairs.

Parameters:

key - the key that has aggregated values

values - the aggregated values associated with the key

emitter - the component that allows for key/value pairs to be emitted as the final result.

generateFinalResult

public Tree generateFinalResult(Iterator<KeyValue<MapReduce.NullObject,Tree>> keyValues)

Description copied from interface: MapReduce

The key/value pairs emitted by reduce() (or map() in a map-only job) can be iterated to generate a local JVM Java object.

Parameters:

keyValues - the key/value pairs that were emitted from reduce() (or map() in a map-only job)

Returns:

the resultant object formed from the emitted key/values.

getMemoryKey

public String getMemoryKey()

Description copied from interface: MapReduce

The results of the MapReduce job are associated with a memory-key to ultimately be stored in Memory.

Returns:

the memory key of the generated result object.