com.tinkerpop.pipes.transform

Class VertexQueryPipe<E extends com.tinkerpop.blueprints.Element>

java.lang.Object

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

com.tinkerpop.pipes.transform.QueryPipe<com.tinkerpop.blueprints.Vertex,E>

com.tinkerpop.pipes.transform.VertexQueryPipe<E>

All Implemented Interfaces:

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

public class VertexQueryPipe<E extends com.tinkerpop.blueprints.Element>
extends QueryPipe<com.tinkerpop.blueprints.Vertex,E>

VertexQueryPipe makes use of the Vertex.query() method in Blueprints which allows for intelligent edge look ups from the underlying graph.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from class com.tinkerpop.pipes.transform.QueryPipe

QueryPipe.HasContainer, QueryPipe.IntervalContainer

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.transform.TransformPipe

TransformPipe.Order

Field Summary

Fields inherited from class com.tinkerpop.pipes.transform.QueryPipe

count, currentIterator, elementClass, hasContainers, highRange, intervalContainers, lowRange

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
VertexQueryPipe(Class<E> resultingElementClass, com.tinkerpop.blueprints.Direction direction, List<QueryPipe.HasContainer> hasContainers, List<QueryPipe.IntervalContainer> intervalContainers, int branchFactor, int lowRange, int highRange, String... labels) Construct a new VertexQuery pipe that wraps an underlying Blueprints VertexQuery object.

Method Summary

Methods

Modifier and Type	Method and Description
E	processNextStart()
void	setBranchFactor(int branchFactor)
void	setDirection(com.tinkerpop.blueprints.Direction direction)
void	setLabels(String... labels)
String	toString()

Methods inherited from class com.tinkerpop.pipes.transform.QueryPipe

addHasContainer, addIntervalContainer, getResultElementClass, reset, setHighRange, setLowRange, setResultingElementClass

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

VertexQueryPipe

public VertexQueryPipe(Class<E> resultingElementClass,
               com.tinkerpop.blueprints.Direction direction,
               List<QueryPipe.HasContainer> hasContainers,
               List<QueryPipe.IntervalContainer> intervalContainers,
               int branchFactor,
               int lowRange,
               int highRange,
               String... labels)

Construct a new VertexQuery pipe that wraps an underlying Blueprints VertexQuery object. Given the optional nature of many of the parameters, note the "wildcard" settings for each parameter.

Parameters:

resultingElementClass - this must be either Vertex.class or Edge.class (anything else will throw an IllegalArgumentException)

direction - this must be a legal direction representing the direction of the edge.

hasContainers - this must be a collection of 'has'-filters (i.e. property filters). Provide an empty list if no such filters are to be applied.

intervalContainers - this must be a collection of 'interval'-filters (i.e. property filters within a range). Provide an empty list if no such filters are to be applied.

branchFactor - the branch factor for a particular vertex (determines the limit() of the VertexQuery)

lowRange - this must be a long value representing the low range of elements to emit

highRange - this must be a long value representing the high range of elements to emit

labels - this is a list of Strings representing the edge label filters to apply. Do not provide any Strings if no such filtering is desired.

Method Detail

setDirection

public void setDirection(com.tinkerpop.blueprints.Direction direction)

setLabels

public void setLabels(String... labels)

setBranchFactor

public void setBranchFactor(int branchFactor)

toString

public String toString()

Overrides:

toString in class QueryPipe<com.tinkerpop.blueprints.Vertex,E extends com.tinkerpop.blueprints.Element>

processNextStart

public E processNextStart()

Specified by:

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