Package com.kodexa.client.remote

Class RemotePipeline

java.lang.Object

com.kodexa.client.pipeline.Pipeline

com.kodexa.client.remote.RemotePipeline

public class RemotePipeline
extends Pipeline

A remote-hosted Pipeline

Field Summary

Fields inherited from class com.kodexa.client.pipeline.Pipeline

connector

Constructor Summary

Constructors

Constructor	Description
RemotePipeline(String ref, Connector connector)
RemotePipeline(String ref, Document document)

Method Summary

Modifier and Type	Method	Description
static RemotePipeline	fromFolder(String ref, String folderPath, String filenameFilter, boolean recursive)
static RemotePipeline	fromInputStream(String ref, InputStream inputStream)
static RemotePipeline	fromText(String ref, String text)	Create a new pipeline based on a remote reference and a text document
static RemotePipeline	fromUrl(String ref, String url)
RemotePipeline	options(Options options)
RemotePipeline	parameters(Map<String,Object> parameters)
PipelineContext	run()
Pipeline	setSink(Sink sink)	Set the sink

Methods inherited from class com.kodexa.client.pipeline.Pipeline

addParameter, addStep, addStep, addStep, fromFolder, fromInputStream, fromText, fromUrl, parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

RemotePipeline

public RemotePipeline(String ref,
                      Connector connector)

RemotePipeline

public RemotePipeline(String ref,
                      Document document)

Method Detail

parameters

public RemotePipeline parameters(Map<String,Object> parameters)

options

public RemotePipeline options(Options options)

run

public PipelineContext run()

Overrides:

run in class Pipeline

setSink

public Pipeline setSink(Sink sink)

Set the sink

Overrides:

setSink in class Pipeline

Parameters:

sink - The sink to use for the documents

fromText

public static RemotePipeline fromText(String ref,
                                      String text)

Create a new pipeline based on a remote reference and a text document

Parameters:

ref - the reference (slug) to the pipeline

text - The text to use to create a new document

Returns:

A new remote pipeline

fromUrl

public static RemotePipeline fromUrl(String ref,
                                     String url)

fromInputStream

public static RemotePipeline fromInputStream(String ref,
                                             InputStream inputStream)

fromFolder

public static RemotePipeline fromFolder(String ref,
                                        String folderPath,
                                        String filenameFilter,
                                        boolean recursive)