Package com.storedobject.iot

Interface ConsumptionCalculator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ConsumptionCalculator

A functional interface for calculating consumption values over a specified time period. The calculation can be customized using various factory methods.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
Double	compute(int resource, Id unitId, long from, long to)	Computes a value based on the specified resource, unit identifier, and time range.
static ConsumptionCalculator	create(Class<? extends Data> dataClass, String variable)	Creates a ConsumptionCalculator instance to compute the difference in values of a specific variable for a given data class between the specified time range.
static ConsumptionCalculator	create(Class<? extends Data> dataClass, String variable, boolean toTrue, double multiplier)	Creates a ConsumptionCalculator instance that computes consumption based on state changes of the specified variable within the provided data class.
static ConsumptionCalculator	create(Class<? extends Data> dataClass, String variable, double multiplier)	Creates a ConsumptionCalculator instance with a specified multiplier to adjust the computed value.

Method Details

compute

Double compute(int resource,
 Id unitId,
 long from,
 long to)

Computes a value based on the specified resource, unit identifier, and time range. The calculation logic can be implemented using the specific details provided.

Parameters:

resource - the resource identifier used in the computation

unitId - the unique identifier for the unit on which computation is performed

from - the starting timestamp for the computation period

to - the ending timestamp for the computation period

Returns:

a Double representing the calculated value, or null if the computation fails or is not applicable

create

static ConsumptionCalculator create(Class<? extends Data> dataClass,
 String variable)

Creates a ConsumptionCalculator instance to compute the difference in values of a specific variable for a given data class between the specified time range.

Parameters:

dataClass - the class type of the data from which values are retrieved

variable - the name of the variable to compute the difference for

Returns:

a ConsumptionCalculator instance configured for the specified data class and variable

create

static ConsumptionCalculator create(Class<? extends Data> dataClass,
 String variable,
 double multiplier)

Creates a ConsumptionCalculator instance with a specified multiplier to adjust the computed value. The created calculator computes the difference of a given variable for the specified data class, then multiplies the result by the provided multiplier.

Parameters:

dataClass - the class type extending Data, representing the data source for the computation

variable - the name of the variable to be used in the computation

multiplier - the factor by which the computed difference is multiplied

Returns:

a ConsumptionCalculator instance configured with the specified parameters

create

static ConsumptionCalculator create(Class<? extends Data> dataClass,
 String variable,
 boolean toTrue,
 double multiplier)

Creates a ConsumptionCalculator instance that computes consumption based on state changes of the specified variable within the provided data class. The calculation can be customized using the boolean condition and multiplier.

Parameters:

dataClass - the class type of the data being used for computation

variable - the name of the variable used for state change computation

toTrue - the condition for computing state changes; if true, only changes to "true" are considered

multiplier - the value by which the computed state changes will be multiplied

Returns:

a ConsumptionCalculator instance that computes values based on state changes in the data