Los gehts: Sehr schnell nach der Veröffentlichen des ersten Tutorials zum Lesen von csv-Daten mit Python, kamen von zwei Identi.ca-Teilnehmern der Hinweis auf das Python csv-Modul. Darauf möchte ich nun eingehen.

Reaktionen auf das erste Tutorial

Erstaunlicherweise kamen buchstäblich Sekunden nach der Veröffentlichung des ersten Tutorials von lutzgh und evgeni über identi.ca zwei Reaktionen in gleiche Richtung. Beide wiesen mich auf das csv-Modul hin, welches genutzt werden kann, um diverse Daten zu importieren.

Natürlich kam mir sofort der Gedanke, warum ich das Modul nicht selber entdeckt habe. Ich muss zugeben, dass ich gar nicht gesucht habe. Mir ist auf Anhieb die Lösung mit den regulären Ausdrücken eingefallen. Doch, aus zwei Gründen bin ich glücklich, dass es nun so gekommen ist:

1. Auf dieser Grundlage lässt sich ein weiterer netter Blog-Artikel schreiben .
2. Aus eins mach zwei: Ursprünglich als alleinstehendes Thema geplant, ist es nun in zunächst zwei verschiedenen Ausführungen vorhanden, die sich prächtig ergänzen. Dadurch ergibt sich eine breitere Grundlage und noch mehr Wissen für meine Leser.

Also nur Vorteile für alle im Thema interessierten.

Das csv-Modul

Das csv-Modul, welches es laut der Python-Dokumentationseite, seit der Version 2.3 gibt, unterstützt den Programmierer in seiner Arbeit beim Import und Export von Daten, welche tabellarisch im csv-Format gespeichert sind oder werden sollen. Dafür stellt es diverse Funktionen zur Verfügung, von denen ich die reader() und writer()-Funktionen als die für mich wichtigsten einstufe.

Sehr interessant ist die Möglichkeit mit Hilfe des csv-Moduls, Excel-Daten zu importieren und in Excel-Stil zu exportieren. Dazu muss lediglich ein bestimmter Parameter übergeben werden, der das Format definiert. Das scheint mir einer der größten Vorteile dieses Moduls zu sein.

Datensatz und Import der Daten mit dem csv-Modul

Wie bereits im ersten Tutorial wird auch hier der kleine Beispiel-Datensatz von walkingrandomly.org übernommen:
header 1;
header 2;
1031,-948,-76, ,"12"
507,635,-1148, ,"34"
-1031,948,750, ,"45"
-507,-635,114, ,"67"

Diese Zeilen sollen nun mit dem csv-Modul in das Programm importiert werden und in drei verschiedenen Listen gespeichert werden. Dabei interessieren uns lediglich die Daten, die nicht Kopfdaten sind oder in Anführungszeichen stehen. Dazu habe ich folgendes Python-Skript geschrieben:

import csv
fileO = open('walking_example.dat','r')
csvreader=csv.reader(fileO, delimiter=',')
k= []; l = []; m = [];

for row in csvreader:
    if len(row) > 1:
        k.append(float(row[0]))
        l.append(float(row[1]))
        m.append(float(row[2]))

print(k,l,m)

fileO.close()

Schrittweise erklärt

1.Zeile: Import des csv-Moduls

2.Zeile: Erstellen eines file-Objekts, welcher die Datei mit dem gezeigten Datensatz enthält.

3.Zeile: Einlesen der Daten von fileO mit der reader()-Funktion des csv-Moduls. Die Funktion erwartet mindestens einen Übergabeparameter und zwar das file-Objekt. Des Weiteren kann ein sogenannter Dialekt vorgegeben werden, welcher für sich die Struktur der csv-Daten definiert. Ein Dialekt könnte zum Beispiel Excel sein (dialect=’excel’). Weitere optionale Argumente wie das Trennungszeichen (delimiter=’,’) können hinzugefügt werden.

4.Zeile: Initialisieren der Listen, mit welchen weiter gerechnet werden soll.

7-10.Zeile: Das Auslesen der importierten Daten erfolgt an dieser Stelle. Die reader()-Funktion liest die Daten zeilenweise ein, dabei spielt es zunächst keine Rolle, ob es Kopfdaten sind oder nicht. Dieses Vorwissen muss bei der vorgestellten Methode vorhanden sein. Im Beispiel haben wir zwei Zeilen mit Kopfdaten, welche ignoriert werden sollen. Dies geschieht über die Abfrage der Länge der Liste row. Zuletzt werden in den Zeilen noch die Listen k,l,m um die ersten drei Spalten erweitert.

11-12.Zeile: Ausgabe der Listen und schließen des file-Objekts.

Schlusswort

Die Vorteile des csv-Moduls im Vergleich zu der Lösung mit regulären Ausdrücken liegen auf der Hand. Zum einen ist der Import effizienter und einfacher zu schreiben und zum anderen ist die Fehleranfälligkeit nicht so hoch.

Auf der anderen Seite stellen die regulären Ausdrücke eine viel allgemeinere Methode dar, Daten zu importieren. Hierbei muss lediglich die Struktur der Daten bekannt sein, Kopfzeilen werden automatisch ignoriert. Des Weiteren stellen zusätzliche Störungen in den Daten für reguläre Ausdrücke kein Problem dar.

Sollte ich jemals in die Verlegenheit kommen, mich zwischen den zwei Lösungen entscheiden zu müssen, so werde ich natürlich das dem Problem am besten angepasste nutzen. Das heißt: bei relativ sauberen Daten das csv-Modul und bei stark ungeordneten Daten die regulären Ausdrücke.

Nun hoffe ich auf konstruktive Kritik!

Deine Stadt - Dein Preis
Mit CityDeal und vielen Anderen den Preis drücken!

© Muvik for muvik-multigrid, 2010. | Permalink | keine Kommentare | Teile es mit deinen Freunden: del.icio.us MisterWong Twitter
Tags: InputOutput, Python, Tutorial

Los gehts: Tutorials, die nicht in die Kurztipp-Serie passen, weil sie zu groß, zu lang, zu wichtig sind oder ein besonderes Feature enthalten haben nun ebenfalls eine eigene Kategorie-Grafik. Diesmal geht es um das Einlesen beliebiger, durch ein Komma getrennter Daten aus sogenannten csv-Dateien (comma-seperated-values) in Python mit Hilfe der regulären Ausdrücke (regular expressions).

Idee und Intention

Wie aus der Seitenleiste des Blogs entnommen werden kann, lese ich regelmäßig die Artikel des walkingrandomly.com Blogs von Mike Croucher. Am 21. Mai 2010 schrieb Mike ein Matlab Tutorial, dessen Inhalt es war, wie csv-Dateien in Matlab eingelesen werden können. Im Rahmen dieses Artikels ging er auf verschiedene Möglichkeiten ein, eine csv-Datei zu importieren.

Begonnen hat er mit einer einfachen zu importierenden Datei, worin die Daten ohne Ausnahmen durch eine Komma getrennt waren. Richtig interessant wurde es beim Import von Daten aus einer unordentlich definierten csv-Datei. Das Beispiel stammte von einem Leser seines Blogs und soll hier ebenfalls verwendet werden.

Der Datensatz

Es lässt sich unendlich lange darüber unterhalten, wie sinnvoll oder sinnlos es ist, innerhalb einer Datei mit csv-Daten weitere Daten zu integrieren, welche nicht durch Kommas getrennt werden und eventuell andere Datentypen sind. Abgesehen davon ist das Beispiel, welches auch Mike verwendet folgendes:

header 1;
header 2;
1031,-948,-76, ,"12"
507,635,-1148, ,"34"
-1031,948,750, ,"45"
-507,-635,114, ,"67"

Da das Ziel beim Import der Daten ist, mit ihnen weiter zu rechnen oder zu plotten, ergeben sich für mich zwei Herausforderungen, bei dem gegebenen Datensatz:

1. Eine straight-forward Lösung bricht sich bereits an der ersten Zeile das Bein, an der ersten Kopfzeile. Also müssen eine vorgegebene Anzahl an Zeilen beim Importieren ignoriert werden können.
2. Da die letzte Spalte nicht nur durch ein Komma getrennt ist, sondern in Anführungszeichen steht, soll angenommen werden, dass es reiner Text ist und soll beim Import ignoriert werden.

Damit wären die Stolpersteine lokalisiert und können aus dem Weg geräumt werden.

Reguläre Ausdrücke (regular expressions, kurz: regex)

Es gibt mehrere Möglichkeiten das beschriebene Problem anzugehen und die regulären Ausdrücke stellen in meinen Augen nicht die schlechteste dar. Zum einen wird aus den zwei Herausforderungen nur noch eine und zum anderen ist die Lösung sehr schnell auf dem Tisch und sieht elegant aus. Sollte sich die Struktur der csv-Daten noch ändern, stellt es für die Lösung mit regulären Ausdrücken kein großes Problem dar. Es muss lediglich eine Zeile angepasst werden.

Reguläre Ausrücke habe ich persönlich bisher sehr sporadisch gebraucht, würde aber dennoch folgendes Vorgehen vorschlagen:

1. Klären der Struktur der Daten
2. Erkennen eines Musters
3. Definition des Musters in regulären Ausdrücken
4. Implementierung des Rahmenprogramms: öffnen einer Datei, ausgeben der Ergebnisse …

Die Struktur des Datensatzes haben wir schon geklärt: es ist ein Datensatz, dessen Elemente durch Kommata getrennt sind. Die zwei Kopfdateien interessieren uns hierbei nicht, die sollen nicht importiert werden.

Das Muster ergibt sich, indem logische Bereiche von einer Zeile betrachtet werden:
-1031,948,750, ,"45"
Zum Einen ist zu bemerken, dass alle Zahlen ganze Zahlen sind. Zudem ist ein Minus auch erlaubt. Also ergibt sich aus der Überlegung folgendes Muster: drei aufeinander folgenden Integer-Zahlen, die durch jeweils ein Komma getrennt sind und evt. ein Minus vor der Integer-Zahl.

Daraus lässt sich nun der folgende einfache reguläre Ausdruck ableiten:
(-?[0-9]*),(-?[0-9]*),(-?[0-9]*),.*
Es sei angemerkt, dass auch an dieser Stelle viele Wege nach Rom führen. Drei Programmierern fallen bestimmt spontan neun verschiedene reguläre Ausdrücke ein, die alle die korrekte Lösung liefern.

Reguläre Ausdrücke in Python

Der glückliche und aktive Linux Benutzer kann reguläre Ausdrücke in sehr vielen Programmen und Tools anwenden. Als Beispiele seien nur die Tools grep und awk genannt.

Ich möchte nicht behaupten, dass die meisten Bücher, jedoch sehr viele erklären reguläre Ausdrücke in Kombination mit der Skriptsprache Perl. In Python lassen sich die regulären Ausdrücke doch ebenso leicht verwenden. Dazu muss lediglich das Modul re importiert werden:
import re Damit sind wir mit einer mächtigen Waffe ausgestattet.

Import der csv-Daten und Ausgabe der Listen (Arrays)

Gehen wir es an und importieren den Datensatz mit den unordentlich formatierten Daten. Dazu schlage ich folgendes kleines Python-Skript vor:

import re

# define a pattern for matching the needed data

fileO = open('walking_example.dat','r')
search_data = fileO.readlines()

fileO.seek(0,0)

print("Following data will be parsed:\n")
print(fileO.read())

fileO.close()

pattern = '(-?[0-9]*),(-?[0-9]*),(-?[0-9]*),.*'
r = []; s = []; t = [];

for line in search_data:
    found = re.search(pattern, line)
    if found:
        r.append(float(found.group(1)))
        s.append(float(found.group(2)))
        t.append(float(found.group(3)))

print("\nThe parsed lists:\n")
print(r,s,t)

Schrittweise erklärt:

1.Zeile: Zu Beginn wird das Modul zur Verwendung regulärer Ausdrücke importiert.

5.Zeile: Es wird ein file-Objekt angelegt, welches die Datei mit dem Datensatz enthält. Die Funktion open erhält im ersten Übergabeparameter die Datei inklusive dem Pfad und im zweiten die Option ‘r’, was bedeutet, dass nur gelesen werden soll. Da in meinem Fall die csv-Datei sich im selben Ordner befindet, wie das Python-Skript, muss lediglich der Dateiname angegeben werden.

6.Zeile: Um die Daten aus dem file-Objekt zu verwenden, werden sie zeilenweise eingelesen und in der Variablen search_data gespeichert.

7-11.Zeile: Dieser Abschnitt ist optional. Zunächst wird die Position im file-Objekt wieder auf den Ausgangszustand zurückgesetzt, damit der Datensatz erneut mittels read() gelesen und dadurch einfach mit print() ausgegeben werden kann. Dies alles dient nur der leichten Kontrolle des regulären Ausdrucks.

13.Zeile: Das file-Objekt wird geschlossen.

15.Zeile: Der bereits vorgestellte reguläre Ausdruck wird in der Variable pattern gespeichert.

16.Zeile: Initialisierung leerer Listen für die drei Spalten aus den Datensatz.

19.Zeile: Anwendung des regulären Ausdrucks für jede Zeile aus search_data, was mit Hilfe der for-Schleife aus Zeile 18 bewerkstelligt wird. Hierzu wird die Funktion search aus dem re-Modul verwendet. search erhält als erstes Argument das Muster und als zweites die zu untersuchende Zeile des Datensatzes.

21-23.Zeile: Wenn re.search etwas gefunden hat, dann werden die Teile, welche im regulären Ausdruck in runden Klammern stehen in die drei Listen r,s,t geschrieben. Vor dem eigentlichen Anhängen an die Liste mittels append wird der Inhalt in float-Zahlen umgewandelt.

26.Zeile: Zu guter Letzt werden die Listen zur Kontrolle ausgegeben.

Ergebnis und Kontrolle

Die Arbeit ist getan, jetzt gilt es nur noch die Lorbeeren zu pflücken.

Dazu schauen wir uns an, was das Skript in der Shell ausgibt:
Following data will be parsed:
header 1;
header 2;
1031,-948,-76, ,"12"
507,635,-1148, ,"34"
-1031,948,750, ,"45"
-507,-635,114, ,"67"
The parsed lists:
([1031.0, 507.0, -1031.0, -507.0], [-948.0, 635.0, 948.0, -635.0], [-76.0, -1148.0, 750.0, 114.0])
Es ist ganz leicht zu erkennen, dass das kleine Programm für diesen Fall richtig funktioniert hat.

Schlusswort

Reguläre Ausdrücke sind ein mächtiges Instrument, welches jedoch aufgrund der etwas undurchsichtigen Syntax oft als zu umständlich abgelehnt werden. Aus meiner Sicht lohnt sich eine kurze Einarbeitung in die Syntax, wenn öfter mal bestimmte Bereiche eines Datensatzes extrahiert werden müssen, was bei mir der Fall ist.

An dieser Stelle ein Dankeschön an Mike vom walkingrandomly.com-Blog für die Steilvorlage.

Weiterhin würde mich interessieren, wie meine Leser an die Sache herangegangen wären und welche Erfahrungen sie gemacht haben in Bezug auf reguläre Ausdrücke.

Deine Stadt - Dein Preis
Mit CityDeal und vielen Anderen den Preis drücken!

© Muvik for muvik-multigrid, 2010. | Permalink | ein Kommentar | Teile es mit deinen Freunden: del.icio.us MisterWong Twitter
Tags: InputOutput, Python, Tutorial

Thema der ersten Liste lautet: Python (Programmieren-) Lernen. Diesen sehr allgemeine Beginn möchte ich kurz begründen, bevor es zur eigentlichen Linkliste geht. Die Linkliste enthält heute einige eBooks und einen Verweis zu Screencasts bzw. Videos zum Thema.

Nur in den seltensten Fällen gibt es lediglich einen gewichtigen Grund für ein Vorgehen oder einen Entschluss eines Menschen; die Auswahl des heutigen Themas stellt dahingehen auch keine Ausnahme dar. Aus folgenden Gründen gibt es heute Links zu dem sehr allgemein gehaltenen Thema “Python Lernen”:

• Python als Programmiersprache und Problemlösungswerkzeug stellt eine wichtige Säule auf meinem Blog dar. Insbesondere steht hierbei das Erlernen von Python im Vordergrund. Das allein ist schon Grund genug, um an dieser Stelle eine Liste mit allgemeinen Büchern für Anfänger und Fortgeschritten in der Python-Programmierung zu erstellen.
• Da ich selber noch ein Anfänger bin, kann ich beurteilen, wie viel Wert eine kompakte Sammlung an Links für Anfänger darstellt. Diese möchte ich auf meiner Webseite daher nicht missen.
• Da ich grundsätzlich nicht vor habe, überwiegend brandaktuelle News in der Linkliste aufzuführen, kann die Linkliste sich zu einer Informationsquelle für im Thema interessierte Leser entwickeln.

Damit möchte ich die Begründung als ausreichen ansehen und zur eigentlichen Linkliste übergehen.

4 eBooks zum Thema Python Lernen

Videos und Screencasts zum Thema Python Lernen

Schlusswort

Das waren die ersten fünf Links zu Resourcen, die mir wichtig waren und sind und denen ich zutraue, dass sie meinen lieben Lesern ebenfalls hilfreich sein können.

Natürlich würde ich mich über Kommentare diesbezüglich freuen. Weitere Links zum Thema “Python Lernen” nehme ich gerne auf und veröffentliche sie in einer weiteren Linkliste.

Deine Stadt - Dein Preis
Mit CityDeal und vielen Anderen den Preis drücken!

© Muvik for muvik-multigrid, 2010. | Permalink | keine Kommentare | Teile es mit deinen Freunden: del.icio.us MisterWong Twitter
Tags: eBook, Python, Tutorial

Der letzte Beitrag der UML-Artikelserie, in dem es über das Klassendiagramm ging, ist etwas länger geworden, als ich das für diese Kurzserie vorgesehen hatte. Über die Aktivitätsdiagramme habe ich heute nicht so viel wie über die Klassendiagramme zu schreiben, daher sollte es diesmal wieder kürzer werden.

Was ist ein Aktivitätsdiagramm und nützt es mir?

Im Gegensatz zu den bisher vorgestellten Diagrammtypen Anwendungsfalldiagramm und Klassendiagramm, welche unter Strukturdiagramme einzuordnen sind, ist das Aktivitätsdiagramm eine Art der Verhaltensdiagramme. Andere Bezeichnungen, die genau das selbe meinen, sind “Ablaufdiagramm” und für englisch affine Leser auch “flow chart”.

Wie der Name schon andeutet, beschreibt ein Aktivitätsdiagramm einen Ablauf, wobei ein Ablauf zum Beispiel ein Anwendungsfall sein kann, welcher im Detail angeschaut werden soll. Aufgrund der Struktur des Aktivitätsdiagramms lassen sich damit zum Teil sehr komplizierte Abläufe grafisch ansprechend aufbereiten und erklären.

Als “Aktivität” wird seit UML 2.0 das ganze Diagramm mit allen Einzelelementen bezeichnet. Beispiele für eine Aktivität aus dem bereits vorgestellten Anwendungsfalldiagramm wären zum Beispiel “Artikel kommentieren” oder “Artikel schreiben”. Die Darlegung, wie nun ein Artikel im Detail kommentiert wird, welche Aktion welcher folgt, ist die Aufgabe eines Aktivitätsdiagramms. Darin werden die Aktionen als Knoten bezeichnet. Vereinfacht betrachtet besteht eine Aktivität aus Knoten und Flüssen, welche die Knoten miteinander verbinden.

Damit kommen wir auch schon zu einigen Besonderheiten und Details eines Aktivitätsdiagramms: Wenn ein ganzes Aktivitätsdiagramm nun Aktivität heißt, wie wird dann der einzelne Ablaufschritt genannt? Ich habe diesen Begriff bereits im vorherigen Abschnitt verwendet: “Aktion”. Die Aktion stellt im
Allgemeinen die kleinste und simpelste Einheit eines Aktivitätsdiagramms dar. Jedoch kann eine Aktion auch eine weitere Aktivität aufrufen, worin der Informationsfluss genauer gezeigt ist. Jede Aktion hat mindestens einen eingehenden und einen ausgehenden Kontrollfluss. Im Falle mehrerer eingehender Kontrollflüsse müssen alle Flüsse zur gleichen Zeit verfügbar sein, damit die Aktion beginnen kann. Bei mehreren Ausgängen gilt das gleiche in Grün: erst wenn alle Ausgänge “bereit” sind, dann werden auch alle zum selben Zeitpunkt ausgegeben.

Neben der Aktion als Knoten existieren weitere wichtige Knoten: Kontroll -und Objektknoten. Doch dazu später mehr.

Wie bereits erwähnt, werden die Knoten durch Flüsse verbunden. Es werden zwei grundlegende Flussarten unterschieden: die Kontrollflüsse und die Objektflüsse. Aber bevor es zu viel trockene Theorie wird, hier erstmal das Beispiel:

Beispiel: Aktivitätsdiagramm

Das Aktivitätsdiagramm habe ich mit einer tollen Browseranwendung aus der WEB2.0 Ecke erstellt: cacoo.com. Ein Tipp für alle, die schnell ein einfaches UML-Diagramm zusammenklicken wollen und es nicht für zum Beispiel einen Kunden bestimmt ist.

Natürlich lasse ich es mir nicht nehmen, auch diesmal ein Diagramm zu einem Weblog-Thema zu erstellen. Diesmal habe ich den Anwendungsfall “Blogartikel schreiben” ausgewählt und mit einigen Elementen des Aktivitätsdiagramms veranschaulicht.

Elemente eines Aktivitätsdiagramms

Im ersten Abschnitt bin ich bereits etwas auf die wichtigsten Elemente eingegangen, nun möchte ich auch etwas zur Notation und Darstellung in UML loswerden. Fangen wir mit der Aktivität an sich an:

Die Aktivität, bzw. der Aktivitätsname “Blogartikel schreiben” wird, wie im Beispiel gezeigt, in die linke obere Ecke geschrieben. Meist wird die ganze Aktivität von einem Rahmen umgeben, welcher die Aktivität von seiner Umgebung abgrenzen soll. Häufig liegen keine Diagrammelemente auf dem Rahmen, im Beispiel ist es auch kein Fehler. Wird ein rechteckiger Knoten auf den Rahmen gelegt, dann stellt es einen Eingangsparameter dar. Also ist die “Idee” der Eingangsparameter für die Aktivität “Blogartikel schreiben”.

Neben der Funktion als Eingangsparameter, deutet der Knoten “Idee” mit seinem rechteckigen Rahmen an, dass er ein Objektknoten ist. Er gibt an, dass in dem Ablauf Objekte verwickelt sind. Von einem Objekt geht kein Kontrollfluss, sondern ein Objektfluss aus, es werden also Objekte transportiert. Meines Wissens nach wird graphisch zwischen Objektfluss und Kontrollfluss nicht direkt unterschieden.

Verfolgen wir das Diagramm weiter, so stoßen wir auf einen Knoten mit abgerundeten Ecken. Ein solcher Knoten ist eine Aktion. Wie bereits angedeutet, ist die Aktion die einfachste Einheit eines Aktivitätsdiagramms. Jedoch kann sie auch durch ein weiteres Aktivitätsdiagramm beschrieben werden und darauf verweisen, was durch eine kleine “Mistgabel” im Aktionsknoten gekennzeichnet wird. Ein derartige Mistgabel habe ich bei einer der sicherlich schwersten Aktionen hinzugefügt: “Wissen beschaffen”. Dieser Aktion müsste ich nur noch ein Aktivitätsdiagramm hinzufügen und schon könnte jeder Unmengen an Wissen beschaffen .

Eine Raute, wie sie zwischen den zwei Aktionsknoten “Thema prüfen” und “Übersicht erstellen” aufgeführt ist, impliziert eine Entscheidung. Sie ist ein Kontrollknoten und gehört meiner Ansicht nach zu den Elementen, welche ein Aktivitätsdiagramm erst richtig interessant machen.

Elemente: Startknoten, Endknoten, Ablaufende

Weitere ganz wichtige Elemente sind der Startknoten, ein ausgefüllter Kreis, der Endknoten, symbolisiert durch einen ausgefüllten Kreis in einem Ring und ein Ablaufende, einem durchgestrichenem leeren Kreis. Die ersten Beiden erklären sich von selbst. Im Beispiel “Blogartikel schreiben” habe ich kein Startknoten, weil die Idee als Parameter übergeben wird und der Fluss an dieser Stelle beginnt. Ein Endknoten beendet im Gegensatz zum Ablaufende den gesamten Fluss und alle Aktionen, das Ablaufende jedoch nur einen einzelnen Fluss.

Element: Konnektoren im Aktivitätsdiagramm

Möchte man einen komplizierten Ablauf mit Hilfe eines Aktivitätsdiagramms veranschaulichen, so wird es schnell ganz unübersichtlich. Um den Chaos in Grenzen zu halten und ewig lange Kontrollfluss-Linien zu vermeiden, gibt es die Konnektoren. Dabei endet ein Fluss an einem Marker, zum Beispiel einem “A”, und geht an einer anderen Stelle von einem “A” aus weiter. Die Marker werden dafür in einfache Kreise geschrieben. Zudem sind die Konnektoren auch dafür gut, wenn ein Diagramm nicht ganz auf ein Blatt passt und auf einem anderen weitergehen soll, dann können ebenfalls Konnektoren eingesetzt werden.

Es gibt noch viele weitere Elemente von Aktivitätsdiagrammen, die durch ihre Zeichen mehr oder weniger selbsterklärend sind. Für den ersten Einstieg sollten die hier aufgeführten aber zunächst reichen. Ergänzungen und Kommentare können gerne hinterlassen werden.

Ende gut alles gut?

Mit diesem Artikel geht meine Mini-Serie zu UML-Diagrammen zu Ende. Während ich die Artikel geschrieben habe, sind mir etliche weitere Artikelideen eingefallen, die ich eventuell noch verwirklichen möchte.

Nun hoffe ich, dass es euch gefallen hat und würde mich über Kommentare und Anregungen freuen.

Deine Stadt - Dein Preis
Mit CityDeal und vielen Anderen den Preis drücken!

© Muvik for muvik-multigrid, 2010. | Permalink | ein Kommentar | Teile es mit deinen Freunden: del.icio.us MisterWong Twitter
Tags: Modellierung, Tutorial, UML

Nachdem es im zweiten Teil der UML-Artikelserie um die Anwendungsfälle ging, die dem Programmierer die Anforderungen an ein Programm darlegen, wird es diesmal mit den Klassendiagrammen etwas technischer.

Was ist ein Klassendiagramm und wofür brauche ich es?

Die Aussage, dass das Klassendiagramm das liebste Kind des Programmierer ist, fällt mir nicht schwer, obwohl ich dafür keinen stichhaltigen Beweis habe. Betrachtet man jedoch die Struktur, den Aufbau und die Funktion eines Klassendiagramms, worauf ich noch eingehen werden, so merkt man, dass dieser Diagrammtyp dem Code objektorientierter Programmiersprachen sehr ähnlich ist. Daher wird jeder, der objektorientiertes Programmieren beherrscht, auch mit dem Klassendiagramm auf Anhieb zurechtkommen.

Gehen wir davon aus, dass die oben getroffene Aussage wahr ist, so ist das Klassendiagramm das wichtigste Diagramm der UML. Es gehört zu den Strukturdiagrammen, zu welchen auch das Anwendungsfalldiagramm gezählt wird. Was Klassendiagramme können lässt sich grob im folgenden Satz zusammenfassen:

Das Klassendiagramm zeigt, welche Klassen existieren, wie sie aufgebaut sind und in welchen Beziehungen sie zu einander stehen.

Somit ist die Struktur der einzelnen Klassen, die gemeinsame Struktur und das daraus resultierende gemeinsame Verhalten aus einem Klassendiagramm erkennbar. Die Betrachtung auf dieser abstrakten Ebene ermöglicht es, sich den Aufbau des Modells klarer zu machen.

Das wohl bekanntest Anwendungsfeld für Klassendiagramme ist wahrscheinlich die objektorientierte Modellierung als Vorarbeit für die Programmierung. Jedoch ist auch der umgekehrte Weg möglich: Liegt eine objektorientierter Code vor, so kann daraus ein UML-Klassendiagramm erstellt werden. Für beide Wege existieren automatische Generatoren, die entweder aus einem Klassendiagramm die Code-Struktur einer objektorientierter Programmiersprache erzeugen oder aus dem Code das Diagramm generieren.

Im folgenden Bild habe ich versucht, ein einfaches Klassendiagramm für den Inhalt eines Weblogs zu erstellen:

Beispiel: Klassendiagramm des Inhalts eines Weblogs

In dem Beispiel sind bereits folgende Elemente zu sehen:

• abstrakte Klasse: Content
• diverse Klassen: Datum, Autor, Artikel…
• Vererbungsbeziehung
• Assoziationsbeziehung
• Aggregationsbeziehung

Das ist nur eine kleine Auswahl der möglichen Elemente eines Klassendiagramms, welche ich unter anderem im nächsten Abschnitt näher erläutere.

Elemente eines Klassendiagramms

Das wichtigste Element des Klassendiagramms steht schon im Namen drin: die Klasse. Manchmal wird statt Klasse auch einfach Typ gesagt, was das gleiche meint. Eine Klasse bzw. ein Typ ist im Grunde eine Zusammenfassung der Eigenschaften (Attribute) und des Verhaltens (Operationen) der Objekte dieser Klasse. Symbolisiert wird eine Klasse mit einem Rechteck, welches im oberen Feld den Namen der Klasse enthält. Werden Attribute und Operationen angegeben, so stehen sie jeweils durch ein horizontalen Strich getrennt unter dem Namen. Jedoch ist es keine Pflicht, Attribute und Operatoren anzugeben. In dem Beispiel hat lediglich die Klasse “Content” ein Attribut und eine Operation.

Möchte man Attribute aufführen, dann kann man dies unterschiedliche Arten tun:

• nur Name
• Name und Typ
• Name, Typ und Anfangswert

Attribute, häufig auch Member genannt, werden an jedes Objekt einer Klasse weitergegeben. Jedoch hat wiederum jedes Objekt seine eigene Identität, was gleichbedeutend ist mit der Aussage, dass jedes Objekt zwar gleich Attribute hat, die Werte der Attribute aber durchaus verschieden sein können. In c++ können mit “static” sogenannte Klassenattribute definiert werden, welche in jedem Objekt verfügbar sind und den gleichen Wert besitzen.

Desweiteren ist es möglich für jedes Attribut die Sichtbarkeit von außen zu beschränken, was oft sehr sinnvoll ist. Dafür stehen grundsätzlich drei Varianten zur Verfügung:

• +: public: für alle sichtbar und benutzbar
• #: protected: sichtbar und benutzbar für die Klasse selbst und ihre Unterklassen
• -: private: nur für die Klasse selbst

In dem Klassen-Rechteck wird entsprechend der Sichtbarkeit eines Attributs das passende Zeichen (+,#,-) angegeben. Generell ist es ein guter Tipp, so zu programmieren, dass nur die Klassen selbst Zugriff auf ihre Attribute hat.

Die Operatoren, auch Memberfunktionen genannt, sind Dienstleistungen des Objekts und werden durch ihre Parameter charakterisiert. Die Parameterliste wird auch Signatur genannt.

Operatoren können wie Attribute auf unterschiedliche Weisen angegeben werden:

• nur Name
• Name und Parameter
• Name, Parameter mit Typ
• Name, Parameter mit Typ und Anfangswert

Außerdem können Operationen als abstrakt bzw. virtuell definiert werden, was bedeutet, dass keine Implementierung vorliegt, sondern nur die Deklaration der Operation. Dadurch wird die Klasse, welche die abstrakte Operation enthält, sofort zur abstrakten Klasse, aber dazu in wenigen Sätzen mehr.

Was nun letztendlich in der Attributen- und Operationenliste aufgeführt ist, ist stets problemspezifisch und hängt stark davon ab, was für das ordentliche Modellieren wichtig ist und was nur störend wirkt.

Der Name der Klasse wird generell in fetter Schrift geschrieben. Ist er fett und kursiv, so handelt es sich um eine abstrakte Klasse. Dieses weitere Element eines Klassendiagramms wird auch als virtuelle Klasse bezeichnet und kann keine eigenen Objekte erzeugen, da sie unvollständig ist. Zum Beispiel enthält sie eine abstrakte Funktion, die wir bereits kennen gelernt haben.
Eine abstrakte Klasse dient oft dazu, zu zeigen, dass es bestimmte Operationen und Attribute gibt, diese werden aber nicht konkret implementiert. Die abstrakte Klasse stellt daher eine Basis für weitere Klassen dar, welche dann die Implementierung beinhalten.

Beispiel: UML-Darstellung einer Template-Klasse

Ein weiteres Element ist die parametrisierbare Klasse. In c++ wird sie Template-Klasse genannt und stellt eine Schablone dar, welche einen formalen Parameter enthält, der bei der Erzeugung weiterer Klassen ersetzt wird. Mit dieser Technik kann leicht wiederverwendbarer Code erzeugt werden. Dargestellt wird die parametrisierbare Klasse durch ein zusätzliches rechteckiges Feld an der rechten oberen Ecke des Klassen-Feldes, welches den Namen des formalen Parameters enthält.

Beispiel: UML-Objekt

Klassen sind im Klassendiagramm nicht die handelnden Elemente, es sind ihre Objekte oder Instanzen. Die Eigenschaften und das Verhalten der Objekte wird durch die Klasse definiert (Attribute und Operationen). In der UML-Darstellung unterscheiden sich Objekte von ihren Klassen dadurch, dass dem Namen des Objekts im obersten Feld nach einem Doppelpunkt der Name der Klasse folgt. Das ganze wird auch noch unterstrichen. Das Objekt-Rechteck stellt nur Attribute mit den aktuellen oder Beispielwerten dar, Operationen sind nicht objektspezifisch und werden daher nicht angegeben.

Soweit zu den Klassen und ihren Objekten. Was noch fehlt sind die Verbindungen zwischen den Klassen, welche sehr vielfältig sind. Ich möchte an dieser Stelle lediglich vier vorstellen:

Die Assoziation beschreibt die Relation zwischen Klassen bzw. ihrer Objekte und wird entweder durch einen einfache Strich oder durch einen Pfeil dargestellt. Im Falle des Pfeils handelt es sich um eine gerichtete Assoziation und die Kommunikation kann nur in eine Richtung stattfinden. Im oberen Beispiel habe ich die Klasse “Artikel” und die Klasse “Kommentar” auf diese Weise verbunden. Berücksichtigt man die Multiplizität, so heißt es gesprochen: “Ein Artikel kann beliebig viele Kommentare enthalten.”

Artikel, Kommentare und Seiten sind in einem Weblog Inhalte und sie besitzen die abstrakten Eigenschaften von Inhalten, hier sind es das Datum und den Autor. Eine derartige Beziehung wird Vererbung genannt. Die Eltern-Klasse (“Content”) wird Oberklasse und die Kind-Klasse (“Artikel”) Unterklasse genannt.

Eine weitere Beziehung ist in dem Beispiel zwischen den Klassen “Datum” und “Content” zu sehen. Das ist ein Sonderfall einer Assoziation und wird Aggregation genannt. Die Aggregation besagt, dass die Beziehung zwischen den Klassen nicht gleichwertig ist. In diesem Fall ist “Datum” ein Teil der Klasse “Content”. Die leere Raute zeigt dabei immer auf das ganze Element, also auf “Content”.

Ist die Raute nicht leer, sondern ausgefüllt, dann handelt es sich um eine Komposition. Die Komposition ist auch ein Sonderfall der Assoziation und eine strengere Form der Aggregation. Wenn das ganze Element, welches die Komposition einnimmt, aus irgendwelchen Gründen verschwindet, dann kann das komposierte Element auch nicht mehr weiter existieren. Das ist bei der Aggregation nicht der Fall. Der Autor lebt immer noch, auch wenn sein Artikel gelöscht wird. Das Gegenteil gibt es nur in Büchern und Filmen .

Das ist ein Klasse-Diagramm

Klassendiagramme sind ein sehr wichtiges und nützliches Werkzeug bei der Programmierung. Und da die Terminologie auch zufällig die gleiche ist, fällt es den Programmierern nicht sehr schwer, sich an die Klassendiagramme zu gewöhnen.

Hast schon Erfahrungen mit Klassendiagrammen gemacht? Und wo wendest du sie an?

Deine Stadt - Dein Preis
Mit CityDeal und vielen Anderen den Preis drücken!

© Muvik for muvik-multigrid, 2010. | Permalink | 2 Kommentare | Teile es mit deinen Freunden: del.icio.us MisterWong Twitter
Tags: Modellierung, Tutorial, UML

Im ersten Teil der UML-Serie ging es vorrangig um die Erläuterung, warum ich in diesem Weblog über UML schreibe und was die Leser zu erwarten haben. Heute geht es ans Eingemachte mit dem ersten Diagrammtyp für Anwendungsfälle.

Was ist ein Anwendungsfalldiagramm und was kann ich damit tun?

In einem Satz zusammengefasst, zeigt das Anwendungsfalldiagramm den strukturellen Zusammenhang und die Abhängigkeiten zwischen sogenannten Akteuren und den Anwendungsfällen. Dabei werden weder das Verhalten der Akteure noch irgendwelche Abläufe beschrieben, sondern nur das Zusammenwirken der Elementen (Akteure und Anwendungsfälle). Was Akteure und Anwendungsfälle sind, dazu komme ich etwas später im Text.

Jeder, der schon einmal etwas komplexeres programmiert hat und dabei einfach drauflos geschrieben hat, musste am Ende wahrscheinlich feststellen, dass hier eine Funktion fehlt und da noch eine Schnittstelle wünschenswert wäre, damit das Gesamtprogramm sinnvoll ist und funktioniert, wie zu Beginn angedacht. Davon abgesehen, dass es meist kein guter Rat ist, ein Programm einfach anfangen zu schreiben, ohne sich zumindest eine grobe Struktur in Gedanken anzulegen, kann ich jedem nur ans Herz legen, die Anforderungen an ein Programm schriftlich oder grafisch festzuhalten. In solchen Fällen eignet sich das Anwendungsfalldiagramm. Im professionellen geschäftlichen Bereich kann es sogar soweit gehen, dass ein Anwendungsfalldiagramm die Grundlage eines Vertrages zwischen einem Softwarehersteller und seinem Kunden wird. Daraus kann eine ganz wichtige Eigenschaft des Anwendungsfalldiagramms heraus gelesen werden: Meist interessiert es den Kunden nicht, wie ein Programm funktioniert, er gibt nur vor, was es leisten soll. Aus dieser Tatsache folgt die Aussage über das Ziel eines Anwendungsfalldiagramms:

Das Anwendungsfalldiagramm hat zum Einen das Ziel den Funktionsumfang des Programms zu definieren und dabei möglichst die Kosten für nachträgliche Veränderungen zu minimieren und zum Anderen eine zielgerichtete, problemorientierte Entwicklung zu unterstützen.

Ein sehr einfaches Beispiel ist im folgenden Bild gezeigt.

Beispiel: Anwendungsfalldiagramm eines Blogs

• Artikel schreiben
• Artikel modifizieren
• Artikel kommentieren
• Artikel lesen

Also beschreiben Anwendungsfälle die Wechselwirkung zwischen den Akteuren und dem System.

Akteure sind die Besucher und der Administrator, folglich in diesem Fall Leute, die vor dem Rechner sitzen und am Blog etwas machen.

Viele weitere Beispiele kannst du mit der Google Bildersuche finden, indem du nach “Anwendungsfalldiagramm” suchst.

Elemente eines Anwendungsfalldiagramms

Die zwei wichtigsten Elemente haben wir schon kennen gelernt: die Anwendungsfälle und die Akteure. Wie im obigen Beispiel dargestellt, werden die Anwendungsfälle mit Ellipsen und einer Bezeichnung symbolisiert. Ein vernünftiger Anwendungsfall besteht meist aus zwei Wörtern, einem Substantiv und einem Verb. Ist das nicht der Fall, dann kann das Diagramm vielleicht noch optimiert werden.

Die Akteure werden als Strichmännchen dargestellt und die Bezeichnung unter das Männchen geschrieben. In der Fachliteratur sind noch weitere Details zum richtigen Darstellen von besonderen Akteuren, worauf ich hier jedoch nicht eingehen möchte.

Die Verbindungslinien zwischen den einzelnen Elementen stehen für die Beziehungen. Eine wichtige Beziehung ist die include-Beziehung. Damit wird ein Anwendungsfall in einen anderen eingebunden. Eine Unterteilung der Anwendungsfälle ist jedoch nur sinnvoll, wenn der ausgegliederte Anwendungsfall mehr als einmal eingebunden wird. Die include-Beziehung wird mit einer gestrichelten Linie und einer Pfeilrichtung hin zum einzugliederndem Anwendungsfall dargestellt.

Würde ich nun in dem Beispiel meiner eigenen Erklärung der include-Beziehung folgen, dürfte ich den Anwendungsfall “Freischaltung anfragen” nicht auslagern. Jedoch kann es an dieser Stelle wichtig sein, um zu verdeutlichen, dass nicht alle Kommentare wahllos zugelassen werden. Es könnte ja Spam dazwischen sein.

Eine ähnliche Funktion hat auch die extend-Beziehung, welche einen Anwendungsfall erweitert, aber im Gegensatz zu include ihn nicht zum Bestandteil des Anwendungsfalls macht.

Ein weiteres wichtiges Element des Anwendungsfalldiagramms ist die Systemgrenze, welche mit einem rechteckigen Rahmen um alle Anwendungsfälle gekennzeichnet wird.

Es gibt noch einige weitere Elemente, welche an dieser Stelle genannt werden können, aber ich denke, dass es für die Verwendung hier im Blog ausreicht, was ich bisher vorgestellt habe. Sollte es im einen oder anderen Fall nicht reichen, dann werde ich direkt im entsprechenden Artikel darauf näher eingehen. Die Ausführungen hier sollten aber für das Grundverständnis ausreichen.

Besonderheiten eines Anwendungsfalldiagramms

Unter den Besonderheiten des Anwendungsfalldiagramms führe ich die Punkte auf, welche beim Erstellen zu beachten sind:

• Beschreibung aus Sicht des Systems
• Beschreibung, was für Anwender sichtbar ist
• kein Verhalten oder Ablauf, nur Interaktion
• Was soll das System leisten?
• Nicht: Wie soll das System die Anforderung erfüllen?
• an jedem Anwendungsfall soll mindestens ein Akteur beteiligt sein
• Bezeichnung von Anwendungsfällen: Substantiv + Verb

Wo hast du bereits ein Anwendungsfalldiagramm gebraucht?

Ja, jetzt ist es wieder soweit: Du, lieber Leser, bist nun an der Reihe deine Erfahrungen darzulegen und etwas aus dem Nähkästchen zu plaudern. Hast du schonmal ein derartiges UML-Diagramm erstellt, hat es dir geholfen oder dich eher bei deiner Arbeit gestört? Kannst du eine Verbesserung vorschlagen?

Deine Stadt - Dein Preis
Mit CityDeal und vielen Anderen den Preis drücken!

© Muvik for muvik-multigrid, 2010. | Permalink | keine Kommentare | Teile es mit deinen Freunden: del.icio.us MisterWong Twitter
Tags: Modellierung, Tutorial, UML