com.tinkerpop.pipes.transform

Class SelectPipe<S>

java.lang.Object

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

com.tinkerpop.pipes.transform.SelectPipe<S>

All Implemented Interfaces:

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

public class SelectPipe<S>
extends AbstractPipe<S,Row>
implements TransformPipe<S,Row>

SelectPipe will emit a List of the objects that are at the respective 'as'-steps (i.e. partition steps) in the Pipeline. In this way, it is possible to isolate particular parts of the Pipeline for emission. If stepNames are provided the only those partition steps are emitted. If stepFunctions are provided then each object of the step is processed by the function prior to emission.

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
SelectPipe(Collection<String> stepNames, List<AsPipe> allPreviousAsPipes, PipeFunction... stepFunctions)

Method Summary

Methods

Modifier and Type	Method and Description
Row	processNextStart()
void	reset() A pipe may maintain state.
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

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

SelectPipe

public SelectPipe(Collection<String> stepNames,
          List<AsPipe> allPreviousAsPipes,
          PipeFunction... stepFunctions)

Method Detail

processNextStart

public Row processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,Row>

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

Overrides:

reset in class AbstractPipe<S,Row>

toString

public String toString()

Overrides:

toString in class AbstractPipe<S,Row>