.. _dev_concept:

******************
Middleware Concept
******************

.. include:: rst_directives.rst

.. contents:: 
    :local:

Instead of let SEEK talk directly to MaSyMoS-Morre or vice versa, a middleware could simplify this job by…
    - knowing enough SEEK-API (i.e. where to get the new version)
    - knowing how to deal with MaSyMoS-Morre (i.e. wait with the annotation indexing on bulk-imports; use more threads)

The middleware is für INSERT, UPDATE, DELETE.

MaSyMoS-Morre is used as query tool by SEEK.

.. image:: ../uml/structure_overview.svg

Terminology
###########
- model
    - a SEEK model, can have more then one valid content files attached
- content
    - a valid file to use with MaSyMoS Morre (SBM, CellML, SEDML)

Requirements
############

Requirements - MaSyMoS
======================

- MaSyMoS needs an permalink (unique, never changing identifier) per model/content and version 
    - mandatory for update, delete
    - given with
        - SEEK id+version, i.e. https://fairdomhub.org/models/20.json
        - SEEK meta.uuid as unique identifier
    - json also provides version history and version-comments
- MaSyMoS needs an information on
    - ``INSERT``: link to model without version
    - ``UPDATE``: link to model without version (MaSyMoS deletes old version, then inserts new version)
    - ``DELETE``: link to model without version
- SEEK json key ``latest_version`` needs to point to the current version used by MaSyMoS
- bulk-import to create/reset the MaSyMoS-database
    - list of all available model-URLs

Process description
===================

Sequence Overview
-----------------

.. image:: ../uml/sequence_overview.svg

INSERT-Process
--------------

.. image:: ../uml/activity_insert.svg