com.tinkerpop.pipes.transform

Class VerticesVerticesPipe

java.lang.Object

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

com.tinkerpop.pipes.transform.VerticesVerticesPipe

All Implemented Interfaces:

Pipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>, TransformPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>, Iterable<com.tinkerpop.blueprints.Vertex>, Iterator<com.tinkerpop.blueprints.Vertex>

Direct Known Subclasses:

BothPipe, InPipe, OutPipe

public class VerticesVerticesPipe
extends AbstractPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>
implements TransformPipe<com.tinkerpop.blueprints.Vertex,com.tinkerpop.blueprints.Vertex>

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

Modifier and Type	Field and Description
protected int	branchFactor
protected com.tinkerpop.blueprints.Direction	direction
protected String[]	labels
protected Iterator<com.tinkerpop.blueprints.Vertex>	nextEnds

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
VerticesVerticesPipe(com.tinkerpop.blueprints.Direction direction, int branchFactor, String... labels)
VerticesVerticesPipe(com.tinkerpop.blueprints.Direction direction, String... labels)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBranchFactor()
com.tinkerpop.blueprints.Direction	getDirection()
String[]	getLabels()
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

Field Detail

branchFactor

protected int branchFactor

direction

protected com.tinkerpop.blueprints.Direction direction

labels

protected String[] labels

nextEnds

protected Iterator<com.tinkerpop.blueprints.Vertex> nextEnds

Constructor Detail

VerticesVerticesPipe

public VerticesVerticesPipe(com.tinkerpop.blueprints.Direction direction,
                    String... labels)

VerticesVerticesPipe

public VerticesVerticesPipe(com.tinkerpop.blueprints.Direction direction,
                    int branchFactor,
                    String... labels)

Method Detail

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>

processNextStart

protected com.tinkerpop.blueprints.Vertex processNextStart()

Specified by:

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

getDirection

public com.tinkerpop.blueprints.Direction getDirection()

getLabels

public String[] getLabels()

getBranchFactor

public int getBranchFactor()

toString

public String toString()

Overrides:

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