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

Class CsvGraphicSource

java.lang.Object

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

edu.ie3.datamodel.io.source.csv.CsvGraphicSource

All Implemented Interfaces:

DataSource, GraphicSource

public class CsvGraphicSource
extends CsvDataSource
implements GraphicSource

Implementation of the GraphicSource interface to read NodeGraphicInput and LineGraphicInput entities from .csv files

Since:

08.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
CsvGraphicSource(String csvSep, String folderPath, FileNamingStrategy fileNamingStrategy, TypeSource typeSource, RawGridSource rawGridSource)

Method Summary

Modifier and Type	Method	Description
Optional<GraphicElements>	getGraphicElements()	Should return either a consistent instance of GraphicElements wrapped in Optional or an empty Optional.
Set<LineGraphicInput>	getLineGraphicInput()	Returns a set of LineGraphicInput instances.
Set<LineGraphicInput>	getLineGraphicInput(Set<LineInput> lines)	Returns a set of LineGraphicInput instances.
Set<NodeGraphicInput>	getNodeGraphicInput()	Returns a set of NodeGraphicInput instances.
Set<NodeGraphicInput>	getNodeGraphicInput(Set<NodeInput> nodes)	Returns a set of NodeGraphicInput 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

CsvGraphicSource

public CsvGraphicSource(String csvSep,
 String folderPath,
 FileNamingStrategy fileNamingStrategy,
 TypeSource typeSource,
 RawGridSource rawGridSource)

Method Details

getGraphicElements

public Optional<GraphicElements> getGraphicElements()

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

getGraphicElements in interface GraphicSource

Returns:

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

getNodeGraphicInput

public Set<NodeGraphicInput> getNodeGraphicInput()

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

Specified by:

getNodeGraphicInput in interface GraphicSource

Returns:

a set of object and uuid unique NodeGraphicInput entities

getNodeGraphicInput

public Set<NodeGraphicInput> getNodeGraphicInput(Set<NodeInput> nodes)

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

In contrast to GraphicSource.getNodeGraphicInput() this interface provides the ability to pass in an already existing set of NodeInput entities, the NodeGraphicInput 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 NodeGraphicInput entities or if an error during the building process occurs, all entities that has been able to be built are returned and the not-built ones are ignored (= filtered out).

Specified by:

getNodeGraphicInput in interface GraphicSource

Parameters:

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

Returns:

a set of object and uuid unique NodeGraphicInput entities

getLineGraphicInput

public Set<LineGraphicInput> getLineGraphicInput()

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

Specified by:

getLineGraphicInput in interface GraphicSource

Returns:

a set of object and uuid unique LineGraphicInput entities

getLineGraphicInput

public Set<LineGraphicInput> getLineGraphicInput(Set<LineInput> lines)

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

In contrast to GraphicSource.getLineGraphicInput() this interface provides the ability to pass in an already existing set of LineInput entities, the LineGraphicInput 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 LineInput entities is not exhaustive for all available LineGraphicInput entities or if an error during the building process occurs, all entities that has been able to be built are returned and the not-built ones are ignored (= filtered out).

Specified by:

getLineGraphicInput in interface GraphicSource

Parameters:

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

Returns:

a set of object and uuid unique LineGraphicInput entities