com.tinkerpop.pipes.filter

Class PropertyFilterPipe<S extends com.tinkerpop.blueprints.Element,T>

java.lang.Object

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

com.tinkerpop.pipes.filter.PropertyFilterPipe<S,T>

All Implemented Interfaces:

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

public class PropertyFilterPipe<S extends com.tinkerpop.blueprints.Element,T>
extends AbstractPipe<S,S>
implements FilterPipe<S>

The PropertyFilterPipe either allows or disallows all Elements that have the provided value for a particular key.

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
PropertyFilterPipe(String key, com.tinkerpop.blueprints.Predicate predicate, Object value)

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey()
com.tinkerpop.blueprints.Predicate	getPredicate()
Object	getValue()
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

PropertyFilterPipe

public PropertyFilterPipe(String key,
                  com.tinkerpop.blueprints.Predicate predicate,
                  Object value)

Method Detail

processNextStart

protected S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S extends com.tinkerpop.blueprints.Element,S extends com.tinkerpop.blueprints.Element>

toString

public String toString()

Overrides:

toString in class AbstractPipe<S extends com.tinkerpop.blueprints.Element,S extends com.tinkerpop.blueprints.Element>

getKey

public String getKey()

getValue

public Object getValue()

getPredicate

public com.tinkerpop.blueprints.Predicate getPredicate()