com.tinkerpop.pipes.filter

Class CollectionFilterPipe<S>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ExceptFilterPipe, RetainFilterPipe

public abstract class CollectionFilterPipe<S>
extends AbstractPipe<S,S>
implements FilterPipe<S>

A CollectionFilterPipe will take a collection of objects and a Filter.NOT_EQUAL or Filter.EQUAL argument. If an incoming object is contained (or not contained) in the provided collection, then it is emitted (or 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
CollectionFilterPipe(Collection<S> storedCollection, com.tinkerpop.blueprints.Contains contains)
CollectionFilterPipe(com.tinkerpop.blueprints.Contains contains, AsMap asMap, String... namedSteps)

Method Summary

Methods

Modifier and Type	Method and Description
protected S	processNextStart()
String	toString()

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

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

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

CollectionFilterPipe

public CollectionFilterPipe(Collection<S> storedCollection,
                    com.tinkerpop.blueprints.Contains contains)

CollectionFilterPipe

public CollectionFilterPipe(com.tinkerpop.blueprints.Contains contains,
                    AsMap asMap,
                    String... namedSteps)

Method Detail

processNextStart

protected S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>

toString

public String toString()

Overrides:

toString in class AbstractPipe<S,S>