org.streampipes.sdk.builder

Class StreamRequirementsBuilder

java.lang.Object

org.streampipes.sdk.builder.StreamRequirementsBuilder

public class StreamRequirementsBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
CollectedStreamRequirements	build() Finishes the stream requirements definition.
static StreamRequirementsBuilder	create() Creates new requirements for a data processor or a data sink.
StreamRequirementsBuilder	requiredProperty(EventProperty propertyRequirement) Sets a new property requirement, e.g., a property of a specific data type or with specific semantics a data stream that is connected to this pipeline element must provide.
StreamRequirementsBuilder	requiredPropertyWithNaryMapping(EventProperty propertyRequirement, Label label, PropertyScope propertyScope) Sets a new property requirement and, in addition, adds a MappingPropertyNary static property to the pipeline element definition.
StreamRequirementsBuilder	requiredPropertyWithUnaryMapping(EventProperty propertyRequirement, Label label, PropertyScope propertyScope) Sets a new property requirement and, in addition, adds a MappingPropertyUnary static property to the pipeline element definition.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StreamRequirementsBuilder create()

Creates new requirements for a data processor or a data sink.

Returns:

StreamRequirementsBuilder

requiredProperty

public StreamRequirementsBuilder requiredProperty(EventProperty propertyRequirement)

Sets a new property requirement, e.g., a property of a specific data type or with specific semantics a data stream that is connected to this pipeline element must provide.

Parameters:

propertyRequirement - The property requirement. Use EpRequirements to create a new requirement.

Returns:

this

requiredPropertyWithUnaryMapping

public StreamRequirementsBuilder requiredPropertyWithUnaryMapping(EventProperty propertyRequirement,
                                                                  Label label,
                                                                  PropertyScope propertyScope)

Sets a new property requirement and, in addition, adds a MappingPropertyUnary static property to the pipeline element definition.

Parameters:

propertyRequirement - The property requirement. Use EpRequirements to create a new requirement.

label - The Label that defines the mapping property.

propertyScope - The PropertyScope of the requirement.

Returns:

this

requiredPropertyWithNaryMapping

public StreamRequirementsBuilder requiredPropertyWithNaryMapping(EventProperty propertyRequirement,
                                                                 Label label,
                                                                 PropertyScope propertyScope)

Sets a new property requirement and, in addition, adds a MappingPropertyNary static property to the pipeline element definition.

Parameters:

propertyRequirement - The property requirement. Use EpRequirements to create a new requirement.

label - The Label that defines the mapping property.

propertyScope - The PropertyScope of the requirement.

Returns:

this

build

public CollectedStreamRequirements build()

Finishes the stream requirements definition.

Returns:

an object of type CollectedStreamRequirements that contains all defined property requirements and static properties.