Projekt . Spezifikation Michael Stolte 1. Allgemeiner Aufbau und Funktionsweise 2. Datenbank 3. Benutzerschnittstelle 4. Generierung der Daten 5. offene Teile der Spezifikation 1. Allgemeiner Aufbau und Funktionsweise 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile EingabeApplikation (Applet) HTML-Seiten ruft auf SQL (JDBC) HTML-Generator SQL XML-Generator ruft auf DB Schnittstelle: XML/XSL ruft auf SQL AuswahlApplikation DokumentenGenerator Dokumente 2. Datenbank 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile Administrator #ADMINID ADMINNAME FBID Fachbereich #FBID BEZEICHNUNG ABKUERZUNG Dozent #DOZENTID NAME VORNAME EMAIL HOMEPAGE RAUM TELEFON SPRECHZEITEN FBID TITEL KOMVOR_ADMIN USERNAME 1 Studiengang #SGID FBID BEZEICHNUNG ABKUERZUNG Vertiefungsrichtung #VERTIEFID SGID BEZEICHNUNG ABKUERZUNG 2 1 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile Vorbedingung #VORBEDINGID VORBEDINGUNG Prüfungsform #PRUEFUNGSID PRUEFFORM Links #LINKID LINK Vorlesung #VORLESUNGSID TITEL STUNDEN DOZENTID VORBEDINGUNGID GHSTUDIUM PRUEFUNGSID HINWEISE VERWEISE SEMESTER FREIGABE Vorlesungsmodule #MODULID VORLESUNGSID TITEL BESCHREIBUNG LITERATURID LINKID STUNDEN SPRACHE SKRIPTLINKID NUMMER FREIGABE 2 Zuordnung #VORLESUNGSID #VERTIEFID JAHRGANG WAHLPFLICHT Literatur #LITERATURID BUCH 3. Benutzerschnittstelle 3.1. Eingabe-Applikation 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile • Siehe Spezifikation vom Projekt KomVor • Szenarien für Administrator • Fachbereiche anlegen / löschen • Studiengang anlegen / löschen • Vertiefungsrichtung anlegen / löschen 3.1.1. Fachbereich 1. Funktion : - löschen eines bestehenden Fachbereiches, sowie eintragen eines neuen Fachbereiches Beschreibung : - Liste aller Fachbereiche, sowie ein Textfeld für den Namen eines neuen Fachbereiches Aufbau Eingabeparameter : - Listenfeld Fachbereiche zum löschen eines bestehenden Fachbereiches 2. Datenbank 3. Benutzerschnittstelle - Eingabefeld für den Namen eines neuen Fachbereiches 4. Generierung - Löschen-Button 5. offene Teile - Hinzufügen-Button Ausgabedaten : - bei Löschen: Rückfrage ob wirklich löschen - Aktualisierung der Datenbank und des Listenfeldes Vorraussetzungen : - Anmeldung des Administrators - bei Hinzufügen: neuer Fachbereich existiert noch nicht - bei Löschen: Name des Fachbereiches 3.1.2. Studiengang Funktion : - löschen eines bestehenden Studiengangs, sowie eintragen eines neuen Studiengangs Beschreibung : - 2 Listenfelder zur schrittweisen Annäherung an zu löschenden Studiengang, sowie ein Neu-Button zum Eintragen eines neuen Studiengangs 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle - Listenfeld mit Studiengängen 4. Generierung - Neu-Button zum Eintragen eines neuen Studiengangs 5. offene Teile Eingabeparameter : - Listenfeld mit Fachbereichen - bei vollständiger Auswahl wird Löschen-Button aktiv Ausgabedaten : - bei Löschen: - Rückfrage ob wirklich löschen - Aktualisierung der Datenbank und des Listenfeldes - bei Neu: - Aufrufen des Dialog für die Eingabe eines neuen Studiengangs danach Aktualisierung des Listenfeldes Vorraussetzungen : - Anmeldung des Administrators - bei Löschen: Studiengangsname und Fachbereich 3.1.3. Neuer Studiengang 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle Funktion : - Eingabe der Daten zum Eintragen eines neuen Studiengangs Beschreibung : - Listenfeld mit Fachbereichen zur Zuweisung des neuen Studiengangs an einen Fachbereich , sowie ein Textfeld für den Namen des neuen Studiengangs Eingabeparameter : - Eingabefeld für den Namen des neuen Studiengngs - Listenfeld für die Auswahl des Fachbereiches - bei vollständiger Auswahl wird OK-Button aktiv 4. Generierung Ausgabedaten : - Hinzufügen des Studiengangs in der Datenbank - Dialog wird geschlossen 5. offene Teile Vorraussetzungen : - Anmeldung des Administrators - neuer Studiengang existiert noch nicht - neuer Studiengangsname und Fachbereich 3.2. Auswahl-Applikation 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile 1. Auswahl der Vorlesungen, die im Dokument enthalten sein sollen 2. Bestimmen der im Dokument enthaltenen Informationen 3. Auswahl von Layout und Format des Dokumentes 3.2.1. Auswahl der Vorlesung(en) 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle Funktion : - Auswahl der Vorlesungen, die in dem zu generierenden Dokument enthalten sein sollen Beschreibung : - Liste für die Auswahl der Vorlesung(en), sowie Möglichkeiten zur Einschränkung der Liste nach Fachbereich(en), Studiengang, Vertiefungsrichtung(en) oder Dozent(en) Eingabeparameter : - Auswahl einer, mehrerer oder aller Vorlesungen aus der Liste 4. Generierung - Einschränkung der Liste mit Vorlesungen durch Auswahl eines oder mehrerer Facheiche, Studiengang, Vertiefungsrichtung oder Dozenten 5. offene Teile - Bestätigung der Auswahl durch den Weiter-Button Ausgabedaten : - Liste der gewählten Vorlesungen - Auswahlkriterium / Detailstufe (Benutzeranforderungen) - Dialog wird geschlossen Vorraussetzungen : - Datenbankverbindung besteht - es wird mindestens eine Vorlesung ausgewählt 3.2.1. Auswahl der Vorlesung(en) 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile 3.2.2. Auswahl der Informationsdetails 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile Funktion : - Auswahl der Informationen, die in dem zu generierenden Dokument enthalten sein sollen Beschreibung : - Es muß eine Fallunterscheidung je nach Auswahlkriterium/ Detailstufe (Benutzeranforderungen) getroffen werden, da jeweils andere Elemente zur Auswahl stehen. - Eine CheckBox für jedes Element, das gewählt bzw. abgewählt werden kann. Eingabeparameter : - CheckBox für jedes Element was gewählt bzw. abgewählt werden kann - OK-Button zum Bestätigen der Auswahl Ausgabedaten : - binäres Feld mit Auswahl der einzelnen Elemente - Dialog wird geschlossen Vorraussetzungen : - siehe Ausgabedaten von Auswahl der Vorlesung(en) - für die einzelnen Auswahlkriteren / Detailstufen (Benutzeranforderungen) ist eine Vorauswahl fest vorgegeben (siehe Beispieldialoge) 3.2.2. Auswahl der Informationsdetails Auswahlkriterium / Detailstufe = Fachbereich oder Studiengang 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile Auswahlkriterium / Detailstufe = Dozent 3.2.3. Auswahl des Ausgabeformates Funktion : - Auswahl der Informationen für die Generierung (Layout, Format, Ausgabe-Pfad) Beschreibung : Aufbau - Je eine ChoiceBox für die Auswahl der zur Verfügung stehenden Layouts und Dokumenten-Formate. 2. Datenbank - Angabe der Zieldatei durch entsprechenden Auswahldialog 3. Benutzerschnittstelle Eingabeparameter : - ChoiceBox für Auswahl von Layout und Format 4. Generierung - Generieren-Button zum Bestätigen und Start des Generators 5. offene Teile 1. - Textfeld und Button für Datei-Auswahl Ausgabedaten : - Layout, Dokumenten-Format und Ziel-Datei - Dialog wird geschlossen - Generierung wird mit Aufruf des XML-Generators gestartet Vorraussetzungen : - Layouts und Formate entweder fest codiert oder variabel in einer Parameter-Datei 3.2.3. Auswahl des Ausgabeformates 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile 4. Generierung 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. Generierung 5. offene Teile • XML-Generator • XML als Zwischenschritt / Schnittstelle • Dokumenten-Generator • HTML-Generator 4.1. XML- Generator Funktion : - Generierung einer XML-Datei als Zwischenschritt für die Generierung von Dokumenten in beliebigen Formaten. Beschreibung : Aufbau - Der XML-Generator soll von der Auswahl-Applikation aus gestartet werden. 2. Datenbank - Alle nötigen Eingangsparameter werden vom Benutzer in der Auswahl-Applikation eingegeben 3. Benutzerschnittstelle 1. 4. Generierung 5. offene Teile Eingangsparameter : - Liste der zu generierenden Vorlesungen - Auswahlkriterium / Detailstufe (Benutzeranforderungen) - Format und Layout des zu generierenden Dokumentes Ausgabedaten : - generierte XML-Datei in noch nicht spezifiziertem Verzeichnis - Aufruf des entsprechenden Dokumenten-Generators - Rückgabe: Erfolgsstatus Vorraussetzungen : - Datenbankverbindung besteht - Schreibzugriff auf Dateisystem - Dokumenten-Generator bekannt 4.2. XML - zwei Möglichkeiten je nach gewähltem Auswahlkriterium / Detailstufe - auswählbare Komponenten aus AuswahlApplikation finden sich auch als optionale Komponenten in der XML-Struktur wieder 4.3. Dokumenten- Generator 1. Funktion : - Generierung von Dokumenten eines bestimmten Formates (RTF, PDF, ...) aus der erzeugten XML-Datei Beschreibung : - Verwendung vorhandener Generatoren zur Erstellung von Dokumenten aus XML und XSL-Dateien Aufbau Eingangsparameter : - XML-Datei enthält die zu verwendenden Daten 2. 3. Datenbank - XSL-Datei enthält die Style Sheets / Formatierungsanweisungen zur Generierung des Dokumentes Benutzerschnittstelle Ausgabedaten : - generiertes Dokument 4. Generierung Vorraussetzungen : - Syntaktisch korrekte XML und XSL-Datei 5. offene Teile - Schreibzugriff auf Dateisystem 4.4. HTML- Generator 1. Aufbau 2. Datenbank 3. Benutzerschnittstelle 4. 5. Funktion : - Generierung der HTML-Seiten bei Veränderungen bzw. bei Neuerstellung Beschreibung : - spezieller Dokumenten-Generator - Der HTML-Generator soll von der Eingabe-Applikation aus mittels des XML-Generators automatisch gestartet werden wenn sich Vorlesungsdaten geändert haben. Eingangsparameter : - siehe Dokumenten-Generator Ausgabedaten : - generierte HTML-Dateien in noch nicht spezifizierter Verzeichnisstruktur Vorraussetzungen : - siehe Dokumenten-Generator Generierung offene Teile 5. offene Teile der Spezifikation - Verzeichnisstruktur und Namensschema für die generierten 1. Aufbau HTML-Seiten und die temporären XML-Dateien - Dozenteninformationen (E-Mail, Raum, ...) weder in 2. Datenbank Benutzeranforderungen noch in Spezifikation enthalten 3. Benutzerschnittstelle 4. Generierung 5. offene Teile - Änderung des Datenbankmodells hinsichtlich Einarbeitung einer Tabelle zur Authentifizierung der Benutzer Projekt . Vortrag - Ende Fragen