com.tinkerpop.pipes.transform

Class GatherFunctionPipe<S,E>

java.lang.Object

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

com.tinkerpop.pipes.transform.GatherFunctionPipe<S,E>

All Implemented Interfaces:

Pipe<S,E>, TransformPipe<S,E>, Iterable<E>, Iterator<E>

public class GatherFunctionPipe<S,E>
extends AbstractPipe<S,E>
implements TransformPipe<S,E>

GatherFunctionPipe emits all the objects up to this step as an ArrayList. This pipe is useful for doing breadth-first traversal where a List of all the current steps objects are gathered up. This gathered up List can then be filtered by the provided postFilterFunction and thus, a selective branch breadth-first traversal can be enacted.

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
GatherFunctionPipe(PipeFunction<List<S>,E> postFilterFunction)

Method Summary

Methods

Modifier and Type	Method and Description
List	getCurrentPath() Returns the transformation path to arrive at the current object of the pipe.
protected E	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

GatherFunctionPipe

public GatherFunctionPipe(PipeFunction<List<S>,E> postFilterFunction)

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

Overrides:

getCurrentPath in class AbstractPipe<S,E>

Returns:

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

processNextStart

protected E processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,E>

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

Overrides:

reset in class AbstractPipe<S,E>