Detailed Description

Abstract base class for all Pipeline builders.

The default implementation is PipelineBuilder.

Parameters: <T> - the builder type

Inheritance diagram for fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >:

Collaboration diagram for fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >:

Public Member Functions

	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	addService (PipelineService service) Add a service to the builder which will be needed by any of the elements being added to the pipeline. 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...

Protected Member Functions

List< FlowElement >	getFlowElements ()
void	addServicesToPipeline (Pipeline pipeline) Add all known services to a Pipeline to be managed. More...
void	onPreBuild () Called just before a pipeline is built.

Protected Attributes

final ILoggerFactory	loggerFactory The ILoggerFactory used to create any loggers required by instances being built by the builder.
final Logger	logger Logger created from loggerFactory to allow logging in this builder.
final List< FlowElement >	flowElements = new ArrayList<>() List of flow elements to add to the Pipeline.
final List< PipelineService >	services = new ArrayList<>() List of services to be managed by the Pipeline.
boolean	autoCloseElements = false
boolean	suppressProcessExceptions = false

Constructor & Destructor Documentation

◆ PipelineBuilderBase()

fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.PipelineBuilderBase

(

ILoggerFactory

loggerFactory

)

Construct a new instance.

Parameters: loggerFactory - the ILoggerFactory used to create any loggers required by instances being built by the builder

Member Function Documentation

◆ addFlowElement()

T fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.addFlowElement

(

FlowElement

element

)

Add a FlowElement to the Pipeline to be run in series.

Parameters: element - to add

Returns: this builder

◆ addFlowElementsParallel()

T fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.addFlowElementsParallel

(

FlowElement []

elements

)

Add an array of FlowElements to the Pipeline to be run in parallel.

Must contain more than 1 element.

Parameters: elements - to add

Returns: this builder

◆ addService()

T fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.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 PipelineBuilderFromConfiguration#buildFromConfiguration(PipelineOptions).

See PipelineService for more details.

Parameters: service - the service instance to add

Returns: this builder

◆ addServicesToPipeline()

void fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.addServicesToPipeline

(

Pipeline

pipeline

)

protected

Add all known services to a Pipeline to be managed.

Parameters: pipeline - pipeline to add service to

◆ build()

Pipeline fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.build

(

)

throws Exception

Build the Pipeline using the FlowElements added.

Returns: new Pipeline instance

Exceptions: Exception - if a pipeline could not be constructed

◆ setAutoCloseElements()

T fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.setAutoCloseElements

(

boolean

autoClose

)

Configure the Pipeline to either call dispose on it's child FlowElements when it is disposed or not.

Parameters: autoClose - true if the Pipeline should call dispose on it's child elements when it is disposed

Returns: this builder

◆ setSuppressProcessException()

T fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >.setSuppressProcessException

(