com.tinkerpop.pipes.filter

Class CyclicPathFilterPipe<S>

java.lang.Object

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

com.tinkerpop.pipes.filter.CyclicPathFilterPipe<S>

All Implemented Interfaces:

FilterPipe<S>, Pipe<S,S>, Iterable<S>, Iterator<S>

public class CyclicPathFilterPipe<S>
extends AbstractPipe<S,S>
implements FilterPipe<S>

CyclicPathFilterPipe will only emit an object if its transformation path has no repeats (loops) in it. 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)

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
CyclicPathFilterPipe()

Method Summary

Methods

Modifier and Type	Method and Description
S	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

CyclicPathFilterPipe

public CyclicPathFilterPipe()

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

Overrides:

setStarts in class AbstractPipe<S,S>

Parameters:

starts - the iterator of incoming objects

processNextStart

public S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>