com.tinkerpop.pipes.util

Class AsPipe<S,E>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class AsPipe<S,E>
extends AbstractMetaPipe<S,E>
implements MetaPipe

An AsPipe wraps a Pipe and provides it a name and 'peak back' access to the last emitted end.

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
AsPipe(String name, Pipe<S,E> pipe)

Method Summary

Methods

Modifier and Type	Method and Description
E	getCurrentEnd()
String	getName()
protected List	getPathToHere()
List<Pipe>	getPipes()
E	processNextStart()
void	setStarts(Iterator<S> starts) Set an iterator of S objects to the head (start) of the pipe.
String	toString()

Methods inherited from class com.tinkerpop.pipes.util.AbstractMetaPipe

enablePath, reset

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

getCurrentPath, hasNext, iterator, next, remove, setStarts, setStarts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AsPipe

public AsPipe(String name,
      Pipe<S,E> pipe)

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

Overrides:

setStarts in class AbstractPipe<S,E>

Parameters:

starts - the iterator of incoming objects

getPathToHere

protected List getPathToHere()

Overrides:

getPathToHere in class AbstractPipe<S,E>

getCurrentEnd

public E getCurrentEnd()

getName

public String getName()

processNextStart

public E processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,E>

getPipes

public List<Pipe> getPipes()

Specified by:

getPipes in interface MetaPipe

toString

public String toString()

Overrides:

toString in class AbstractPipe<S,E>