Package edu.ie3.datamodel.io.source

Interface ThermalSource

All Superinterfaces:

DataSource

All Known Implementing Classes:

CsvThermalSource

public interface ThermalSource
extends DataSource

Interface that provides the capability to build thermal AssetInput entities from persistent data e.g. .csv files or databases

Since:

08.04.20

Method Summary

Modifier and Type	Method	Description
Set<CylindricalStorageInput>	getCylindricStorages()	Returns a unique set of CylindricalStorageInput instances.
Set<CylindricalStorageInput>	getCylindricStorages(Set<OperatorInput> operators, Set<ThermalBusInput> thermalBuses)	Returns a set of CylindricalStorageInput instances.
Set<ThermalBusInput>	getThermalBuses()	Returns a unique set of ThermalBusInput instances.
Set<ThermalBusInput>	getThermalBuses(Set<OperatorInput> operators)	Returns a set of ThermalBusInput instances.
Set<ThermalHouseInput>	getThermalHouses()	Returns a unique set of ThermalHouseInput instances.
Set<ThermalHouseInput>	getThermalHouses(Set<OperatorInput> operators, Set<ThermalBusInput> thermalBuses)	Returns a set of ThermalHouseInput instances.
Set<ThermalStorageInput>	getThermalStorages()	Returns a unique set of instances of all entities implementing the ThermalStorageInput abstract class.
Set<ThermalStorageInput>	getThermalStorages(Set<OperatorInput> operators, Set<ThermalBusInput> thermalBuses)	Returns a unique set of instances of all entities implementing the ThermalStorageInput abstract class.

Method Details

getThermalBuses

Set<ThermalBusInput> getThermalBuses()

Returns a unique set of ThermalBusInput instances.

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

Returns:

a set of object and uuid unique ThermalBusInput entities

getThermalBuses

Set<ThermalBusInput> getThermalBuses(Set<OperatorInput> operators)

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

In contrast to getThermalBuses() this interface provides the ability to pass in an already existing set of OperatorInput entities, the ThermalBusInput 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.

Parameters:

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 ThermalBusInput entities

getThermalStorages

Set<ThermalStorageInput> getThermalStorages()

Returns a unique set of instances of all entities implementing the ThermalStorageInput abstract class.

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

Returns:

a set of object and uuid unique ThermalStorageInput entities

getThermalStorages

Set<ThermalStorageInput> getThermalStorages(Set<OperatorInput> operators,
 Set<ThermalBusInput> thermalBuses)

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

In contrast to getThermalStorages() this interface provides the ability to pass in an already existing set of OperatorInput entities, the ThermalStorageInput 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.

Parameters:

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

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

Returns:

a set of object and uuid unique ThermalStorageInput entities

getThermalHouses

Set<ThermalHouseInput> getThermalHouses()

Returns a unique set of ThermalHouseInput instances.

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

Returns:

a set of object and uuid unique ThermalHouseInput entities

getThermalHouses

Set<ThermalHouseInput> getThermalHouses(Set<OperatorInput> operators,
 Set<ThermalBusInput> thermalBuses)

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

In contrast to getThermalHouses() this interface provides the ability to pass in an already existing set of OperatorInput entities, the ThermalHouseInput 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.

Parameters:

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

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

Returns:

a set of object and uuid unique ThermalHouseInput entities

getCylindricStorages

Set<CylindricalStorageInput> getCylindricStorages()

Returns a unique set of CylindricalStorageInput instances.

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

Returns:

a set of object and uuid unique CylindricalStorageInput entities

getCylindricStorages

Set<CylindricalStorageInput> getCylindricStorages(Set<OperatorInput> operators,
 Set<ThermalBusInput> thermalBuses)

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

In contrast to getCylindricStorages() this interface provides the ability to pass in an already existing set of OperatorInput entities, the CylindricalStorageInput 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.

Parameters:

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

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

Returns:

a set of object and uuid unique CylindricalStorageInput entities