DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Funktionen des Pattern Endpunktes für den Pattern Editor ======

===== Einleitung =====
Um die neuen Use-Cases des Pattern Editors zu erfüllen, muss der Pattern Endpunkt einzelne Pattern laden können und speichern/aktualisieren.
Die beiden Standard Cases sind:

- Ein Pattern wird mithilfe des Editors erstellt und soll in der Datenbank abgelegt werden
  - Ein Pattern wird aus der Datenbank geladen und im Editor verändert und danach erneut gespeichert werden
===== Anforderungen =====

==== IST-Zustand ====
Der Endpunkt kann keine Pattern speichern/aktualisieren. Der Endpunkt kann keine einzelnen einzelnen Pattern Gruppen laden.

==== SOLL-Zustand ====
Der Endpunkt ''pattern.controller.ts'' soll um die folgenden Punkte erweitert werden:

{{https://plantuml.progresso-group.de/png/fPAn2i9038RtGjyXeu9FqAbW5nSHmKaSGXlhuTsbvD8kuhjRjAKMpqMNMtB_z-U3v45Hj7KM6bGbyK2-QjXuXO0TfKcu6j-We0F7dikBi2DGQVjHQJ44sBroQ_OgR2q9t00WJVhdYJW4ak7FOkZ8nb2Xl1gBDnLvDMT3aa5GCRvUPj2ngUQeFLlw3RU2TiXlqT7NaeBEs5hzS-KNhoQDwCTM8uV6lb6cjkDfnehuntZogHb5ncsZObC-JUvfalU7qj_D0m00.png}}

Diese Methoden sind über folgende Endpunkt erreichbar:

<code>
get pattern/user/{eMail}/{patternIdentifier} ---> getUserPattern
get pattern/role/{userRoleName}/{patternIdentifier} ---> getUserRolePattern
get pattern/default/{patternIdentifier} ---> getDefaultPattern
put pattern/ {email}/{patternIdentifier} ---> saveUserPattern
put pattern/{userRoleName}/{patternIdentifier} ---> saveUserRolePattern
put pattern/default/{patternIdentifier} ---> saveDefaultPattern
</code>

===== Umsetzung =====
==== Ablauf ====
=== Save/Update ===
  - Der Endpunkt wird aufgerufen
  - Es wird geprüft, ob sich bereits ein Pattern mit den übergebenen Kriterien in der Datenbank befindet, sollte dieser Fall eintreten
  - Das übergebende Pattern wird in eine PatternBuilder importiert
  - Anhand der übergebenen Parameter wird das Pattern erweitert, sodass es möglich ist es an den PatternToNeo4j Parser zu übergeben
  - Das erzeugte Cypher wird mithilfe des neo4j service ausgeführt

**Diagramm ablauf_save_pattern.wsd einbinden**

=== Get ===
  - Der Endpunkt wird aufgerufen
  - Anhand des PatternIdentifiers wird ein Pattern erstellt, das die betroffene Element lädt
  - Mithilfe der Parameter wird das Pattern um entscheidende Wert angereicht. Dieser Werte können Benutzer Email oder Benutzerrollen Name sein
  - Das erzeugte Cypher wird mithilfe des neo4j service ausgeführt

<WRAP center round important 60%>
'''Anhand der übergebenen Parameter wird das Pattern erweitert [...]''' ist mir etwas zu vage. Was soll gemacht werden?
</WRAP>

==== Schritt 1 ====
Erstellen der Endpunkt. Die Endpunkt müssen wie in dem oben zu sehenden Diagramm umgesetzt werden. Dabei sollen 6 neue Endpunkt entstehen. Diese sollen mit einem e2e Test versehen werden, ob die über die angedachte URL verfügbar sind.
==== Schritt 2 ====
Die Klasse ''patternIdentifierToNeo4j.parser.ts'' muss refakturiert werden. Innerhalb der Klasse muss der gemeinsame Code der Methoden ''createUserCypher'' und ''createUserRolePattern'' zusammengefasst werden. Dazu ist es nötig, den PatternBuilder um eine weitere Methode zu erweitern. Diese Methode soll den Index eines Knoten anhand des Namen wiedergeben. 
<WRAP center round important 60%>
Hier verstehe ich das "wozu" nicht? Kannst du das erläutern?
</WRAP>

==== Schritt 3 ====
Die Methoden ''getUserPattern, getUserRolePattern, getDefaultPattern'' der Klasse ''pattern.service.ts'' werden zu öffentlichen Methoden und müssen eine eigenständige Testabdeckung erhalten. Auch ist es nötig, dass die Testdaten erweitert werden.

==== Schritt 4 ====
Es müssen acht neue Klassen erstellt werden. Diese haben folgende Aufgaben:
  - Laden von Pattern
  - Umwandeln eines Graph Results in ein PatternDto[]
  - Entscheiden, ob create oder update
  - Erstellen eines Patterns zum Createn
  - Erstellen eines Patterns zum Updaten
  - Createn von Pattern in der Datenbank 
  - Updaten vom Pattern in der Datenbank

==== Schritt 5 ====
Der ''pattern.loader.ts'' stellt kann dazu verwendet werden Pattern anhand ihrere Identifiers aus der Datenbank zu laden. Seine Methoden geben ein oder mehrere PatternDto wieder.

{{https://plantuml.progresso-group.de/png/fT2_2i903CVn_U3U8QE-GgSENGG74Pp48VRIUdX_IfARn7UtrdOH1yNCNpxmIosAh2K6652LE8MCZjWQkVeq86E4c5DkBvmZWN8XQzg08h1xzTkfXvirCDvGpi6tq9CUX7XELZEzSPJKTvwu0b7sgLzN2zDeFfu-6ViSw5-deGvBqD-OTsJPwqM_4PxTfDojgIcvySKF.png}}

==== Schritt 6 ====
Der ''pattern.converter.ts'' konvertiert ein GraphResult zu einem PatternDto oder einem Array von PatternDto.

{{https://plantuml.progresso-group.de/png/bOz12W8n34NtXTuXIxt283AYu5R42yGQdC6s6T9K4F7kLYlKbU1VXVptVqYV54LpyDQaonWd50mGEB8RX0E1IYPheCXvJ0bsg4eIrnol96M2UtLVclBHZmvSzRQ2qx2dbBqU-1FRAC_ERT_15pJle55_bgv4yFQh-GqiMc1P3poiwIcUoljF.png}}
==== Schritt 7 ====
Der ''pattern.saveActionDecisionMaker.ts'' trifft die Entscheidung, ob ein Pattern aktualisiert werden muss oder es sich um ein neues Pattern handelt und es in der Datenbank neu erstellt werden muss.

{{https://plantuml.progresso-group.de/png/fOyn3i8m34NtIhs3HxX2fo9OEY0X40Tm4mDM4oSu3WlYxXILaOst_ENfIRylXcerXhOf4qj6nGWnIN8tJP70j5BRm8mBM0eSq8nKJlYWZJDEiYF7PTuzJgJmNDmFkOw17GnbguJsjOzqhwpaLtdf39x4-CAa7HHJbkkwWp6bG2W_KkVi_qYzsgOdyVFPDm00.png}}

==== Schritt 8 ====
Der ''pattern.createStoredPatternPatternCreator.ts'' erzeugt mithilfe seiner Parameter ein Pattern, das einen neuen Pattern Knoten in der Datenbank hinterlegt.

{{https://plantuml.progresso-group.de/png/jP312i8m38RlXRv3ZWfxWfq6Yk15nE43n2xJOjkCD3s9x-wOzUn1p2NaI_x_XtHPKRJ4O4s--pIXO8J8YTrDE1Ae5BB61SmPDaAer2iB3KTK9KcrBHiMW8SrCDTKBi4xS8kWtknOpfbaDRt75Yfle9BzG4dzw4bQo2e-NHiei-A0aJva_TN_n87-cR6b4KlGdoEUrdIKXldpBm00.png}}

==== Schritt 9 ====
Der ''pattern.updateStoredPatternPatternCreator.ts'' erzeugt mithilfe seiner Parameter ein Pattern, das einen neuen Pattern Knoten in der Datenbank hinterlegt.

{{https://plantuml.progresso-group.de/png/jP1D2W8n38NtXTuXIuKvmQm65C6DYCCS84upMkmVQReIxsxHkdOXPlF8Hzvxa24BiXJljCet6n8oUl0nnFdAqHC85z9gTfWpJCcWq2YHoHnHX3WqsJ1XnG1thQ1EAcTdPoWlGxlPHPuoyIgzrnuQxw2HlQ4WTh74FMHX6ouTbEeueASFMN_DFqL7_-pOqeB5oSyL3wq62gP-_Wa0.png}}
==== Schritt 10  ====
Der ''pattern.creator.ts'' ist dafür verantwortlich ein Pattern neue Pattern zu beziehen.

{{https://plantuml.progresso-group.de/png/fP112W8n34NtXTuXIuKvmQm6d8qR4S43n3QZnROPqdGsujqTSLoAeDby-FptGz8LHT6QeZNb6lA8WWaIPtONuKIWKiaQ5x4KsACgITu8eRB0pHgOPwod61oufql7GhB4LkDBspVNApUmc5jFMSCGI5eeAY6VrorC7Fo7pWD7-gstWRhmEqpqVLjF0zQeVnvnjwQZxEU_FW00.png}}

==== Schritt 11 ====
Der ''pattern.updater.ts'' ist dafür verantwortlich ein Pattern zu aktualisieren.

{{https://plantuml.progresso-group.de/png/fL2x2W8n4Em3-OSj5UuBKbrnZOs8S1-mb-nfC2ys6nlntptqB4NGQGQ6dHbc-oh8qcBGgbvyAiWO8UQKxPbp911kf9KDM2iSK8GuZSNXmZUjO45fK_0MsbCSA_5wjIalDc_R8Bc3LTmvIk9dJsoW2ljqsXguPky-P1vpeDzoEsYhVu-HlhSDD6CBykU8krOz9RUyzG40.png}}

<WRAP center round important 60%>
Anstatt hier viele einzelne Klassen zu sehen, hätte ich lieber ein Diagramm mit alle drin, in dem auch Abhängigkeiten sichtbar sind.
</WRAP>

Please fill all the letters into the box to prove you're human. L X P G L Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International