Package org.pipecraft.pipes.terminal

Class CompoundTerminalPipe

java.lang.Object

org.pipecraft.pipes.terminal.TerminalPipe

org.pipecraft.pipes.terminal.CompoundTerminalPipe

All Implemented Interfaces:

Closeable, AutoCloseable, BasePipe

Direct Known Subclasses:

BinFileWriterPipe, SharderBySeqPipe

public abstract class CompoundTerminalPipe
extends TerminalPipe

A terminal pipe encapsulating a pipeline. Subclasses should implement createPipeline() method.

Author:

Eyal Schneider

Constructor Summary

Constructors

Constructor	Description
CompoundTerminalPipe()

Method Summary

Modifier and Type	Method	Description
void	close()
protected abstract TerminalPipe	createPipeline()
float	getProgress()
void	start()	Performs pre-processing prior to item flow throw the pipe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompoundTerminalPipe

public CompoundTerminalPipe()

Method Detail

close

public void close()
           throws IOException

Throws:

IOException

start

public void start()
           throws PipeException,
                  InterruptedException

Description copied from interface: BasePipe

Performs pre-processing prior to item flow throw the pipe. Implementations must call the same method for all their input pipes before accessing their items. This is typically done here.

Throws:

PipeException - In case of pipe errors in this pipe or somewhere up-stream.

InterruptedException - In case that the operation has been interrupted by another thread.

createPipeline

protected abstract TerminalPipe createPipeline()
                                        throws PipeException,
                                               InterruptedException

Returns:

A new terminal pipeline to represent the logic of this pipe

Throws:

PipeException - In case of a pipeline creation error

InterruptedException - In case that the thread is interrupted

getProgress

public float getProgress()

Specified by:

getProgress in interface BasePipe

Overrides:

getProgress in class TerminalPipe

Returns:

The pipe flow progress, as a floating number between 0.0 and 1.0. Important implementation rules: 1) Calling this method before start() call is complete isn't allowed and has an undefined behavior. 2) Implementation should do best effort to provide an estimate of the progress this pipe has made (0.0 - 1.0) 3) When the pipe is fully consumed, getProgress() should return 1.0. 4) Results must be monotonous, i.e. results of consecutive calls may never be decreasing. 5) Thread safety: progress may be maintained by some thread/s but monitoring by other threads. Implementations must be thread safe.