com.tinkerpop.pipes.sideeffect

Class StorePipe<S>

java.lang.Object

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

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

All Implemented Interfaces:

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

public class StorePipe<S>
extends AbstractPipe<S,S>
implements SideEffectPipe.LazySideEffectPipe<S,Collection>

The StoragePipe yields its input, however, each input is added to the provided collection. If a PipeFunction is provided then it process the object and stores the result of that process. This pipe is similar to AggregatePipe except that is does not aggregate everything up to the current step. Instead, it fills the storage collection as objects pass through it.

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
StorePipe(Collection storage)
StorePipe(Collection storage, PipeFunction<S,?> preStoreFunction) The provided PipeFunction will process the object prior to inserting it into the storage collection.

Method Summary

Methods

Modifier and Type	Method and Description
Collection	getSideEffect()
protected S	processNextStart()
void	reset() A pipe may maintain state.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

enablePath, getCurrentPath, 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, getCurrentPath, setStarts, setStarts

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

StorePipe

public StorePipe(Collection storage)

StorePipe

public StorePipe(Collection storage,
         PipeFunction<S,?> preStoreFunction)

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

Parameters:

storage - the storage collection

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

Method Detail

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>