Uses of Interface
com.tinkerpop.pipes.Pipe

Packages that use Pipe

Package	Description
com.tinkerpop.pipes
com.tinkerpop.pipes.branch
com.tinkerpop.pipes.filter
com.tinkerpop.pipes.sideeffect
com.tinkerpop.pipes.transform
com.tinkerpop.pipes.util

Uses of Pipe in com.tinkerpop.pipes

Classes in com.tinkerpop.pipes that implement Pipe

Modifier and Type	Class and Description
class	AbstractPipe<S,E> An AbstractPipe provides most of the functionality that is repeated in every instance of a Pipe.
class	FunctionPipe<S,E> FunctionPipe is a generic pipe where the pipe's computation is determined by the provided PipeFunction.
class	IdentityPipe<S> The IdentityPipe is the most basic pipe.

Methods in com.tinkerpop.pipes with parameters of type Pipe

Modifier and Type	Method and Description
void	AbstractPipe.setStarts(Pipe<?,S> starts)

Uses of Pipe in com.tinkerpop.pipes.branch

Classes in com.tinkerpop.pipes.branch that implement Pipe

Modifier and Type	Class and Description
class	CopySplitPipe<S> CopySplitPipe takes a number of pipes during construction.
class	ExhaustMergePipe<S> ExhaustiveMergePipe will drain its first internal pipe, then its second, so on until all internal pipes are drained.
class	FairMergePipe<S> FairMergePipe will, in a round robin fashion, emit the the objects of its internal pipes.
class	IfThenElsePipe<S,E> IfThenElsePipe will run each incoming S through the provided ifFunction.
class	LoopPipe<S> LoopPipe takes one or two Boolean-based PipeFunctions.

Methods in com.tinkerpop.pipes.branch that return types with arguments of type Pipe

Modifier and Type	Method and Description
List<Pipe>	LoopPipe.getPipes()
List<Pipe>	FairMergePipe.getPipes()
List<Pipe>	ExhaustMergePipe.getPipes()
List<Pipe>	CopySplitPipe.getPipes()

Constructors in com.tinkerpop.pipes.branch with parameters of type Pipe

Constructor and Description
CopySplitPipe(Pipe... pipes)
LoopPipe(Pipe<S,S> pipe, PipeFunction<LoopPipe.LoopBundle<S>,Boolean> whileFunction)
LoopPipe(Pipe<S,S> pipe, PipeFunction<LoopPipe.LoopBundle<S>,Boolean> whileFunction, PipeFunction<LoopPipe.LoopBundle<S>,Boolean> emitFunction)

Constructor parameters in com.tinkerpop.pipes.branch with type arguments of type Pipe

Constructor and Description
CopySplitPipe(List<Pipe> pipes)
ExhaustMergePipe(List<Pipe> pipes)
FairMergePipe(List<Pipe> pipes)

Uses of Pipe in com.tinkerpop.pipes.filter

Subinterfaces of Pipe in com.tinkerpop.pipes.filter

Modifier and Type	Interface and Description
interface	FilterPipe<S> A FilterPipe has no specified behavior save that it takes the same objects it emits.

Classes in com.tinkerpop.pipes.filter that implement Pipe

Modifier and Type	Class and Description
class	AndFilterPipe<S> The AndFilterPipe takes a collection of pipes.
class	BackFilterPipe<S> BackFilterPipe will fully process the object through its internal pipe.
class	CollectionFilterPipe<S> A CollectionFilterPipe will take a collection of objects and a Filter.NOT_EQUAL or Filter.EQUAL argument.
class	CyclicPathFilterPipe<S> CyclicPathFilterPipe will only emit an object if its transformation path has no repeats (loops) in it.
class	DuplicateFilterPipe<S> The DuplicateFilterPipe will not allow a duplicate object to pass through it.
class	ExceptFilterPipe<S> ExceptFilterPipe extends CollectionFilterPipe by assuming Compare.NOT_EQUAL and thus, "except/disjoint-union"-semantics.
class	FilterFunctionPipe<S> FilterFunctionPipe is a generic filter pipe.
class	FutureFilterPipe<S> FutureFilterPipe will allow an object to pass through it if the object has an output from the pipe provided in the constructor of the FutureFilterPipe.
class	IdFilterPipe
class	IntervalFilterPipe<S extends com.tinkerpop.blueprints.Element> IntervalFilterPipe will filter an element flowing through it according to whether a particular property value of the element is within provided range.
class	LabelFilterPipe The LabelFilterPipe either allows or disallows all Edges that have the provided label.
class	ObjectFilterPipe<S> The ObjectFilterPipe will either allow or disallow all objects that pass through it depending on the result of the compareObject() method.
class	OrFilterPipe<S> The OrFilterPipe takes a collection of pipes that are wrapped in HasNextPipes.
class	PropertyFilterPipe<S extends com.tinkerpop.blueprints.Element,T> The PropertyFilterPipe either allows or disallows all Elements that have the provided value for a particular key.
class	RandomFilterPipe<S> The RandomFilterPipe filters out objects that pass through it using a biased coin.
class	RangeFilterPipe<S> The RangeFilterPipe will only allow a sequential subset of its incoming objects to be emitted to its output.
class	RetainFilterPipe<S> RetainFilterPipe extends CollectionFilterPipe by assuming Compare.EQUAL and thus, "retain/intersect"-semantics.

Methods in com.tinkerpop.pipes.filter that return types with arguments of type Pipe

Modifier and Type	Method and Description
List<Pipe>	OrFilterPipe.getPipes()
List<Pipe>	FutureFilterPipe.getPipes()
List<Pipe>	BackFilterPipe.getPipes()
List<Pipe>	AndFilterPipe.getPipes()

Constructors in com.tinkerpop.pipes.filter with parameters of type Pipe

Constructor and Description
AndFilterPipe(Pipe<S,?>... pipes)
BackFilterPipe(Pipe<S,?> pipe)
FutureFilterPipe(Pipe<S,?> pipe)
OrFilterPipe(Pipe<S,?>... pipes)

Uses of Pipe in com.tinkerpop.pipes.sideeffect

Subinterfaces of Pipe in com.tinkerpop.pipes.sideeffect

Modifier and Type	Interface and Description
interface	SideEffectPipe<S,T> A SideEffectPipe will produce a side effect which can be retrieved by the getSideEffect() method.
static interface	SideEffectPipe.GreedySideEffectPipe<S,T> Specifies that the SideEffect is ready after Pipe.iterate()
static interface	SideEffectPipe.LazySideEffectPipe<S,T> Specifies that the SideEffect is ready after each Pipe.next()

Classes in com.tinkerpop.pipes.sideeffect that implement Pipe

Modifier and Type	Class and Description
class	AggregatePipe<S> The AggregatePipe produces a side effect that is the provided Collection filled with the contents of all the objects that have passed through it.
class	CountPipe<S> The CountPipe produces a side effect that is the total number of objects that have passed through it.
class	GroupByPipe<S,K,V>
class	GroupByReducePipe<S,K,V,V2>
class	GroupCountFunctionPipe<S,K> GroupCountFunctionPipe is analogous to GroupCountPipe save that it takes two optional functions.
class	GroupCountPipe<S> The GroupCountPipe will simply emit the incoming object, but generate a map side effect.
class	LinkPipe LinkPipe supports the creation of an edge between the current vertex in the pipe and some other vertex.
class	OptionalPipe<S> OptionalPipe will compute the incoming object within the internal pipe.
class	SideEffectFunctionPipe<S> SideEffectFunctionPipe will emit the incoming object, but compute the PipeFunction on S.
class	StorePipe<S> The StoragePipe yields its input, however, each input is added to the provided collection.
class	TablePipe<S>
class	TreePipe<S>

Methods in com.tinkerpop.pipes.sideeffect that return types with arguments of type Pipe

Modifier and Type	Method and Description
List<Pipe>	OptionalPipe.getPipes()

Constructors in com.tinkerpop.pipes.sideeffect with parameters of type Pipe

Constructor and Description
OptionalPipe(Pipe<S,?> pipe)

Uses of Pipe in com.tinkerpop.pipes.transform

Subinterfaces of Pipe in com.tinkerpop.pipes.transform

Modifier and Type	Interface and Description
interface	TransformPipe<S,E> A TransformPipe will take an object of one type and transform it to an object of another type.

Classes in com.tinkerpop.pipes.transform that implement Pipe

Modifier and Type	Class and Description
class	BothEdgesPipe BothEdgesPipe emits both the outgoing and incoming edges of a vertex.
class	BothPipe BothPipe will emit those vertices adjacent to the incoming and outgoing edges of the incoming vertex.
class	BothVerticesPipe BothVerticesPipe emits both vertices connected the the edge.
class	EdgesVerticesPipe
class	GatherFunctionPipe<S,E> GatherFunctionPipe emits all the objects up to this step as an ArrayList.
class	GatherPipe<S> GatherPipe emits all the objects up to this step as an ArrayList.
class	GraphQueryPipe<E extends com.tinkerpop.blueprints.Element> GraphQueryPipe makes use of the Graph.query() method in Blueprints which allows for intelligent element look ups from the underlying graph.
class	HasCountPipe<S>
class	HasNextPipe<S>
class	IdEdgePipe<S>
class	IdPipe IdPipe emits the id of the element.
class	IdVertexPipe<S>
class	IndexElementsPipe<E extends com.tinkerpop.blueprints.Element>
class	InEdgesPipe
class	InPipe InPipe will emit vertices that are the head/target of the incoming edges to the current vertex.
class	InVertexPipe InVertexPipe emits the incoming/target/head vertex of an edge.
class	LabelPipe LabelPipe emits the label of an edge.
class	MemoizePipe<S,E>
class	OrderMapPipe<S>
class	OrderPipe<S> OrderPipe supports in-stream sorting of objects.
class	OutEdgesPipe OutEdgesPipe emits the outgoing edges of a vertex.
class	OutPipe OutPipe will emit vertices that are the tail/source of the outgoing edges to the current vertex.
class	OutVertexPipe OutVertexPipe emits the outgoing/source/tail vertex of an edge.
class	PathPipe<S> PathPipe emits the path that the traverser has taken up to this object.
class	PropertyMapPipe<S extends com.tinkerpop.blueprints.Element> PropertyMapPipe emits the property map of an element.
class	PropertyPipe<S extends com.tinkerpop.blueprints.Element,E> The PropertyPipe returns the property value of the Element identified by the provided key.
class	QueryPipe<S,E extends com.tinkerpop.blueprints.Element> QueryPipe consolidates the fields and methods required for both VertexQueryPipe and GraphQueryPipe.
class	ScatterPipe<S,E> ScatterPipe will unroll any iterator/iterable/map that is provided to it.
class	SelectPipe<S> SelectPipe will emit a List of the objects that are at the respective 'as'-steps (i.e.
class	ShufflePipe<S> The ShufflePipe emits all the objects up to this step as an ArrayList then randomizes the order of the items in the list.
class	SideEffectCapPipe<S,T> The SideEffectCapPipe will yield an E that is the side effect of the provided SideEffectPipe.
class	ToStringPipe<S> ToStringPipe turns an stream of objects into their Object.toString() representation.
class	TransformFunctionPipe<S,E> TransformFunctionPipe computes a transformation on the S object, where the PipeFunction determines the E.
class	VertexQueryPipe<E extends com.tinkerpop.blueprints.Element> VertexQueryPipe makes use of the Vertex.query() method in Blueprints which allows for intelligent edge look ups from the underlying graph.
class	VerticesEdgesPipe
class	VerticesVerticesPipe

Fields in com.tinkerpop.pipes.transform declared as Pipe

Modifier and Type	Field and Description
protected Pipe<S,E>	MemoizePipe.pipe

Methods in com.tinkerpop.pipes.transform that return types with arguments of type Pipe

Modifier and Type	Method and Description
List<Pipe>	SideEffectCapPipe.getPipes()
List<Pipe>	MemoizePipe.getPipes()
List<Pipe>	HasNextPipe.getPipes()

Constructors in com.tinkerpop.pipes.transform with parameters of type Pipe

Constructor and Description
HasNextPipe(Pipe<S,?> pipe) Initialize this pipe to apply its conditions to the given pipe.
MemoizePipe(Pipe<S,E> pipe)
MemoizePipe(Pipe<S,E> pipe, Map<S,List<E>> map)

Uses of Pipe in com.tinkerpop.pipes.util

Classes in com.tinkerpop.pipes.util that implement Pipe

Modifier and Type	Class and Description
class	AbstractMetaPipe<S,E>
class	AsPipe<S,E> An AsPipe wraps a Pipe and provides it a name and 'peak back' access to the last emitted end.
class	ExpandablePipe<S>
class	Pipeline<S,E> A Pipeline is a linear composite of Pipes.
class	PipesPipeline<S,E> Deprecated.
class	StartPipe<S> StartPipe is a handy way to create a pipe out of the provided object.

Fields in com.tinkerpop.pipes.util declared as Pipe

Modifier and Type	Field and Description
protected Pipe<?,E>	Pipeline.endPipe
protected Pipe<S,?>	Pipeline.startPipe

Fields in com.tinkerpop.pipes.util with type parameters of type Pipe

Modifier and Type	Field and Description
protected List<Pipe>	Pipeline.pipes

Methods in com.tinkerpop.pipes.util that return Pipe

Modifier and Type	Method and Description
Pipe	Pipeline.get(int index)
static Pipe	FluentUtility.getPreviousPipe(Pipeline pipeline) Get the last pipe in the Pipeline
Pipe	Pipeline.remove(int index)

Methods in com.tinkerpop.pipes.util that return types with arguments of type Pipe

Modifier and Type	Method and Description
List<Pipe>	Pipeline.getPipes()
List<Pipe>	MetaPipe.getPipes()
List<Pipe>	AsPipe.getPipes()
static List<Pipe>	FluentUtility.getPreviousPipes(Pipeline pipeline, int numberedStep)
static List<Pipe>	FluentUtility.removePreviousPipes(Pipeline pipeline, int numberedStep) A utility method to remove all the pipes back some number of steps and return them as a list.
static List<Pipe>	FluentUtility.removePreviousPipes(Pipeline pipeline, String namedStep) A utility method to remove all the pipes back some partition step and return them as a list.

Methods in com.tinkerpop.pipes.util with parameters of type Pipe

Modifier and Type	Method and Description
<T> PipesPipeline<S,T>	PipesPipeline.add(Pipe<?,T> pipe) Deprecated.
void	Pipeline.addPipe(int location, Pipe pipe)
void	Pipeline.addPipe(Pipe pipe) Adds a new pipe to the end of the pipeline and then reconstructs the pipeline chain.
PipesPipeline<S,E>	PipesPipeline.and(Pipe<E,?>... pipes) Deprecated.
PipesFluentPipeline<S,E>	PipesFluentPipeline.and(Pipe<E,?>... pipes) Deprecated. Add an AndFilterPipe to the end the Pipeline.
PipesPipeline<S,?>	PipesPipeline.copySplit(Pipe... pipes) Deprecated.
PipesFluentPipeline<S,?>	PipesFluentPipeline.copySplit(Pipe<E,?>... pipes) Deprecated. Add a CopySplitPipe to the end of the pipeline.
static String	PipeHelper.makePipeString(Pipe pipe, Object... arguments) Generate a String representation of a pipe given the pipe and some arguments of the pipe.
PipesPipeline<S,E>	PipesPipeline.or(Pipe<E,?>... pipes) Deprecated.
PipesFluentPipeline<S,E>	PipesFluentPipeline.or(Pipe<E,?>... pipes) Deprecated. Add an OrFilterPipe to the end the Pipeline.
<T> PipesPipeline<S,T>	PipesPipeline.step(Pipe<E,T> pipe) Deprecated.
<T> PipesFluentPipeline<S,T>	PipesFluentPipeline.step(Pipe<E,T> pipe) Deprecated. Add an arbitrary Pipe to the end of the pipeline.

Method parameters in com.tinkerpop.pipes.util with type arguments of type Pipe

Modifier and Type	Method and Description
protected void	Pipeline.setPipes(List<Pipe> pipes) Useful for constructing the pipeline chain without making use of the constructor.

Constructors in com.tinkerpop.pipes.util with parameters of type Pipe

Constructor and Description
AsPipe(String name, Pipe<S,E> pipe)
Pipeline(Pipe... pipes) Constructs a pipeline from the provided pipes.

Constructor parameters in com.tinkerpop.pipes.util with type arguments of type Pipe

Constructor and Description
Pipeline(List<Pipe> pipes) Constructs a pipeline from the provided pipes.