Detailed Description

Configuration object that describes how to build a Pipeline using a PipelineBuilder.

See also: Specification

Collaboration diagram for fiftyone.pipeline.core.configuration.PipelineOptions:

Public Member Functions

String	find (String builderName, String buildParameter) Retrieve the value for the build option specified. More...
String	findAndSubstitute (String builderName, String buildParameter) Retrieve the value for the build option specified. More...
boolean	replace (String builderName, String buildParameter, String value) Replace the value for the build option specified. More...

Public Attributes

List< ElementOptions >	elements = new ArrayList<>() Configuration information for the FlowElements that the Pipeline will contain. More...
Map< String, Object >	pipelineBuilderParameters = new HashMap<>() A map where the keys are method names and the values are parameter values. More...

Member Function Documentation

◆ find()

String fiftyone.pipeline.core.configuration.PipelineOptions.find	(	String	builderName,
		String	buildParameter
	)

Retrieve the value for the build option specified.

Parameters: builderName - a builder name; buildParameter - a builder parameter

Returns: the value for that option or null if not present

◆ findAndSubstitute()

String fiftyone.pipeline.core.configuration.PipelineOptions.findAndSubstitute	(	String	builderName,
		String	buildParameter
	)

Retrieve the value for the build option specified.

Parameters: builderName - a builder name; buildParameter - a builder parameter

Returns: the value for that option, with Lookup Options substituted or null if not present

◆ replace()

boolean fiftyone.pipeline.core.configuration.PipelineOptions.replace	(	String	builderName,
		String	buildParameter,
		String	value
	)

Replace the value for the build option specified.

Parameters: builderName - a builder name; buildParameter - a builder parameter; value - the new value

Returns: true if the option was found and replaced, false otherwise

Member Data Documentation

◆ elements

List<ElementOptions> fiftyone.pipeline.core.configuration.PipelineOptions.elements = new ArrayList<>()

Configuration information for the FlowElements that the Pipeline will contain.

The order of elements is important as the pipeline will execute them sequentially in the order they are supplied. To execute elements in parallel, the ElementOptions#subElements property should be used.

◆ pipelineBuilderParameters

Map<String, Object> fiftyone.pipeline.core.configuration.PipelineOptions.pipelineBuilderParameters = new HashMap<>()

A map where the keys are method names and the values are parameter values.

The method names can be exact matches, 'set' + name or match an AlternateName annotation.

51Degrees Pipeline Java 4.4

fiftyone.pipeline.core.configuration.PipelineOptions Class Reference