Package edu.ie3.datamodel.io.sink

Interface InputDataSink

All Superinterfaces:
DataSink
All Known Implementing Classes:
CsvFileSink
public interface InputDataSink extends DataSink

  • Method Details

    • persistIgnoreNested

      <C extends InputEntity> void persistIgnoreNested(C entity)
      Should implement the entry point of a data sink to persist an input entity. In contrast to DataSink.persist(C) and persistIncludeNested(C), this method should not take care about the extraction process of nested entities (if any) but only persist the uuid of the nested entity. This might speed up things a little bit because of missing if-/else-clauses but can also lead to missing persisted data that should be persisted, but is not e.g. nested types that are not available anymore afterwards. It might be useful especially for all entities without nested entities. For all doubts about if the provided entity contains needed nested data or not DataSink.persist(UniqueEntity) is the recommended method to be used.
      Type Parameters:
      C - bounded to be all input entities. Handling of the entities is normally then executed by a InputEntityProcessor
      Parameters:
      entity - the entity that should be persisted

    • persistAllIgnoreNested

      <C extends InputEntity> void persistAllIgnoreNested(Collection<C> entities)
      Should implement the entry point of a data sink to persist multiple input entities in a collection. In contrast to DataSink.persistAll(Collection) and persistAllIncludeNested(java.util.Collection<C>), this method should not take care about the extraction process of nested entities (if any) but only persist the uuid of the nested entity. This might speed up things a little bit because of missing if-/else-clauses but but can also lead to missing persisted data that should be persisted, but is not e.g. nested types that are not available anymore afterwards. It might be useful especially for all entities without nested entities. For all doubts about if the provided entity contains needed nested data or not DataSink.persistAll(Collection) is the recommended method to be used.
      Type Parameters:
      C - bounded to be all unique entities. Handling of the entities is normally then executed by a InputEntityProcessor
      Parameters:
      entities - the entities that should be persisted

    • persistIncludeNested

      <C extends InputEntity> void persistIncludeNested(C entity)
      Should offer a clear alternative to persistIgnoreNested(C) if the nested entities of an input entity are supposed to be persisted as well. However this might take longer as additional entities have to be extracted and persisted.
      Type Parameters:
      C - bounded to be all input entities. Handling of specific entities is normally then executed by a specific InputEntityProcessor
      Parameters:
      entity - the entity that should be persisted including its nested entities

    • persistAllIncludeNested

      <C extends InputEntity> void persistAllIncludeNested(Collection<C> entities)
      Should offer a clear alternative to persistAllIgnoreNested(java.util.Collection<C>) if the nested entities of the input entities are supposed to be persisted as well. However this might take longer as additional entities have to be extracted and persisted.
      Type Parameters:
      C - bounded to be all unique entities. Handling of the entities is normally then executed by a InputEntityProcessor
      Parameters:
      entities - the entities that should be persisted including its nested entities

    • persistJointGrid

      void persistJointGrid(JointGridContainer jointGridContainer)
      Should implement the entry point of a data sink to persist a whole JointGridContainer
      Parameters:
      jointGridContainer - the JointGridContainer that should be persisted