Package com.kodexa.client.pipeline

Class PipelineContext

java.lang.Object

com.kodexa.client.pipeline.PipelineContext

public class PipelineContext
extends Object

The pipeline context is used to manage state through a running pipeline

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,DataStore>	stores	The available stores

Constructor Summary

Constructors

Constructor	Description
PipelineContext()

Method Summary

Modifier and Type	Method	Description
void	addStore(String name, DataStore store)	Add the given store to the pipeline context
Document	getOutputDocument()	Returns the final output document, or null if there isn't one
Map<String,Object>	getParameterMap()
List<PipelineParameter>	getParameters()	The parameters that were passed to the pipeline
DataStore	getStore(String name)	Get a specific store
Set<String>	getStoreNames()	Return a set of the names of the stores in the pipeline
void	setOutputDocument(Document document)	Sets the final output document for the pipeline
void	setParameters(List<PipelineParameter> parameters)	The parameters that were passed to the pipeline

Methods inherited from class java.lang.Object

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

Field Detail

stores

public Map<String,DataStore> stores

The available stores

Constructor Detail

PipelineContext

public PipelineContext()

Method Detail

getStore

public DataStore getStore(String name)

Get a specific store

Parameters:

name - the name of the store to get

Returns:

The instance of the store (or null if not found)

getStoreNames

public Set<String> getStoreNames()

Return a set of the names of the stores in the pipeline

Returns:

set of names

addStore

public void addStore(String name,
                     DataStore store)

Add the given store to the pipeline context

Parameters:

name - the name of the store

store - The implementation of the store

setOutputDocument

public void setOutputDocument(Document document)

Sets the final output document for the pipeline

Parameters:

document - the final output document

getOutputDocument

public Document getOutputDocument()

Returns the final output document, or null if there isn't one

Returns:

final output document

getParameterMap

public Map<String,Object> getParameterMap()

getParameters

public List<PipelineParameter> getParameters()

The parameters that were passed to the pipeline

setParameters

public void setParameters(List<PipelineParameter> parameters)

The parameters that were passed to the pipeline