com.tinkerpop.pipes.sideeffect

Class TreePipe<S>

java.lang.Object

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

com.tinkerpop.pipes.sideeffect.TreePipe<S>

All Implemented Interfaces:

Pipe<S,S>, SideEffectPipe<S,Map>, SideEffectPipe.GreedySideEffectPipe<S,Map>, Iterable<S>, Iterator<S>

public class TreePipe<S>
extends AbstractPipe<S,S>
implements SideEffectPipe.GreedySideEffectPipe<S,Map>

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.sideeffect.SideEffectPipe

SideEffectPipe.GreedySideEffectPipe<S,T>, SideEffectPipe.LazySideEffectPipe<S,T>

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
TreePipe(PipeFunction... branchFunctions)
TreePipe(Tree tree, PipeFunction... branchFunctions)

Method Summary

Methods

Modifier and Type	Method and Description
Map	getSideEffect()
S	processNextStart()
void	reset() A pipe may maintain state.
void	setStarts(Iterator<S> starts) Set an iterator of S objects to the head (start) of the pipe.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

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

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

TreePipe

public TreePipe(PipeFunction... branchFunctions)

TreePipe

public TreePipe(Tree tree,
        PipeFunction... branchFunctions)

Method Detail

setStarts

public void setStarts(Iterator<S> starts)

Description copied from interface: Pipe

Set an iterator of S objects to the head (start) of the pipe.

Specified by:

setStarts in interface Pipe<S,S>

Overrides:

setStarts in class AbstractPipe<S,S>

Parameters:

starts - the iterator of incoming objects

processNextStart

public S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>

getSideEffect

public Map getSideEffect()

Specified by:

getSideEffect in interface SideEffectPipe<S,Map>

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>