com.tinkerpop.pipes.sideeffect

Class AggregatePipe<S>

java.lang.Object

com.tinkerpop.pipes.AbstractPipe<S,S>

com.tinkerpop.pipes.sideeffect.AggregatePipe<S>

All Implemented Interfaces:

Pipe<S,S>, SideEffectPipe<S,Collection>, SideEffectPipe.GreedySideEffectPipe<S,Collection>, Iterable<S>, Iterator<S>

public class AggregatePipe<S>
extends AbstractPipe<S,S>
implements SideEffectPipe.GreedySideEffectPipe<S,Collection>

The AggregatePipe produces a side effect that is the provided Collection filled with the contents of all the objects that have passed through it. Before the first object is emitted from the AggregatePipe, all of its incoming objects have been aggregated into the collection. Finally, note that different Collections have different behaviors and write/read times.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.sideeffect.SideEffectPipe

SideEffectPipe.GreedySideEffectPipe<S,T>, SideEffectPipe.LazySideEffectPipe<S,T>

Field Summary

Fields inherited from class com.tinkerpop.pipes.AbstractPipe

currentEnd, pathEnabled, starts

Fields inherited from interface com.tinkerpop.pipes.Pipe

NO_PATH_MESSAGE

Constructor Summary

Constructors

Constructor and Description
AggregatePipe(Collection aggregate)
AggregatePipe(Collection aggregate, PipeFunction<S,?> preAggregateFunction) The provided PipeFunction will process the object prior to inserting it into the aggregate collection.

Method Summary

Methods

Modifier and Type	Method and Description
List	getCurrentPath() Returns the transformation path to arrive at the current object of the pipe.
Collection	getSideEffect()
protected S	processNextStart()
void	reset() A pipe may maintain state.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

enablePath, getPathToHere, hasNext, iterator, next, remove, setStarts, setStarts, setStarts, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.pipes.Pipe

enablePath, setStarts, setStarts

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

AggregatePipe

public AggregatePipe(Collection aggregate)

AggregatePipe

public AggregatePipe(Collection aggregate,
             PipeFunction<S,?> preAggregateFunction)

The provided PipeFunction will process the object prior to inserting it into the aggregate collection.

Parameters:

aggregate - the aggregate collection

preAggregateFunction - a function to process an object with prior to insertion into the collection

Method Detail

getCurrentPath

public List getCurrentPath()

Description copied from interface: Pipe

Returns the transformation path to arrive at the current object of the pipe.

Specified by:

getCurrentPath in interface Pipe<S,S>

Overrides:

getCurrentPath in class AbstractPipe<S,S>

Returns:

a List of all of the objects traversed for the current iterator position of the pipe.

processNextStart

protected S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>

getSideEffect

public Collection getSideEffect()

Specified by:

getSideEffect in interface SideEffectPipe<S,Collection>

reset

public void reset()

Description copied from interface: Pipe

A pipe may maintain state. Reset is used to remove state. The general use case for reset() is to reuse a pipe in another computation without having to create a new Pipe object. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.

Specified by:

reset in interface Pipe<S,S>

Overrides:

reset in class AbstractPipe<S,S>