UMLet Readme (zu UMLet v5.1/Feu 1.8)

Willkommen liebe Studenten!
Diese Readme befasst sich mit UMLet und darauf aufbauenden Erweiterungen der FernUni Hagen. Thematisch ist diese Readme in drei Kapitel aufgeteilt:

Howto / Quickstart
Tipps & Tricks
FAQ

Dieses Dokument soll lediglich als erste Hilfe im Umgang mit UMLet und den Erweiterungen dienen. Eine Kurzfassung der Inhalte dieser Readme in Textform kann hier eingesehen werden: UMLet_Feu_Readme.txt. Aktualisierte Versionen dieses Dokumentes finden Sie, sofern vorhanden, in der virtuellen Universität.

Howto / Quickstart

Um mit UMLet arbeiten zu können, benötigt man als erstes das Java Runtime Environment 5 (JRE 1.5) von Sun (erhältlich auf http://java.sun.com). Danach wird UMLet in ein beliebiges Verzeichnis entpackt und die Datei umlet.jar gestartet (entweder über Doppelklick oder über die Konsole mit java -jar umlet.jar). Alternativ lässt sich UMLet auch als Eclipse-Plugin installieren. Dazu führen Sie folgende Schritte durch:

ZIP-File ins "plugins"-Verzeichnis von Eclipse entpacken.
Eclipse dann ggf. neu starten.
In Eclipse mit "File/New/Other.." und Auswahl von "Umlet/Diagram" ein neues Diagramm erzeugen.

Erste Schritte

UMLet ist in zwei Hauptfenster eingeteilt:

den Arbeitsbereich (links),
die Palette (rechts).

Man beginnt zunächst mit einem leeren Dokument. Um ein Element der Palette in den Arbeitsbereich zu kopieren, klickt man es doppelt in der Palette an. Das Element erscheint dann oben links im Arbeitsbereich. Es lassen sich auch im Arbeitsbereich Elemente mittels Doppelklick duplizieren. Um zwischen den verschiedenen vorhandenen Paletten auswählen zu können, benutzt man das Drop-Down-Menü >>Palettes<< im Bereich der Menüleiste. Im Arbeitsbereich kann man die Elemente dann beliebig verschieben. Dazu klickt man die Elemente an und zieht sie an die gewünschte Stelle. Durch Anklicken und Ziehen des Hintergrundes kann das gesamte Diagramm verschoben werden, um z.B. links oder oben mehr Platz zu bekommen.
Des Weiteren befinden sich unterhalb der Palette noch zwei Bereiche:

der Eigenschaftenbereich,
Komponenten-Source-Editor.

Letzteres ist für den alltäglichen Gebrauch eher unwichtig und dient dazu, UMLet zu erweitern. Im Eigenschaftenbereich jedoch kann man die Optionen eines ausgewählten Elements verändern.

Eigenschaften der Elemente

Jedes Element besitzt Eigenschaften. Diese lassen sich textuell im Eigenschaftenbereich (rechts Mitte) modifizieren. Dabei dienen sowohl Formatierungskürzel als auch sog. Escape-Sequenzen zur Identifikation einer speziellen Eigenschaft. Wird kein Formatierungskürzel verwendet, so wird der eingegebene Text der Standardbeschriftung des ausgewählten Objektes zugeordnet.

Formatierungskürzel

Um eine spezielle Eigenschaft des ausgewählten Elements zu verändern, benutzt UMLet Formatierungskürzel. So wird zum Beispiel der Linientyp eines Verbinders (Pfeil) mit dem Kürzel >>lt=<< eingeleitet. Die Benutzung ergibt sich aus den in den Paletten aufgeführten Beispielen.

Escape-Sequenzen

Um eine einfache Formatierung des Textes innerhalb eines Elements zu erlauben, unterstützen manche Elemente sog. Escape-Sequenzen. So lässt sich z. B. ein Text unterstrichen oder kursiv setzen, indem man ihn als >>_Text_<< bzw. >> /Text/ << in eine einzelne Zeile schreibt.

Verbinder

Verbinder sind spezielle Elemente, die dazu dienen, zwei oder mehr (in der Regel 2) Elemente miteinander zu verbinden. Sie können durch das Ziehen eines ihrer Endpunkte an ein anderes angehängt werden. Des Weiteren kann man sie in Segmente unterteilen, indem man auf ihre Linie klickt und diese dann in eine beliebige Richtung zieht. Es wird dann automatisch ein weiterer Punkt zu dieser Linie hinzugefügt.
Verbinder besitzen eine Reihe an Formatierungsmöglichkeiten:

Veränderung des Linientyps,
Veränderung der Pfeilspitzen,
Arten der Beschriftung sowie
Veränderung der Beschriftung.

Um einen Linientyp zu verändern, können z.B. die folgenden Formatierungskürzel benutzt werden:

Formatierungskürzel	Beschreibung
lt=.	Es wird eine gestrichelte Linie erzeugt.
lt=.>	Es wird eine gestrichelte Linie mit einer normalen Pfeilspitze erzeugt.
lt=->>	Es wird eine durchzogene Linie mit geschlossener Pfeilspitze erzeugt.
lt=<->	Es wird eine durchzogene Linie mit offenen Pfeilspitzen an beiden Enden erzeugt.
lt=->>>>	Es wird eine durchzogene Linie mit Kompositions-Ende erzeugt.

Diese Optionen können nahezu beliebig konbiniert werden.

Verbinder besitzen in der Regel noch weitere Eigenschaften. So besitzen sie z.B. Rollen und Multiplizitäten. Die folgende Liste gibt hier eine Übersicht:

Formatierungskürzel	Beschreibung
r1=Rolle1	Der Rolle an der 1. Pfeilspitze wird der Bezeichner Rolle1 zugeordnet.
r2=Rolle2	Der Rolle an der 2. Pfeilspitze wird der Bezeichner Rolle2 zugeordnet.
m1=1	Der Multiplizität and der 1. Pfeilspitze wird die 1 zugewiesen.
m2=*	Der Multiplizität and der 2. Pfeilspitze wird der * zugewiesen.

Die Beschriftung eines Standardverbinders wird einfach als normaler Text in den Eigenschaftenbereich des gewählten Objekts geschrieben. Dieser Text wird automatisch in der Mitte des Verbinders und immer horizontal angezeigt. Einen Verbinder mit mehr Formatierungsmöglichkeiten bietet die Fernuni-Palette.

Paletten

Die unterschiedlichen Paletten dienen dazu, die vorhandenen Elemente nach Themen zu sortieren. Die jeweilige Palette wird im dazugehörigen DropDown-Menü in der Applikationsleiste ausgewählt. Es gibt folgende Paletten:

Palette	Beschreibung
default_palette	Hier finden Sie die am häufigsten genutzten Elemente aus den verschiedenen UML-Diagrammen (Verbinder, Notizen, Elemente für Use Case- und Klassendiagramme etc.).
activity_palette	Diese Palette beinhaltet Elemente für Aktivitätsdiagramme.
extra_palette	Diese Palette beinhaltet sonstige Elemente.
sequence_palette	Diese Palette beinhaltet Elemente zum manuellen Zusammenstellen von Sequenzdiagrammen.
sequence2_palette	Bietet genau ein Element zur Erstellung eines automatisch gezeichneten, allein durch Text im Eigenschaftenbereich definiertes Sequenzdiagramm. (Bietet jedoch wesentlich weniger Möglichkeiten als das manuelle Zeichnen von Sequenzdiagrammen mit Elementen aus sequence_palette.)
Feu_Aktivitätsdiagramm	Diese Palette beinhaltet die Erweiterungen der Fernuni für Aktivitätsdiagramme.
Feu_Kommunikation	Diese Palette beinhaltet die Erweiterungen der Fernuni für Kollaborationsdiagramme.
Feu_Zusaetze	Diese Palette beinhaltet sonstige Erweiterungen der Fernuni.

Die Besonderheiten der Fernuni-Paletten

Zusätzlich zu der Standardfunktionalität hat das Lehrgebiet Software Engineering der FernUniversität Hagen ein paar zusätzliche Elemente und Verbinder zur Verfügung gestellt. Die hier enthaltenen Elemente sind z.T. zusätzliche Elemente, wie sie in den Kursen 1793 / 1794 vorgestellt werden. Die Benutzung ergibt sich aus den in der Palette gezeigten Beispielen. Hier soll exemplarisch der Verbinder der Feu_Zusaetze-Palette erläutert werden.

Der Verbinder ist grundsätzlich wie ein normaler Verbinder aufgebaut. Jedoch lässt sich bei diesem Verbinder der Text auch anders als mittig und horizontal anordnen. Dazu wird das Formatierungkürzel textpos neu eingeführt. Diesem Kürzel können die Optionen Position, Distance, Alignment, Rotation und Segment hinzugefügt werden. Die Optionen werden dabei von einem Semikolon getrennt in beliebiger Reihenfolge im Formatierungskürzel angeordnet.

Kürzel	Bedeutung	Werte
p	gibt die Position auf dem gesamten Polygonzug (Segment) des Verbinders an	0.0 .. 1.0
d	gibt den (senkrechten) Abstand zum Polygonsegment an	beliebig
a	gibt die Ausrichtung des Textes an (linksbündig/zentriert)	l(eft) / c(enter)
r	gibt die Rotation des Textes in Grad an (* richtet den Text parallel zum aktuellen Segment aus)	0 .. 360 oder *
s	wählt das aktuelle Segement aus (Wenn die Option s gewählt ist, so bezieht sich p nicht auf den gesamten Polygonzug sondern nur auf dieses Segment!)	1 .. n

Beispiel: textpos=d:-30;a:c;r:*;s:1

Tipps & Tricks

Hier werden ein paar kleine Tipps & Tricks verraten, die den Arbeitsalltag mit UMLet vereinfachen.

Tipp: Verbinder andocken

Ist ein Element fokussiert, wird meist auch ein rot gepunktetes Rechteck angezeigt. An diesem bleiben Verbinder-Enden "kleben" (beim Verschieben des Elementes).

Tipp: Mehrere Elemente markieren

Um mehrere Elemente markieren zu können, halten Sie die Ctrl-Taste gedrückt und klicken Sie die einzelnen Elemente an oder ziehen Sie einen Rahmen um diese. Achtung: Im UMLet funktioniert das Aufziehen eines Selektionsrahmens nur von oben links nach unten rechts!

Tipp: Kopieren in die Zwischenablage

Mit der Taste 'C' kopieren Sie das Diagramm in die Windows-Zwischenablage.

FAQ

Hier werden die häufigsten Fragen und deren Antworten zum UMLet gesammelt.

Warum wird die Reihenfolge der Tiefensortierung beim Exportieren invertiert?

Hier handelt es sich offensichtlich um einen Fehler der Programmierer, der hauptsächlich in Sequenzdiagrammen sichtbar wird. Als einzige Abhilfe bietet sich hier das inverse Sortieren der Objekte an.