org.hawkular.inventory.impl.tinkerpop

Class DrainedRangeFilterPipe<S>

java.lang.Object

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

org.hawkular.inventory.impl.tinkerpop.DrainedRangeFilterPipe<S>

All Implemented Interfaces:

com.tinkerpop.pipes.filter.FilterPipe<S>, com.tinkerpop.pipes.Pipe<S,S>, Iterable<S>, Iterator<S>

public class DrainedRangeFilterPipe<S>
extends com.tinkerpop.pipes.AbstractPipe<S,S>
implements com.tinkerpop.pipes.filter.FilterPipe<S>

This is almost the same as the RangeFilterPipe in Tinkerpop with the difference being that the pipe is always fully drained even if the elements being processed would be out of range of this filter.

This is useful in scenarios where you want all the elements processed by the previous pipes in the pipeline but you don't want elements out of the range be present in the final result. Example use case is getting the total of elements while at the same time filtering out a subset of them in a single query.

Since:

0.0.2

Author:

Lukas Krejci

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

Method Summary

Modifier and Type	Method and Description
int	getHighRange()
int	getLowRange()
protected S	processNextStart()
void	reset()
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

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

DrainedRangeFilterPipe

public DrainedRangeFilterPipe(int low,
                              int high)

Method Detail

processNextStart

protected S processNextStart()

Specified by:

processNextStart in class com.tinkerpop.pipes.AbstractPipe<S,S>

toString

public String toString()

Overrides:

toString in class com.tinkerpop.pipes.AbstractPipe<S,S>

reset

public void reset()

Specified by:

reset in interface com.tinkerpop.pipes.Pipe<S,S>

Overrides:

reset in class com.tinkerpop.pipes.AbstractPipe<S,S>

getHighRange

public int getHighRange()

getLowRange

public int getLowRange()