org.streampipes.sdk.builder

Class AbstractConfigurablePipelineElementBuilder<BU extends AbstractConfigurablePipelineElementBuilder<BU,T>,T extends NamedStreamPipesEntity>

java.lang.Object

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

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

Direct Known Subclasses:

AbstractProcessingElementBuilder, AdapterDescriptionBuilder, FormatDescriptionBuilder, ProtocolDescriptionBuilder

public abstract class AbstractConfigurablePipelineElementBuilder<BU extends AbstractConfigurablePipelineElementBuilder<BU,T>,T extends NamedStreamPipesEntity>
extends AbstractPipelineElementBuilder<BU,T>

Field Summary

Fields

Modifier and Type	Field and Description
protected List<StaticProperty>	staticProperties

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

elementDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfigurablePipelineElementBuilder(String appId, String label, String description, T element)
protected	AbstractConfigurablePipelineElementBuilder(String appId, T element)

Method Summary

Modifier and Type	Method and Description
protected List<StaticProperty>	getStaticProperties()
BU	requiredAlternatives(Label label, StaticPropertyAlternative... alternatives)
BU	requiredFile(Label label)
BU	requiredFloatParameter(Label label) Assigns a new number-based configuration parameter (a float) which is required by the pipeline element.
BU	requiredFloatParameter(Label label, Float defaultValue) Defines a number-based configuration parameter of type float provided by preprocessing developers at preprocessing authoring time and initializes the parameter with a default value.
BU	requiredFloatParameter(Label label, String linkedMappingPropertyInternalName) Defines a number-based configuration parameter of type float provided by pipeline developers at pipeline authoring time.
BU	requiredFloatParameter(String internalId, String label, String description) Deprecated. Use requiredFloatParameter(Label) instead.
BU	requiredFloatParameter(String internalId, String label, String description, Float defaultValue) Deprecated. Use requiredFloatParameter(Label, Float) instead.
BU	requiredFloatParameter(String internalId, String label, String description, Float min, Float max, Float step) Defines a number-based configuration parameter of type float provided by preprocessing developers at preprocessing authoring time.
BU	requiredFloatParameter(String internalId, String label, String description, String linkedMappingPropertyInternalName) Deprecated. use requiredFloatParameter(Label, String)
BU	requiredHtmlInputParameter(Label label) Defines a text-based configuration parameter provided by pipeline developers at pipeline authoring time.
BU	requiredIntegerParameter(Label label) Assigns a new number-based configuration parameter (an integer) which is required by the pipeline element.
BU	requiredIntegerParameter(Label label, Integer defaultValue) Defines a number-based configuration parameter of type integer provided by pipeline developers at pipeline authoring time and initializes the parameter with a default value.
BU	requiredIntegerParameter(Label label, Integer min, Integer max, Integer step)
BU	requiredIntegerParameter(Label label, String linkedMappingPropertyInternalName) Defines a number-based configuration parameter of type integer provided by pipeline developers at pipeline authoring time.
BU	requiredIntegerParameter(String internalId, String label, String description) Deprecated. Use requiredIntegerParameter(Label) instead
BU	requiredIntegerParameter(String internalId, String label, String description, Integer defaultValue) Deprecated. Use requiredIntegerParameter(Label, Integer) instead
BU	requiredIntegerParameter(String internalId, String label, String description, Integer min, Integer max, Integer step)
BU	requiredIntegerParameter(String internalId, String label, String description, String linkedMappingPropertyInternalName) Deprecated. use requiredIntegerParameter(Label, String) instead
BU	requiredMultiValueSelection(Label label, List<Option> options) Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options, but multiple selections are allowed.
BU	requiredMultiValueSelection(Label label, Option... options) Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options, but multiple selections are allowed.
BU	requiredMultiValueSelection(String internalId, String label, String description, List<Option> options) Deprecated. Use requiredMultiValueSelection(Label, List) instead.
BU	requiredMultiValueSelection(String internalId, String label, String description, Option... options) Deprecated. Use requiredMultiValueSelection(Label, Option...) instead.
BU	requiredMultiValueSelectionFromContainer(Label label)
BU	requiredMultiValueSelectionFromContainer(Label label, List<String> dependsOn)
BU	requiredOntologyConcept(Label label, String requiredConceptUri, SupportedProperty... supportedOntologyProperties)
BU	requiredOntologyConcept(Label label, SupportedProperty... supportedOntologyProperties) Defines the requirement for an instance that is defined in the knowledge base.
BU	requiredParameterAsCollection(Label label, StaticProperty staticProperty)
BU	requiredSecret(Label label) Assigns a new secret text-based configuration parameter (e.g., a password) which is required by the processing element.
BU	requiredSingleValueSelection(Label label, List<Option> options) Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options.
BU	requiredSingleValueSelection(Label label, Option... options) Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options.
BU	requiredSingleValueSelection(String internalId, String label, String description, List<Option> options) Deprecated. Use requiredSingleValueSelection(Label, List) instead.
BU	requiredSingleValueSelection(String internalId, String label, String description, Option... options) Deprecated. Use requiredSingleValueSelection(Label, Option...) instead.
BU	requiredSingleValueSelectionFromContainer(Label label)
BU	requiredSingleValueSelectionFromContainer(Label label, List<String> dependsOn)
BU	requiredStaticProperty(StaticProperty staticProperty)
BU	requiredTextParameter(Label label) Assigns a new text-based configuration parameter (a string) which is required by the pipeline element.
BU	requiredTextParameter(Label label, boolean multiLine, boolean placeholdersSupported) Defines a text-based configuration parameter provided by pipeline developers at pipeline authoring time.
BU	requiredTextParameter(Label label, String linkedMappingPropertyInternalName) Defines a text-based configuration parameter provided by pipeline developers at pipeline authoring time.
BU	requiredTextParameter(String internalId, String label, String description) Deprecated. use requiredTextParameter(Label)
BU	requiredTextParameter(String internalId, String label, String description, String linkedMappingPropertyInternalName) Deprecated. Use requiredTextParameter(Label, String)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

staticProperties

protected List<StaticProperty> staticProperties

Constructor Detail

AbstractConfigurablePipelineElementBuilder

protected AbstractConfigurablePipelineElementBuilder(String appId,
                                                     String label,
                                                     String description,
                                                     T element)

AbstractConfigurablePipelineElementBuilder

protected AbstractConfigurablePipelineElementBuilder(String appId,
                                                     T element)

Method Detail

requiredStaticProperty

public BU requiredStaticProperty(StaticProperty staticProperty)

Parameters:

staticProperty: - The required static property (e.g., user input as shown in the StreamPipes UI

Returns:

BU

requiredOntologyConcept

public BU requiredOntologyConcept(Label label,
                                  SupportedProperty... supportedOntologyProperties)

Defines the requirement for an instance that is defined in the knowledge base.

Parameters:

label: - A human-readable label that describes the required static property.

supportedOntologyProperties: - All RDF properties any instance in the knowledge base must provide. Use OntologyProperties to assign supported properties.

Returns:

requiredOntologyConcept

public BU requiredOntologyConcept(Label label,
                                  String requiredConceptUri,
                                  SupportedProperty... supportedOntologyProperties)

Parameters:

label: - A human-readable label that describes the required static property.

requiredConceptUri: - Limits the search for matching instance in the knowledge base to an instance of this concept.

supportedOntologyProperties: - All RDF properties any instance of the provided concept must provide. Use OntologyProperties to assign supported properties.

Returns:

requiredParameterAsCollection

public BU requiredParameterAsCollection(Label label,
                                        StaticProperty staticProperty)

Parameters:

label: - A human-readable label that describes the required static property.

staticProperty -

Returns:

requiredTextParameter

public BU requiredTextParameter(String internalId,
                                String label,
                                String description)

Deprecated. use requiredTextParameter(Label)

Parameters:

internalId -

label -

description -

Returns:

requiredSecret

public BU requiredSecret(Label label)

Assigns a new secret text-based configuration parameter (e.g., a password) which is required by the processing element.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

Returns:

requiredTextParameter

public BU requiredTextParameter(Label label)

Assigns a new text-based configuration parameter (a string) which is required by the pipeline element.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

Returns:

requiredTextParameter

public BU requiredTextParameter(String internalId,
                                String label,
                                String description,
                                String linkedMappingPropertyInternalName)

Deprecated. Use requiredTextParameter(Label, String)

Parameters:

internalId -

label -

description -

linkedMappingPropertyInternalName -

Returns:

this

requiredTextParameter

public BU requiredTextParameter(Label label,
                                String linkedMappingPropertyInternalName)

Defines a text-based configuration parameter provided by pipeline developers at pipeline authoring time. The value range of the parameter is restricted to the value specification of a selected input event property.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

linkedMappingPropertyInternalName - The inernalId of the MappingProperty

Returns:

this

requiredHtmlInputParameter

public BU requiredHtmlInputParameter(Label label)

Defines a text-based configuration parameter provided by pipeline developers at pipeline authoring time. The input field generated in the StreamPipes UI allows to enter HTML content (and an HTML Wysiwyg editor will be rendered).

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

Returns:

this

requiredTextParameter

public BU requiredTextParameter(Label label,
                                boolean multiLine,
                                boolean placeholdersSupported)

Defines a text-based configuration parameter provided by pipeline developers at pipeline authoring time.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

multiLine - Defines whether the input dialog allows multiple lines.

placeholdersSupported - Defines whether placeholders are supported, i.e., event property field names that are replaced with the actual value at pipeline execution time.

Returns:

this

requiredIntegerParameter

public BU requiredIntegerParameter(String internalId,
                                   String label,
                                   String description)

Deprecated. Use requiredIntegerParameter(Label) instead

Parameters:

internalId -

label -

description -

Returns:

requiredIntegerParameter

public BU requiredIntegerParameter(Label label)

Assigns a new number-based configuration parameter (an integer) which is required by the pipeline element.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

Returns:

requiredIntegerParameter

public BU requiredIntegerParameter(String internalId,
                                   String label,
                                   String description,
                                   String linkedMappingPropertyInternalName)

Deprecated. use requiredIntegerParameter(Label, String) instead

Parameters:

internalId -

label -

description -

linkedMappingPropertyInternalName -

Returns:

requiredIntegerParameter

public BU requiredIntegerParameter(Label label,
                                   String linkedMappingPropertyInternalName)

Defines a number-based configuration parameter of type integer provided by pipeline developers at pipeline authoring time. The value range of the parameter is restricted to the value specification of a selected input event property.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

linkedMappingPropertyInternalName - The inernalId of the MappingProperty

Returns:

this

requiredIntegerParameter

public BU requiredIntegerParameter(String internalId,
                                   String label,
                                   String description,
                                   Integer defaultValue)

Deprecated. Use requiredIntegerParameter(Label, Integer) instead

Parameters:

internalId -

label -

description -

defaultValue -

Returns:

requiredIntegerParameter

public BU requiredIntegerParameter(Label label,
                                   Integer defaultValue)

Defines a number-based configuration parameter of type integer provided by pipeline developers at pipeline authoring time and initializes the parameter with a default value.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

defaultValue - The default integer value.

Returns:

this

requiredFloatParameter

public BU requiredFloatParameter(String internalId,
                                 String label,
                                 String description)

Deprecated. Use requiredFloatParameter(Label) instead.

Parameters:

internalId -

label -

description -

Returns:

requiredFloatParameter

public BU requiredFloatParameter(Label label)

Assigns a new number-based configuration parameter (a float) which is required by the pipeline element.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

Returns:

requiredFloatParameter

public BU requiredFloatParameter(String internalId,
                                 String label,
                                 String description,
                                 String linkedMappingPropertyInternalName)

Deprecated. use requiredFloatParameter(Label, String)

Defines a number-based configuration parameter of type float provided by pipeline developers at pipeline authoring time. The value range of the parameter is restricted to the value specification of a selected input event property.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

linkedMappingPropertyInternalName - The inernalId of the MappingProperty

Returns:

this

requiredFloatParameter

public BU requiredFloatParameter(Label label,
                                 String linkedMappingPropertyInternalName)

Defines a number-based configuration parameter of type float provided by pipeline developers at pipeline authoring time. The value range of the parameter is restricted to the value specification of a selected input event property.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

linkedMappingPropertyInternalName - The inernalId of the MappingProperty

Returns:

this

requiredFloatParameter

public BU requiredFloatParameter(String internalId,
                                 String label,
                                 String description,
                                 Float defaultValue)

Deprecated. Use requiredFloatParameter(Label, Float) instead.

Parameters:

internalId -

label -

description -

defaultValue -

Returns:

this

requiredFloatParameter

public BU requiredFloatParameter(Label label,
                                 Float defaultValue)

Defines a number-based configuration parameter of type float provided by preprocessing developers at preprocessing authoring time and initializes the parameter with a default value.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

defaultValue - The default integer value.

Returns:

this

requiredSingleValueSelection

public BU requiredSingleValueSelection(String internalId,
                                       String label,
                                       String description,
                                       Option... options)

Deprecated. Use requiredSingleValueSelection(Label, Option...) instead.

Parameters:

options - An arbitrary number of Option elements. Use Options to create option elements from string values.

Returns:

this

requiredSingleValueSelection

public BU requiredSingleValueSelection(Label label,
                                       Option... options)

Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options. The parameter will be rendered as a RadioGroup in the StreamPipes UI.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

options - An arbitrary number of Option elements. Use Options to create option elements from string values.

Returns:

this

requiredSingleValueSelection

public BU requiredSingleValueSelection(String internalId,
                                       String label,
                                       String description,
                                       List<Option> options)

Deprecated. Use requiredSingleValueSelection(Label, List) instead.

Parameters:

internalId -

label -

description -

options -

Returns:

requiredSingleValueSelection

public BU requiredSingleValueSelection(Label label,
                                       List<Option> options)

Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options. The parameter will be rendered as a RadioGroup in the StreamPipes UI.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

options - A list of Option elements. Use Options to create option elements from string values.

Returns:

this

requiredMultiValueSelection

public BU requiredMultiValueSelection(String internalId,
                                      String label,
                                      String description,
                                      Option... options)

Deprecated. Use requiredMultiValueSelection(Label, Option...) instead.

Parameters:

internalId -

label -

description -

options -

Returns:

requiredMultiValueSelection

public BU requiredMultiValueSelection(Label label,
                                      Option... options)

Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options, but multiple selections are allowed. The parameter will be rendered as a Checkbox group in the StreamPipes UI.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

options - An arbitrary number of Option elements. Use Options to create option elements from string values.

Returns:

this

requiredMultiValueSelection

public BU requiredMultiValueSelection(String internalId,
                                      String label,
                                      String description,
                                      List<Option> options)

Deprecated. Use requiredMultiValueSelection(Label, List) instead.

Parameters:

internalId -

label -

description -

options -

Returns:

requiredMultiValueSelection

public BU requiredMultiValueSelection(Label label,
                                      List<Option> options)

Defines a configuration parameter that lets preprocessing developers select from a list of pre-defined configuration options, but multiple selections are allowed. The parameter will be rendered as a Checkbox group in the StreamPipes UI.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

options - A list of Option elements. Use Options to create option elements from string values.

Returns:

this

requiredIntegerParameter

public BU requiredIntegerParameter(Label label,
                                   Integer min,
                                   Integer max,
                                   Integer step)

requiredIntegerParameter

public BU requiredIntegerParameter(String internalId,
                                   String label,
                                   String description,
                                   Integer min,
                                   Integer max,
                                   Integer step)

requiredFloatParameter

public BU requiredFloatParameter(String internalId,
                                 String label,
                                 String description,
                                 Float min,
                                 Float max,
                                 Float step)

Defines a number-based configuration parameter of type float provided by preprocessing developers at preprocessing authoring time. In addition, an allowed value range of the expected input can be assigned.

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

min - The minimum value of the allowed value range.

max - The maximum value of the allowed value range.

step - The granularity

Returns:

this

requiredFile

public BU requiredFile(Label label)

Parameters:

label - The Label that describes why this parameter is needed in a user-friendly manner.

Returns:

this

requiredAlternatives

public BU requiredAlternatives(Label label,
                               StaticPropertyAlternative... alternatives)

requiredSingleValueSelectionFromContainer

public BU requiredSingleValueSelectionFromContainer(Label label)

requiredSingleValueSelectionFromContainer

public BU requiredSingleValueSelectionFromContainer(Label label,
                                                    List<String> dependsOn)

requiredMultiValueSelectionFromContainer

public BU requiredMultiValueSelectionFromContainer(Label label)

requiredMultiValueSelectionFromContainer

public BU requiredMultiValueSelectionFromContainer(Label label,
                                                   List<String> dependsOn)

getStaticProperties

protected List<StaticProperty> getStaticProperties()