ENH: xlsx template generator

Summary

Allows to create XLSX templates

Focus

Test Environment

unit test (including one for all dimr schemas which is to be removed)

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosadvancedtools/table_json_conversion/table_generator.py

@@ -38,6 +38,7 @@ class ColumnType(Enum):
     SCALAR = 1
     LIST = 2
     FOREIGN = 3
+    IGNORE = 3
 
 
 class RowType(Enum):
@@ -62,20 +63,20 @@ class TableTemplateGenerator(ABC):
                       elements of the path within the JSON where the key is needed. Suppose we want
                       to distinguis Persons that are referenced by Trainings, foreign_keys must at
                       least contain the following: {"Training": {"Person": [key1, key2]}}.
-                      Values wihtin the dicts can be a list representing the keys, a tuple where
-                      the first element is the list representing the keys and the second elment is
-                      a dict that allows to set further foreign keys at lower depth. The third
-                      possibility is a dict. In that case no foreign keys exist at that level (
-                      e.g. in the above example there is no foreign key for the path ["Training"].
+                      Values wihtin the dicts can be a list representing the keys or
+                      a dict that allows to set further foreign keys at lower depth.
+                      In latter case if foreign keys exist at that level (
+                      e.g. in the above example there might be further levels below "Person".),
+                      then the keys can be set using the special "__this__" key.
+                      Example: {"Training": {"__this__": ["date"], "Person": [key1, key2]}}
+                      Here, "date" is the sole key for Training.
         """
         pass
 
     def _generate_sheets_from_schema(self, schema: dict, foreign_keys: dict = None
-                                     ) -> dict[str, dict[str, tuple[str, list]]]:
+                                     ) -> dict[str, dict[str, list]]:
         """ generates a sheet definition from a given JSON schema
 
-
-
         Parameters
         ----------
         schema: dict