com.tinkerpop.pipes.transform

Class SideEffectCapPipe<S,T>

java.lang.Object

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

com.tinkerpop.pipes.util.AbstractMetaPipe<S,T>

com.tinkerpop.pipes.transform.SideEffectCapPipe<S,T>

All Implemented Interfaces:

Pipe<S,T>, TransformPipe<S,T>, MetaPipe, Iterable<T>, Iterator<T>

public class SideEffectCapPipe<S,T>
extends AbstractMetaPipe<S,T>
implements MetaPipe, TransformPipe<S,T>

The SideEffectCapPipe will yield an E that is the side effect of the provided SideEffectPipe. This is useful for when the side effect of a Pipe is desired in a computational stream. Note that LazySideEffectPipes are handled differently from GreedySideEffectPipes.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.transform.TransformPipe

TransformPipe.Order

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
SideEffectCapPipe(SideEffectPipe<S,T> pipeToCap)

Method Summary

Methods

Modifier and Type	Method and Description
List	getCurrentPath() Returns the transformation path to arrive at the current object of the pipe.
List<Pipe>	getPipes()
protected T	processNextStart()
void	reset() A pipe may maintain state.
void	setStarts(Iterator<S> starts) Set an iterator of S objects to the head (start) of the pipe.
String	toString()

Methods inherited from class com.tinkerpop.pipes.util.AbstractMetaPipe

enablePath

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

getPathToHere, hasNext, iterator, next, remove, setStarts, setStarts

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

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

SideEffectCapPipe

public SideEffectCapPipe(SideEffectPipe<S,T> pipeToCap)

Method Detail

setStarts

public void setStarts(Iterator<S> starts)

Description copied from interface: Pipe

Set an iterator of S objects to the head (start) of the pipe.

Specified by:

setStarts in interface Pipe<S,T>

Overrides:

setStarts in class AbstractPipe<S,T>

Parameters:

starts - the iterator of incoming objects

processNextStart

protected T processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,T>

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,T>

Overrides:

getCurrentPath in class AbstractPipe<S,T>

Returns:

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

toString

public String toString()

Overrides:

toString in class AbstractPipe<S,T>

getPipes

public List<Pipe> getPipes()

Specified by:

getPipes in interface MetaPipe

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,T>

Overrides:

reset in class AbstractMetaPipe<S,T>