com.tinkerpop.pipes.filter

Class RangeFilterPipe<S>

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The RangeFilterPipe will only allow a sequential subset of its incoming objects to be emitted to its output. This pipe can be provided -1 for both its high and low range to denote a wildcard for high and/or low. Note that -1 for both high and low is equivalent to the IdentityPipe.

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
RangeFilterPipe(int low, int high)

Method Summary

Methods

Modifier and Type	Method and Description
int	getHighRange()
int	getLowRange()
protected S	processNextStart()
void	reset() A pipe may maintain state.
String	toString()

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

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

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

RangeFilterPipe

public RangeFilterPipe(int low,
               int high)

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>

reset

public void reset()

Description copied from interface: Pipe

A pipe may maintain state. Reset is used to remove state. The general use case for reset() is to reuse a pipe in another computation without having to create a new Pipe object. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.

Specified by:

reset in interface Pipe<S,S>

Overrides:

reset in class AbstractPipe<S,S>

getHighRange

public int getHighRange()

getLowRange

public int getLowRange()