Package edu.ie3.datamodel.io.source

Interface RawGridSource

All Superinterfaces:

DataSource

All Known Implementing Classes:

CsvRawGridSource

public interface RawGridSource
extends DataSource

Interface that provides the capability to build entities that are hold by a RawGridElements as well as the RawGridElements container as well from different data sources e.g. .csv files or databases.

Since:

08.04.20

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.

Method Details

getGridData

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.

Returns:

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

getNodes

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.

Returns:

a set of object and uuid unique NodeInput entities

getNodes

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

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

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.

Returns:

a set of object and uuid unique LineInput entities

getLines

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

Parameters:

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

nodes - a set of object and uuid unique NodeInput entities

lineTypeInputs - a set of object and uuid unique LineTypeInput entities

Returns:

a set of object and uuid unique LineInput entities

get2WTransformers

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.

Returns:

a set of object and uuid unique Transformer2WInput entities

get2WTransformers

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

Parameters:

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

nodes - a set of object and uuid unique NodeInput entities

transformer2WTypes - a set of object and uuid unique Transformer2WTypeInput entities

Returns:

a set of object and uuid unique Transformer2WInput entities

get3WTransformers

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.

Returns:

a set of object and uuid unique Transformer3WInput entities

get3WTransformers

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

Parameters:

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

nodes - a set of object and uuid unique NodeInput entities

transformer3WTypeInputs - a set of object and uuid unique Transformer3WTypeInput entities

Returns:

a set of object and uuid unique Transformer3WInput entities

getSwitches

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.

Returns:

a set of object and uuid unique SwitchInput entities

getSwitches

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

Parameters:

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

nodes - a set of object and uuid unique NodeInput entities

Returns:

a set of object and uuid unique SwitchInput entities

getMeasurementUnits

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.

Returns:

a set of object and uuid unique MeasurementUnitInput entities

getMeasurementUnits

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

Parameters:

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

nodes - a set of object and uuid unique NodeInput entities

Returns:

a set of object and uuid unique MeasurementUnitInput entities