enhancement
major
minor
major
minor
Eindeutigkeitsbeschränkung
Begründung
Anwendungen erfordern regelmäßig, dass bestimmte Werte nicht doppelt eingegeben werden. Ein Projekt darf keine zwei Meilensteine mit demselben Namen haben, die E-Mail-Adresse eines Ansprechpartners sollte eindeutig sein, eine Auftragspositionsnummer muss innerhalb ihres Auftrags eindeutig sein. Derzeit muss dies in jeder Anwendung durch manuell erstellte Einschränkungen oder benutzerdefinierten Code überprüft werden. Da TopLogic ein allgemeines Framework ist, sollte dies eine deklarative Funktion auf Modellebene sein: Der Modellierer legt fest, „welche Kombination von Attributen eindeutig sein muss“, und das Framework setzt dies durch und gibt dem Benutzer frühzeitig Rückmeldung.
Dies ist das Objektmodell-Äquivalent eines SQL-UNIQUE-Index, wird jedoch anhand des Modells (Typen, Attribute, Referenzen) statt anhand von Tabellen und Spalten ausgedrückt.
Deklaration
Eine Eindeutigkeitsbeschränkung ist eine integrierte Beschränkungsprüfung, die für das Primärattribut deklariert wird, dessen Wert voraussichtlich eindeutig sein wird, unter Verwendung der allgemeinen <constraints> -Annotation:
{{{#!xml <property name="name">
<annotations>
<constraints>
<unique additional-attributes="project"/>
</constraints>
</annotations>
</property> }}}
Zusätzliche Attribute können an der Einschränkung beteiligt sein: Der Wert des annotierten Attributs muss dann nur unter den Objekten eindeutig sein, die die Werte aller zusätzlichen Attribute gemeinsam haben. Beteiligte Attribute können Dateneigenschaften oder 1:1-Referenzen sein – beide werden einheitlich behandelt, genau wie ein SQL-Index Datenspalten und Fremdschlüsselspalten mischt.
Dieser einzige Mechanismus deckt alle üblichen Fälle ab:
- Einzelne Eigenschaft – <unique/> für „name“: ein einfacher, global eindeutiger Wert.
- Mehrere Eigenschaften – <unique additional-attributes="lastName"/> für „firstName“: eine eindeutige Kombination.
- Eigenschaft plus Referenz – <unique additional-attributes="project"/> für „name“: eindeutig innerhalb eines Geltungsbereichs. Der „Geltungsbereich“ (z. B. der Container) ist kein eigenständiges Konzept: Es handelt sich lediglich um ein Referenzattribut, das an der Einschränkung beteiligt ist.
- Nur Referenzen – höchstens eine Verknüpfung einer bestimmten Form zwischen Objekten: Bei einem Mitgliedschaftstyp mit den Referenzen „person“ und „project“ wird eine der Referenzen annotiert, z. B. <unique additional-attributes="project"/> für „person“.
Verstöße werden am annotierten (primären) Attribut gemeldet – in einem Formular, und zwar genau in dem Feld, in das der Benutzer gerade eingibt. Da es sich bei der Deklaration um eine reguläre Einschränkungsprüfung handelt, kann sie auch in der App über den Modell-Editor deklariert werden, und eine Variante mit type="warning" zeigt den Konflikt im Formular an, ohne das Speichern zu verhindern.
Anwendungsnutzen: frühzeitiges Feedback im Formular
Der wichtigste Aspekt für den Endbenutzer ist die frühzeitige Validierung im Formular. Wenn der Benutzer einen Wert eingibt, der gegen eine Eindeutigkeitsbeschränkung verstoßen würde, wird das betroffene Feld sofort (bei der Eingabe des Werts oder beim Verlassen des Feldes) mit einer eindeutigen Meldung als ungültig markiert – lange bevor die Änderung gespeichert wird. Dies ist der sichtbare Vorteil der Funktion.
Die Formularprüfung:
- verwendet die aktuell eingegebenen (noch nicht festgeschriebenen) Werte;
- schließt das bearbeitete Objekt selbst bei der Prüfung eines bestehenden Objekts aus (in einem Erstellungsdialog gibt es noch kein „self“);
- wird neu ausgewertet, wenn ein Scoping- Attribut im selben Formular geändert wird (z. B. wenn der Benutzer zuerst den Container auswählt und dann den Namen eingibt), nicht nur, wenn sich das eingeschränkte Feld selbst ändert.
Durchsetzung beim Speichern
Unabhängig vom Formular wird die Einschränkung auch bei Änderungen durchgesetzt, die nicht über ein Formular erfolgen – Importe, Skripte, die API. Die Prüfung zum Zeitpunkt des Commits ist die Integritätssicherung: Sie läuft innerhalb des Commits (bevor etwas geschrieben wird) und lehnt die Transaktion bei einem Konflikt ab. Da Transaktionen beim Commit sequenziert werden (um eine lückenlose Revisionsreihenfolge zu erzeugen), ist die Prüfung auf Anwendungsebene ohne weiteren Aufwand wettlaufsicher: Keine zwei konfliktreichen Werte können gleichzeitig festgeschrieben werden. Objekte, die innerhalb derselben Transaktion erstellt oder geändert werden, werden ebenfalls gegeneinander abgeglichen.
Formularprüfung und Commit-Prüfung nutzen dieselbe Implementierung zum „Auffinden widersprüchlicher Objekte“, sodass die beiden Ebenen nicht auseinanderdriften können.
Semantische Entscheidungen
- Null gilt als Wert. „Unset“ wird wie jeder andere Wert in die Einschränkung einbezogen, sodass höchstens ein Objekt den leeren Wert (bzw. die leere Kombination von Werten) haben darf. Dies ist für eine Modelleinschränkung intuitiver als die SQL-Regel, wonach mehrere NULL-Werte unterschiedlich sind.
- „To-many“-Referenzen können nicht einbezogen werden. Ein Attribut mit Mengenwert hat keinen einzelnen Wert, der eingeschränkt werden könnte; „eindeutig über eine Menge“ hat keine eindeutige Bedeutung. Die Einbeziehung ist auf Dateneigenschaften und „to-one“-Referenzen beschränkt.
- Vererbung. Eine Einschränkung gilt für die gesamte Instanzmenge des Typs, der sie deklariert, einschließlich der Instanzen von Untertypen. Ein Untertyp, der das eingeschränkte Attribut überschreibt, erbt die Einschränkung und bleibt Teil derselben Eindeutigkeitsdomäne – eine Überschreibung aus einem anderen Grund (ein eingeschränkter Typ, eine andere Bezeichnung) schränkt die Domäne nicht ein.
- Deklaration bei einer Überschreibung. Wird die Einschränkung auf ein überschreibendes Attribut statt auf dessen Definition deklariert, wird die Domäne auf die Instanzen des überschreibenden Typs eingeschränkt: Diese werden dann nur gegeneinander geprüft. Da eine lokale <constraints> -Annotation die geerbte ersetzt, anstatt sich mit ihr zu vereinen, schränken Deklarationen auf gleichrangigen Typen unabhängige Eindeutigkeitsdomänen ein.
Konfiguration innerhalb der App
Die zusätzlichen Attribute, die an einer Einschränkung beteiligt sind, werden aus den Attributen des Typs ausgewählt, zu dem das annotierte Attribut gehört; „to-many“-Attribute werden nicht angeboten, da sie nicht beteiligt sein können.
Die im Modell-Editor angebotenen Einschränkungstypen sind diejenigen, die als anwendungsinterne Implementierungen annotiert sind, wie bei anderen konfigurierbaren Algorithmen. Eine Implementierung, die lediglich als interner Adapter für eine eigene Modellannotation dient (die Annotationen „mandatory“, „size“ und „range“), wird daher nicht als separat konfigurierbare Einschränkung angeboten, und die Optionsliste enthält ausschließlich übersetzte Einträge.
Versionierung
Die Eindeutigkeit gilt pro Zweig und für den aktuellen Zustand: Zwei Objekte, die gleichzeitig im selben Zweig existieren, dürfen die eingeschränkten Werte nicht gemeinsam nutzen. Historische Zustände sind davon nicht betroffen – ein durch eine Löschung freigegebener Wert kann später wiederverwendet werden. (Auf Speicherebene entspricht dies der Einbeziehung des Zweigs und des Revisionsbereichsmarkers in die Suche, genau wie es die internen Indizes der Wissensdatenbank bereits tun.)
Optional: Durchsetzung auf Datenbankebene (erweitertes DB-Mapping)
Prüfungen auf Anwendungsebene (Formular + Commit) reichen für die Korrektheit aus und sind die Standardeinstellung. Wenn die eingeschränkten Attribute in echten Spalten der Objekttabelle gespeichert sind, wird der Gleichheitstest bereits auf eine indizierbare Datenbankabfrage heruntergebrochen. Bei einem erweiterten Datenbank-Mapping kann die Einschränkung aus Effizienzgründen zusätzlich durch einen echten eindeutigen Datenbankindex abgesichert werden:
- Bei monomorpher Speicherung (alle durch Einschränkungen betroffenen Instanzen in einer Tabelle) kann der Index direkt auf die Speichertabelle angelegt werden (über den Zweig, den Revisionsbereichsmarker und die beteiligten Spalten).
- Bei polymorpher Speicherung (Instanzen verteilt über mehrere Tabellen) kann ein einzelner nativer Index diese nicht abdecken. Die Durchsetzung auf Datenbankebene erfordert dann eine separate flache Hilfstabelle, die die beteiligten Werte (sowie den Zweig-/Revisionsmarker und das zugehörige Objekt) enthält, bei jedem Commit aktualisiert wird und über einen eindeutigen Index verfügt.
Eine solche flache Hilfstabelle dient, sofern vorhanden, gleichzeitig als schneller Suchpfad für die Prüfungen auf Anwendungsebene (Form- und Nicht-Form-Mutationen) und ist der natürliche Ort, um die Semantik „Null zählt als Wert“ explizit zu realisieren. Es handelt sich jedoch um eine Optimierung – sie ist für die Funktionsweise der Funktion nicht erforderlich.