Package com.kodexa.client.pipeline

Class Pipeline

java.lang.Object

com.kodexa.client.pipeline.Pipeline

Direct Known Subclasses:

RemotePipeline

public class Pipeline
extends Object

A Pipeline allows you to put together steps from a connector to a sink to enable re-use and encapsulation of steps.

Field Summary

Fields

Modifier and Type	Field	Description
protected Connector	connector
protected List<PipelineParameter>	parameters

Constructor Summary

Constructors

Constructor	Description
Pipeline(Connector connector)
Pipeline(Document document)

Method Summary

Modifier and Type	Method	Description
Pipeline	addParameter(String name, String value)
Pipeline	addStep(PipelineStep step)
Pipeline	addStep(Class stepClass, Options options)
Pipeline	addStep(String actionSlug, Options options)
static Pipeline	fromFolder(String folderPath, String filenameFilter, boolean recursive)
static Pipeline	fromInputStream(InputStream inputStream)
static Pipeline	fromText(String text)	Create a pipeline with a single document as input containing the content from this text
static Pipeline	fromUrl(String url)
Pipeline	parameters(List<PipelineParameter> parameters)
PipelineContext	run()
Pipeline	setSink(Sink sink)

Methods inherited from class java.lang.Object

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

Field Detail

connector

protected final Connector connector

parameters

protected List<PipelineParameter> parameters

Constructor Detail

Pipeline

public Pipeline(Connector connector)

Pipeline

public Pipeline(Document document)

Method Detail

addStep

public Pipeline addStep(Class stepClass,
                        Options options)

addStep

public Pipeline addStep(String actionSlug,
                        Options options)

addStep

public Pipeline addStep(PipelineStep step)

setSink

public Pipeline setSink(Sink sink)

parameters

public Pipeline parameters(List<PipelineParameter> parameters)

run

public PipelineContext run()

fromText

public static Pipeline fromText(String text)

Create a pipeline with a single document as input containing the content from this text

Parameters:

text - The text to use as the content of the document

Returns:

an instance of the pipeline

fromUrl

public static Pipeline fromUrl(String url)

fromInputStream

public static Pipeline fromInputStream(InputStream inputStream)

fromFolder

public static Pipeline fromFolder(String folderPath,
                                  String filenameFilter,
                                  boolean recursive)

addParameter

public Pipeline addParameter(String name,
                             String value)