Package cern.nxcals.api.custom.service.aggregation

Class ExpandableAggregationFunction

java.lang.Object

cern.nxcals.api.custom.service.aggregation.AggregationFunction

cern.nxcals.api.custom.service.aggregation.ExpandableAggregationFunction

public abstract class ExpandableAggregationFunction
extends AggregationFunction

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.spark.sql.expressions.WindowSpec	RECORDS_ROW_WINDOW

Fields inherited from class cern.nxcals.api.custom.service.aggregation.AggregationFunction

TIMESTAMP_COLUMN_NAME, VALUE_COLUMN_NAME

Method Summary

Modifier and Type	Method	Description
ExpandableAggregationFunction	expandTimeWindowBy(long amountBefore, long amountAfter, @NonNull java.time.temporal.TemporalUnit unit)	Replaces the default data query time window expansion associated with this AggregationFunctions implementation.

Methods inherited from class cern.nxcals.api.custom.service.aggregation.AggregationFunction

getTimeWindowExpansion

Methods inherited from class java.lang.Object

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

Field Detail

RECORDS_ROW_WINDOW

protected static final org.apache.spark.sql.expressions.WindowSpec RECORDS_ROW_WINDOW

Method Detail

expandTimeWindowBy

public ExpandableAggregationFunction expandTimeWindowBy(long amountBefore,
                                                        long amountAfter,
                                                        @NonNull
                                                        @NonNull java.time.temporal.TemporalUnit unit)

Replaces the default data query time window expansion associated with this AggregationFunctions implementation.

Parameters:

amountBefore - the amount of the duration to expand, before the start time of query time window, measured in terms of the unit. Parameter should be a positive value and would be validated against that expectation

amountAfter - the amount of the duration to expand, after the end time of query time window, measured in terms of the unit. Parameter should be a positive value and would be validated against that expectation

unit - the unit that the duration is measured in, must have an exact duration, not null

Returns:

a new ExpandableAggregationFunction based on this function containing the specified time window expansion settings