Hermes@Neo4j
Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E > Class Template Reference
Inheritance diagram for Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >:
Neo4jSpatiotemporal.pipes.impl.PipeTemporal< S, E > Neo4jSpatiotemporal.pipes.GeoPipelineTemporal

Public Member Functions

 PipelineTemporal ()
 
 PipelineTemporal (final List< PipeTemporal > pipes)
 
 PipelineTemporal (final PipeTemporal...pipes)
 
void addPipe (final PipeTemporal pipe)
 
void setStarts (final Iterator< S > starts)
 
void setStarts (final Iterable< S > starts)
 
void remove ()
 
boolean hasNext ()
 
next ()
 
List getPath ()
 
int size ()
 
void reset ()
 
Iterator< E > iterator ()
 
String toString ()
 
List< PipeTemporalgetPipes ()
 
Iterator< S > getStarts ()
 
PipeTemporal remove (final int index)
 
PipeTemporal get (final int index)
 
boolean equals (final Object object)
 
long count ()
 
void iterate ()
 
List< E > next (final int number)
 
List< E > toList ()
 
Collection< E > fill (final Collection< E > collection)
 
- Public Member Functions inherited from Neo4jSpatiotemporal.pipes.impl.PipeTemporal< S, E >
void setStarts (Iterator< S > starts)
 
void setStarts (Iterable< S > starts)
 

Static Public Member Functions

static boolean areEqual (final Iterator it1, final Iterator it2)
 

Protected Member Functions

void setPipes (final List< PipeTemporal > pipes)
 
void setPipes (final PipeTemporal...pipes)
 

Protected Attributes

PipeTemporal< S,?> startPipe
 
PipeTemporal<?, E > endPipe
 
List< PipeTemporalpipes
 
Iterator< S > starts
 

Detailed Description

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.

Constructor & Destructor Documentation

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
pipesthe ordered list of pipes to chain together into a pipeline
Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.PipelineTemporal ( final PipeTemporal...  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
pipesthe ordered array of pipes to chain together into a pipeline

Member Function Documentation

void Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.addPipe ( final PipeTemporal  pipe)

Adds a new pipe to the end of the pipeline and then reconstructs the pipeline chain.

Parameters
pipethe new pipe to add to the pipeline
static boolean Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.areEqual ( final Iterator  it1,
final Iterator  it2 
)
static
boolean Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.equals ( final Object  object)
Collection<E> Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.fill ( final Collection< E >  collection)

Returns the transformation path to arrive at the current object of the pipe.

Returns
a List of all of the objects traversed for the current iterator position of the pipe.

Implements Neo4jSpatiotemporal.pipes.impl.PipeTemporal< S, E >.

Iterator<S> Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.getStarts ( )

Determines if there is another object that can be emitted from the pipeline.

Returns
true if an object can be next()'d out of the pipeline
Iterator<E> Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.iterator ( )

Simply returns this as as a pipeline (more specifically, pipe) implements Iterator.

Returns
returns the iterator representation of this pipeline

Get the next object emitted from the pipeline. If no such object exists, then a NoSuchElementException is thrown.

Returns
the next emitted object
List<E> Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.next ( final int  number)

An unsupported operation that throws an UnsupportedOperationException.

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.

Implements Neo4jSpatiotemporal.pipes.impl.PipeTemporal< S, E >.

void Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.setPipes ( final List< PipeTemporal pipes)
protected

Useful for constructing the pipeline chain without making use of the constructor.

Parameters
pipesthe ordered list of pipes to chain together into a pipeline
void Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.setPipes ( final PipeTemporal...  pipes)
protected

Useful for constructing the pipeline chain without making use of the constructor.

Parameters
pipesthe ordered array of pipes to chain together into a pipeline
void Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.setStarts ( final Iterator< S >  starts)
void Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.setStarts ( final Iterable< S >  starts)

Get the number of pipes in the pipeline.

Returns
the pipeline length

Member Data Documentation

Iterator<S> Neo4jSpatiotemporal.pipes.impl.PipelineTemporal< S, E >.starts
protected

The documentation for this class was generated from the following file: