Programmierprojekt - LVA Q&A Tool

Ziel war es, eine Anwendung zu schreiben, die es LVA-Leitern ermöglicht, Anfragen von Studierenden übersichtlich zu bearbeiten.

Inhalt

verwendete Umgebung:

Java Compiler:

XML Parser bzw. API:

Installation:

Allgemein

Folgende Ansätze bzw. Gedanken liegen dem Programm zugrunde bzw gingen der Implementierung voraus:

Beschreibung der Programmmodule

  1. Applikation
  2. Editor
  3. Baumdarstellung
  4. Datenschnittstelle
  5. Frameworkaspekt

1. Applikation

In der Klasse RequestHandlerClientApp bzw. RequestHandlerUI als deren "MainFrame" wird das Zusammenspiel zwischen den Schirmkomponenten (Editor unten, Baumdarstellung oben, Menüleiste und Datenschnittstelle) koordiniert.

Zentrale Methoden sind dabei

Wichtig ist dabei, dass die Nominklatur von "engage,finish,cancel" ist derselbem Bedeutung sich durch das ganze Programm zieht. Hier wird auch ein Objekt der Datenschnittstelle angelegt und verwendet, das aishc an dieser Stelle (in dieser Klasse) auch leicht austauschen läßt. (HOTSPOT!)

2. Editor

Die Editorfunktionen sind in der Klasse RequestUI gekapselt, dass sich als JPanel in die Oberfläche einfügt. Zentrale Methoden sind

siehe dazu auch Abschnitt Probleme und Lösungen

3. Baumdarstellung

Zur Baumdarstellung wird die Swing-Klasse JTree verwendet. Als Knoten werden abgeleitete Klassen von DefaultMutableTreeNode verwendet. Da JTree bereits mit DefaultMutableTreeNodes umgehen kann und diese anzeigen kann, ist die Einbindung ein leichtes. Die Abbildung der Request-Struktur erfolgt durch rekursives Einsortieren von neuen Request in den RootNode.

Die abstrakte zentrale Methode insertRequest der abstrakten Klasse ToolTreeNode wird dabei in jeder Request-Hierarchie-Ebene seperat implementiert (um die unterschiedlichen Kriterien zu wahren). Prinzipieller Ablauf in insertRequest:

  1. Passt der Request zu einem Subbaum (ist die entsprechende Information vorhanden), so suche diesen Subbaum, ist er nicht vorhanden, so lege ihn an und reiche das insertRequest an diesen weiter.
  2. Passt der Request zu keinem Subbaum, so lege direkt als Request-Knoten an.

Sollten z.B. zu einer Hierarchieebene keine Informationen vorhanden sein, wird der Request in der letzten bekannten Ebene angelegt.Beispiel: Wird keine Übung zur Anfrage angegeben, wird die Anfrage direkt unterhalb der LVA angesiedelt. (= allgemeine Anfrage an die LVA).

Kleinste bzw. detaillierteste Ebene sind somit die RequestTreeNode Objekte, die auch eine Referenz auf ein Request Objekt beinhalten.

Die optische Darstellung wird über die toString() und getIDString() Funktionen gesteuert. Die Funktion getIDString() gibt einen den Request beschreibenden String zurück. Auf diesen bezieht sich auch die insertRequest() Methode. die toString() wird auch von JTree benutzt um die Darstellung in der Baumstruktur zu bestimmen. Darum wird wird toString() den getIDString() mit HTML Code anreichern um eine besondere Darstellung abhängig vom Status der Anfrage zu erreichen.

Derzeit werden folgende Darstellungen unterstützt:

4. Globale Daten

In einem Objekt der Klasse GlobalData werden sogenannte globale Daten gespeichert, die für die gesamte Laufzeit der Applikation gültig sind. Diese Einstellungen werden aus der zentralen XML Datei gewonnen bzw. aus der Methode getGenericData der Datenschnittstelle und beinhalten folgendes:

Verwendet werden diese Information u.a. zur Bestückung von Auswahlboxen im Editor und zur Generierung des Anfragenbaums.

4. Datenschnittstelle

Als Datenschnittstelle wurde DataExchange bestimmt, da die alle relevanten Methoden beinhalten sollte. Bereits in Hinblick auf eine mögliche Datenbankschnittstelle wurde writeLock als eigene Methode ausgeführt. Zu beachten ist, dass alle Methoden einen String als Id verlangen. So soll auch in einer Datenbank das Auffinden von Datensätzen sichergestellt werden.

4a. Implementierung der XML Schnittstelle

In der Klasse XMLDataExchange, die das Interface DataExchange implementiert, wurden die XML Funktionen gekapselt. Durch die Verwendung von SAX beschränkt sich das Parsen von XML Dateien auf das Prüfen, welches Tag gerade in Arbeit ist. So werden jeweils die XML Datei eingelesen und die Einstellungen gemerkt. Sobald ein entsprechendes Tag (FRAGE) abgeschlossen ist, wird das neue Objekt gespeichert bzw. die Ausgangsobjekte entsprechend bestückt.

4b. Realisierung des Locks in der XML Schnittstelle

siehe Abschnitt Probleme und Lösungen

4c Validierung der XML Dateien

Die Validierung der XML Dateien wird ebenfalls durch das vorhandene API übernommen, jedoch wird dabei eine von mir vordefinierte DTD verwendet, die das Aussehen der XML Dateien wie folgt regelt:

Überblicksliste
<!ELEMENT LVALISTE (LVA+)>
   <!ELEMENT LVA (LEITER*,UE*,FRAGE*)>
   <!ELEMENT LEITER (#PCDATA)>
   <!ELEMENT UE (AUFGABE*,FRAGE*)>
   <!ELEMENT FRAGE (#PCDATA)>
   <!ELEMENT AUFGABE (FRAGE*)>
   <!ATTLIST LVA 
   name CDATA #REQUIRED
   type CDATA #REQUIRED
   >
   <!ATTLIST LEITER 
   name CDATA #REQUIRED
   >
   <!ATTLIST UE 
   name CDATA #REQUIRED
   >
   <!ATTLIST AUFGABE
   name CDATA #REQUIRED
   >

Dies entspricht der Angabe und wurde nicht verändert. Als Daten im Tag FRAGE wird ein Dateiname erwartet.

Anfragedatei
<!ELEMENT FRAGE (BEARBEITER?,DATUM,ENDDATUM?,CLOSEDATUM?,TEXT,ANTWORT?,EDITOR*,WRITELOCK?)>
   <!ELEMENT BEARBEITER (#PCDATA)>
   <!ELEMENT DATUM (#PCDATA)>
   <!ELEMENT ENDDATUM (#PCDATA)>
   <!ELEMENT CLOSEDATUM (#PCDATA)>
   <!ELEMENT TEXT (#PCDATA)>
   <!ELEMENT ANTWORT (#PCDATA)>
   <!ATTLIST BEARBEITER 
   name CDATA #REQUIRED
   >
   <!ELEMENT EDITOR (#PCDATA)>
   <!ELEMENT WRITELOCK EMPTY>

Diese Definition der Anfrage XML Datei wurde gegenüber der Angabe leicht geändert:

Achtung: Um klar definierte XML Dateien sicherzustellen, verlangt die XML Schnittstelle verlangt immer nach einer DTD, darum muss die DTD immer im Kopf einer einzulesenden Datei angegeben werden.

<!DOCTYPE LVALISTE SYSTEM "lvaliste.dtd">

und

<!DOCTYPE FRAGE SYSTEM "frage.dtd">

5. Frameworkaspekt

Wie gefordert wurde die Anwendung als Framework realisiert. interface DataExchange birgt das Interface, das eine Klasse implementieren muss, um der Anwendung als Ein- Ausgabeklasse zu dienen. Zur Laufzeit kann dieses durch die Methode

 public void changeDataExchange(DataExchange x) 

erfolgen.

Ablauf der Bearbeitung für den Benutzer

  1. Nach dem Einstieg ins Programm ist über das Menü (File -> Read Main XML File) erst einmal die Hauptdatei einzulesen, die mit SSW-SS01.xml hier hardcoded ist.
  2. Danach kann im oberen Teil die entsprechenden Anfrage anwählen. (Rot= Dringend zu erledigen, Fett = Offene Anfrage). Per Doppelklick wird die Anfrage in den Editierbereich übernommen, wo dann Ansprechperson, Antworttext und "Abgeschlossen" verändert werden können.
  3. Den Editiermodus verlassen kann man durch:
    1. Neuwahl eines anderen Knoten
    2. Button "Änderungen speichern"
    3. Button "Abbrechen"
    4. Aussteigen aus dem Programm
  4. Sollte es zum Verlassen des Editiermodus ohne vorheriges Drücken des Buttons "Änderungen speichern" kommen, wird ein Dialog eingeblendet, der nachfragt, ob die Änderungen gespeichert werden sollen. Dieser Dialog kann durch das Anhaken im Menü "Never ask saving" unterdrückt werden. Dann wird dieser Dialog immer automatisch mit "Ja" beantwortet.

Probleme und Lösungen

Locks

Vor ein mittleres Problem stellte mich die Realisierung des Sperrens in der XML Implementation. Versuche mit Setzen des Schreibschutzflags auf das File waren erfolglos, da ich in Java keine Möglichkeit gefunden habe, dieses Flag wieder zu löschen. Schließlich fand ich einen Weg:

Beim Ändern des Lockzustandes wird die Quelldatei neu geschrieben mit oder ohne dem Writelock Tag.

siehe auch mögliche Verbesserungen

Layout

Die Layout Möglichkeiten von Java Swing sind mächtig, aber eher mächtig unkomfortabel. Nachdem ich dieses Projekt vollständig im Texteditor gecodet habe, standen mir keine grafischen Layout Tools zur Verfügung. Das ist ein äußerst mühsamer Prozess, der mir viel Kopfzerbrechen bereitet hat. Java Swing Layout im Texteditor => Wenn möglich, nie wieder.

Mögliche Verbesserungen

Aspekte zur Anforderung vs. Realisierung

Downloadlinks