com.tinkerpop.pipes.filter

Class FilterFunctionPipe<S>

java.lang.Object

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

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

All Implemented Interfaces:

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

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

FilterFunctionPipe is a generic filter pipe. It takes a PipeFunction that returns a Boolean for its compute() step. The argument is the next start of the pipe. If the return is true, then start is emitted. Otherwise, the start is not emitted.

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
FilterFunctionPipe(PipeFunction<S,Boolean> filterFunction)

Method Summary

Methods

Modifier and Type	Method and Description
S	processNextStart()

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

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

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

FilterFunctionPipe

public FilterFunctionPipe(PipeFunction<S,Boolean> filterFunction)

Method Detail

processNextStart

public S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>