Benutzerhandbuch Koala Editor
Inhalt Einführung, Allgemeine Hinweise... 2 Installation... 2 Allgemeine Funktionen... 3 Neu... 3 Öffnen und Speichern... 4 Modulfunktionen... 5 Klassisches Zustandsdiagramm... 5 Hinzufügen von Elementen... 5 Bearbeiten von Zuständen... 5 Ziehen von Transitionen... 5 Bearbeiten von Transitionen... 7 Zustandsdiagramm mit JSF-Export... 8 Bearbeiten von Zuständen... 8 Bearbeiten von Transitionen... 9 Export von Zustandsdiagrammen mit JSF-Export... 10 Zustandsdiagramm mit UDL-Export... 11 Bearbeiten von Zuständen... 11 Bearbeiten von Transitionen... 12 Export von Zustandsdiagrammen mit UDL-Export... 12 Glossar... 13 Benutzerhandbuch Seite 1
Einführung, Allgemeine Hinweise Die Koala-Software wurde im Rahmen des Software-Engineering-Projektes an der Hochschule Osnabrück erstellt und dient der Erstellung sowie dem Export von Zustandsdiagrammen als Java- Server-Faces, sowie UML-Statechart Description Language. Die Zustandsdiagramme orientieren sich am UML 2.0-Standard. Die Version 1.0 gibt den Stand der Softwareentwicklung am 10. August 2011 wieder. Für die Erstellung der Software wurde die Bibliothek JGraph verwendet. Die folgenden Funktionalitäten sind in der Software implementiert: Erstellung komplexer Statecharts Erfassung von Zustands- und Kanteninhalten mit Hilfe von Eingabemasken Schachtelung von Zuständen Export eines Diagramms als Java Server Faces Prototyp Export eines Diagramms als UML-Statechart Description Language Prototyp Drag&Drop der gewünschten Symbole aus der Palette auf die Zeichenfläche Drucken eines Diagramms Laden & Speichern eines Diagramms Prüfung auf mehrere Startzustände Die Software ist modular aufgebaut und kann um weitere Diagrammarten erweitert werden. Installation Geliefert wird das Produkt als Zip-Archiv. Um die Software zu installieren, ist es lediglich notwendig, die JAR -Datei auszuführen. Zu beachten ist außerdem, dass sich der Ordner LIB auf der gleichen Dateisystemebene wie die JAR -Datei befindet. Benutzerhandbuch Seite 2
Allgemeine Funktionen Neu Um ein neues Diagramm anzulegen, muss eine Diagrammart über das Menü Datei->Neu gewählt werden(abb. 1). Abbildung 1: Dateimenü Alternativ kann in der Toolbar der Menüpunkt Neu angeklickt werden (Abb. 2). Abbildung 2: Menüpunkt Neu Im nun erscheinenden Dialog kann aus einem Dropdownmenü die gewünschte Diagrammart ausgewählt werden (Abb. 3). Abbildung 3: Diagrammauswahlmenü Benutzerhandbuch Seite 3
Die Bestätigung erfolgt mit einem Klick auf OK. Anschließend können die gewünschten Elemente aus der Palette (Abb. 4) auf die Zeichenfläche gezogen und das Diagramm erstellt werden. Abbildung 4: Editorpalette Öffnen und Speichern Die erstellten Diagramme können über Datei->Öffnen oder die Toolbar geöffnet werden (Abb. 5). Abbildung 5: Toolbar Über den Menüpunkt Datei->Speichern oder die Toolbar kann das Diagramm unter dem gewünschten Namen abgespeichert werden. Benutzerhandbuch Seite 4
Modulfunktionen Klassisches Zustandsdiagramm Hinzufügen von Elementen Im Classic Editor können Zustandsdiagramme nach UML 2.0-Standard erstellen werden. Nach Laden der benötigten Elemente können diese aus der Palette auf die Zeichenfläche gezogen werden. Bearbeiten von Zuständen Mit einem Doppelklick auf einen auf die Zeichenfläche gezogenen Zustand wird die Eingabemaske des Zustands geöffnet (Abb. 6). Abbildung 6: Eingabemaske für einen Zustand Hier können der Titel des Zustands sowie die Entry-, Do- und Exit-Actions in einem Textfeld festgelegt werden. Ziehen von Transitionen Um eine Kante von einem Objekt zu einem weiteren Objekt zu ziehen, muss der Mauszeiger auf ein Objekt bewegt werden, bis der Transitionsindikator erscheint (Abb. 7). Benutzerhandbuch Seite 5
Abbildung 7: Zustand mit Transitionsindikator Der Mauszeiger muss direkt auf den Transitionsindikator bewegt werden, bis das Hand-Symbol erscheint (Abb. 8). Abbildung 8: Transitionsindikator zum Ziehen von Transitionen Nun kann mittels Drag&Drop eine Transition zu einem anderen Zustand gezogen werden. Die Transition wird gesetzt, wenn um den Endpunkt der Transition ein grüner Rahmen erscheint (Abb. 9). Abbildung 9: Zustand mit korrektem Transitionsende Benutzerhandbuch Seite 6
Das grüne Fenster erscheint, wenn die Maus in den Bereich des Transitionsindikator bewegt wird. Wenn Transitionen, die nicht erlaubt sind, gezogen werden, wird der Endpunkt mit einem roten Rahmen umrandet (Abb. 10). Abbildung 10: Zustand mit inkorrektem Transitionsende Die Software gibt bei Loslassen der linken Maustaste eine Fehlermeldung mit einem Hinweis aus (Abb. 11). Abbildung 11: Angezeigte Fehlermeldung bei inkorrekten Transitionsende Wenn eine Transition gezogen wird und die linke Maustaste losgelassen wird, ohne dass das Zielobjekt grün umrandet ist oder die Transition auf die leere Zeichenfläche gesetzt wird, wird keine Transition erstellt. Bearbeiten von Transitionen Wenn zwischen zwei Objekten nur eine Transition existiert, kann die Transition durch verschieben des grünen Ankerpunktes versetzt werden. Dabei wird die neue Position als gestrichelte Linie angezeigt (Abb. 12). Abbildung 12: Verschieben von Transitionen Wenn mehr als eine Transition zwischen zwei Objekten existieren, wird die verwendete JGraph- Bibliothek diese Transitionen automatisch ausrichten, ein manuelles verschieben ist dann anhand der Benutzerhandbuch Seite 7
Transitionen nicht mehr möglich, sondern nur noch durch das Ausrichten der beiden Objekte zueinander. Das Ausrichten der Objekte kann auch dazu genutzt werden, Transitionen besser zu überblicken. Durch Doppelklick auf die Beschriftung einer Transition öffnet sich die dazugehörige Eingabemaske mit der Möglichkeit, die Kante zu beschriften(abb. 13). Abbildung 13: Eingabemaske für Transitionen Zustandsdiagramm mit JSF-Export Zustandsdiagramme mit JSF-Export beinhalten lediglich Startzustände und normale Zustände. Zustände und Transitionen können wie im klassischen Zustandsdiagramm bearbeitet werden. Bearbeiten von Zuständen Durch einen Doppelklick auf einen Zustand erscheint die entsprechende Eingabemaske für diesen Zustand (Abb. 14). Benutzerhandbuch Seite 8
Abbildung 14: Eingabemaske für Zustände mit JSF-Export Hier kann der Name des Zustands angegeben und der Scope der zu erstellenden Bean festgelegt werden. Zudem können globale Varianten angelegt werden. Diese können von allen Zuständen und Transitionen verwendet werden. Die ebenfalls verfügbaren lokalen Variablen können nur von dem Zustand und seinen abgehenden Kanten verwendet werden, in dem diese eingetragen werden. Bei Eingabe von ungültigen Werten bekommt der Benutzer eine entsprechende Fehlermeldung. Unter dem Karteireiter VariableIO können die globalen oder lokalen Variablen für die Eingabe oder die Ausgabe definiert werden. Die Richtung In gibt dabei eine Eingabemöglichkeit für eine Variable an, die Richtung Out legt fest, dass die ausgewählte Variable ausgegeben wird. Im Feld Text kann ein optional vor der Variable angezeigter Text festgelegt werden. Durch einen Klick auf Add werden die eingetragenen Werte, sofern diese korrekt eingegeben wurden, hinzugefügt. Die Änderungen werden erst durch einen Klick auf OK übernommen. Bearbeiten von Transitionen Durch einen Doppelklick auf eine Transition erscheint die Eingabemaske (Abb. 15). Benutzerhandbuch Seite 9
Abbildung 15: Eingabemaske für Kanten mit JSF-Export Hier kann der Name der Transition angegeben werden. Auch kann ausgewählt werden, ob der Wechsel zwischen den Zuständen nach dem Export mittels Link oder Button erfolgen soll. Neben den ebenfalls verfügbaren globalen und lokalen Variablen kann optional auch Quellcode angegeben werden, der nach dem Export bei Wechsel zwischen den Zuständen ausgeführt wird. Dabei können auch Variablen im Quelltext verwendet werden. Um die Get-Funktion einer Variable zu verwenden, kann die Variable mittels Drag&Drop in das Quellcode-Fenster gezogen werden. Soll die Set-Funktion einer Variable verwendet werden, muss dazu zusätzlich die STRG-Taste gedrückt gehalten werden. Bei Falscheingabe von Variablenwerten bekommt der Benutzer eine Fehlermeldung. Durch einen Klick auf Add werden die eingetragenen Variablen, sofern diese korrekt eingegeben wurden, hinzugefügt. Die Änderungen werden erst durch einen Klick auf OK übernommen. Export von Zustandsdiagrammen mit JSF-Export Das erstellte Diagramm kann über den Menüpunkt Datei->Exportieren exportiert werden (Abb. 16). Benutzerhandbuch Seite 10
Abbildung 16: Dateimenü In der anschließenden Maske muss für den Export noch ein Ordnername angegeben werden. Zustandsdiagramm mit UDL-Export Zustandsdiagramme mit UDL-Export beinhalten lediglich Startzustände, Endzustände und normale Zustände. Zustände und Transitionen können wie im klassischen Zustandsdiagramm erstellt und bearbeitet werden. Bearbeiten von Zuständen Durch einen Doppelklick auf einen Zustand erscheint die Eingabemaske (Abb. 17). Abbildung 17: Eingabemaske für Zustände mit UDL-Export Benutzerhandbuch Seite 11
Jetzt kann der Name für den Zustand festgelegt werden. Zustände eines Typs haben standartmäßig immer den gleichen Namen. Wenn mehrere Zustände eines Typs vorhanden sind, müssen die Namen dieser Zustände manuell geändert werden, um beim Export unterschieden werden zu können. Des Weiteren können die nach UDL-Standard möglichen Entry- und Exit-Actions festgelegt werden. Auch können hier globale und lokale Variablen sowie Signale festgelegt werden. Bei Eingabe der Variablen oder Signale dürfen die Klammern nicht mit angegeben werden, da diese von der Software automatisch hinzugefügt werden. Der Inhalt des rechten Teils der Eingabemaske ist in allen Zuständen und Transitionen gleich. Bearbeiten von Transitionen Durch einen Doppelklick auf eine Transition erscheint die Eingabemaske (Abb. 18). Abbildung 18: Eingabemaske für Transitionen mit UDL-Export Export von Zustandsdiagrammen mit UDL-Export Das erstellte Diagramm kann über den Menüpunkt Datei->Exportieren exportiert werden (Abb. 19). Benutzerhandbuch Seite 12
Abbildung 19: Dateimenü Glossar JGraph JGraph ist eine freie Graphenbibliothek, die von dieser Software verwendet wird. JGraph wird unter der BSD-Lizenz veröffentlicht. JAR Dateiformat von Java, dass durch einen Doppelklick ausgeführt werden kann. Transitionsindikator Bereich in einem Objekt, ab dem eine Transition zu einem anderen auf der Zeichenfläche befindlichen Objekt gezogen werden kann. Benutzerhandbuch Seite 13
Abbildung 1: Dateimenü... 3 Abbildung 2: Menüpunkt Neu... 3 Abbildung 3: Diagrammauswahlmenü... 3 Abbildung 4: Editorpalette... 4 Abbildung 5: Toolbar... 4 Abbildung 6: Eingabemaske für einen Zustand... 5 Abbildung 7: Zustand mit Transitionsindikator... 6 Abbildung 8: Transitionsindikator zum Ziehen von Transitionen... 6 Abbildung 9: Zustand mit korrektem Transitionsende... 6 Abbildung 10: Zustand mit inkorrektem Transitionsende... 7 Abbildung 11: Angezeigte Fehlermeldung bei inkorrekten Transitionsende... 7 Abbildung 12: Verschieben von Transitionen... 7 Abbildung 13: Eingabemaske für Transitionen... 8 Abbildung 14: Eingabemaske für Zustände mit JSF-Export... 9 Abbildung 15: Eingabemaske für Kanten mit JSF-Export... 10 Abbildung 16: Dateimenü... 11 Abbildung 17: Eingabemaske für Zustände mit UDL-Export... 11 Abbildung 18: Eingabemaske für Transitionen mit UDL-Export... 12 Abbildung 19: Dateimenü... 13 Benutzerhandbuch Seite 14