Detailed Description

The PipelineBuilder follows the fluent builder pattern.

It is used to construct instances of the Pipeline. FlowElements can be added individually to be run in series, or as an array to be run in parallel.

A PipelineBuilder is intended to be used once only and once build() has been called it cannot be used further.

Inheritance diagram for fiftyone.pipeline.core.flowelements.PipelineBuilder:

[legend]

Collaboration diagram for fiftyone.pipeline.core.flowelements.PipelineBuilder:

[legend]

Public Member Functions

	PipelineBuilder () Construct a new builder.
	PipelineBuilder (ILoggerFactory loggerFactory) Construct a new instance. More...
Pipeline	buildFromConfiguration (PipelineOptions options) throws Exception Build the pipeline using the specified configuration options. More...
PipelineBuilder	addService (PipelineService service) Add a service to the builder which will be needed by any of the elements being added to the pipeline. More...
Public Member Functions inherited from fiftyone.pipeline.core.flowelements.PipelineBuilderBase< PipelineBuilder >
	PipelineBuilderBase () Construct a new instance using the default ILoggerFactory implementation returned by the LoggerFactory#getILoggerFactory() method.
	PipelineBuilderBase (ILoggerFactory loggerFactory) Construct a new instance. More...
Pipeline	build () throws Exception Build the Pipeline using the FlowElements added. More...
T	addFlowElement (FlowElement element) Add a FlowElement to the Pipeline to be run in series. More...
T	addFlowElementsParallel (FlowElement[] elements) Add an array of FlowElements to the Pipeline to be run in parallel. More...
T	setAutoCloseElements (boolean autoClose) Configure the Pipeline to either call dispose on it's child FlowElements when it is disposed or not. More...
T	setSuppressProcessException (boolean suppress) Configure the Pipeline to either suppress exceptions added to FlowData#getErrors() during processing or to throw them as an aggregate exception once processing is complete. More...

Constructor & Destructor Documentation

◆ PipelineBuilder()

fiftyone.pipeline.core.flowelements.PipelineBuilder.PipelineBuilder

(

ILoggerFactory

loggerFactory

)

Construct a new instance.

Parameters: loggerFactory - logger factory to use when passing loggers to any instances created by the builder

Member Function Documentation

◆ addService()

PipelineBuilder fiftyone.pipeline.core.flowelements.PipelineBuilder.addService

(

PipelineService

service

)

Add a service to the builder which will be needed by any of the elements being added to the pipeline.

This should be used when calling buildFromConfiguration(PipelineOptions).

See PipelineService for more details.

Parameters: service - the service instance to add

Returns: this builder

◆ buildFromConfiguration()

Pipeline fiftyone.pipeline.core.flowelements.PipelineBuilder.buildFromConfiguration

(

PipelineOptions

options

)

throws Exception

Build the pipeline using the specified configuration options.

Parameters: options - a PipelineOptions instance describing how to build the pipeline

Returns: a new Pipeline instance containing the configured FlowElement instances

Exceptions: Exception - if the configuration could not be used to build a valid Pipeline

Implements fiftyone.pipeline.core.flowelements.PipelineBuilderFromConfiguration.

51Degrees Pipeline Java 4.2

fiftyone.pipeline.core.flowelements.PipelineBuilder Class Reference