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

Class CsvRawGridSource

java.lang.Object

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

edu.ie3.datamodel.io.source.csv.CsvRawGridSource

All Implemented Interfaces:

DataSource, RawGridSource

public class CsvRawGridSource
extends CsvDataSource
implements RawGridSource

Source that provides the capability to build entities that are hold by a RawGridElements as well as the RawGridElements 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
CsvRawGridSource(String csvSep, String gridFolderPath, FileNamingStrategy fileNamingStrategy, TypeSource typeSource)

Method Summary

Modifier and Type	Method	Description
Set<Transformer2WInput>	get2WTransformers()	Returns a unique set of Transformer2WInput instances.
Set<Transformer2WInput>	get2WTransformers(Set<NodeInput> nodes, Set<Transformer2WTypeInput> transformer2WTypes, Set<OperatorInput> operators)	Returns a set of Transformer2WInput instances.
Set<Transformer3WInput>	get3WTransformers()	Returns a unique set of Transformer3WInput instances.
Set<Transformer3WInput>	get3WTransformers(Set<NodeInput> nodes, Set<Transformer3WTypeInput> transformer3WTypeInputs, Set<OperatorInput> operators)	Returns a set of Transformer3WInput instances.
Optional<RawGridElements>	getGridData()	Should return either a consistent instance of RawGridElements wrapped in Optional or an empty Optional.
Set<LineInput>	getLines()	Returns a unique set of LineInput instances.
Set<LineInput>	getLines(Set<NodeInput> nodes, Set<LineTypeInput> lineTypeInputs, Set<OperatorInput> operators)	Returns a set of LineInput instances.
Set<MeasurementUnitInput>	getMeasurementUnits()	Returns a unique set of MeasurementUnitInput instances.
Set<MeasurementUnitInput>	getMeasurementUnits(Set<NodeInput> nodes, Set<OperatorInput> operators)	Returns a set of MeasurementUnitInput instances.
Set<NodeInput>	getNodes()	Returns a unique set of NodeInput instances.
Set<NodeInput>	getNodes(Set<OperatorInput> operators)	Returns a set of NodeInput instances.
Set<SwitchInput>	getSwitches()	Returns a unique set of SwitchInput instances.
Set<SwitchInput>	getSwitches(Set<NodeInput> nodes, Set<OperatorInput> operators)	Returns a set of SwitchInput 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

CsvRawGridSource

public CsvRawGridSource(String csvSep,
 String gridFolderPath,
 FileNamingStrategy fileNamingStrategy,
 TypeSource typeSource)

Method Details

getGridData

public Optional<RawGridElements> getGridData()

Should return either a consistent instance of RawGridElements wrapped in Optional or an empty Optional. The decision to use Optional instead of returning the RawGridElements instance directly is motivated by the fact, that a RawGridElements 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 RawGridElements 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 RawGridElements 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:

getGridData in interface RawGridSource

Returns:

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

getNodes

public Set<NodeInput> getNodes()

Returns a unique set of NodeInput instances.

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

Specified by:

getNodes in interface RawGridSource

Returns:

a set of object and uuid unique NodeInput entities

getNodes

public Set<NodeInput> getNodes(Set<OperatorInput> operators)

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

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

getNodes in interface RawGridSource

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

getLines

public Set<LineInput> getLines()

Returns a unique set of LineInput instances.

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

Specified by:

getLines in interface RawGridSource

Returns:

a set of object and uuid unique LineInput entities

getLines

public Set<LineInput> getLines(Set<NodeInput> nodes,
 Set<LineTypeInput> lineTypeInputs,
 Set<OperatorInput> operators)

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

In contrast to RawGridSource.getNodes() this interface provides the ability to pass in an already existing set of NodeInput, LineTypeInput and OperatorInput entities, the LineInput instances depend on. Doing so, already loaded nodes, line types and operators 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 LineTypeInput entities is not exhaustive for all available LineInput entities (e.g. a NodeInput or LineTypeInput 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:

getLines in interface RawGridSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

lineTypeInputs - a set of object and uuid unique LineTypeInput 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 LineInput entities

get2WTransformers

public Set<Transformer2WInput> get2WTransformers()

Returns a unique set of Transformer2WInput instances.

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

Specified by:

get2WTransformers in interface RawGridSource

Returns:

a set of object and uuid unique Transformer2WInput entities

get2WTransformers

public Set<Transformer2WInput> get2WTransformers(Set<NodeInput> nodes,
 Set<Transformer2WTypeInput> transformer2WTypes,
 Set<OperatorInput> operators)

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

In contrast to RawGridSource.getNodes() this interface provides the ability to pass in an already existing set of NodeInput, Transformer2WTypeInput and OperatorInput entities, the Transformer2WInput instances depend on. Doing so, already loaded nodes, line types and operators 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 Transformer2WTypeInput entities is not exhaustive for all available Transformer2WInput entities (e.g. a NodeInput or Transformer2WTypeInput 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:

get2WTransformers in interface RawGridSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

transformer2WTypes - a set of object and uuid unique Transformer2WTypeInput 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 Transformer2WInput entities

get3WTransformers

public Set<Transformer3WInput> get3WTransformers()

Returns a unique set of Transformer3WInput instances.

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

Specified by:

get3WTransformers in interface RawGridSource

Returns:

a set of object and uuid unique Transformer3WInput entities

get3WTransformers

public Set<Transformer3WInput> get3WTransformers(Set<NodeInput> nodes,
 Set<Transformer3WTypeInput> transformer3WTypeInputs,
 Set<OperatorInput> operators)

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

In contrast to RawGridSource.getNodes() this interface provides the ability to pass in an already existing set of NodeInput, Transformer3WTypeInput and OperatorInput entities, the Transformer3WInput instances depend on. Doing so, already loaded nodes, line types and operators 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 Transformer3WTypeInput entities is not exhaustive for all available Transformer3WInput entities (e.g. a NodeInput or Transformer3WTypeInput 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:

get3WTransformers in interface RawGridSource

Parameters:

nodes - a set of object and uuid unique NodeInput entities

transformer3WTypeInputs - a set of object and uuid unique Transformer3WTypeInput 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 Transformer3WInput entities

getSwitches

public Set<SwitchInput> getSwitches()

Returns a unique set of SwitchInput instances.

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

Specified by:

getSwitches in interface RawGridSource

Returns:

a set of object and uuid unique SwitchInput entities

getSwitches

public Set<SwitchInput> getSwitches(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

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

In contrast to RawGridSource.getNodes() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the SwitchInput instances depend on. Doing so, already loaded nodes, line types and operators 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 entities is not exhaustive for all available SwitchInput 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:

getSwitches in interface RawGridSource

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

getMeasurementUnits

public Set<MeasurementUnitInput> getMeasurementUnits()

Returns a unique set of MeasurementUnitInput instances.

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

Specified by:

getMeasurementUnits in interface RawGridSource

Returns:

a set of object and uuid unique MeasurementUnitInput entities

getMeasurementUnits

public Set<MeasurementUnitInput> getMeasurementUnits(Set<NodeInput> nodes,
 Set<OperatorInput> operators)

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

In contrast to RawGridSource.getNodes() this interface provides the ability to pass in an already existing set of NodeInput and OperatorInput entities, the MeasurementUnitInput instances depend on. Doing so, already loaded nodes, line types and operators 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 entities is not exhaustive for all available MeasurementUnitInput 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:

getMeasurementUnits in interface RawGridSource

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