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

Class CsvThermalSource

java.lang.Object

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

edu.ie3.datamodel.io.source.csv.CsvThermalSource

All Implemented Interfaces:

DataSource, ThermalSource

public class CsvThermalSource
extends CsvDataSource
implements ThermalSource

Source that provides the capability to build thermal AssetInput entities 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
CsvThermalSource(String csvSep, String thermalUnitsFolderPath, FileNamingStrategy fileNamingStrategy, TypeSource typeSource)

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.

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

CsvThermalSource

public CsvThermalSource(String csvSep,
 String thermalUnitsFolderPath,
 FileNamingStrategy fileNamingStrategy,
 TypeSource typeSource)

Method Details

getThermalBuses

public 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.

Specified by:

getThermalBuses in interface ThermalSource

Returns:

a set of object and uuid unique ThermalBusInput entities

getThermalBuses

public 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 ThermalSource.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.

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

Specified by:

getThermalBuses in interface ThermalSource

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

public 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.

Specified by:

getThermalStorages in interface ThermalSource

Returns:

a set of object and uuid unique ThermalStorageInput entities

getThermalStorages

public 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 ThermalSource.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.

If the set of ThermalBusInput entities is not exhaustive for all available ThermalStorageInput entities (e.g. a ThermalBusInput 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:

getThermalStorages in interface ThermalSource

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

public 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.

Specified by:

getThermalHouses in interface ThermalSource

Returns:

a set of object and uuid unique ThermalHouseInput entities

getThermalHouses

public 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 ThermalSource.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.

If the set of ThermalBusInput entities is not exhaustive for all available ThermalHouseInput entities (e.g. a ThermalBusInput 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:

getThermalHouses in interface ThermalSource

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

public 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.

Specified by:

getCylindricStorages in interface ThermalSource

Returns:

a set of object and uuid unique CylindricalStorageInput entities

getCylindricStorages

public 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 ThermalSource.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.

If the set of ThermalBusInput entities is not exhaustive for all available CylindricalStorageInput entities (e.g. a ThermalBusInput 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:

getCylindricStorages in interface ThermalSource

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