com.tinkerpop.pipes.filter

Class RandomFilterPipe<S>

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The RandomFilterPipe filters out objects that pass through it using a biased coin. For each passing object, a random number generator creates a double value between 0 and 1. If the randomly generated double is less than or equal the provided bias, then the object is allowed to pass. If the randomly generated double is greater than the provided bias, then the object is not allowed to pass.

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
RandomFilterPipe(double bias)

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

RandomFilterPipe

public RandomFilterPipe(double bias)

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>