|
> Verzeichnis der Dokumente mit den theoretischen Grundlagen |
|
Letzte
Bearbeitung dieses Dokuments: |
Voraussetzungen für das Verständnis dieses Dokuments:* Kenntnisse der
Programmierung von Heavyweight-Clients (Fat-Clients) in Java. |
Ungefährer Zeitbedarf zum Durcharbeiten dieses Dokuments:Das
ist ein Dokument zur Erklärung des theoretischen
Hintergrundes des JavaScout-Fat-Client-Frameworks (JS-FCF). |
Dieses
Dokument beschreibt die XML-Struktur in der Datei
'ErrorMessages.xml'.
Diese Datei ist Teil des
JavaScout-Fat-Client-Frameworks und enthält
sprachabhängige Texte für die Anzeige von Fehlern und
Hinweisen auf Situationen, die eine Entscheidung des Anwenders
erfordern.
Die Datei ist im Unterverzeichnis 'TEXT.ls' (dabei wird ls durch den ISO-Code der jeweiligen Sprache ersetzt) abgelegt; eine detaillierte Beschreibung zur Verzeichnisstruktur finden Sie im Dokument Verzeichnisstruktur für die Entwicklung von Heavyweight-Clients mit dem JS-FCF.
Die XML-Struktur ist in folgende Abschnitte unterteilt:
Zuerst einzelne XML-Elemente mit Texten zur Erklärung verschiedener Ereignis-Gründe, Namen von Dateien mit Graphischen Symbolen (Icons) zur Unterstützung der Wahrnehmung des Ereignissen und Dateien zur eventuellen Aufzeichnung des Ereignisses in einer Log-Datei.
In <Messages> sind beliebig viele XML-Elemente mit Hinweis-Texten für ein bestimmtes Ereignis im Anwendungsprogramm und Markierungen, ob beim Auftreten dieses Ereignisses der Anwender die Ursache korrigieren kann oder das Anwendungsprogramm beendet werden muss.
Vorbemerkung
Vorbedingungen
Muster
einer Datei (Übersicht)
Abschnitt
mit individuellen
XML-Elementen
* <NotFoundMessageText>
* <WarningExplanationText>
* <ErrorExplanationText>
* <StorableExplanationText>
* <NotStorableExplanationText>
* <WarningIconFileName>
* <ErrorIconFileName>
* <UnixStyleLogFileDirectoryAndName>
* <WindowsStyleLogFileDirectoryAndName>
Abschnitt
<Messages>
* <Message>
* <OriginClass>
* <OriginCode>
* <Processing>
* <Logging>
* <MessageText>
* alternativ <Reference>
* <ReferenceOriginClass>
* <ReferenceOriginCode>
Verwandte
Dokumentation
Zur
Wartung der Einträge im Abschnitt <Messages>
in
diese Datei wird JavaScout
ProjectAssist empfohlen.
Aus
diesen Einträgen kann dann der Abschnitt <Messages>
generiert
werden. Die manuell eingetragenen Texte in den anderen XML-Elementen
bleibt dabei erhalten.
Eine Beschreibung für das
Teilprogramm zur Erfassung der Fehlermeldungen und Warnungen finden
Sie im Dokument Fehlermeldungen
und Warnungen verwalten.
Das
Generieren der Datei mit der XML-Struktur ist im Dokument Datei
mit der XML-Struktur mit Fehlermeldungen und Warnungen erstellen
beschrieben.
Die
Einträge in dieser Datei werden von den JavaScout
Basisklassen
JSBS:ErrorDialog
und JSBS_UnstoredChangesDialog
verwendet.
Die Methoden dieser Klassen können von
Anwendungsprogrammen aufgerufen werden und abhängig von den
übergebenen Parametern wird der entsprechende Hinweis aus der
XML-Struktur ausgelesen. Detaillierte Informationen finden Sie bei
den Beschreibungen für die XML-Elemente.
Einige Beispiele über die 'Auswirkungen' der Einträge in dieser Datei sehen Sie im Dokument Fehler und Warnungen – Generelle Beschreibung :: ProjectAssist für das JavaScout Fat-Client-Framework.
Grundlegende Kenntnisse über XML-Strukturen.
Die Einträge für die Ereignis-Gründe, die Datei-Namen für die Log-Datei und die Graphischen Symbole (Icons) zu Beginn der XML-Struktur sind aus ProjectAssist.
Im
Abschnitt <Messages>
werden beispielhaft nur zwei Einträge als Muster verwendet:
*
Der erste Eintrag enthält den Text der bei Auftreten des
Ereignisses angezeigt wird.
* Der zweite Eintrag ist ein Beispiel
für den Verweis (<Reference>)
auf einen anderen Eintrag.
Zur Beschreibung für einen Abschnitt gelangen Sie über den 'Link' wenn Sie auf den unterstrichenen Teil des Textes klicken.
<!--
Root-Element; muß vorhanden sein sonst meldet der Parser einen
Fehler --><root><!--
*********************************************************************************
--><!--
********** Einzelne XML-Elemente mit Text für Ereignisse,
Datei-Namen für Icons und Log-Datei ***********
--> <NotFoundMessageText>Für
'Herkunfts-Klasse' und 'Herkunfts-Code'
ist kein individueller
Hinweis vorhanden.
Aus Sicherheitsgründen muss das
Anwendungsprogramm beendet werden.
Sie können anschließend
versuchen, das Programm neu zu starten;
möglicherweise ist
die Ursache des Fehlers nur temporär aufgetreten oder
durch
eine besondere – bei der Erstellung des Programms nicht
berücksichtigte Kombination von Daten-Inhalten
verursacht.
Klicken Sie bitte auf die Schaltfläche
[Drucken] und geben Sie den
Ausdruck an die/den Verantwortliche/n
für das Programm weiter.
Sie unterstützen damit die
Suche nach der Ursache des Fehlers.
Anschließend klicken
Sie bitte auf die Schaltfläche [Weiter] -
das
Anwendungsprogramm wird dann
beendet. </NotFoundMessageText> <WarningExplanationText>Es
ist eine Situation aufgetreten die eine Korrektur durch Sie
erfordert.
Weitere Hinweise finden Sie in der Detail-Beschreibung
weiter unten.
Wenn Ihnen die Hinweise nicht helfen die
Situation zu korrigieren
dann klicken Sie bitte auf die
Schaltfläche [Drucken] und geben Sie
den Ausdruck an die/den
Verantwortliche/n für das Programm weiter.
Sie unterstützen
damit die Suche nach der Ursache des Hinweises.
Anschließend
klicken Sie bitte auf die Schaltfläche [Weiter] -
Sie kommen
damit zum Fenster für den Geschäftsfall zurück und
können
die Eingabe
korrigieren. </WarningExplanationText> <ErrorExplanationText>Es
ist ein schwerer Fehler aufgetreten.
Das Anwendungsprogramm muss
aus Sicherheitsgründen beendet werden.
Weitere Hinweise
finden Sie in der Detail-Beschreibung weiter unten.
Sie können
anschließend versuchen, das Programm neu zu
starten;
möglicherweise ist die Ursache des Fehlers nur
temporär aufgetreten oder
durch eine besondere – bei
der Erstellung des Programms nicht
berücksichtigte
Kombination von Daten-Inhalten verursacht.
Klicken Sie bitte
auf die Schaltfläche [Drucken] und geben Sie den
Ausdruck an
die/den Verantwortliche/n für das Programm weiter.
Sie
unterstützen damit die Suche nach der Ursache des
Fehlers.
Anschließend klicken Sie bitte auf die
Schaltfläche [Weiter] -
das Anwendungsprogramm wird dann
beendet. </ErrorExplanationText> <StoreableExplanationText>Sie
haben im Teilprogamm
%FrameTitle%
Daten neu erfasst oder
geändert -
diese Daten aber nicht gespeichert !
Die Daten
sind fehlerfrei und können gespeichert werden.
Bitte
wählen Sie aus folgenden Möglichkeiten:
*
Schaltfläche [Zurück zur Dateneingabe]:
Ihre gewünschte
Aktion wird nicht fortgesetzt und
das Programm erlaubt eine
Korrektur der eingegebenen Daten.
* Schaltfläche
[Speichern]:
Die erfassten Daten werden gespeichert und das
Programm
führt anschließend Ihre gewünschte Aktion
aus.
* Schaltfläche [Nicht Speichern]:
Die erfassten
Daten werden nicht gespeichert - das Programm
führt sofort
Ihre gewünschte Aktion aus.
Wenn Sie dieses Fenster
schließen ohne vorher
eine Schaltfläche anzuklicken
werden die erfassten
Daten
gespeichert. </StoreableExplanationText> <NotStoreableExplanationText>Sie
haben im Teilprogramm
%FrameTitle%
Daten neu erfasst oder
geändert -
diese Daten aber nicht gespeichert !
Die Daten
sind nicht komplett oder enthalten Fehler
und können nicht
gespeichert werden.
Bitte wählen Sie aus folgenden
Möglichkeiten:
* Schaltfläche [Zurück zur
Dateneingabe]:
Ihre gewünschte Aktion wird nicht fortgesetzt
und
das Programm erlaubt eine Korrektur der eingegebenen Daten.
*
Schaltfläche [Nicht Speichern]:
Die erfassten Daten werden
nicht gespeichert - das Programm
führt sofort Ihre gewünschte
Aktion aus.
Wenn Sie dieses Fenster schließen ohne
vorher
eine Schaltfläche anzuklicken werden die
erfassten
Daten nicht
gespeichert. </NotStoreableExplanationText> <WarningIconFileName>Icon_Warning_80x80.gif</WarningIconFileName> <ErrorIconFileName>Icon_Stop_80x80.gif</ErrorIconFileName> <UnixStyleLogFileDirectoryAndName>/server/directory/file</UnixStyleLogFileDirectoryAndName> <WindowsStyleLogFileDirectoryAndName>drive:directory\file</WindowsStyleLogFileDirectoryAndName><!--
********************************************
--><!--
********** Abschnitt für Hinweis-Texte für ein Ereignis
***********
--> <Messages> <Message> <OriginClass>js_prass.clientframes.JS_ProjAssist_Project__ActionHandler</OriginClass> <OriginCode>DupKey</OriginCode> <Processing>W</Processing> <Reference> <ReferenceOriginClass>MultipleUsedMessages</ReferenceOriginClass> <ReferenceOriginCode>DuplicateUserKnownKey1Parm</ReferenceOriginCode> </Reference> </Message> <Message> <OriginClass>MultipleUsedMessages</OriginClass> <OriginCode>DuplicateUserKnownKey1Parm</OriginCode> <MessageText>Es
existiert bereits ein Datensatz mit der eindeutigen
Identifikation
%Parameter1%/%Parameter2% !
Die Identifikation
%Parameter1%/%Parameter2% ist notwendig um
den Datensatz wieder
finden zu können.
Klicken Sie bitte auf die Schaltfläche
[Weiter] und korrigieren Sie
die Eingabe bevor Sie die Daten
erneut
speichern. </MessageText> <Processing>W</Processing> </Message> <Message> <OriginClass>MultipleUsedMessages</OriginClass> <OriginCode>DBSysError</OriginCode> <Processing>D</Processing> <Logging></Logging> <MessageText>Es
ist ein Fehler beim Zugriff auf die Datenbank aufgetreten.
Dieser
Fehler kann nicht durch eine Aktion von Ihnen
behoben oder
umgangen werden.
Verständigen Sie bitte den Betreiber des
Rechenzentrums oder
jene Person die für die Verbindung zum
Rechenzentrum verantwortlich
ist und geben Sie die folgende
Fehlermeldung weiter:
Parameter1: %Parameter1%
Parameter2:
%Parameter2%
Parameter3: %Parameter3%Parameter4:
%Parameter4%
Parameter5:
%Parameter5%. </Message> </Messages></root>
In diesem Abschnitt sind sprachabhängige Texte und weitere Parameter festgelegt die für das gesamte Anwendungsprogramm gelten.
Dieser Text wird angezeigt, wenn für die Kombination der Werte von <OriginClass> und <OriginCode> kein XML-Element <Message> oder <MessageText> definiert sind.
In
dem in der Basisklasse JSBS_ErrorDialog
erzeugten Dialog-Fenster wird dann im Feld 'Bedeutung des Fehlers
oder der Warnung:' der in diesem XML-Element erfasste Text
angezeigt:
Dieser Text wird angezeigt wenn das XML-Element <Processing> im XML-Element <Message> für die Kombination von <OriginClass> und <OriginCode> den Wert 'W' (Warning) enthält.
In
dem in der Basisklasse JSBS_ErrorDialog
erzeugten Dialog-Fenster wird dann im oberen Text-Bereich der in
diesem XML-Element erfasste Text angezeigt:
Dieser
Text wird unter folgenden Vorrausssetzungen angezeigt:
* Für
die Kombination der Werte von <OriginClass>
und
<OriginCode>
ist
kein XML-Element <Message>
oder
<MessageText>
definiert.
* Das
XML-Element <Processing>
im
XML-Element <Message>
für
die Kombination von <OriginClass>
und
<OriginCode>
enthält
den Wert 'D'
(Dump).
In
dem in der Basisklasse JSBS_ErrorDialog
erzeugten Dialog-Fenster wird dann im oberen Text-Bereich der in
diesem XML-Element erfasste Text angezeigt:
Dieser
Text wird angezeigt, wenn der Anwender Daten neu erfasst oder
geändert aber nicht gespeichert hat.
Die erfassten Daten sind
fehlerfrei und könnten gespeichert werden.
In
dem in der Basisklasse JSBS_UnstoredChangesDialog
erzeugten Dialog-Fenster wird dann im linken Text-Bereich der in
diesem XML-Element erfasste Text angezeigt:
Der
Text in der Title-Bar (obere Leiste) des aufrufenden Frames wird
anstelle des Platzhalters '%FrameTitle%' in den Text eingefügt.
Im
Beispiel ist das die zweite Zeile des Textes.
Dieser
Text wird angezeigt, wenn der Anwender Daten neu erfasst oder
geändert aber nicht gespeichert hat.
Die erfassten Daten sind
nicht vollständig oder enthalten Fehlen und können nicht
gespeichert werden.
In
dem in der Basisklasse JSBS_UnstoredChangesDialog
erzeugten Dialog-Fenster wird dann im linken Text-Bereich der in
diesem XML-Element erfasste Text angezeigt:
Der
Text in der Title-Bar (obere Leiste) des aufrufenden Frames wird
anstelle des Platzhalters '%FrameTitle%' in den Text eingefügt.
Im
Beispiel ist das die zweite Zeile des Textes.
Dieses
XML-Element enthält die Datei mit dem graphischen Symbol das
gemeinsam mit dem <WarningExplanationText>
angezeigt
wird und dem Anwender rasch signalisiert, dass eine Warnung und kein
schwerer Fehler aufgetreten ist.
Das XML-Element enthält nur
den Namen der Datei – ohne Verzeichnisstruktur.
Die
Basisklasse sucht diesen Dateinamen im Unterverzeichnis GRAPHICS im
Stamm-Unterverzeichnis des Anwendungsprogramms.
Die Beschreibung
der Verzeichnis-Struktur, die das JavaScout
Fat-Client-Framework
voraussetzt finden Sie im Dokument Verzeichnisstruktur
für die Entwicklung von Heavyweight-Clients mit dem JS-FCF.
In
dem in der Basisklasse JSBS_ErrorDialog
oder JSBS_UnstoredChangesDialog
erzeugten Dialog-Fenster wird das Graphische Symbol dann im oberen
rechten Bereich auf der [ Hilfe ]-Schaltfläche
angezeigt:
Dieses
XML-Element enthält die Datei mit dem graphischen Symbol das
gemeinsam mit dem <ErrorExplanationText>
angezeigt
wird und dem Anwender rasch signalisiert, dass ein schwerer Fehler
aufgetreten ist und das Anwendungsprogramm beendet werden muss.
Das
XML-Element enthält nur den Namen der Datei – ohne
Verzeichnisstruktur.
Die Basisklasse sucht diesen Dateinamen im
Unterverzeichnis GRAPHICS im Stamm-Unterverzeichnis des
Anwendungsprogramms.
Die Beschreibung der Verzeichnis-Struktur,
die das JavaScout
Fat-Client-Framework
voraussetzt finden Sie im Dokument Verzeichnisstruktur
für die Entwicklung von Heavyweight-Clients mit dem JS-FCF.
In
dem in der Basisklasse JSBS_ErrorDialog
erzeugten Dialog-Fenster wird das Graphische Symbol dann im oberen
rechten Bereich auf der [ Hilfe ]-Schaltfläche
angezeigt:
Wenn das Anwendungsprogramm unter einem Unix-Betriebssystem läuft und dieses XML-Element einen gültigen Dateinamen (inklusive Verzeichnisstruktur) enthält, wird bei Auftreten eines Ereignisses ein Eintrag in die hier festgelegte Datei geschrieben.
Wenn das Anwendungsprogramm unter einem Windows-Betriebssystem läuft und dieses XML-Element einen gültigen Dateinamen (inklusive Verzeichnisstruktur) enthält, wird bei Auftreten eines Ereignisses ein Eintrag in die hier festgelegte Datei geschrieben.
In diesem Abschnitt sind sprachabhängige Texte und weitere Parameter festgelegt die für das gesamte Anwendungsprogramm gelten.
Dieses
XML-Element kommt mehrmals (1 mal für jede Kombination der Werte
in <OriginClass>
und
<OriginCode>)
und enthält untergeordnete XML-Elemente mit
* einer
Anweisung ob das Auftreten des Ereignisses nur in die Log-Datei
geschrieben wird, dem Anwender eine Warnung angezeigt und das
Programm fortgesetzt wird oder ob das Programm wegen der Schwere des
Fehlers beendet werden muß (<Processing>);
*
dem Text des Fehlerhinweises oder der Warnung (<MessageText>);
*
alternativ zum <MessageText>
den
Verweis auf den Text eines anderen <Message>-Elementes
(<Reference>).
Das
Auslösen der Anzeige der Einträge in diesem XML-Element
erfolgt durch den Aufruf der Methode handleErrorEvent(...)
in
den Basisklassen JSBS_StartFrame
und JSBS_TaskFrame.
In
dieser Methode wird in weiterer Folge die Basisklasse
JSBS_ErrorDialog
aufgerufen die die Einträge in dieser Datei
('ErrorMessages.xml') liest und in einem Fenster anzeigt.
Dieser Wert ist der erste Teil der eindeutigen Identifikation eines – im Programm aufgetretenen – Ereignisses.
Der
Wert kann prinzipiell frei gewählt werden; empfehlenswert ist
aber, den Namen der Java-Klasse in dem das Ereignis aufgetreten ist,
zu verwenden.
Das Einhalten dieser Empfehlung hilft die Übersicht
zu bewahren und erleichtert das Finden der Ursache eines Eintrags in
der Log-Datei oder einer angezeigten Fehlermeldung oder Warnung.
Der
Wert wird auch in einem Feld des Fensters für Fehler oder
Warnungen angezeigt:
Dieser Wert ist der zweite Teil der eindeutigen Identifikation eines – im Programm aufgetretenen – Ereignisses.
Der
Wert kann prinzipiell frei gewählt werden; empfehlenswert ist
aber, eine Kurzform für die Ursache des Ereignisses zu
verwenden..
Zum Beispiel 'DupKey' (Duplikate Key / doppelter
Schlüssel) wenn der Anwender einen Datensatz erfassen will,
dessen Anwender-bekannter Schlüssel (eindeutige Identifikation
des Datensatzes) bereits für einen anderen Eintrag auf der
Datenbank verwendet wird.
Der
Wert wird auch in einem Feld des Fensters für Fehler oder
Warnungen angezeigt:
Dieser
Wert legt fest, welche Auswirkungen das Ereignis hat.
In der
Basisklasse JSBS_ErrorDialog
sind folgende Verarbeitungen definiert:
'L'
(Log): über das Auftreten dieses Ereignisses wird der Anwender
nicht informiert.
Wenn über das XML-Element <Logging>
so
festgelegt dann wird nur ein Eintrag in die Log-Datei geschrieben.
'W'
(Warnung): das Auftreten dieses Ereignisses zeigt eine Warnung für
den Anwender an; dabei wird der im XML-Element
<WarningExplanationText>
festgelegte
Information angezeigt. Darin wird darauf hingewiesen, dass die
Ursache der Warnung durch den Anwender korrigiert werden kann und
eine detaillierte Erklärung und Anweisung im XML-Element
<MessageText>
enthalten
ist.
Das Programm wird nach der Bestätigung durch den
Anwender fortgesetzt.
'D'
(Warnung): das Auftreten dieses Ereignisses zeigt eine Fehlermedlung
für den Anwender an; dabei wird der im XML-Element
<ErrorExplanationText>
festgelegte
Information angezeigt. Darin wird darauf hingewiesen, dass die
Ursache der Fehlermeldung so schwer ist, dass das Programm beendet
werden muß und eine detaillierte Erklärung im XML-Element
<MessageText>
enthalten
ist.
Das Programm wird nach der Bestätigung durch den
Anwender beendet.
Wenn kein XML-Element <Processing> vorhanden ist, wird in der Basisklasse JSBS_ErrorDialog der Wert 'D' (Dump) verwendet und das Programm beendet.
Dieser
Wert legt fest, ob für das Ereignis ein Eintrag in die Log-Datei
geschrieben wird.
Die genaue Verarbeitung dieses XML-Elements ist
in der Basisklasse JSBS_ErrorDialog
definiert.
Dieser Wert enthält die detaillierte Information über die Ursache des Fehlers oder der Warnung.
Der
Wert wird im unteren Teil des durch die Basisklasse JSBS_ErrorDialog
erstellten Fensters für Fehler oder Warnungen angezeigt:
In
diesem Text können auch Platzhalter für 5 verschiedene
Werte eingefügt werden.
Die Platzhalter werden als
%Parameter1%
bis
%Parameter5%
eingefügt.
Anstatt
dieser Platzhalter werden dann Werte angezeigt, die beim Aufruf der
Methode handleErrorEvent(...)
in
den Basisklassen JSBS_StartFrame
und JSBS_TaskFrame
als Parameter an die Methode übergeben werden.
Statt der individuellen Erstellung eines Textes für ein Ereignis ist es manchmal sinnvoll, einen generellen Text für gleichartige Ereignisse zu definieren.
Das
ist besonders dann sinnvoll,
* wenn der Anwender die Ursache des
Ereignisses ganz einfach korrigieren kann (z.B. bei einem 'Duplicate
Key')
oder
* der Anwender das Ereignis nicht verursacht hat
und damit auch den Grund nicht korrigieren kann.
Ein
Beispiel für ein Ereignis, dass durch den Anwender nicht
korrigiert werden kann ist ein Fehler beim Zugriff auf die
Datenbank.
Hauptursachen dafür sind meistens eine
Unterbrechung der Verbindung zur Datenbank oder ein Fehler in einem
SQL-Kommando (verursacht bei der Programmierung).
In diesen Fällen
reicht eine Information an den Anwender, dass ein 'technischer
Fehler' aufgetreten ist und er gebeten wird, einen Ausdruck
auszuführen.
Dieses XML-Element enthält den Wert der <OriginClass> der referenzierten <Message>.
Dieses XML-Element enthält den Wert des <OriginCode> der referenzierten <Message>.
|
Dokument |
Inhalt |
|
Fehlermeldungen und Warnungen verwalten :: ProjectAssist für das JavaScout Fat-Client-Framework |
Teilprogramm von JavaScout ProjectAssist zur Verwaltung von Fehlermeldungen und Warnungen. |
|
Datei mit der XML-Struktur mit Fehlermeldungen und Warnungen erstellen :: ProjectAssist für das JavaScout Fat-Client-Framework |
Teilprogramm von JavaScout ProjectAssist zum Generieren der Datei mit der XML-Struktur mit den Einträgen für Fehlermeldungen und Warnungen. |
|
JavaScout Basisklasse mit den Methoden zur Anzeige einer Fehlermeldung oder Warnung. |
|
|
JavaScout Basisklasse mit den Methoden zur Anzeige des Hinweises, dass Daten verändert aber nicht gespeichert wurden. |
|
|
JavaScout Basisklasse mit den Methoden zum Auslesen der XML-Elemente in dieser Datei 'ErrorMessages.xml'). |
|
|
Fehler und Warnungen – Generelle Beschreibung :: ProjectAssist für das JavaScout Fat-Client-Framework |
Für den Anwender bestimmte Hilfe-Dokumentation zur Anzeige von Fehlern und Warnungen als Beispiel für das Erscheinungsbild der in den JavaScout Basisklassen definierten Dialoge. |