Umgang ruleset.xsd

[henning-gerhardt]

Implementierung

Aufgrund von #6005 kann man sich Fragen zu dem Umgang mit der ruleset.xsd Datei stellen. Es wurde ein neue Konfigurationseinstellung filterable im Programmcode durch #5810 hinzugefügt, jedoch ohne dies in der Schema Datei für die Regelsätze aka ruleset.xsd selbst zu hinterlegen. Der PR #6006 versucht dies zu beheben.
Es kann aber nicht ausgeschlossen werden, dass es noch weitere Diskrepanzen zwischen der Schema Datei und der Implementierung gibt. Dies immer gleich zu halten, ist nur mit viel Aufwand sowohl bei der Entwicklung neuer Einstellungen als auch der Abnahme (Review) der neuen Einstellungen zu bewerkstelligen.

An der Stelle, wo es darum geht, auf METS und / oder MODS Daten zuzugreifen, wird dies anders gelöst. Hier werden die XSD Dateien als ausschließliche Quelle genommen und mit Hilfe eines Übersetzungsmechanismuses wird aus der XSD Datei der Programmcode generiert und die Zugriffe erfolgen über diese generierten Klassen. So muss nur an einer Stelle eine Pflege / Erweiterung durchgeführt werden, statt an zwei.

Kann man daher nicht das gleiche Prinzip (Generierung der Klassen für den Zugriff aus der XSD Datei) nicht auch für die ruleset.xsd Datei anwenden und auf selbst geschriebenen Programmcode verzichtet werden?

Vorhandensein im Quellcode-Repo

Unabhängig davon existiert die ruleset.xsd Datei nahezu identisch an zwei Stellen im Quellcode: Einmal unter Kitodo/rulesets/ruleset.xsd und ein zweites Mal Kitodo-DataEditor/src/test/resources/ruleset.xsd: Hier sollte / kann in Erwähnung gezogen werden, dass die Datei nur an einer Stelle liegt und somit auch Änderungen nur noch an einer Stelle gemacht werden müssen, da sich ansonsten die zwei Dateien unterschiedlich entwickeln und es unklar ist, welche der beiden Dateien die korrekte ist. Soweit es aus der aktuellen Nutzung der ruleset.xsd im Programmcode hervor geht, werden die beiden Dateien in beiden Modulen Kitodo und Kitodo-DataEditor auch schon über kreuz (d.h. im Kitodo Module wird auf die ruleset.xsd Datei im Modul Kitodo-DataEditor zugegriffen) in den Tests genutzt.

Im PR #6006 wird neben der Bekanntmachung des filterable Attributes auch die zwei Dateien inhaltlich vereinheitlicht, da es zwar nur dokumentarische Unterschiede gab.