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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PipesPipeline
```
public class Pipeline<S,E>
extends Object
implements Pipe<S,E>, MetaPipe
```
A Pipeline is a linear composite of Pipes. Pipeline takes a List of Pipes and joins them according to their order as specified by their location in the List. It is important to ensure that the provided ordered Pipes can connect together. That is, that the output type of the n-1 Pipe is the same as the input type of the n Pipe. Once all provided Pipes are composed, a Pipeline can be treated like any other Pipe.

Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Pipe<?,E>`	`endPipe`
`protected boolean`	`pathEnabled`
`protected List<Pipe>`	`pipes`
`protected Pipe<S,?>`	`startPipe`
`protected Iterator<S>`	`starts`

Fields inherited from interface com.tinkerpop.pipes.Pipe
NO_PATH_MESSAGE

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPipe(int location, Pipe pipe)`
`void`	`addPipe(Pipe pipe)` Adds a new pipe to the end of the pipeline and then reconstructs the pipeline chain.
`<E> Pipeline<S,E>`	`cast(Class<E> end)` Returns the current pipeline with a new end type.
`long`	`count()`
`void`	`enablePath(boolean enable)` Calculating paths can be an expensive operation for some pipes.
`boolean`	`equals(Object object)`
`Collection<E>`	`fill(Collection<E> collection)`
`Pipe`	`get(int index)`
`List`	`getCurrentPath()` Returns the transformation path to arrive at the current object of the pipe.
`List<Pipe>`	`getPipes()`
`Iterator<S>`	`getStarts()`
`boolean`	`hasNext()` Determines if there is another object that can be emitted from the pipeline.
`void`	`iterate()`
`Iterator<E>`	`iterator()` Simply returns this as as a pipeline (more specifically, pipe) implements Iterator.
`E`	`next()` Get the next object emitted from the pipeline.
`List<E>`	`next(int number)`
`void`	`remove()` An unsupported operation that throws an UnsupportedOperationException.
`Pipe`	`remove(int index)`
`void`	`reset()` A pipe may maintain state.
`protected void`	`setPipes(List<Pipe> pipes)` Useful for constructing the pipeline chain without making use of the constructor.
`void`	`setStarts(Iterable<S> starts)` Set an iterable of S objects to the head (start) of the pipe.
`void`	`setStarts(Iterator<S> starts)` Set an iterator of S objects to the head (start) of the pipe.
`int`	`size()` Get the number of pipes in the pipeline.
`List<E>`	`toList()`
`String`	`toString()`

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

- Field Detail
  - startPipe
```
protected Pipe<S,?> startPipe
```
  - endPipe
```
protected Pipe<?,E> endPipe
```
  - pipes
```
protected List<Pipe> pipes
```
  - starts
```
protected Iterator<S> starts
```
  - pathEnabled
```
protected boolean pathEnabled
```
- Constructor Detail
  - Pipeline
```
public Pipeline()
```
  - Pipeline
```
public Pipeline(List<Pipe> pipes)
```
    Constructs a pipeline from the provided pipes. The ordered list determines how the pipes will be chained together. When the pipes are chained together, the start of pipe n is the end of pipe n-1.
    
    Parameters:
    pipes - the ordered list of pipes to chain together into a pipeline
  - Pipeline
```
public Pipeline(Pipe... pipes)
```
    Constructs a pipeline from the provided pipes. The ordered array determines how the pipes will be chained together. When the pipes are chained together, the start of pipe n is the end of pipe n-1.
    
    Parameters:
    pipes - the ordered array of pipes to chain together into a pipeline
- Method Detail
  - setPipes
```
protected void setPipes(List<Pipe> pipes)
```
    Useful for constructing the pipeline chain without making use of the constructor.
    
    Parameters:
    pipes - the ordered list of pipes to chain together into a pipeline
  - addPipe
```
public void addPipe(Pipe pipe)
```
    Adds a new pipe to the end of the pipeline and then reconstructs the pipeline chain.
    
    Parameters:
    pipe - the new pipe to add to the pipeline
  - addPipe
```
public void addPipe(int location,
           Pipe pipe)
```
  - setStarts
```
public void setStarts(Iterator<S> starts)
```
    Description copied from interface: Pipe
    
    Set an iterator of S objects to the head (start) of the pipe.
    
    Specified by:
    
    setStarts in interface Pipe<S,E>
    
    Parameters:
    starts - the iterator of incoming objects
  - setStarts
```
public void setStarts(Iterable<S> starts)
```
    Description copied from interface: Pipe
    
    Set an iterable of S objects to the head (start) of the pipe.
    
    Specified by:
    
    setStarts in interface Pipe<S,E>
    
    Parameters:
    starts - the iterable of incoming objects
  - remove
```
public void remove()
```
    An unsupported operation that throws an UnsupportedOperationException.
    
    Specified by:
    
    remove in interface Iterator<E>
  - hasNext
```
public boolean hasNext()
```
    Determines if there is another object that can be emitted from the pipeline.
    
    Specified by:
    
    hasNext in interface Iterator<E>
    
    Returns:
    true if an object can be next()'d out of the pipeline
  - next
```
public E next()
```
    Get the next object emitted from the pipeline. If no such object exists, then a NoSuchElementException is thrown.
    
    Specified by:
    
    next in interface Iterator<E>
    
    Returns:
    the next emitted object
  - getCurrentPath
```
public List getCurrentPath()
```
    Description copied from interface: Pipe
    
    Returns the transformation path to arrive at the current object of the pipe.
    
    Specified by:
    
    getCurrentPath in interface Pipe<S,E>
    
    Returns:
    a List of all of the objects traversed for the current iterator position of the pipe.
  - enablePath
```
public void enablePath(boolean enable)
```
    Description copied from interface: Pipe
    
    Calculating paths can be an expensive operation for some pipes. This method is used to activate or deactivate the calculation of paths. The default state of a newly constructed pipe should have its path calculations disabled. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.
    
    Specified by:
    
    enablePath in interface Pipe<S,E>
    
    Parameters:
    enable - enable path calculations
  - size
```
public int size()
```
    Get the number of pipes in the pipeline.
    
    Returns:
    the pipeline length
  - 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>
  - iterator
```
public Iterator<E> iterator()
```
    Simply returns this as as a pipeline (more specifically, pipe) implements Iterator.
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Returns:
    returns the iterator representation of this pipeline
  - cast
```
public <E> Pipeline<S,E> cast(Class<E> end)
```
    Returns the current pipeline with a new end type. Useful if the end type of the pipeline cannot be implicitly derived.
    
    Returns:
    returns the current pipeline with the new end type.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPipes
```
public List<Pipe> getPipes()
```
    Specified by:
    
    getPipes in interface MetaPipe
  - getStarts
```
public Iterator<S> getStarts()
```
  - remove
```
public Pipe remove(int index)
```
  - get
```
public Pipe get(int index)
```
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - count
```
public long count()
```
  - iterate
```
public void iterate()
```
  - next
```
public List<E> next(int number)
```
  - toList
```
public List<E> toList()
```
  - fill
```
public Collection<E> fill(Collection<E> collection)
```

Class Pipeline<S,E>

Field Summary

Fields inherited from interface com.tinkerpop.pipes.Pipe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startPipe

endPipe

pipes

starts

pathEnabled

Constructor Detail

Pipeline

Pipeline

Pipeline

Method Detail

setPipes

addPipe

addPipe

setStarts

setStarts

remove

hasNext

next

getCurrentPath

enablePath

size

reset

iterator

cast

toString

getPipes

getStarts

remove

get

equals

count

iterate

next

toList

fill