com.tinkerpop.pipes.transform

Class PathPipe<S>

java.lang.Object

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

com.tinkerpop.pipes.transform.PathPipe<S>

All Implemented Interfaces:

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

public class PathPipe<S>
extends AbstractPipe<S,List>
implements TransformPipe<S,List>

PathPipe emits the path that the traverser has taken up to this object. If provided, the path functions are applied in a round robin fashion. As such, the number of functions need not equal the number of objects in the path. This pipe requires that path calculations be enabled. As such, when the start is set, enablePath(true) is invoked.

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
PathPipe(PipeFunction... pathFunctions)

Method Summary

Methods

Modifier and Type	Method and Description
List	processNextStart()
void	setStarts(Iterator<S> starts) Set an iterator of S objects to the head (start) of the pipe.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

enablePath, getCurrentPath, getPathToHere, hasNext, iterator, next, remove, reset, 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, reset, setStarts

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

PathPipe

public PathPipe(PipeFunction... pathFunctions)

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

Overrides:

setStarts in class AbstractPipe<S,List>

Parameters:

starts - the iterator of incoming objects

processNextStart

public List processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,List>