com.tinkerpop.pipes.sideeffect

Class LinkPipe

java.lang.Object

com.tinkerpop.pipes.AbstractPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>

com.tinkerpop.pipes.sideeffect.LinkPipe

All Implemented Interfaces:

Pipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>, SideEffectPipe<com.tinkerpop.blueprints.Vertex,Object>, SideEffectPipe.LazySideEffectPipe<com.tinkerpop.blueprints.Vertex,Object>, Iterable<com.tinkerpop.blueprints.Vertex>, Iterator<com.tinkerpop.blueprints.Vertex>

public class LinkPipe
extends AbstractPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>
implements SideEffectPipe.LazySideEffectPipe<com.tinkerpop.blueprints.Vertex,Object>

LinkPipe supports the creation of an edge between the current vertex in the pipe and some other vertex. That other vertex is either defined by an AsPipe or a specifically specified vertex.

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
LinkPipe(com.tinkerpop.blueprints.Direction direction, String label, AsPipe<?,com.tinkerpop.blueprints.Vertex> asPipe)
LinkPipe(com.tinkerpop.blueprints.Direction direction, String label, com.tinkerpop.blueprints.Vertex other)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getSideEffect()
protected com.tinkerpop.blueprints.Vertex	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

LinkPipe

public LinkPipe(com.tinkerpop.blueprints.Direction direction,
        String label,
        com.tinkerpop.blueprints.Vertex other)

LinkPipe

public LinkPipe(com.tinkerpop.blueprints.Direction direction,
        String label,
        AsPipe<?,com.tinkerpop.blueprints.Vertex> asPipe)

Method Detail

getSideEffect

public Object getSideEffect()

Specified by:

getSideEffect in interface SideEffectPipe<com.tinkerpop.blueprints.Vertex,Object>

processNextStart

protected com.tinkerpop.blueprints.Vertex processNextStart()

Specified by:

processNextStart in class AbstractPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>

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<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>

Overrides:

reset in class AbstractPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>

toString

public String toString()

Overrides:

toString in class AbstractPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>