Module io.annot8.api

Package io.annot8.api.pipelines

Interface PipelineDescriptor.Builder

Enclosing interface:

PipelineDescriptor

public static interface PipelineDescriptor.Builder

Builder interface for building new pipeline descriptors

Method Summary

Modifier and Type	Method	Description
PipelineDescriptor	build()	Build the pipeline descriptor described by this builder
PipelineDescriptor.Builder	from(PipelineDescriptor pipelineDescriptor)	Add sources and processors from an existing pipeline descriptor to the one being built
PipelineDescriptor.Builder	withDescription(String description)	Set a description of the pipeline
PipelineDescriptor.Builder	withName(String name)	Set the name of the pipeline
PipelineDescriptor.Builder	withOrderer(PipelineOrderer orderer)	Set an orderer to order components
PipelineDescriptor.Builder	withProcessor(ProcessorDescriptor processor)	Add a processor to the pipeline that is being built
default PipelineDescriptor.Builder	withProcessors(ProcessorDescriptor... processors)	Add multiple processors to the pipeline that is being built, in the order provided
default PipelineDescriptor.Builder	withProcessors(Collection<ProcessorDescriptor> processors)	Add multiple processors to the pipeline that is being built, in the order provided
PipelineDescriptor.Builder	withSource(SourceDescriptor source)	Add a source to the pipeline that is being built
default PipelineDescriptor.Builder	withSources(SourceDescriptor... sources)	Add multiple sources to the pipeline that is being built, in the order provided
default PipelineDescriptor.Builder	withSources(Collection<SourceDescriptor> sources)	Add multiple sources to the pipeline that is being built, in the order provided

Method Detail

from

PipelineDescriptor.Builder from(PipelineDescriptor pipelineDescriptor)

Add sources and processors from an existing pipeline descriptor to the one being built

Parameters:

pipelineDescriptor - descriptor to use as basis for the pipeline

Returns:

builder

withName

PipelineDescriptor.Builder withName(String name)

Set the name of the pipeline

Parameters:

name - pipeline's name

Returns:

builder

withDescription

PipelineDescriptor.Builder withDescription(String description)

Set a description of the pipeline

Parameters:

description - pipeline's description

Returns:

builder

withOrderer

PipelineDescriptor.Builder withOrderer(PipelineOrderer orderer)

Set an orderer to order components

Parameters:

orderer - pipeline orderer to use

Returns:

builder

withSource

PipelineDescriptor.Builder withSource(SourceDescriptor source)

Add a source to the pipeline that is being built

Parameters:

source - source to add

Returns:

builder

withProcessor

PipelineDescriptor.Builder withProcessor(ProcessorDescriptor processor)

Add a processor to the pipeline that is being built

Parameters:

processor - processor to add

Returns:

builder

withSources

default PipelineDescriptor.Builder withSources(SourceDescriptor... sources)

Add multiple sources to the pipeline that is being built, in the order provided

Parameters:

sources - sources to add

Returns:

builder

withSources

default PipelineDescriptor.Builder withSources(Collection<SourceDescriptor> sources)

Add multiple sources to the pipeline that is being built, in the order provided

Parameters:

sources - sources to add

Returns:

builder

withProcessors

default PipelineDescriptor.Builder withProcessors(ProcessorDescriptor... processors)

Add multiple processors to the pipeline that is being built, in the order provided

Parameters:

processors - processors to add

Returns:

builder

withProcessors

default PipelineDescriptor.Builder withProcessors(Collection<ProcessorDescriptor> processors)

Add multiple processors to the pipeline that is being built, in the order provided

Parameters:

processors - processors to add

Returns:

builder

build

PipelineDescriptor build()
                  throws IncompleteException

Build the pipeline descriptor described by this builder

Returns:

pipeline descriptor

Throws:

IncompleteException - If the pipeline is missing components (i.e. doesn't have at least 1 source and processor)