Package energy.eddie.regionconnector.shared.services.data.needs

Class DataNeedCalculationServiceImpl

java.lang.Object

energy.eddie.regionconnector.shared.services.data.needs.DataNeedCalculationServiceImpl

All Implemented Interfaces:

DataNeedCalculationService

public class DataNeedCalculationServiceImpl
extends Object
implements DataNeedCalculationService

Implementation of the DataNeedCalculationService that can be customized to fit the requirements of the region connector.

Constructor Summary

Constructors

Constructor	Description
DataNeedCalculationServiceImpl(DataNeedsService dataNeedsService, RegionConnectorMetadata regionConnectorMetadata, DataNeedRuleSet dataNeedRuleSet)	Uses PermissionEndIsEnergyDataEndStrategy for the PermissionTimeframeStrategy and DefaultEnergyDataTimeframeStrategy for the EnergyDataTimeframeStrategy.
DataNeedCalculationServiceImpl(DataNeedsService dataNeedsService, RegionConnectorMetadata regionConnectorMetadata, PermissionTimeframeStrategy strategy, EnergyDataTimeframeStrategy energyDataTimeframeStrategy, DataNeedRuleSet dataNeedRuleSet)	Constructs an instance with custom PermissionTimeframeStrategy and EnergyDataTimeframeStrategy.

Method Summary

Modifier and Type	Method	Description
DataNeedCalculationResult	calculate(DataNeed dataNeed)	Calculates relevant information for a data need
DataNeedCalculationResult	calculate(DataNeed dataNeed, ZonedDateTime referenceDateTime)	Calculates relevant information for a data need, using the reference datetime
DataNeedCalculationResult	calculate(String dataNeedId)	Calculate relevant information for a given data need ID
DataNeedCalculationResult	calculate(String dataNeedId, ZonedDateTime referenceDateTime)	Calculates relevant information for given data need ID, using the reference datetime
MultipleDataNeedCalculationResult	calculateAll(Set<String> dataNeedIds)	Calculates the relevant information for multiple given data need IDs.
MultipleDataNeedCalculationResult	calculateAll(Set<String> dataNeedIds, ZonedDateTime referenceDateTime)	Calculates the relevant information for multiple given data need IDs, using the reference datetime.
String	regionConnectorId()	The id of the region-connector that provides the implementation of this service.

Methods inherited from class java.lang.Object

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

Constructor Details

DataNeedCalculationServiceImpl

public DataNeedCalculationServiceImpl(DataNeedsService dataNeedsService,
 RegionConnectorMetadata regionConnectorMetadata,
 DataNeedRuleSet dataNeedRuleSet)

Uses PermissionEndIsEnergyDataEndStrategy for the PermissionTimeframeStrategy and DefaultEnergyDataTimeframeStrategy for the EnergyDataTimeframeStrategy. These are used to calculate the start and end of a permission request and the start and end of the metered data, if needed.

Parameters:

dataNeedsService - service to get the data need

regionConnectorMetadata - metadata of the region connector

DataNeedCalculationServiceImpl

public DataNeedCalculationServiceImpl(DataNeedsService dataNeedsService,
 RegionConnectorMetadata regionConnectorMetadata,
 PermissionTimeframeStrategy strategy,
 EnergyDataTimeframeStrategy energyDataTimeframeStrategy,
 DataNeedRuleSet dataNeedRuleSet)

Constructs an instance with custom PermissionTimeframeStrategy and EnergyDataTimeframeStrategy. Furthermore, it allows adding additional checks for the data need.

Parameters:

dataNeedsService - service to get the data need

regionConnectorMetadata - metadata of the region connector

strategy - strategy that is used to calculate the permission timeframe

energyDataTimeframeStrategy - strategy that is used to calculate the energy timeframe

dataNeedRuleSet - ruleset for data needs per region connector

Method Details

calculate

public DataNeedCalculationResult calculate(DataNeed dataNeed)

Description copied from interface: DataNeedCalculationService

Calculates relevant information for a data need

Specified by:

calculate in interface DataNeedCalculationService

Parameters:

dataNeed - the data need

Returns:

the calculation results for the data need

calculate

public DataNeedCalculationResult calculate(DataNeed dataNeed,
 ZonedDateTime referenceDateTime)

Description copied from interface: DataNeedCalculationService

Calculates relevant information for a data need, using the reference datetime

Specified by:

calculate in interface DataNeedCalculationService

Parameters:

dataNeed - the data need

referenceDateTime - the reference datetime the calculations are based on

Returns:

the calculation results for the data need

calculate

public DataNeedCalculationResult calculate(String dataNeedId)

Description copied from interface: DataNeedCalculationService

Calculate relevant information for a given data need ID

Specified by:

calculate in interface DataNeedCalculationService

Parameters:

dataNeedId - the ID of the data need

Returns:

the calculation results for the data need

calculate

public DataNeedCalculationResult calculate(String dataNeedId,
 ZonedDateTime referenceDateTime)

Description copied from interface: DataNeedCalculationService

Calculates relevant information for given data need ID, using the reference datetime

Specified by:

calculate in interface DataNeedCalculationService

Parameters:

dataNeedId - the ID of the data need

referenceDateTime - the reference datetime the calculations are based on

Returns:

the calculation results for the data need

calculateAll

public MultipleDataNeedCalculationResult calculateAll(Set<String> dataNeedIds)

Description copied from interface: DataNeedCalculationService

Calculates the relevant information for multiple given data need IDs.

Specified by:

calculateAll in interface DataNeedCalculationService

Parameters:

dataNeedIds - the ID of the data needs

Returns:

a Map of the calculations, where the key is the data need ID and the value the calculation result.

calculateAll

public MultipleDataNeedCalculationResult calculateAll(Set<String> dataNeedIds,
 ZonedDateTime referenceDateTime)

Description copied from interface: DataNeedCalculationService

Calculates the relevant information for multiple given data need IDs, using the reference datetime.

Specified by:

calculateAll in interface DataNeedCalculationService

Parameters:

dataNeedIds - the ID of the data needs

referenceDateTime - the reference datetime the calculations are based on

Returns:

a Map of the calculations, where the key is the data need ID and the value the calculation result.

regionConnectorId

public String regionConnectorId()

Description copied from interface: DataNeedCalculationService

The id of the region-connector that provides the implementation of this service.

Specified by:

regionConnectorId in interface DataNeedCalculationService

Returns:

region-connector id