PipesPipeline (Pipes: A Lazy Data Flow Framework 2.6.0 API)

java.lang.Object
- com.tinkerpop.pipes.util.Pipeline<S,E>
- - com.tinkerpop.pipes.util.PipesPipeline<S,E>

All Implemented Interfaces:

Pipe<S,E>, MetaPipe, PipesFluentPipeline<S,E>, Iterable<E>, Iterator<E>

Deprecated.
```
@Deprecated
public class PipesPipeline<S,E>
extends Pipeline<S,E>
implements PipesFluentPipeline<S,E>
```
PipesPipeline allows for the creation of a Pipeline using the fluent-pattern (http://en.wikipedia.org/wiki/Fluent_interface). Each Pipe in Pipes maintains a fluent method in PipesPipeline. Numerous method overloadings are provided in order to accommodate the various ways in which one logically thinks of a pipeline structure.

Author:

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

Field Summary
- Fields inherited from class com.tinkerpop.pipes.util.Pipeline
  endPipe, pathEnabled, pipes, startPipe, starts
- Fields inherited from interface com.tinkerpop.pipes.Pipe
  NO_PATH_MESSAGE

Constructor Summary

Constructors
Constructor and Description

PipesPipeline()
Deprecated.

PipesPipeline(Object starts)
Deprecated.

Constructors
Constructor and Description
`PipesPipeline()` Deprecated.
`PipesPipeline(Object starts)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`PipesPipeline<S,E>`	`_()` Deprecated. Add an IdentityPipe to the end of the Pipeline.
`<T> PipesPipeline<S,T>`	`add(Pipe<?,T> pipe)` Deprecated.
`PipesPipeline<S,E>`	`aggregate()` Deprecated. Add an AggregatePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`aggregate(Collection<E> aggregate)` Deprecated. Add an AggregatePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`aggregate(Collection aggregate, PipeFunction<E,?> aggregateFunction)` Deprecated. Add an AggregatePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`aggregate(PipeFunction<E,?> aggregateFunction)` Deprecated. Add an AggregatePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`and(Pipe<E,?>... pipes)` Deprecated. Add an AndFilterPipe to the end the Pipeline.
`PipesPipeline<S,E>`	`as(String name)` Deprecated. Wrap the previous step in an AsPipe.
`PipesPipeline<S,?>`	`back(int numberedStep)` Deprecated. Add a BackFilterPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`back(String namedStep)` Deprecated. Add a BackFilterPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`cap()` Deprecated. Add a SideEffectCapPipe to the end of the Pipeline.
`<E> PipesPipeline<S,E>`	`cast(Class<E> end)` Deprecated. Returns the current pipeline with a new end type.
`PipesPipeline<S,?>`	`copySplit(Pipe... pipes)` Deprecated. Add a CopySplitPipe to the end of the pipeline.
`PipesPipeline<S,E>`	`dedup()` Deprecated. Add a DuplicateFilterPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`dedup(PipeFunction<E,?> dedupFunction)` Deprecated. Add a DuplicateFilterPipe to the end of the Pipeline.
`PipesFluentPipeline<S,E>`	`enablePath()` Deprecated. Enable path calculations in the pipeline.
`PipesPipeline<S,E>`	`except(Collection<E> collection)` Deprecated. Add an ExceptFilterPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`except(String... namedSteps)` Deprecated. Add an ExceptFilterPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`exhaustMerge()` Deprecated. Add an ExhaustMergePipe to the end of the pipeline.
`PipesPipeline<S,?>`	`fairMerge()` Deprecated. Add a FairMergePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`filter(PipeFunction<E,Boolean> filterFunction)` Deprecated. Add an FilterFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,List>`	`gather()` Deprecated. Add a GatherPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`gather(PipeFunction<List,?> function)` Deprecated. Add a GatherPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupBy(Map<?,List<?>> map, PipeFunction keyFunction, PipeFunction valueFunction)` Deprecated. Add a GroupByPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupBy(Map reduceMap, PipeFunction keyFunction, PipeFunction valueFunction, PipeFunction reduceFunction)` Deprecated. Add a GroupByReducePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupBy(PipeFunction keyFunction, PipeFunction valueFunction)` Deprecated. Add a GroupByPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupBy(PipeFunction keyFunction, PipeFunction valueFunction, PipeFunction reduceFunction)` Deprecated. Add a GroupByReducePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupCount()` Deprecated. Add a GroupCountPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupCount(Map<?,Number> map)` Deprecated. Add a GroupCountPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupCount(Map<?,Number> map, PipeFunction keyFunction)` Deprecated. Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupCount(Map<?,Number> map, PipeFunction keyFunction, PipeFunction<Pair<?,Number>,Number> valueFunction)` Deprecated. Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupCount(PipeFunction keyFunction)` Deprecated. Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`groupCount(PipeFunction keyFunction, PipeFunction<Pair<?,Number>,Number> valueFunction)` Deprecated. Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`ifThenElse(PipeFunction<E,Boolean> ifFunction, PipeFunction<E,?> thenFunction, PipeFunction<E,?> elseFunction)` Deprecated. Add an IfThenElsePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`loop(int numberedStep, PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction)` Deprecated. Add a LoopPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`loop(int numberedStep, PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction, PipeFunction<LoopPipe.LoopBundle<E>,Boolean> emitFunction)` Deprecated. Add a LoopPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`loop(String namedStep, PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction)` Deprecated. Add a LoopPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`loop(String namedStep, PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction, PipeFunction<LoopPipe.LoopBundle<E>,Boolean> emitFunction)` Deprecated. Add a LoopPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`memoize(int numberedStep)` Deprecated. Add a MemoizePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`memoize(int numberedStep, Map map)` Deprecated. Add a MemoizePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`memoize(String namedStep)` Deprecated. Add a MemoizePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`memoize(String namedStep, Map map)` Deprecated. Add a MemoizePipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`optional(int numberedStep)` Deprecated. Add an OptionalPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`optional(String namedStep)` Deprecated. Add an OptionalPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`or(Pipe<E,?>... pipes)` Deprecated. Add an OrFilterPipe to the end the Pipeline.
`PipesPipeline<S,E>`	`order()` Deprecated. Add an OrderPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`order(PipeFunction<Pair<E,E>,Integer> compareFunction)` Deprecated. Add an OrderPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`order(TransformPipe.Order order)` Deprecated. Add an OrderPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`orderMap(PipeFunction<Pair<Map.Entry,Map.Entry>,Integer> compareFunction)` Deprecated. Add a OrderMapPipe to the end of the Pipeline Given a Map as an input, the map is first ordered and then the keys are emitted in the order.
`PipesPipeline<S,?>`	`orderMap(TransformPipe.Order order)` Deprecated. Add a OrderMapPipe to the end of the Pipeline Given a Map as an input, the map is first ordered and then the keys are emitted in the order.
`PipesPipeline<S,List>`	`path(PipeFunction... pathFunctions)` Deprecated. Add a PathPipe or PathPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`random(Double bias)` Deprecated. Add a RandomFilterPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`range(int low, int high)` Deprecated. Add a RageFilterPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`retain(Collection<E> collection)` Deprecated. Add a RetainFilterPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`retain(String... namedSteps)` Deprecated. Add a RetainFilterPipe to the end of the Pipeline.
`PipesPipeline<S,?>`	`scatter()` Deprecated. Add a ScatterPipe to the end of the Pipeline.
`PipesPipeline<S,Row>`	`select()` Deprecated. Add a SelectPipe to the end of the Pipeline.
`PipesPipeline<S,Row>`	`select(Collection<String> stepNames, PipeFunction... columnFunctions)` Deprecated. Add a SelectPipe to the end of the Pipeline.
`PipesPipeline<S,Row>`	`select(PipeFunction... columnFunctions)` Deprecated. Add a SelectPipe to the end of the Pipeline.
`PipesPipeline<S,List>`	`shuffle()` Deprecated. Add a ShufflePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`sideEffect(PipeFunction<E,?> sideEffectFunction)` Deprecated. Add a SideEffectFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`simplePath()` Deprecated. Add a CyclicPathFilterPipe to the end of the Pipeline.
`PipesPipeline<S,S>`	`start(S object)` Deprecated. Add a StartPipe to the end of the pipeline.
`<T> PipesPipeline<S,T>`	`step(Pipe<E,T> pipe)` Deprecated. Add an arbitrary Pipe to the end of the pipeline.
`PipesPipeline<S,?>`	`step(PipeFunction function)` Deprecated. Add a FunctionPipe to the end of the pipeline.
`PipesPipeline<S,E>`	`store()` Deprecated. Add an StorePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`store(Collection<E> storage)` Deprecated. Add a StorePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`store(Collection storage, PipeFunction<E,?> storageFunction)` Deprecated. Add a StorePipe to the end of the Pipeline.
`PipesFluentPipeline<S,E>`	`store(PipeFunction<E,?> storageFunction)` Deprecated. Add a StorePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`table()` Deprecated. Add a TablePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`table(PipeFunction... columnFunctions)` Deprecated. Add a TablePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`table(Table table)` Deprecated. Add a TablePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`table(Table table, Collection<String> stepNames, PipeFunction... columnFunctions)` Deprecated. Add a TablePipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`table(Table table, PipeFunction... columnFunctions)` Deprecated. Add a TablePipe to the end of the Pipeline.
`<T> PipesPipeline<S,T>`	`transform(PipeFunction<E,T> function)` Deprecated. Add a TransformFunctionPipe to the end of the Pipeline.
`PipesPipeline<S,E>`	`tree(PipeFunction... branchFunctions)` Deprecated. Add a TreePipe to the end of the Pipeline This step maintains an internal tree representation of the paths that have flowed through the step.
`PipesPipeline<S,E>`	`tree(Tree tree, PipeFunction... branchFunctions)` Deprecated. Add a TreePipe to the end of the Pipeline This step maintains an internal tree representation of the paths that have flowed through the step.

Methods inherited from class com.tinkerpop.pipes.util.Pipeline
addPipe, addPipe, count, enablePath, equals, fill, get, getCurrentPath, getPipes, getStarts, hasNext, iterate, iterator, next, next, remove, remove, reset, setPipes, setStarts, setStarts, size, toList, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.pipes.util.PipesFluentPipeline
count, fill, iterate, next, toList

- Constructor Detail
  - PipesPipeline
```
public PipesPipeline()
```
    Deprecated.
  - PipesPipeline
```
public PipesPipeline(Object starts)
```
    Deprecated.
- Method Detail
  - add
```
public <T> PipesPipeline<S,T> add(Pipe<?,T> pipe)
```
    Deprecated.
  - step
```
public PipesPipeline<S,?> step(PipeFunction function)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a FunctionPipe to the end of the pipeline. The provide provided PipeFunction emits whatever is defined by the function. This serves as an arbitrary step computation.
    
    Specified by:
    
    step in interface PipesFluentPipeline<S,E>
    
    Parameters:
    function - the function of the FunctionPipe
    
    Returns:
    the extended Pipeline
  - step
```
public <T> PipesPipeline<S,T> step(Pipe<E,T> pipe)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an arbitrary Pipe to the end of the pipeline.
    
    Specified by:
    
    step in interface PipesFluentPipeline<S,E>
    
    Type Parameters:
    T - the object type emitted by the provided pipe.
    Parameters:
    pipe - The provided pipe.
    
    Returns:
    the extended Pipeline
  - copySplit
```
public PipesPipeline<S,?> copySplit(Pipe... pipes)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a CopySplitPipe to the end of the pipeline. The incoming objects are copied to the provided pipes. This "split-pipe" is used in conjunction with some type of "merge-pipe."
    
    Specified by:
    
    copySplit in interface PipesFluentPipeline<S,E>
    
    Parameters:
    pipes - the internal pipes of the CopySplitPipe
    
    Returns:
    the extended Pipeline
  - exhaustMerge
```
public PipesPipeline<S,?> exhaustMerge()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an ExhaustMergePipe to the end of the pipeline. The one-step previous MetaPipe in the pipeline's pipes are used as the internal pipes. The pipes' emitted objects are merged where the first pipe's objects are exhausted, then the second, etc.
    
    Specified by:
    
    exhaustMerge in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - fairMerge
```
public PipesPipeline<S,?> fairMerge()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a FairMergePipe to the end of the Pipeline. The one-step previous MetaPipe in the pipeline's pipes are used as the internal pipes. The pipes' emitted objects are merged in a round robin fashion.
    
    Specified by:
    
    fairMerge in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - ifThenElse
```
public PipesPipeline<S,?> ifThenElse(PipeFunction<E,Boolean> ifFunction,
                            PipeFunction<E,?> thenFunction,
                            PipeFunction<E,?> elseFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an IfThenElsePipe to the end of the Pipeline. If the ifFunction is true, then the results of the thenFunction are emitted. If the ifFunction is false, then the results of the elseFunction are emitted.
    
    Specified by:
    
    ifThenElse in interface PipesFluentPipeline<S,E>
    
    Parameters:
    ifFunction - the function denoting the "if" part of the pipe
    thenFunction - the function denoting the "then" part of the pipe
    elseFunction - the function denoting the "else" part of the pipe
    
    Returns:
    the extended Pipeline
  - loop
```
public PipesPipeline<S,E> loop(int numberedStep,
                      PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a LoopPipe to the end of the Pipeline. Looping is useful for repeating a section of a pipeline. The provided whileFunction determines when to drop out of the loop. The whileFunction is provided a LoopBundle object which contains the object in loop along with other useful metadata.
    
    Specified by:
    
    loop in interface PipesFluentPipeline<S,E>
    
    Parameters:
    numberedStep - the number of steps to loop back to
    whileFunction - whether or not to continue looping on the current object
    
    Returns:
    the extended Pipeline
  - loop
```
public PipesPipeline<S,E> loop(String namedStep,
                      PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a LoopPipe to the end of the Pipeline. Looping is useful for repeating a section of a pipeline. The provided whileFunction determines when to drop out of the loop. The whileFunction is provided a LoopBundle object which contains the object in loop along with other useful metadata.
    
    Specified by:
    
    loop in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedStep - the name of the step to loop back to
    whileFunction - whether or not to continue looping on the current object
    
    Returns:
    the extended Pipeline
  - loop
```
public PipesPipeline<S,E> loop(int numberedStep,
                      PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction,
                      PipeFunction<LoopPipe.LoopBundle<E>,Boolean> emitFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a LoopPipe to the end of the Pipeline. Looping is useful for repeating a section of a pipeline. The provided whileFunction determines when to drop out of the loop. The provided emitFunction can be used to emit objects that are still going through a loop. The whileFunction and emitFunctions are provided a LoopBundle object which contains the object in loop along with other useful metadata.
    
    Specified by:
    
    loop in interface PipesFluentPipeline<S,E>
    
    Parameters:
    numberedStep - the number of steps to loop back to
    whileFunction - whether or not to continue looping on the current object
    emitFunction - whether or not to emit the current object (irrespective of looping)
    
    Returns:
    the extended Pipeline
  - loop
```
public PipesPipeline<S,E> loop(String namedStep,
                      PipeFunction<LoopPipe.LoopBundle<E>,Boolean> whileFunction,
                      PipeFunction<LoopPipe.LoopBundle<E>,Boolean> emitFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a LoopPipe to the end of the Pipeline. Looping is useful for repeating a section of a pipeline. The provided whileFunction determines when to drop out of the loop. The provided emitFunction can be used to emit objects that are still going through a loop. The whileFunction and emitFunctions are provided a LoopBundle object which contains the object in loop along with other useful metadata.
    
    Specified by:
    
    loop in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedStep - the number of steps to loop back to
    whileFunction - whether or not to continue looping on the current object
    emitFunction - whether or not to emit the current object (irrespective of looping)
    
    Returns:
    the extended Pipeline
  - and
```
public PipesPipeline<S,E> and(Pipe<E,?>... pipes)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an AndFilterPipe to the end the Pipeline. If the internal pipes all yield objects, then the object is not filtered. The provided pipes are provided the object as their starts.
    
    Specified by:
    
    and in interface PipesFluentPipeline<S,E>
    
    Parameters:
    pipes - the internal pipes of the AndFilterPipe
    
    Returns:
    the extended Pipeline
  - back
```
public PipesPipeline<S,?> back(int numberedStep)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a BackFilterPipe to the end of the Pipeline. The object that was seen numberedSteps ago is emitted.
    
    Specified by:
    
    back in interface PipesFluentPipeline<S,E>
    
    Parameters:
    numberedStep - the number of steps previous to back up to
    
    Returns:
    the extended Pipeline
  - back
```
public PipesPipeline<S,?> back(String namedStep)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a BackFilterPipe to the end of the Pipeline. The object that was seen namedSteps ago is emitted.
    
    Specified by:
    
    back in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedStep - the name of the step previous to back up to
    
    Returns:
    the extended Pipeline
  - dedup
```
public PipesPipeline<S,E> dedup()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a DuplicateFilterPipe to the end of the Pipeline. Will only emit the object if it has not been seen before.
    
    Specified by:
    
    dedup in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - dedup
```
public PipesPipeline<S,E> dedup(PipeFunction<E,?> dedupFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a DuplicateFilterPipe to the end of the Pipeline. Will only emit the object if the object generated by its function hasn't been seen before.
    
    Specified by:
    
    dedup in interface PipesFluentPipeline<S,E>
    
    Parameters:
    dedupFunction - a function to call on the object to yield the object to dedup on
    
    Returns:
    the extended Pipeline
  - except
```
public PipesPipeline<S,E> except(Collection<E> collection)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an ExceptFilterPipe to the end of the Pipeline. Will only emit the object if it is not in the provided collection.
    
    Specified by:
    
    except in interface PipesFluentPipeline<S,E>
    
    Parameters:
    collection - the collection except from the stream
    
    Returns:
    the extended Pipeline
  - except
```
public PipesPipeline<S,E> except(String... namedSteps)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an ExceptFilterPipe to the end of the Pipeline. Will only emit the object if it is not equal to any of the objects contained at the named steps.
    
    Specified by:
    
    except in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedSteps - the named steps in the pipeline
    
    Returns:
    the extended Pipeline
  - filter
```
public PipesPipeline<S,E> filter(PipeFunction<E,Boolean> filterFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an FilterFunctionPipe to the end of the Pipeline. The serves are an arbitrary filter where the filter criteria is provided by the filterFunction.
    
    Specified by:
    
    filter in interface PipesFluentPipeline<S,E>
    
    Parameters:
    filterFunction - the filter function of the pipe
    
    Returns:
    the extended Pipeline
  - or
```
public PipesPipeline<S,E> or(Pipe<E,?>... pipes)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an OrFilterPipe to the end the Pipeline. Will only emit the object if one or more of the provides pipes yields an object. The provided pipes are provided the object as their starts.
    
    Specified by:
    
    or in interface PipesFluentPipeline<S,E>
    
    Parameters:
    pipes - the internal pipes of the OrFilterPipe
    
    Returns:
    the extended Pipeline
  - random
```
public PipesPipeline<S,E> random(Double bias)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a RandomFilterPipe to the end of the Pipeline. A biased coin toss determines if the object is emitted or not.
    
    Specified by:
    
    random in interface PipesFluentPipeline<S,E>
    
    Parameters:
    bias - the bias of the random coin
    
    Returns:
    the extended Pipeline
  - range
```
public PipesPipeline<S,E> range(int low,
                       int high)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a RageFilterPipe to the end of the Pipeline. Analogous to a high/low index lookup.
    
    Specified by:
    
    range in interface PipesFluentPipeline<S,E>
    
    Parameters:
    low - the low end of the range
    high - the high end of the range
    
    Returns:
    the extended Pipeline
  - retain
```
public PipesPipeline<S,E> retain(Collection<E> collection)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a RetainFilterPipe to the end of the Pipeline. Will emit the object only if it is in the provided collection.
    
    Specified by:
    
    retain in interface PipesFluentPipeline<S,E>
    
    Parameters:
    collection - the collection to retain
    
    Returns:
    the extended Pipeline
  - retain
```
public PipesPipeline<S,E> retain(String... namedSteps)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a RetainFilterPipe to the end of the Pipeline. Will only emit the object if it is equal to any of the objects contained at the named steps.
    
    Specified by:
    
    retain in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedSteps - the named steps in the pipeline
    
    Returns:
    the extended Pipeline
  - simplePath
```
public PipesPipeline<S,E> simplePath()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a CyclicPathFilterPipe to the end of the Pipeline. If the object's path is repeating (looping), then the object is filtered. Thus, what is emitted are those objects whose history is composed of unique objects.
    
    Specified by:
    
    simplePath in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - aggregate
```
public PipesPipeline<S,E> aggregate()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an AggregatePipe to the end of the Pipeline. The objects prior to aggregate are greedily collected into an ArrayList.
    
    Specified by:
    
    aggregate in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - aggregate
```
public PipesPipeline<S,E> aggregate(Collection<E> aggregate)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an AggregatePipe to the end of the Pipeline. The objects prior to aggregate are greedily collected into the provided collection.
    
    Specified by:
    
    aggregate in interface PipesFluentPipeline<S,E>
    
    Parameters:
    aggregate - the collection to aggregate results into
    
    Returns:
    the extended Pipeline
  - aggregate
```
public PipesPipeline<S,E> aggregate(Collection aggregate,
                           PipeFunction<E,?> aggregateFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an AggregatePipe to the end of the Pipeline. The results of the function evaluated on the objects prior to the aggregate are greedily collected into the provided collection.
    
    Specified by:
    
    aggregate in interface PipesFluentPipeline<S,E>
    
    Parameters:
    aggregate - the collection to aggregate results into
    aggregateFunction - the function to run over each object prior to insertion into the aggregate
    
    Returns:
    the extended Pipeline
  - aggregate
```
public PipesPipeline<S,E> aggregate(PipeFunction<E,?> aggregateFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an AggregatePipe to the end of the Pipeline. The results of the function evaluated on the objects prior to the aggregate are greedily collected into an ArrayList.
    
    Specified by:
    
    aggregate in interface PipesFluentPipeline<S,E>
    
    Parameters:
    aggregateFunction - the function to run over each object prior to insertion into the aggregate
    
    Returns:
    the extended Pipeline
  - optional
```
public PipesPipeline<S,?> optional(int numberedStep)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an OptionalPipe to the end of the Pipeline. The section of pipeline back to the numbered step is evaluated.
    
    Specified by:
    
    optional in interface PipesFluentPipeline<S,E>
    
    Parameters:
    numberedStep - the number of steps previous to optional back to
    
    Returns:
    the extended Pipeline
  - optional
```
public PipesPipeline<S,?> optional(String namedStep)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an OptionalPipe to the end of the Pipeline. The section of pipeline back to the partition step is evaluated.
    
    Specified by:
    
    optional in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedStep - the name of the step previous to optional back to
    
    Returns:
    the extended Pipeline
  - groupBy
```
public PipesPipeline<S,E> groupBy(Map<?,List<?>> map,
                         PipeFunction keyFunction,
                         PipeFunction valueFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupByPipe to the end of the Pipeline. Group the objects inputted objects according to a key generated from the object and a value generated from the object. The grouping map has values that are Lists.
    
    Specified by:
    
    groupBy in interface PipesFluentPipeline<S,E>
    
    Parameters:
    map - the map to store the grouping in
    keyFunction - the function that generates the key from the object
    valueFunction - the function that generates the value from the function
    
    Returns:
    the extended Pipeline
  - groupBy
```
public PipesPipeline<S,E> groupBy(PipeFunction keyFunction,
                         PipeFunction valueFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupByPipe to the end of the Pipeline. Group the objects inputted objects according to a key generated from the object and a value generated from the object. The grouping map has values that are Lists.
    
    Specified by:
    
    groupBy in interface PipesFluentPipeline<S,E>
    
    Parameters:
    keyFunction - the function that generates the key from the object
    valueFunction - the function that generates the value from the function
    
    Returns:
    the extended Pipeline
  - groupBy
```
public PipesPipeline<S,E> groupBy(Map reduceMap,
                         PipeFunction keyFunction,
                         PipeFunction valueFunction,
                         PipeFunction reduceFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupByReducePipe to the end of the Pipeline. Group the objects inputted objects according to a key generated from the object and a value generated from the object. The grouping map has values that are Lists. When the pipe has no more incoming objects, apply the reduce function to the keyed Lists. The sideEffect is only fully available when the pipe is empty.
    
    Specified by:
    
    groupBy in interface PipesFluentPipeline<S,E>
    
    Parameters:
    reduceMap - a map to perform the reduce operation on (good for having a later reference)
    keyFunction - the function that generates the key from the object
    valueFunction - the function that generates the value from the function
    reduceFunction - the function that reduces the value lists
    
    Returns:
    the extended Pipeline
  - groupBy
```
public PipesPipeline<S,E> groupBy(PipeFunction keyFunction,
                         PipeFunction valueFunction,
                         PipeFunction reduceFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupByReducePipe to the end of the Pipeline. Group the objects inputted objects according to a key generated from the object and a value generated from the object. The grouping map has values that are Lists. When the pipe has no more incoming objects, apply the reduce function to the keyed Lists. The sideEffect is only fully available when the pipe is empty.
    
    Specified by:
    
    groupBy in interface PipesFluentPipeline<S,E>
    
    Parameters:
    keyFunction - the function that generates the key from the object
    valueFunction - the function that generates the value from the function
    reduceFunction - the function that reduces the value lists
    
    Returns:
    the extended Pipeline
  - groupCount
```
public PipesPipeline<S,E> groupCount(Map<?,Number> map,
                            PipeFunction keyFunction,
                            PipeFunction<Pair<?,Number>,Number> valueFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline. A map is maintained of counts. The map keys are determined by the function on the incoming object. The map values are determined by the function on the incoming object (getA()) and the previous value (getB()).
    
    Specified by:
    
    groupCount in interface PipesFluentPipeline<S,E>
    
    Parameters:
    map - a provided count map
    keyFunction - the key function to determine map key
    valueFunction - the value function to determine map value
    
    Returns:
    the extended Pipeline
  - groupCount
```
public PipesPipeline<S,E> groupCount(PipeFunction keyFunction,
                            PipeFunction<Pair<?,Number>,Number> valueFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline. map is maintained of counts. The map keys are determined by the function on the incoming object. The map values are determined by the function on the incoming object (getA()) and the previous value (getB()).
    
    Specified by:
    
    groupCount in interface PipesFluentPipeline<S,E>
    
    Parameters:
    keyFunction - the key function to determine map key
    valueFunction - the value function to determine map value
    
    Returns:
    the extended Pipeline
  - groupCount
```
public PipesPipeline<S,E> groupCount(Map<?,Number> map,
                            PipeFunction keyFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline. A map is maintained of counts. The map keys are determined by the function on the incoming object. The map values are 1 plus the previous value for that key.
    
    Specified by:
    
    groupCount in interface PipesFluentPipeline<S,E>
    
    Parameters:
    map - a provided count map
    keyFunction - the key function to determine map key
    
    Returns:
    the extended Pipeline
  - groupCount
```
public PipesPipeline<S,E> groupCount(PipeFunction keyFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupCountPipe or GroupCountFunctionPipe to the end of the Pipeline. A map is maintained of counts. The map keys are determined by the function on the incoming object. The map values are 1 plus the previous value for that key.
    
    Specified by:
    
    groupCount in interface PipesFluentPipeline<S,E>
    
    Parameters:
    keyFunction - the key function to determine map key
    
    Returns:
    the extended Pipeline
  - groupCount
```
public PipesPipeline<S,E> groupCount(Map<?,Number> map)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupCountPipe to the end of the Pipeline. A map is maintained of counts. The map keys are the incoming objects. The map values are 1 plus the previous value for that key.
    
    Specified by:
    
    groupCount in interface PipesFluentPipeline<S,E>
    
    Parameters:
    map - a provided count map
    
    Returns:
    the extended Pipeline
  - groupCount
```
public PipesPipeline<S,E> groupCount()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GroupCountPipe to the end of the Pipeline. A map is maintained of counts. The map keys are the incoming objects. The map values are 1 plus the previous value for that key.
    
    Specified by:
    
    groupCount in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - sideEffect
```
public PipesPipeline<S,E> sideEffect(PipeFunction<E,?> sideEffectFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a SideEffectFunctionPipe to the end of the Pipeline. The provided function is evaluated and the incoming object is the outgoing object.
    
    Specified by:
    
    sideEffect in interface PipesFluentPipeline<S,E>
    
    Parameters:
    sideEffectFunction - the function of the pipe
    
    Returns:
    the extended Pipeline
  - store
```
public PipesPipeline<S,E> store(Collection<E> storage)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a StorePipe to the end of the Pipeline. Lazily store the incoming objects into the provided collection.
    
    Specified by:
    
    store in interface PipesFluentPipeline<S,E>
    
    Parameters:
    storage - the collection to store results into
    
    Returns:
    the extended Pipeline
  - store
```
public PipesPipeline<S,E> store(Collection storage,
                       PipeFunction<E,?> storageFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a StorePipe to the end of the Pipeline. Lazily store the object returned by the function over the incoming object into the provided collection.
    
    Specified by:
    
    store in interface PipesFluentPipeline<S,E>
    
    Parameters:
    storage - the collection to store results into
    storageFunction - the function to run over each object prior to insertion into the storage collection
    
    Returns:
    the extended Pipeline
  - store
```
public PipesFluentPipeline<S,E> store(PipeFunction<E,?> storageFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a StorePipe to the end of the Pipeline. An ArrayList storage collection is provided and filled lazily with the return of the function evaluated over the incoming objects.
    
    Specified by:
    
    store in interface PipesFluentPipeline<S,E>
    
    Parameters:
    storageFunction - the function to run over each object prior to insertion into the storage collection
    
    Returns:
    the extended Pipeline
  - store
```
public PipesPipeline<S,E> store()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an StorePipe to the end of the Pipeline. An ArrayList storage collection is provided and filled lazily with incoming objects.
    
    Specified by:
    
    store in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - table
```
public PipesPipeline<S,E> table(Table table,
                       Collection<String> stepNames,
                       PipeFunction... columnFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TablePipe to the end of the Pipeline. This step is used for grabbing previously seen objects the pipeline as identified by as-steps.
    
    Specified by:
    
    table in interface PipesFluentPipeline<S,E>
    
    Parameters:
    table - the table to fill
    stepNames - the partition steps to include in the filling
    columnFunctions - the post-processing function for each column
    
    Returns:
    the extended Pipeline
  - table
```
public PipesPipeline<S,E> table(Table table,
                       PipeFunction... columnFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TablePipe to the end of the Pipeline. This step is used for grabbing previously seen objects the pipeline as identified by as-steps.
    
    Specified by:
    
    table in interface PipesFluentPipeline<S,E>
    
    Parameters:
    table - the table to fill
    columnFunctions - the post-processing function for each column
    
    Returns:
    the extended Pipeline
  - table
```
public PipesPipeline<S,E> table(PipeFunction... columnFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TablePipe to the end of the Pipeline. This step is used for grabbing previously seen objects the pipeline as identified by as-steps.
    
    Specified by:
    
    table in interface PipesFluentPipeline<S,E>
    
    Parameters:
    columnFunctions - the post-processing function for each column
    
    Returns:
    the extended Pipeline
  - table
```
public PipesPipeline<S,E> table(Table table)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TablePipe to the end of the Pipeline. This step is used for grabbing previously seen objects the pipeline as identified by as-steps.
    
    Specified by:
    
    table in interface PipesFluentPipeline<S,E>
    
    Parameters:
    table - the table to fill
    
    Returns:
    the extended Pipeline
  - table
```
public PipesPipeline<S,E> table()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TablePipe to the end of the Pipeline. This step is used for grabbing previously seen objects the pipeline as identified by as-steps.
    
    Specified by:
    
    table in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - tree
```
public PipesPipeline<S,E> tree(Tree tree,
                      PipeFunction... branchFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TreePipe to the end of the Pipeline This step maintains an internal tree representation of the paths that have flowed through the step.
    
    Specified by:
    
    tree in interface PipesFluentPipeline<S,E>
    
    Parameters:
    tree - an embedded Map data structure to store the tree representation in
    branchFunctions - functions to apply to each path object in a round robin fashion
    
    Returns:
    the extended Pipeline
  - tree
```
public PipesPipeline<S,E> tree(PipeFunction... branchFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TreePipe to the end of the Pipeline This step maintains an internal tree representation of the paths that have flowed through the step.
    
    Specified by:
    
    tree in interface PipesFluentPipeline<S,E>
    
    Parameters:
    branchFunctions - functions to apply to each path object in a round robin fashion
    
    Returns:
    the extended Pipeline
  - gather
```
public PipesPipeline<S,List> gather()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GatherPipe to the end of the Pipeline. All the objects previous to this step are aggregated in a greedy fashion and emitted as a List.
    
    Specified by:
    
    gather in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - gather
```
public PipesPipeline<S,?> gather(PipeFunction<List,?> function)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a GatherPipe to the end of the Pipeline. All the objects previous to this step are aggregated in a greedy fashion into a List. The provided function is applied to the aggregate and the results of the function are emitted. Typically, the output of the function is a pruned List. This is good for selective breadth-first searching.
    
    Specified by:
    
    gather in interface PipesFluentPipeline<S,E>
    
    Parameters:
    function - a transformation to apply to the gathered list
    
    Returns:
    the extended Pipeline
  - _
```
public PipesPipeline<S,E> _()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an IdentityPipe to the end of the Pipeline. Useful in various situations where a step is needed without processing. For example, useful when two as-steps are needed in a row.
    
    Specified by:
    
    _ in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - memoize
```
public PipesPipeline<S,E> memoize(String namedStep)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a MemoizePipe to the end of the Pipeline. This step will hold a Map of the objects that have entered into its pipeline section. If an input is seen twice, then the map stored output is emitted instead of recomputing the pipeline section.
    
    Specified by:
    
    memoize in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedStep - the name of the step previous to memoize to
    
    Returns:
    the extended Pipeline
  - memoize
```
public PipesPipeline<S,E> memoize(int numberedStep)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a MemoizePipe to the end of the Pipeline. This step will hold a Map of the objects that have entered into its pipeline section. If an input is seen twice, then the map stored output is emitted instead of recomputing the pipeline section.
    
    Specified by:
    
    memoize in interface PipesFluentPipeline<S,E>
    
    Parameters:
    numberedStep - the number of the step previous to memoize to
    
    Returns:
    the extended Pipeline
  - memoize
```
public PipesPipeline<S,E> memoize(String namedStep,
                         Map map)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a MemoizePipe to the end of the Pipeline. This step will hold a Map of the objects that have entered into its pipeline section. If an input is seen twice, then the map stored output is emitted instead of recomputing the pipeline section.
    
    Specified by:
    
    memoize in interface PipesFluentPipeline<S,E>
    
    Parameters:
    namedStep - the name of the step previous to memoize to
    map - the memoization map
    
    Returns:
    the extended Pipeline
  - memoize
```
public PipesPipeline<S,E> memoize(int numberedStep,
                         Map map)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a MemoizePipe to the end of the Pipeline. This step will hold a Map of the objects that have entered into its pipeline section. If an input is seen twice, then the map stored output is emitted instead of recomputing the pipeline section.
    
    Specified by:
    
    memoize in interface PipesFluentPipeline<S,E>
    
    Parameters:
    numberedStep - the number of the step previous to memoize to
    map - the memoization map
    
    Returns:
    the extended Pipeline
  - order
```
public PipesPipeline<S,E> order()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an OrderPipe to the end of the Pipeline. This step will sort the objects in the stream in a default Comparable order.
    
    Specified by:
    
    order in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - order
```
public PipesPipeline<S,E> order(TransformPipe.Order order)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an OrderPipe to the end of the Pipeline. This step will sort the objects in the stream in a default Comparable order.
    
    Specified by:
    
    order in interface PipesFluentPipeline<S,E>
    
    Parameters:
    order - if the stream is composed of comparable objects, then increment or decrement can be specified
    
    Returns:
    the extended Pipeline
  - order
```
public PipesPipeline<S,E> order(PipeFunction<Pair<E,E>,Integer> compareFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add an OrderPipe to the end of the Pipeline. This step will sort the objects in the stream according to a comparator defined in the provided function.
    
    Specified by:
    
    order in interface PipesFluentPipeline<S,E>
    
    Parameters:
    compareFunction - a comparator function of two objects of type E
    
    Returns:
    the extended Pipeline
  - path
```
public PipesPipeline<S,List> path(PipeFunction... pathFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a PathPipe or PathPipe to the end of the Pipeline. This will emit the path that has been seen thus far. If path functions are provided, then they are evaluated in a round robin fashion on the objects of the path.
    
    Specified by:
    
    path in interface PipesFluentPipeline<S,E>
    
    Parameters:
    pathFunctions - the path function of the PathPipe
    
    Returns:
    the extended Pipeline
  - select
```
public PipesPipeline<S,Row> select(Collection<String> stepNames,
                          PipeFunction... columnFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a SelectPipe to the end of the Pipeline. The objects of the named steps (via as) previous in the pipeline are emitted as a Row object. A Row object extends ArrayList and simply provides named columns and some helper methods. If column functions are provided, then they are evaluated in a round robin fashion on the objects of the Row.
    
    Specified by:
    
    select in interface PipesFluentPipeline<S,E>
    
    Parameters:
    stepNames - the name of the steps in the expression to retrieve the objects from
    columnFunctions - the functions to apply to the column objects prior to filling the Row
    
    Returns:
    the extended Pipeline
  - select
```
public PipesPipeline<S,Row> select(PipeFunction... columnFunctions)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a SelectPipe to the end of the Pipeline. The objects of the named steps (via as) previous in the pipeline are emitted as a Row object. A Row object extends ArrayList and simply provides named columns and some helper methods. If column functions are provided, then they are evaluated in a round robin fashion on the objects of the Row.
    
    Specified by:
    
    select in interface PipesFluentPipeline<S,E>
    
    Parameters:
    columnFunctions - the functions to apply to the column objects prior to filling the Row
    
    Returns:
    the extended Pipeline
  - select
```
public PipesPipeline<S,Row> select()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a SelectPipe to the end of the Pipeline. The objects of the named steps (via as) previous in the pipeline are emitted as a Row object. A Row object extends ArrayList and simply provides named columns and some helper methods.
    
    Specified by:
    
    select in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - scatter
```
public PipesPipeline<S,?> scatter()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a ScatterPipe to the end of the Pipeline. Any inputted iterator or iterable is unrolled and the iterator/iterable's objects are emitted one at a time.
    
    Specified by:
    
    scatter in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - shuffle
```
public PipesPipeline<S,List> shuffle()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a ShufflePipe to the end of the Pipeline. All the objects previous to this step are aggregated in a greedy fashion, their order randomized and emitted as a List.
    
    Specified by:
    
    shuffle in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - cap
```
public PipesPipeline<S,?> cap()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a SideEffectCapPipe to the end of the Pipeline. When the previous step in the pipeline is implements SideEffectPipe, then it has a method called getSideEffect(). The cap step will greedily iterate the pipeline and then, when its empty, emit the side effect of the previous pipe.
    
    Specified by:
    
    cap in interface PipesFluentPipeline<S,E>
    
    Returns:
    the extended Pipeline
  - orderMap
```
public PipesPipeline<S,?> orderMap(TransformPipe.Order order)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a OrderMapPipe to the end of the Pipeline Given a Map as an input, the map is first ordered and then the keys are emitted in the order.
    
    Specified by:
    
    orderMap in interface PipesFluentPipeline<S,E>
    
    Parameters:
    order - if the values implement Comparable, then a increment or decrement sort is usable
    
    Returns:
    the extended Pipeline
  - orderMap
```
public PipesPipeline<S,?> orderMap(PipeFunction<Pair<Map.Entry,Map.Entry>,Integer> compareFunction)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a OrderMapPipe to the end of the Pipeline Given a Map as an input, the map is first ordered and then the keys are emitted in the order.
    
    Specified by:
    
    orderMap in interface PipesFluentPipeline<S,E>
    
    Parameters:
    compareFunction - a function to compare to map entries
    
    Returns:
    the extended Pipeline
  - transform
```
public <T> PipesPipeline<S,T> transform(PipeFunction<E,T> function)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a TransformFunctionPipe to the end of the Pipeline. Given an input, the provided function is computed on the input and the output of that function is emitted.
    
    Specified by:
    
    transform in interface PipesFluentPipeline<S,E>
    
    Parameters:
    function - the transformation function of the pipe
    
    Returns:
    the extended Pipeline
  - as
```
public PipesPipeline<S,E> as(String name)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Wrap the previous step in an AsPipe. Useful for naming steps and is used in conjunction with various other steps including: loop, select, back, table, etc.
    
    Specified by:
    
    as in interface PipesFluentPipeline<S,E>
    
    Parameters:
    name - the name of the AsPipe
    
    Returns:
    the extended Pipeline
  - start
```
public PipesPipeline<S,S> start(S object)
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Add a StartPipe to the end of the pipeline. Though, in practice, a StartPipe is usually the beginning. Moreover, the constructor of the Pipeline will internally use StartPipe.
    
    Specified by:
    
    start in interface PipesFluentPipeline<S,E>
    
    Parameters:
    object - the object that serves as the start of the pipeline (iterator/iterable are unfolded)
    
    Returns:
    the extended Pipeline
  - enablePath
```
public PipesFluentPipeline<S,E> enablePath()
```
    Deprecated.
    
    Description copied from interface: PipesFluentPipeline
    
    Enable path calculations in the pipeline. This is typically handled automatically and on rare occasions requires an explicit call.
    
    Specified by:
    
    enablePath in interface PipesFluentPipeline<S,E>
    
    Returns:
    the path-enabled Pipeline
  - cast
```
public <E> PipesPipeline<S,E> cast(Class<E> end)
```
    Deprecated.
    
    Returns the current pipeline with a new end type. Useful if the end type of the pipeline cannot be implicitly derived.
    
    Specified by:
    
    cast in interface PipesFluentPipeline<S,E>
    
    Overrides:
    
    cast in class Pipeline<S,E>
    
    Returns:
    returns the current pipeline with the new end type.

Class PipesPipeline<S,E>

Field Summary

Fields inherited from class com.tinkerpop.pipes.util.Pipeline

Fields inherited from interface com.tinkerpop.pipes.Pipe

Constructor Summary

Method Summary

Methods inherited from class com.tinkerpop.pipes.util.Pipeline

Methods inherited from class java.lang.Object

Methods inherited from interface com.tinkerpop.pipes.util.PipesFluentPipeline

Constructor Detail

PipesPipeline

PipesPipeline

Method Detail

add

step

step

copySplit

exhaustMerge

fairMerge

ifThenElse

loop

loop

loop

loop

and

back

back

dedup

dedup

except

except

filter

or

random

range

retain

retain

simplePath

aggregate

aggregate

aggregate

aggregate

optional

optional

groupBy

groupBy

groupBy

groupBy

groupCount

groupCount

groupCount

groupCount

groupCount

groupCount

sideEffect

store

store

store

store

table

table

table

table

table

tree

tree

gather

gather

_

memoize

memoize

memoize

memoize

order

order

order

path

select

select

select