com.tinkerpop.pipes.transform

Class QueryPipe<S,E extends com.tinkerpop.blueprints.Element>

java.lang.Object

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

com.tinkerpop.pipes.transform.QueryPipe<S,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

GraphQueryPipe, VertexQueryPipe

public abstract class QueryPipe<S,E extends com.tinkerpop.blueprints.Element>
extends AbstractPipe<S,E>
implements TransformPipe<S,E>

QueryPipe consolidates the fields and methods required for both VertexQueryPipe and GraphQueryPipe.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryPipe.HasContainer
static class	QueryPipe.IntervalContainer

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

TransformPipe.Order

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected Iterator<E>	currentIterator
protected Class<E>	elementClass
protected List<QueryPipe.HasContainer>	hasContainers
protected int	highRange
protected List<QueryPipe.IntervalContainer>	intervalContainers
protected int	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
QueryPipe()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHasContainer(QueryPipe.HasContainer container)
void	addIntervalContainer(QueryPipe.IntervalContainer container)
Class<? extends com.tinkerpop.blueprints.Element>	getResultElementClass()
void	reset() A pipe may maintain state.
void	setHighRange(int highRange)
void	setLowRange(int lowRange)
void	setResultingElementClass(Class<? extends com.tinkerpop.blueprints.Element> elementClass)
String	toString()

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

enablePath, getCurrentPath, getPathToHere, hasNext, iterator, next, processNextStart, 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

hasContainers

protected List<QueryPipe.HasContainer> hasContainers

intervalContainers

protected List<QueryPipe.IntervalContainer> intervalContainers

elementClass

protected Class<E extends com.tinkerpop.blueprints.Element> elementClass

lowRange

protected int lowRange

highRange

protected int highRange

count

protected int count

currentIterator

protected Iterator<E extends com.tinkerpop.blueprints.Element> currentIterator

Constructor Detail

QueryPipe

public QueryPipe()

Method Detail

setResultingElementClass

public void setResultingElementClass(Class<? extends com.tinkerpop.blueprints.Element> elementClass)

getResultElementClass

public Class<? extends com.tinkerpop.blueprints.Element> getResultElementClass()

addHasContainer

public void addHasContainer(QueryPipe.HasContainer container)

addIntervalContainer

public void addIntervalContainer(QueryPipe.IntervalContainer container)

setHighRange

public void setHighRange(int highRange)

setLowRange

public void setLowRange(int lowRange)

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,E extends com.tinkerpop.blueprints.Element>

Overrides:

reset in class AbstractPipe<S,E extends com.tinkerpop.blueprints.Element>

toString

public String toString()

Overrides:

toString in class AbstractPipe<S,E extends com.tinkerpop.blueprints.Element>