org.streampipes.sdk.builder

Class AbstractProcessingElementBuilder<BU extends AbstractProcessingElementBuilder<BU,T>,T extends ConsumableStreamPipesEntity>

java.lang.Object

org.streampipes.sdk.builder.AbstractPipelineElementBuilder<BU,T>

org.streampipes.sdk.builder.AbstractConfigurablePipelineElementBuilder<BU,T>

org.streampipes.sdk.builder.AbstractProcessingElementBuilder<BU,T>

Direct Known Subclasses:

DataSinkBuilder, ProcessingElementBuilder

public abstract class AbstractProcessingElementBuilder<BU extends AbstractProcessingElementBuilder<BU,T>,T extends ConsumableStreamPipesEntity>
extends AbstractConfigurablePipelineElementBuilder<BU,T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	stream1
protected List<EventProperty>	stream1Properties
protected boolean	stream2
protected List<EventProperty>	stream2Properties
protected List<SpDataStream>	streamRequirements
protected EventGrounding	supportedGrounding

Fields inherited from class org.streampipes.sdk.builder.AbstractConfigurablePipelineElementBuilder

staticProperties

Fields inherited from class org.streampipes.sdk.builder.AbstractPipelineElementBuilder

elementDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProcessingElementBuilder(String id, String label, String description, T element)
protected	AbstractProcessingElementBuilder(String id, T element)

Method Summary

Modifier and Type	Method and Description
BU	naryMappingPropertyWithoutRequirement(Label label, PropertyScope propertyScope) Adds a new MappingPropertyNary to the pipeline element definition which is not linked to a specific input property.
BU	naryMappingPropertyWithoutRequirement(String internalName, String label, String description) Deprecated. Use naryMappingPropertyWithoutRequirement(Label, PropertyScope) instead.
void	prepareBuild()
BU	requiredStream(CollectedStreamRequirements streamRequirements) Set a new stream requirement by adding restrictions on this stream.
BU	requiredStream(SpDataStream stream) Deprecated. Use requiredStream(CollectedStreamRequirements) instead
BU	setStream1() Deprecated. Use requiredStream(CollectedStreamRequirements) instead
BU	setStream2() Deprecated. Use requiredStream(CollectedStreamRequirements) instead
BU	supportedFormats(List<TransportFormat> formats) Assigns supported transport formats to the pipeline elements that can be handled at runtime (e.g., JSON or XMl).
BU	supportedFormats(TransportFormat... format) Assigns supported transport formats to the pipeline elements that can be handled at runtime (e.g., JSON or XMl).
BU	supportedProtocols(List<TransportProtocol> protocols) Assigns supported communication/transport protocols to the pipeline elements that can be handled at runtime (e.g., Kafka or JMS).
BU	supportedProtocols(TransportProtocol... protocol) Assigns supported communication/transport protocols to the pipeline elements that can be handled at runtime (e.g., Kafka or JMS).
BU	unaryMappingPropertyWithoutRequirement(Label label) Deprecated. Use this method if you want to present users a single-value selection of all available input event properties.
BU	unaryMappingPropertyWithoutRequirement(Label label, PropertyScope propertyScope) Adds a new MappingPropertyUnary to the pipeline element definition which is not linked to a specific input property.
BU	unaryMappingPropertyWithoutRequirement(String internalName, String label, String description) Deprecated. Use unaryMappingPropertyWithoutRequirement(Label) instead. Use this method if you want to present users a single-value selection of all available input event properties.

Methods inherited from class org.streampipes.sdk.builder.AbstractConfigurablePipelineElementBuilder

getStaticProperties, requiredAlternatives, requiredFile, requiredFloatParameter, requiredFloatParameter, requiredFloatParameter, requiredFloatParameter, requiredFloatParameter, requiredFloatParameter, requiredFloatParameter, requiredHtmlInputParameter, requiredIntegerParameter, requiredIntegerParameter, requiredIntegerParameter, requiredIntegerParameter, requiredIntegerParameter, requiredIntegerParameter, requiredIntegerParameter, requiredIntegerParameter, requiredMultiValueSelection, requiredMultiValueSelection, requiredMultiValueSelection, requiredMultiValueSelection, requiredMultiValueSelectionFromContainer, requiredMultiValueSelectionFromContainer, requiredOntologyConcept, requiredOntologyConcept, requiredParameterAsCollection, requiredSecret, requiredSingleValueSelection, requiredSingleValueSelection, requiredSingleValueSelection, requiredSingleValueSelection, requiredSingleValueSelectionFromContainer, requiredSingleValueSelectionFromContainer, requiredStaticProperty, requiredTextParameter, requiredTextParameter, requiredTextParameter, requiredTextParameter, requiredTextParameter

Methods inherited from class org.streampipes.sdk.builder.AbstractPipelineElementBuilder

build, iconUrl, me, prepareStaticProperty, providesAssets, withAssets, withLocales

Methods inherited from class java.lang.Object

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

Field Detail

streamRequirements

protected List<SpDataStream> streamRequirements

stream1Properties

protected List<EventProperty> stream1Properties

stream2Properties

protected List<EventProperty> stream2Properties

supportedGrounding

protected EventGrounding supportedGrounding

stream1

protected boolean stream1

stream2

protected boolean stream2

Constructor Detail

AbstractProcessingElementBuilder

protected AbstractProcessingElementBuilder(String id,
                                           String label,
                                           String description,
                                           T element)

AbstractProcessingElementBuilder

protected AbstractProcessingElementBuilder(String id,
                                           T element)

Method Detail

requiredStream

@Deprecated
public BU requiredStream(SpDataStream stream)

Deprecated. Use requiredStream(CollectedStreamRequirements) instead

requiredStream

public BU requiredStream(CollectedStreamRequirements streamRequirements)

Set a new stream requirement by adding restrictions on this stream. Use StreamRequirementsBuilder to create requirements for a single stream.

Parameters:

streamRequirements: - A bundle of collected CollectedStreamRequirements

Returns:

this

naryMappingPropertyWithoutRequirement

public BU naryMappingPropertyWithoutRequirement(String internalName,
                                                String label,
                                                String description)

Deprecated. Use naryMappingPropertyWithoutRequirement(Label, PropertyScope) instead.

Parameters:

internalName -

label -

description -

Returns:

naryMappingPropertyWithoutRequirement

public BU naryMappingPropertyWithoutRequirement(Label label,
                                                PropertyScope propertyScope)

Adds a new MappingPropertyNary to the pipeline element definition which is not linked to a specific input property. Use this method if you want to present users a selection (in form of a Checkbox Group) of all available input event properties.

Parameters:

label - A human-readable label that is displayed to users in the StreamPipes UI.

propertyScope - Only input event properties that match the PropertyScope are displayed.

Returns:

unaryMappingPropertyWithoutRequirement

public BU unaryMappingPropertyWithoutRequirement(String internalName,
                                                 String label,
                                                 String description)

Deprecated. Use unaryMappingPropertyWithoutRequirement(Label) instead. Use this method if you want to present users a single-value selection of all available input event properties.

Adds a new MappingPropertyUnary to the pipeline element definition which is not linked to a specific input property.

Parameters:

label - A human-readable label

Returns:

this

unaryMappingPropertyWithoutRequirement

public BU unaryMappingPropertyWithoutRequirement(Label label)

Deprecated. Use this method if you want to present users a single-value selection of all available input event properties.

Adds a new MappingPropertyUnary to the pipeline element definition which is not linked to a specific input property.

Parameters:

label -

Returns:

this

unaryMappingPropertyWithoutRequirement

public BU unaryMappingPropertyWithoutRequirement(Label label,
                                                 PropertyScope propertyScope)

Adds a new MappingPropertyUnary to the pipeline element definition which is not linked to a specific input property.

Parameters:

label - A human-readable label that is displayed to users in the StreamPipes UI.

propertyScope - Only input event properties that match the PropertyScope are displayed.

Returns:

this Use this method if you want to present users a single-value selection of all available input event properties.

supportedFormats

public BU supportedFormats(TransportFormat... format)

Assigns supported transport formats to the pipeline elements that can be handled at runtime (e.g., JSON or XMl).

Parameters:

format - An arbitrary number of supported TransportFormats. Use SupportedFormats to assign formats from some pre-defined ones or create your own by following the developer guide.

Returns:

this

supportedFormats

public BU supportedFormats(List<TransportFormat> formats)

Assigns supported transport formats to the pipeline elements that can be handled at runtime (e.g., JSON or XMl).

Parameters:

formats - A list of supported TransportFormats. Use SupportedFormats to assign formats from some pre-defined ones or create your own by following the developer guide.

Returns:

this

supportedProtocols

public BU supportedProtocols(TransportProtocol... protocol)

Assigns supported communication/transport protocols to the pipeline elements that can be handled at runtime (e.g., Kafka or JMS).

Parameters:

protocol - An arbitrary number of supported TransportProtocols. Use SupportedProtocols to assign protocols from some pre-defined ones or create your own by following the developer guide.

Returns:

this

supportedProtocols

public BU supportedProtocols(List<TransportProtocol> protocols)

Assigns supported communication/transport protocols to the pipeline elements that can be handled at runtime (e.g., Kafka or JMS).

Parameters:

protocols - A list of supported TransportProtocols. Use SupportedProtocols to assign protocols from some pre-defined ones or create your own by following the developer guide.

Returns:

this

setStream1

public BU setStream1()

Deprecated. Use requiredStream(CollectedStreamRequirements) instead

setStream2

public BU setStream2()

Deprecated. Use requiredStream(CollectedStreamRequirements) instead

prepareBuild

public void prepareBuild()

Specified by:

prepareBuild in class AbstractPipelineElementBuilder<BU extends AbstractProcessingElementBuilder<BU,T>,T extends ConsumableStreamPipesEntity>