net.sf.filePiper.model
Class Pipeline

java.lang.Object
  net.sf.filePiper.model.Pipeline

public class Pipeline
extends Object

The pipeline is the object controlling the overall processing.
The pipeline is composed of:

• A pipeline start: The object selecting the input file(s) and creating the initial input stream(s).
• A list of ProcessorThread: each ProcessorThread is controlling the job of one FileProcessor object. If there are several processorThreads, they will create Piped streams to communicate.
• A pipeline end: The component of the pipeline writing the resulting output stream(s) to file(s).

Author:

berol

Field Summary

static int	OUTPUT_NAME_CURRENT Possible options for ouput name choice
static int	OUTPUT_NAME_NEW
static int	OUTPUT_NAME_PROPOSED
static int	OUTPUT_TO_CONSOLE Possible option for ouput destination
static int	OUTPUT_TO_FILE

Constructor Summary

Pipeline(net.sf.sfac.setting.Settings setts)

Method Summary

void	addProcessor(FileProcessor fp)
void	addProcessor(int index, FileProcessor fp)
void	changeProcessorAt(int processorIndex, FileProcessor newProto)
void	duplicateProcessor(int index)
String	getExcludesPattern()
String	getIncludesPattern()
int	getOutputCardinality()
int	getOutputDestination()
File	getOutputFile()
int	getOutputNameChoice()
List<FileProcessor>	getProcessors()
net.sf.sfac.setting.Settings	getSettings()
File	getSource()
boolean	isSourceMultiFile()
void	process(PipelineEnvironment reporter)
void	removeProcessor(int index)
void	reset()
void	setExcludesPattern(String newExcludesPattern)
void	setIncludesPattern(String newIncludesPattern)
void	setOutputDestination(int newOutputDestination)
void	setOutputFile(File newOutputFile)
void	setOutputNameChoice(int newOutputNameChoice)
void	setSource(File newSource)
void	setSourceMultiFile(boolean multi)

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_NAME_CURRENT

public static final int OUTPUT_NAME_CURRENT

Possible options for ouput name choice

See Also:

Constant Field Values

OUTPUT_NAME_PROPOSED

public static final int OUTPUT_NAME_PROPOSED

See Also:

Constant Field Values

OUTPUT_NAME_NEW

public static final int OUTPUT_NAME_NEW

See Also:

Constant Field Values

OUTPUT_TO_CONSOLE

public static final int OUTPUT_TO_CONSOLE

Possible option for ouput destination

See Also:

Constant Field Values

OUTPUT_TO_FILE

public static final int OUTPUT_TO_FILE

See Also:

Constant Field Values

Constructor Detail

Pipeline

public Pipeline(net.sf.sfac.setting.Settings setts)

Method Detail

reset

public void reset()

isSourceMultiFile

public boolean isSourceMultiFile()

setSourceMultiFile

public void setSourceMultiFile(boolean multi)

getOutputDestination

public int getOutputDestination()

setOutputDestination

public void setOutputDestination(int newOutputDestination)

getOutputNameChoice

public int getOutputNameChoice()

setOutputNameChoice

public void setOutputNameChoice(int newOutputNameChoice)

getSource

public File getSource()

setSource

public void setSource(File newSource)

getIncludesPattern

public String getIncludesPattern()

setIncludesPattern

public void setIncludesPattern(String newIncludesPattern)

getExcludesPattern

public String getExcludesPattern()

setExcludesPattern

public void setExcludesPattern(String newExcludesPattern)

getOutputFile

public File getOutputFile()

setOutputFile

public void setOutputFile(File newOutputFile)

getSettings

public net.sf.sfac.setting.Settings getSettings()

changeProcessorAt

public void changeProcessorAt(int processorIndex,
                              FileProcessor newProto)

removeProcessor

public void removeProcessor(int index)

addProcessor

public void addProcessor(FileProcessor fp)

addProcessor

public void addProcessor(int index,
                         FileProcessor fp)

duplicateProcessor

public void duplicateProcessor(int index)

getProcessors

public List<FileProcessor> getProcessors()

process

public void process(PipelineEnvironment reporter)
             throws IOException

Throws:

IOException

getOutputCardinality

public int getOutputCardinality()