Package edu.ie3.datamodel.io.source.csv

Class CsvSystemParticipantSource

java.lang.Object

edu.ie3.datamodel.io.source.csv.CsvDataSource

edu.ie3.datamodel.io.source.csv.CsvSystemParticipantSource

All Implemented Interfaces:

DataSource, SystemParticipantSource

public class CsvSystemParticipantSource
extends CsvDataSource
implements SystemParticipantSource

Source that provides the capability to build entities of type SystemParticipantInput as well as SystemParticipants container from .csv files.

This source is not buffered which means each call on a getter method always tries to read all data is necessary to return the requested objects in a hierarchical cascading way.

If performance is an issue, it is recommended to read the data cascading starting with reading nodes and then using the getters with arguments to avoid reading the same data multiple times.

The resulting sets are always unique on object and UUID base (with distinct UUIDs).

Since:

03.04.20

Field Summary

Fields inherited from class edu.ie3.datamodel.io.source.csv.CsvDataSource

connector, csvSep, FIELDS_TO_VALUES_MAP, log, NODE, NODE_A, NODE_B, OPERATOR, TYPE

Constructor Summary

Constructors

Constructor	Description
CsvSystemParticipantSource(String csvSep, String participantsFolderPath, FileNamingStrategy fileNamingStrategy, TypeSource typeSource, ThermalSource thermalSource, RawGridSource rawGridSource)

Method Summary

Modifier and Type	Method	Description
Set<BmInput>	getBmPlants()	Returns a unique set of BmInput instances.
Set<BmInput>	getBmPlants(Set<NodeInput> nodes, Set<OperatorInput> operators, Set<BmTypeInput> types)	Returns a set of BmInput instances.
Set<ChpInput>	getChpPlants()	Returns a unique set of ChpInput instances.
Set<ChpInput>	getChpPlants(Set<NodeInput> nodes, Set<OperatorInput> operators, Set<ChpTypeInput> types, Set<ThermalBusInput> thermalBuses, Set<ThermalStorageInput> thermalStorages)	Returns a set of ChpInput instances.
Set<EmInput>	getEmSystems()	Returns a unique set of EmInput instances.
Set<EmInput>	getEmSystems(Set<NodeInput> nodes, Set<OperatorInput> operators)	This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EmInput which has to be checked manually, as EmInput.equals(Object) is NOT restricted on the uuid of EmInput.
Set<EvcsInput>	getEvCS()	Returns a unique set of EvcsInput instances.
Set<EvcsInput>	getEvCS(Set<NodeInput> nodes, Set<OperatorInput> operators)	Returns a set of EvcsInput instances.
Set<EvInput>	getEvs()	Returns a unique set of EvInput instances.
Set<EvInput>	getEvs(Set<NodeInput> nodes, Set<OperatorInput> operators, Set<EvTypeInput> types)	Returns a set of EvInput instances.
Set<FixedFeedInInput>	getFixedFeedIns()	Returns a unique set of FixedFeedInInput instances.
Set<FixedFeedInInput>	getFixedFeedIns(Set<NodeInput> nodes, Set<OperatorInput> operators)	Returns a set of FixedFeedInInput instances.
Set<HpInput>	getHeatPumps()	Returns a unique set of HpInput instances.
Set<HpInput>	getHeatPumps(Set<NodeInput> nodes, Set<OperatorInput> operators, Set<HpTypeInput> types, Set<ThermalBusInput> thermalBuses)	Returns a set of HpInput instances.
Set<LoadInput>	getLoads()	Returns a unique set of LoadInput instances.
Set<LoadInput>	getLoads(Set<NodeInput> nodes, Set<OperatorInput> operators)	Returns a set of LoadInput instances.
Set<PvInput>	getPvPlants()	Returns a unique set of PvInput instances.
Set<PvInput>	getPvPlants(Set<NodeInput> nodes, Set<OperatorInput> operators)	Returns a set of PvInput instances.
Set<StorageInput>	getStorages()	Returns a unique set of StorageInput instances.
Set<StorageInput>	getStorages(Set<NodeInput> nodes, Set<OperatorInput> operators, Set<StorageTypeInput> types)	Returns a set of StorageInput instances.
Optional<SystemParticipants>	getSystemParticipants()	Should return either a consistent instance of SystemParticipants wrapped in Optional or an empty Optional.
Set<WecInput>	getWecPlants()	Returns a unique set of WecInput instances.
Set<WecInput>	getWecPlants(Set<NodeInput> nodes, Set<OperatorInput> operators, Set<WecTypeInput> types)	Returns a set of WecInput instances.

Methods inherited from class edu.ie3.datamodel.io.source.csv.CsvDataSource

assetInputEntityDataStream, assetInputEntityDataStream, buildStreamWithFieldsToAttributesMap, buildStreamWithFieldsToAttributesMap, csvRowFieldValueMapping, distinctRowsWithLog, findFirstEntityByUuid, getAssetType, isPresentCollectIfNot, logSkippingWarning, nodeAssetEntityStream, nodeAssetInputEntityDataStream, parseCsvRow, printInvalidElementInformation, saveMapGet, simpleEntityDataStream

Methods inherited from class java.lang.Object

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

Constructor Details

CsvSystemParticipantSource

public CsvSystemParticipantSource(String csvSep,
 String participantsFolderPath,
 FileNamingStrategy fileNamingStrategy,
 TypeSource typeSource,
 ThermalSource thermalSource,
 RawGridSource rawGridSource)

Method Details

getSystemParticipants

public Optional<SystemParticipants> getSystemParticipants()

Should return either a consistent instance of SystemParticipants wrapped in Optional or an empty Optional. The decision to use Optional instead of returning the SystemParticipants instance directly is motivated by the fact, that a SystemParticipants is a container instance that depends on several other entities. Without being complete, it is useless for further processing.

Hence, whenever at least one entity SystemParticipants depends on cannot be provided, Optional.empty() should be returned and extensive logging should provide enough information to debug the error and fix the persistent data that has been failed to processed.

Furthermore, it is expected, that the specific implementation of this method ensures not only the completeness of the resulting SystemParticipants instance, but also its validity e.g. in the sense that not duplicate UUIDs exist within all entities contained in the returning instance.

Specified by:

getSystemParticipants in interface SystemParticipantSource

Returns:

either a valid, complete SystemParticipants optional or Optional.empty()

getFixedFeedIns

public Set<FixedFeedInInput> getFixedFeedIns()

Returns a unique set of FixedFeedInInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided FixedFeedInInput which has to be checked manually, as FixedFeedInInput.equals(Object) is NOT restricted on the uuid of FixedFeedInInput.

Specified by:

getFixedFeedIns in interface SystemParticipantSource

Returns:

a set of object and uuid unique FixedFeedInInput entities

getFixedFeedIns

public Set<FixedFeedInInput> getFixedFeedIns(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

Returns a set of FixedFeedInInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided FixedFeedInInput which has to be checked manually, as FixedFeedInInput.equals(Object) is NOT restricted on the uuid of FixedFeedInInput.

In contrast to SystemParticipantSource.getFixedFeedIns() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the FixedFeedInInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If the set of NodeInput entities is not exhaustive for all available FixedFeedInInput entities (e.g. a NodeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality), but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getFixedFeedIns in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

Returns:

a set of object and uuid unique FixedFeedInInput entities

getPvPlants

public Set<PvInput> getPvPlants()

Returns a unique set of PvInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided PvInput which has to be checked manually, as PvInput.equals(Object) is NOT restricted on the uuid of PvInput.

Specified by:

getPvPlants in interface SystemParticipantSource

Returns:

a set of object and uuid unique PvInput entities

getPvPlants

public Set<PvInput> getPvPlants(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

Returns a set of PvInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided PvInput which has to be checked manually, as PvInput.equals(Object) is NOT restricted on the uuid of PvInput.

In contrast to SystemParticipantSource.getPvPlants() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the PvInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If the set of NodeInput entities is not exhaustive for all available PvInput entities (e.g. a NodeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality), but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getPvPlants in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

Returns:

a set of object and uuid unique PvInput entities

getLoads

public Set<LoadInput> getLoads()

Returns a unique set of LoadInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided LoadInput which has to be checked manually, as LoadInput.equals(Object) is NOT restricted on the uuid of LoadInput.

Specified by:

getLoads in interface SystemParticipantSource

Returns:

a set of object and uuid unique LoadInput entities

getLoads

public Set<LoadInput> getLoads(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

Returns a set of LoadInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided LoadInput which has to be checked manually, as LoadInput.equals(Object) is NOT restricted on the uuid of LoadInput.

In contrast to SystemParticipantSource.getLoads() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the LoadInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If the set of NodeInput entities is not exhaustive for all available LoadInput entities (e.g. a NodeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality), but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getLoads in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

Returns:

a set of object and uuid unique LoadInput entities

getEvCS

public Set<EvcsInput> getEvCS()

Returns a unique set of EvcsInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EvcsInput which has to be checked manually, as EvcsInput.equals(Object) is NOT restricted on the uuid of EvcsInput.

Specified by:

getEvCS in interface SystemParticipantSource

Returns:

a set of object and uuid unique EvcsInput entities

getEvCS

public Set<EvcsInput> getEvCS(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

Returns a set of EvcsInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EvcsInput which has to be checked manually, as EvcsInput.equals(Object) is NOT restricted on the uuid of EvcsInput.

In contrast to SystemParticipantSource.getEvCS() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the EvcsInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If the set of NodeInput entities is not exhaustive for all available EvcsInput entities (e.g. a NodeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality), but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getEvCS in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

Returns:

a set of object and uuid unique EvcsInput entities

getBmPlants

public Set<BmInput> getBmPlants()

Returns a unique set of BmInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided BmInput which has to be checked manually, as BmInput.equals(Object) is NOT restricted on the uuid of BmInput.

Specified by:

getBmPlants in interface SystemParticipantSource

Returns:

a set of object and uuid unique BmInput entities

getBmPlants

public Set<BmInput> getBmPlants(Set<NodeInput> nodes,
 Set<OperatorInput> operators,
 Set<BmTypeInput> types)

Returns a set of BmInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided BmInput which has to be checked manually, as BmInput.equals(Object) is NOT restricted on the uuid of BmInput.

In contrast to SystemParticipantSource.getBmPlants() this interface provides the ability to pass in an already existing set of NodeInput, BmTypeInput and OperatorInput entities, the BmInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If one of the sets of NodeInput or BmTypeInput entities is not exhaustive for all available BmInput entities (e.g. a NodeInput or BmTypeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality) but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getBmPlants in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

types - a set of object and uuid unique BmTypeInput entities

Returns:

a set of object and uuid unique BmInput entities

getStorages

public Set<StorageInput> getStorages()

Returns a unique set of StorageInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided StorageInput which has to be checked manually, as StorageInput.equals(Object) is NOT restricted on the uuid of StorageInput.

Specified by:

getStorages in interface SystemParticipantSource

Returns:

a set of object and uuid unique StorageInput entities

getStorages

public Set<StorageInput> getStorages(Set<NodeInput> nodes,
 Set<OperatorInput> operators,
 Set<StorageTypeInput> types)

Returns a set of StorageInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided StorageInput which has to be checked manually, as StorageInput.equals(Object) is NOT restricted on the uuid of StorageInput.

In contrast to SystemParticipantSource.getStorages() this interface provides the ability to pass in an already existing set of NodeInput, StorageTypeInput and OperatorInput entities, the StorageInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If one of the sets of NodeInput or StorageTypeInput entities is not exhaustive for all available StorageInput entities (e.g. a NodeInput or StorageTypeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality) but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getStorages in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

types - a set of object and uuid unique StorageTypeInput entities

Returns:

a set of object and uuid unique StorageInput entities

getWecPlants

public Set<WecInput> getWecPlants()

Returns a unique set of WecInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided WecInput which has to be checked manually, as WecInput.equals(Object) is NOT restricted on the uuid of WecInput.

Specified by:

getWecPlants in interface SystemParticipantSource

Returns:

a set of object and uuid unique WecInput entities

getWecPlants

public Set<WecInput> getWecPlants(Set<NodeInput> nodes,
 Set<OperatorInput> operators,
 Set<WecTypeInput> types)

Returns a set of WecInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided WecInput which has to be checked manually, as WecInput.equals(Object) is NOT restricted on the uuid of WecInput.

In contrast to SystemParticipantSource.getWecPlants() this interface provides the ability to pass in an already existing set of NodeInput, WecTypeInput and OperatorInput entities, the WecInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If one of the sets of NodeInput or WecTypeInput entities is not exhaustive for all available WecInput entities (e.g. a NodeInput or WecTypeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality) but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getWecPlants in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

types - a set of object and uuid unique WecTypeInput entities

Returns:

a set of object and uuid unique WecInput entities

getEvs

public Set<EvInput> getEvs()

Returns a unique set of EvInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EvInput which has to be checked manually, as EvInput.equals(Object) is NOT restricted on the uuid of EvInput.

Specified by:

getEvs in interface SystemParticipantSource

Returns:

a set of object and uuid unique EvInput entities

getEvs

public Set<EvInput> getEvs(Set<NodeInput> nodes,
 Set<OperatorInput> operators,
 Set<EvTypeInput> types)

Returns a set of EvInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EvInput which has to be checked manually, as EvInput.equals(Object) is NOT restricted on the uuid of EvInput.

In contrast to SystemParticipantSource.getEvs() this interface provides the ability to pass in an already existing set of NodeInput, EvTypeInput and OperatorInput entities, the EvInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If one of the sets of NodeInput or EvTypeInput entities is not exhaustive for all available EvInput entities (e.g. a NodeInput or EvTypeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality) but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getEvs in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

types - a set of object and uuid unique EvTypeInput entities

Returns:

a set of object and uuid unique EvInput entities

getChpPlants

public Set<ChpInput> getChpPlants()

Returns a unique set of ChpInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided ChpInput which has to be checked manually, as ChpInput.equals(Object) is NOT restricted on the uuid of ChpInput.

Specified by:

getChpPlants in interface SystemParticipantSource

Returns:

a set of object and uuid unique ChpInput entities

getChpPlants

public Set<ChpInput> getChpPlants(Set<NodeInput> nodes,
 Set<OperatorInput> operators,
 Set<ChpTypeInput> types,
 Set<ThermalBusInput> thermalBuses,
 Set<ThermalStorageInput> thermalStorages)

Returns a set of ChpInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided ChpInput which has to be checked manually, as ChpInput.equals(Object) is NOT restricted on the uuid of ChpInput.

In contrast to SystemParticipantSource.getChpPlants() this interface provides the ability to pass in an already existing set of NodeInput, ChpTypeInput, ThermalBusInput, ThermalStorageInput and OperatorInput entities, the ChpInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If one of the sets of NodeInput, ThermalBusInput, ThermalStorageInput or ChpTypeInput entities is not exhaustive for all available ChpInput entities (e.g. a NodeInput or ChpTypeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality) but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getChpPlants in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

types - a set of object and uuid unique ChpTypeInput entities

thermalBuses - a set of object and uuid unique ThermalBusInput entities

thermalStorages - a set of object and uuid unique ThermalStorageInput entities

Returns:

a set of object and uuid unique ChpInput entities

getHeatPumps

public Set<HpInput> getHeatPumps()

Returns a unique set of HpInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided HpInput which has to be checked manually, as HpInput.equals(Object) is NOT restricted on the uuid of HpInput.

Specified by:

getHeatPumps in interface SystemParticipantSource

Returns:

a set of object and uuid unique HpInput entities

getHeatPumps

public Set<HpInput> getHeatPumps(Set<NodeInput> nodes,
 Set<OperatorInput> operators,
 Set<HpTypeInput> types,
 Set<ThermalBusInput> thermalBuses)

Returns a set of HpInput instances. This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided HpInput which has to be checked manually, as HpInput.equals(Object) is NOT restricted on the uuid of HpInput.

In contrast to SystemParticipantSource.getHeatPumps() this interface provides the ability to pass in an already existing set of NodeInput, HpTypeInput, ThermalBusInput, ThermalStorageInput and OperatorInput entities, the HpInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If one of the sets of NodeInput, ThermalBusInput or HpTypeInput entities is not exhaustive for all available HpInput entities (e.g. a NodeInput or HpTypeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality) but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getHeatPumps in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

types - a set of object and uuid unique HpTypeInput entities

thermalBuses - a set of object and uuid unique ThermalBusInput entities

Returns:

a set of object and uuid unique HpInput entities

getEmSystems

public Set<EmInput> getEmSystems()

Description copied from interface: SystemParticipantSource

Returns a unique set of EmInput instances.

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EmInput which has to be checked manually, as EmInput.equals(Object) is NOT restricted on the uuid of EmInput.

Specified by:

getEmSystems in interface SystemParticipantSource

Returns:

a set of object and uuid unique EmInput entities

getEmSystems

public Set<EmInput> getEmSystems(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

This set has to be unique in the sense of object uniqueness but also in the sense of UUID uniqueness of the provided EmInput which has to be checked manually, as EmInput.equals(Object) is NOT restricted on the uuid of EmInput.

In contrast to SystemParticipantSource.getHeatPumps() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the EmInput instances depend on. Doing so, already loaded nodes can be recycled to improve performance and prevent unnecessary loading operations.

If something fails during the creation process it's up to the concrete implementation of an empty set or a set with all entities that has been able to be build is returned.

If the set of NodeInput entities is not exhaustive for all available LoadInput entities (e.g. a NodeInput entity is missing) or if an error during the building process occurs, the entity that misses something will be skipped (which can be seen as a filtering functionality), but all entities that are able to be built will be returned anyway and the elements that couldn't have been built are logged.

If the set with OperatorInput is not exhaustive, the corresponding operator is set to OperatorInput.NO_OPERATOR_ASSIGNED

Specified by:

getEmSystems in interface SystemParticipantSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

operators - a set of object and uuid unique OperatorInput that should be used for the returning instances

Returns:

a set of object and uuid unique EmInput entities