org.streampipes.model.schema

Enum PropertyScope

java.lang.Object

java.lang.Enum<PropertyScope>

org.streampipes.model.schema.PropertyScope

All Implemented Interfaces:

Serializable, Comparable<PropertyScope>

public enum PropertyScope
extends Enum<PropertyScope>

A property scope defines the scope of an event property. Although an event schema consists of a flat list of event properties, properties might differ in terms of their purpose. For instance, a property indicating a timestamp are typically not be used for performing calculations (e.g., filter operations or sensor measurement value transformations). In contrast, a property that describes an identifier (e.g., machineId) is often used for partitioning a stream (e.g., calculating seperate temperature values per machine). Use the SDK to assign property scopes to stream descriptions and stream (property) requirements. For better understanding the meaning of property scopes, think of the meaning of variables in the data warehousing domains: Measurements are often numbers, while the dimension is what numbers are “sliced and diced” by.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIMENSION_PROPERTY A property that describes context of a measurement, e.g., the ID of a machine or a thing.
HEADER_PROPERTY A property that defines meta-information about the event, for instance its occurrence time.
MEASUREMENT_PROPERTY A property that contains (often quantitative) measurement values.
NONE The property scope is not further described.

Method Summary

Modifier and Type	Method and Description
static PropertyScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEADER_PROPERTY

public static final PropertyScope HEADER_PROPERTY

A property that defines meta-information about the event, for instance its occurrence time.

DIMENSION_PROPERTY

public static final PropertyScope DIMENSION_PROPERTY

A property that describes context of a measurement, e.g., the ID of a machine or a thing.

MEASUREMENT_PROPERTY

public static final PropertyScope MEASUREMENT_PROPERTY

A property that contains (often quantitative) measurement values.

NONE

public static final PropertyScope NONE

The property scope is not further described. Use this scope for defining property requirements where the data processor's functionality does not require any specific property scope (e.g., a text filter that can filter any text-based property).

Method Detail

values

public static PropertyScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropertyScope c : PropertyScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertyScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null