org.streampipes.sdk.builder

Class PrimitivePropertyBuilder

java.lang.Object

org.streampipes.sdk.builder.PrimitivePropertyBuilder

public class PrimitivePropertyBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
PrimitivePropertyBuilder	accuracy(Float accuracy, URI measurementUnit)
EventPropertyPrimitive	build()
static PrimitivePropertyBuilder	create(Datatypes datatype, String runtimeName) A builder class helping to define advanced primitive properties.
PrimitivePropertyBuilder	description(String description) Assigns a human-readable description to the event property.
PrimitivePropertyBuilder	domainProperty(String domainProperty) Specifies the semantics of the property (e.g., whether a double value stands for a latitude coordinate).
PrimitivePropertyBuilder	label(String label) Assigns a human-readable label to the event property.
PrimitivePropertyBuilder	measurementUnit(URI measurementUnit) Defines the measurement unit (e.g., tons) of the event property.
PrimitivePropertyBuilder	resolution(Float resolution, URI measurementUnit)
PrimitivePropertyBuilder	scope(PropertyScope propertyScope) Assigns a property scope to the event property.
PrimitivePropertyBuilder	valueSpecification(Float min, Float max, Float step) Defines the value range.
PrimitivePropertyBuilder	valueSpecification(String label, String description, List<String> allowedValues) Defines the value range in form of an enumeration.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static PrimitivePropertyBuilder create(Datatypes datatype,
                                              String runtimeName)

A builder class helping to define advanced primitive properties. For simple property definitions, you can also use EpProperties.

Parameters:

datatype - The primitive Datatypes definition of the new property.

runtimeName - The name of the property at runtime (e.g., the field name of the JSON primitive.

Returns:

this

domainProperty

public PrimitivePropertyBuilder domainProperty(String domainProperty)

Specifies the semantics of the property (e.g., whether a double value stands for a latitude coordinate).

Parameters:

domainProperty - The domain property as a String. The domain property should reflect an URI. Use some existing vocabulary from org.streampipes.vocabulary or create your own.

Returns:

measurementUnit

public PrimitivePropertyBuilder measurementUnit(URI measurementUnit)

Defines the measurement unit (e.g., tons) of the event property.

Parameters:

measurementUnit - The measurement unit as a URI from a vocabulary (e.g., QUDT).

Returns:

valueSpecification

public PrimitivePropertyBuilder valueSpecification(Float min,
                                                   Float max,
                                                   Float step)

Defines the value range. The data type of the event property must be a number.

Parameters:

min - The minimum value the property can have at runtime.

max - The maximum value the property can have at runtime.

step - The expected granularity the property has at runtime.

Returns:

this

valueSpecification

public PrimitivePropertyBuilder valueSpecification(String label,
                                                   String description,
                                                   List<String> allowedValues)

Defines the value range in form of an enumeration. The data type of the event property must be of type String or Number.

Parameters:

label - A human-readable label describing this enumeration.

description - A human-readable description of the enumeration.

allowedValues - A list of allowed values of the event property at runtime.

Returns:

this

label

public PrimitivePropertyBuilder label(String label)

Assigns a human-readable label to the event property. The label is used in the StreamPipes UI for better explaining users the meaning of the property.

Parameters:

label -

Returns:

this

description

public PrimitivePropertyBuilder description(String description)

Assigns a human-readable description to the event property. The description is used in the StreamPipes UI for better explaining users the meaning of the property.

Parameters:

description -

Returns:

this

accuracy

public PrimitivePropertyBuilder accuracy(Float accuracy,
                                         URI measurementUnit)

resolution

public PrimitivePropertyBuilder resolution(Float resolution,
                                           URI measurementUnit)

scope

public PrimitivePropertyBuilder scope(PropertyScope propertyScope)

Assigns a property scope to the event property.

Parameters:

propertyScope - The PropertyScope.

Returns:

this

build

public EventPropertyPrimitive build()