com.tinkerpop.pipes.transform

Class ScatterPipe<S,E>

java.lang.Object

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

com.tinkerpop.pipes.transform.ScatterPipe<S,E>

All Implemented Interfaces:

Pipe<S,E>, TransformPipe<S,E>, Iterable<E>, Iterator<E>

public class ScatterPipe<S,E>
extends AbstractPipe<S,E>
implements TransformPipe<S,E>

ScatterPipe will unroll any iterator/iterable/map that is provided to it. This will only occur for one level deep. In other words, it will not unroll an iterator within an iterator.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.transform.TransformPipe

TransformPipe.Order

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
ScatterPipe()

Method Summary

Methods

Modifier and Type	Method and Description
E	processNextStart()
void	reset() A pipe may maintain state.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

enablePath, getCurrentPath, getPathToHere, hasNext, iterator, next, remove, setStarts, setStarts, setStarts, toString

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

ScatterPipe

public ScatterPipe()

Method Detail

processNextStart

public E processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,E>

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,E>

Overrides:

reset in class AbstractPipe<S,E>