Package cern.nxcals.api.custom.service

Interface WindowAggregationService

public interface WindowAggregationService

Represents a service for data aggregation actions, as configured by the provided properties. Actions defined on this service operate on top of raw data that are directly extractable via DataQuery or DevicePropertyDataQuery.

See Also:

Variable, Entity, WindowAggregationProperties, AggregationFunctions

Method Summary

Modifier and Type	Method	Description
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getData(Entity entity, WindowAggregationProperties properties)	Returns a dataset where each row contains an aggregated entity data point on fixed, distinct timestamp.
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getData(Variable variable, WindowAggregationProperties properties)	Returns a dataset where each row contains an aggregated variable data point on fixed, distinct timestamp.

Method Detail

getData

org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getData(Variable variable,
                                                               WindowAggregationProperties properties)

Returns a dataset where each row contains an aggregated variable data point on fixed, distinct timestamp. The timestamp (in utc seconds) represents the start of an interval, part of a generated sequence of time windows. Each data point contains the result of an applied aggregation function, as specified by the provided properties. The aggregation function is applied on values present within the right-open intervals [startInclusive, endExclusive)

Parameters:

variable - an instance of Variable pointing to raw data for the extraction

properties - the aggregation properties containing all semantics to control the action

Returns:

a dataset of aggregated rows

getData

org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getData(Entity entity,
                                                               WindowAggregationProperties properties)

Returns a dataset where each row contains an aggregated entity data point on fixed, distinct timestamp. The timestamp (in utc seconds) represents the start of an interval, part of a generated sequence of time windows. Each data point contains the result of an applied aggregation function, as specified by the provided properties. The aggregation function is applied on values present within the right-open intervals [startInclusive, endExclusive)

Parameters:

entity - an instance of Entity pointing to raw data for the extraction

properties - the aggregation properties containing all semantics to control the action

Returns:

a dataset of aggregated rows