com.tinkerpop.pipes.util

Class AbstractMetaPipe<S,E>

java.lang.Object

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

com.tinkerpop.pipes.util.AbstractMetaPipe<S,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

AndFilterPipe, AsPipe, BackFilterPipe, CopySplitPipe, ExhaustMergePipe, FairMergePipe, FutureFilterPipe, HasNextPipe, LoopPipe, MemoizePipe, OptionalPipe, OrFilterPipe, SideEffectCapPipe

public abstract class AbstractMetaPipe<S,E>
extends AbstractPipe<S,E>
implements MetaPipe

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

Method Summary

Methods

Modifier and Type	Method and Description
void	enablePath(boolean enable) Calculating paths can be an expensive operation for some pipes.
void	reset() A pipe may maintain state.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

getCurrentPath, getPathToHere, hasNext, iterator, next, processNextStart, 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.util.MetaPipe

getPipes

Constructor Detail

AbstractMetaPipe

public AbstractMetaPipe()

Method Detail

enablePath

public void enablePath(boolean enable)

Description copied from interface: Pipe

Calculating paths can be an expensive operation for some pipes. This method is used to activate or deactivate the calculation of paths. The default state of a newly constructed pipe should have its path calculations disabled. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.

Specified by:

enablePath in interface Pipe<S,E>

Overrides:

enablePath in class AbstractPipe<S,E>

Parameters:

enable - enable path calculations

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>