org.streampipes.sdk.helpers

Class EpProperties

java.lang.Object

org.streampipes.sdk.helpers.EpProperties

public class EpProperties
extends Object

Constructor Summary

Constructors

Constructor and Description
EpProperties()

Method Summary

Modifier and Type	Method and Description
static EventPropertyPrimitive	booleanEp(Label label, String runtimeName, String domainProperty) Creates a new primitive property of type boolean and the provided domain property.
static EventPropertyPrimitive	doubleEp(Label label, String runtimeName, String domainProperty)
static EventPropertyPrimitive	doubleEp(Label label, String runtimeName, String domainProperty, Float minValue, Float maxValue, Float step)
static EventPropertyPrimitive	integerEp(Label label, String runtimeName, List<URI> domainProperties) Creates a new primitive property of type integer and the provided domain properties.
static EventPropertyPrimitive	integerEp(Label label, String runtimeName, String domainProperty) Creates a new primitive property of type integer and the provided domain property.
static EventPropertyPrimitive	integerEp(Label label, String runtimeName, String domainProperty, Float minValue, Float maxValue, Float step)
static EventPropertyPrimitive	integerEp(Label label, String runtimeName, String domainProperty, QuantitativeValue valueSpecification)
static EventPropertyList	listBooleanEp(Label label, String runtimeName, String domainProperty) Creates a new list-based event property of type boolean and with the assigned domain property.
static EventPropertyList	listDoubleEp(Label label, String runtimeName, String domainProperty) Creates a new list-based event property of type double and with the assigned domain property.
static EventPropertyList	listEp(Label label, String runtimeName, Datatypes runtimeType, String domainProperty)
static EventPropertyList	listEp(Label label, String runtimeName, EventProperty eventProperty) Creates a new list-based event property of the parameter type eventProperty
static EventPropertyList	listEp(Label label, String runtimeName, EventProperty eventProperty, String domainProperty) Creates a new list-based event property of the parameter type eventProperty
static EventPropertyList	listIntegerEp(Label label, String runtimeName, String domainProperty) Creates a new list-based event property of type integer and with the assigned domain property.
static EventPropertyList	listLongEp(Label label, String runtimeName, String domainProperty) Creates a new list-based event property of type long and with the assigned domain property.
EventPropertyList	listNestedEp(Label label, String runtimeName, EventProperty... nestedProperties)
static EventPropertyList	listStringEp(Label label, String runtimeName, String domainProperty) Creates a new list-based event property of type string and with the assigned domain property.
static EventPropertyPrimitive	longEp(Label label, String runtimeName, List<URI> domainProperties)
static EventPropertyPrimitive	longEp(Label label, String runtimeName, String domainProperty) Creates a new primitive property of type integer and the provided domain property.
static EventPropertyNested	nestedEp(Label label, String runtimeName, EventProperty... eventProperties)
static EventPropertyPrimitive	numberEp(Label label, String runtimeName, String domainProperty) Creates a new primitive property of type number and the provided domain property.
static EventPropertyPrimitive	stringEp(Label label, String runtimeName, List<URI> domainProperties) Creates a new primitive property of type string and the provided domain property.
static EventPropertyPrimitive	stringEp(Label label, String runtimeName, String domainProperty) Creates a new primitive property of type string and the provided domain property.
static EventPropertyPrimitive	stringEp(Label label, String runtimeName, String domainProperty, Enumeration enumeration) Creates a new primitive property of type string and the provided domain property.
static EventPropertyPrimitive	timestampProperty(String runtimeName) Creates a new primitive property of type timestamp (with data type long and domain property schema.org/DateTime

Methods inherited from class java.lang.Object

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

Constructor Detail

EpProperties

public EpProperties()

Method Detail

nestedEp

public static EventPropertyNested nestedEp(Label label,
                                           String runtimeName,
                                           EventProperty... eventProperties)

listNestedEp

public EventPropertyList listNestedEp(Label label,
                                      String runtimeName,
                                      EventProperty... nestedProperties)

timestampProperty

public static EventPropertyPrimitive timestampProperty(String runtimeName)

Creates a new primitive property of type timestamp (with data type long and domain property schema.org/DateTime

Parameters:

runtimeName - The field identifier of the event property at runtime.

Returns:

EventPropertyPrimitive

listIntegerEp

public static EventPropertyList listIntegerEp(Label label,
                                              String runtimeName,
                                              String domainProperty)

Creates a new list-based event property of type integer and with the assigned domain property.

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

listLongEp

public static EventPropertyList listLongEp(Label label,
                                           String runtimeName,
                                           String domainProperty)

Creates a new list-based event property of type long and with the assigned domain property.

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

listDoubleEp

public static EventPropertyList listDoubleEp(Label label,
                                             String runtimeName,
                                             String domainProperty)

Creates a new list-based event property of type double and with the assigned domain property.

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

listStringEp

public static EventPropertyList listStringEp(Label label,
                                             String runtimeName,
                                             String domainProperty)

Creates a new list-based event property of type string and with the assigned domain property.

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

listBooleanEp

public static EventPropertyList listBooleanEp(Label label,
                                              String runtimeName,
                                              String domainProperty)

Creates a new list-based event property of type boolean and with the assigned domain property.

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

listEp

public static EventPropertyList listEp(Label label,
                                       String runtimeName,
                                       Datatypes runtimeType,
                                       String domainProperty)

listEp

public static EventPropertyList listEp(Label label,
                                       String runtimeName,
                                       EventProperty eventProperty)

Creates a new list-based event property of the parameter type eventProperty

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

eventProperty - The complex type of data in the list

Returns:

EventPropertyList

listEp

public static EventPropertyList listEp(Label label,
                                       String runtimeName,
                                       EventProperty eventProperty,
                                       String domainProperty)

Creates a new list-based event property of the parameter type eventProperty

Parameters:

label - A human-readable label of the property

runtimeName - The field identifier of the event property at runtime.

eventProperty - The complex type of data in the list

Returns:

EventPropertyList

booleanEp

public static EventPropertyPrimitive booleanEp(Label label,
                                               String runtimeName,
                                               String domainProperty)

Creates a new primitive property of type boolean and the provided domain property.

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

numberEp

public static EventPropertyPrimitive numberEp(Label label,
                                              String runtimeName,
                                              String domainProperty)

Creates a new primitive property of type number and the provided domain property.

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

stringEp

public static EventPropertyPrimitive stringEp(Label label,
                                              String runtimeName,
                                              String domainProperty)

Creates a new primitive property of type string and the provided domain property.

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

stringEp

public static EventPropertyPrimitive stringEp(Label label,
                                              String runtimeName,
                                              String domainProperty,
                                              Enumeration enumeration)

Creates a new primitive property of type string and the provided domain property. In addition, the value range of the property is restricted to the defined Enumeration

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

enumeration - The allowed values of the event property at runtime.

Returns:

EventPropertyPrimitive

stringEp

public static EventPropertyPrimitive stringEp(Label label,
                                              String runtimeName,
                                              List<URI> domainProperties)

Creates a new primitive property of type string and the provided domain property. In addition, the value range of the property is restricted to the defined Enumeration

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperties - The semantics of the list property as a list of URIs. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

integerEp

public static EventPropertyPrimitive integerEp(Label label,
                                               String runtimeName,
                                               String domainProperty)

Creates a new primitive property of type integer and the provided domain property.

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

integerEp

public static EventPropertyPrimitive integerEp(Label label,
                                               String runtimeName,
                                               List<URI> domainProperties)

Creates a new primitive property of type integer and the provided domain properties. In addition, the value range of the property is restricted to the defined Enumeration

Parameters:

runtimeName - The field identifier of the event property at runtime.

domainProperties - The semantics of the list property as a list of URIs. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

longEp

public static EventPropertyPrimitive longEp(Label label,
                                            String runtimeName,
                                            String domainProperty)

Creates a new primitive property of type integer and the provided domain property.

Parameters:

label - A human-readable identifier of the property presented to users in the StreamPipes UI. If you do not want to have a label besides the runtime name, use Labels

runtimeName - The field identifier of the event property at runtime.

domainProperty - The semantics of the list property as a String. The string should correspond to a URI provided by a vocabulary. Use one of the vocabularies provided in org.streampipes.vocabulary or create your own domain-specific vocabulary.

Returns:

EventPropertyPrimitive

longEp

public static EventPropertyPrimitive longEp(Label label,
                                            String runtimeName,
                                            List<URI> domainProperties)

integerEp

public static EventPropertyPrimitive integerEp(Label label,
                                               String runtimeName,
                                               String domainProperty,
                                               Float minValue,
                                               Float maxValue,
                                               Float step)

integerEp

public static EventPropertyPrimitive integerEp(Label label,
                                               String runtimeName,
                                               String domainProperty,
                                               QuantitativeValue valueSpecification)

doubleEp

public static EventPropertyPrimitive doubleEp(Label label,
                                              String runtimeName,
                                              String domainProperty)

doubleEp

public static EventPropertyPrimitive doubleEp(Label label,
                                              String runtimeName,
                                              String domainProperty,
                                              Float minValue,
                                              Float maxValue,
                                              Float step)