Leitfaden für die Entwicklung von Heavyweight-Clients mit dem JS-FCF – Alle Schritte zur Entwicklung des Start-Frames

Inhaltsverzeichnis

Vorbedingungen 
Leitfaden – Notwendige Schritte 
Leitfaden – Abschließende Schritte 
Leitfaden – Schritte bei einer Client/Server Version 
Weitere Schritte und verwandte Dokumentation 

Vorbedingungen

Die Anleitungen in diesem Dokument werden Sie nur verstehen, wenn Sie bereits Kenntnisse über die Entwicklung von Heavyweight-Clients mit dem JavaScout-Fat-Client-Framework (JS-FCF) besitzen.

Wenn Sie zufällig auf dieses Dokument gestoßen sind und mehr über das JS-FCF wissen wollen, empfehle ich, mit dem Dokument Vorstellung des JavaScout-Fat-Client-Framework (JS-FCF) zu beginnen und – abhängig von Ihrer verfügbaren Zeit – das dort enthaltene Tutorial durchzuarbeiten.

▲ zum Inhaltsverzeichnis

Leitfaden – Notwendige Schritte

Wenn Sie mit dem JS-FCF Erfahrung haben, ist diese Übersicht als 'To Do Liste' zum 'Abhaken' der Tätigkeiten gedacht.
Bei jeder Tätigkeit ist in der Spalte in Stichworten ein 'Link' ([mehr...]) zu finden, der Sie zu einer detaillierteren Beschreibung der Tätigkeit führt.
In der Spalte Tutorial finden Sie den 'Link' zum entsprechenden Dokument im Tutorial für die Entwicklung von Fat-Clients mit Java.

▲ zum Inhaltsverzeichnis

Klasse für das Start-Frame eröffnen

• * 'Package' mit der Namenskonvention projektname.client.
  * Klassen mit der Namenskonvention ProjektName_CommandCenter.
  * Folgende Auswahlmöglichkeiten markieren bzw. nicht markieren:
    [X] public static void main(String[]args)
    [  ] Constructors from superclass
    [  ] Inherit abstract methods

• Code von Muster-Code für die Klassen eines Start-Frames > Muster-Code für die Klasse für das Frame (GUI) oder bestehendem Projekt kopieren und anpassen.
  'Angepasst' werden müssen:
  * Name des Packages;
  * Kommentar mit Beschreibung des Anwendungsprogramms,
  * Name der Klasse – durch Verwenden von 'Find/Replace' wird auch die Constructor-Methode, der aufgerufene ActionHandler und die Klasse für die Verbindung zum Java Application Server (JAS) geändert.

▲ zum Inhaltsverzeichnis

Klasse für den ActionHandler eröffnen

• * 'Package' mit der Namenskonvention projektname.client.
  * Klassen mit der Namenskonvention ProjektName_CommandCenter__ActionHandler.
  * Folgende Auswahlmöglichkeiten markieren bzw. nicht markieren:
    [  ] public static void main(String[]args)
    [  ] Constructors from superclass
    [  ] Inherit abstract methods

• Code von Muster-Code für die Klassen eines Start-Frames > Muster-Code für die Klasse für den ActionHandler oder bestehendem Projekt kopieren und anpassen.
  'Angepasst' werden müssen:
  * Name des Packages,
  * Name der Klasse; dabei wird auch der Name der als Parameter übergebenen Klasse für das CommandCenter verändert.
     Die Klasse für das CommandCenter kommt in der Klasse für den ActionHandler mehrmals vor.
  * 'Auskommentieren' des Aufrufs des 'TaskFrame' – nur notwendig wenn Sie die Warnung des Compilers stört.

▲ zum Inhaltsverzeichnis

Verbindung zur Datenbank herstellen

• Die Datei 'Connections.xml' mit den Parametern für die Verbindung zur Datenbank (oder zu einem Java-Application-Server) ist im Verzeichnis 'CONNECTIONS' enthalten. Ein Muster für die XML-Struktur finden Sie unter JavaScout ProjectAssist, Start-Frame Grundlagen (Java_Fatclient_01) – Weitere XML-Strukturen einlesen > Datei mit der XML-Struktur mit Parametern für die Datenbank-Verbindung erstellen.
  Eine Beschreibung der Wirkungsweise der einzelnen XML-Elemente finden Sie im Dokument Datei 'Connections.xml' mit Parametern für Datenbank und JAS.

• Das Anlegen der Datenbank wurde unter Leitfaden für die Entwicklung von Heavyweight-Clients mit dem JS-FCF - Vorbereitung > Einrichten der Datenbank beschrieben.
  Falls Sie dort diesen Schritt übersprungen haben und das Datenbanksystem MySQL verwenden:
  Eine Beschreibung für das MySQL-Datenbanksystem finden Sie im Dokument MySQL Datenbank für die Verwendung mit Java-Programmen einrichten.
  
  Für andere Datenbanksysteme befolgen Sie bitte die Anleitungen des Herstellers des Datenbanksystems.

▲ zum Inhaltsverzeichnis

Datenbank-Tabelle 'Parameter' anlegen

• In dieser Datenbank-Tabelle wird die Größe und Position eines Fensters gespeichert.
  Das Speichern und Lesen der Information ist in den Basisklassen des JavaScout BaseSystems (JSBS) implementiert.

• Eine Datei mit den SQL-Kommandos ist in der Datei JSBS_Initial_Texts.zip (Details im Dokument Sprachabhängige Texte und weitere Einstellungen aus der Zip-Datei mit den Mustern extrahieren) enthalten; und zwar die Datei 'Create_Tables.txt' im Verzeichnis 'DB_SCRIPTS'.
  
  Wie Sie die Datei mit den SQL-Kommandos ausführen ist in der Dokumentation des verwendeten Datenbanksystems beschrieben.
  Aus einer MySQL-Umgebung führen Sie die die SQL-Kommandos der Datei wie folgt aus:
  mysql> source /Verzeichnis/DB_SCRIPTS/Create_Tables.txt;

• Falls Sie – aus welchem Grund immer – die Datei 'Create_Tables.txt' nicht verwenden können folgen die SQL-Kommandos hier:
  CREATE TABLE Parameter (DataSetID DOUBLE NOT NULL PRIMARY KEY);
  ALTER TABLE Parameter ADD COLUMN ClientID INTEGER NOT NULL DEFAULT 0;
  ALTER TABLE Parameter ADD COLUMN ObjectID DOUBLE NOT NULL DEFAULT 0;
  ALTER TABLE Parameter ADD COLUMN CreatedBy VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN CreatedAt TIMESTAMP;
  ALTER TABLE Parameter ADD COLUMN ChangedBy VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN ChangedAt TIMESTAMP;
  ALTER TABLE Parameter ADD COLUMN ValidFrom DATE NOT NULL DEFAULT '1999-01-01';
  ALTER TABLE Parameter ADD COLUMN ValidTill DATE NOT NULL DEFAULT '7999-12-31';
  ALTER TABLE Parameter ADD COLUMN ParameterName CHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value01 VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value02 VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value03 VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value04 VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value05 VARCHAR(254) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value06 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value07 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value08 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value09 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value10 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value11 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value12 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value13 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value14 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value15 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value16 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value17 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value18 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value19 TEXT(2046) NOT NULL DEFAULT '';
  ALTER TABLE Parameter ADD COLUMN Value20 TEXT(2046) NOT NULL DEFAULT '';
  CREATE INDEX Parameter_IX01 ON Parameter (ClientID ASC, ParameterName ASC, Value01 ASC, Value02 ASC, ValidTill DESC, ValidFrom ASC);

▲ zum Inhaltsverzeichnis

Erfassen des Parameters für die Sprache und erstes Starten des Anwendungsprogramms

▲ zum Inhaltsverzeichnis

Sprachabhängigen Text für die GUI-Elemente erfassen

• Für die 'echte' Entwicklung von Anwendungsprogrammen wird die Verwendung von JavaScout ProjectAssist empfohlen.
  Dieses Anwendungsprogramm erleichtert die Verwaltung der sprachabhängigen Text-Bausteine – besonders wenn diese in mehr als einer Sprache erfasst werden müssen.
  
  Erleichtert wird der Umgang mit JavaScout ProjectAssist wenn Sie bereits die 'Start-Versionen' der sprachabhängigen Texte in das Eclipse-Project integriert haben.
  Die Anleitung dazu finden Sie im Dokument Leitfaden für die Entwicklung von Heavyweight-Clients mit dem JS-FCF – Sprachabhängige Texte und weitere Einstellungen aus der Zip-Datei mit den Mustern extrahieren.
  Wie Sie die Werte aus der 'Start-Version' importieren ist im Dokument JavaScout ProjectAssist::Leitfaden – Start-Frame (CommandCenter); Importieren von Standard-Layout und -Textbausteinen beschrieben.
  Wenn Sie JavaScout ProjectAssist verwenden wollen dann entpacken Sie Muster-Dateien zusätzlich zu dem Projekt-Verzeichnis auch in ein eigenes Verzeichnis !
  Grund dafür ist, dass nach dem 'Generieren' der Dateien für das Start-Frame (CommandCenter) die importierten Dateien im Projekt-Verzeichnis überschrieben werden und die Muster für ein Task-Frame verloren gehen würden.
  
  Wenn Sie JavaScout ProjectAssist verwendet haben setzen Sie bitte mit dem Abschnitt Test des CommandCenters mit sprachabhängigen Texten auf der Benutzeroberfläche fort.

• Alternative:
  Für einen ersten Eindruck über die Wirkungsweise der XML-Dateien ist die schnellste und einfachste Art eine 'Start-Version' der Datei mit den sprachabhängigen Texten zu erhalten, die 'gezipte' Muster-Datei herunterzuladen und deren Inhalt in das Eclipse-Project-Verzeichnis zu entpacken.
  Eine Detailbeschreibung finden Sie im Dokument Leitfaden für die Entwicklung von Heavyweight-Clients mit dem JS-FCF – Sprachabhängige Texte und weiter Einstellungen aus der Zip-Datei mit den Mustern extrahieren.
  
  Anschließend sind folgende XML-Elemente an Ihr aktuelles Anwendungsprogramm anzupassen:
  <FrameIndividual>
    <Frame>
      <FrameClass>js_base.frame.JSBS_ErrorDialog</FrameClass>
      <FrameTitle>Fehler oder Warnung – project-name and description / © 20xx creator</FrameTitle>
  . . . . . . .
    <Frame>
      <FrameClass>application_package.client.application_CommandCenter</FrameClass>
      <FrameTitle>CommandCenter – project-name and description / © 20xx creator</FrameTitle>
  . . . . . . .
  und
  <CommonElements>
  . . . . . . .
    <CommonElement>
      <ElementName>lbl_ApplicationTitle1</ElementName>
      <ElementText>project-name</ElementText>
      <ToolTipText>project-name and description</ToolTipText>
  . . . . . . .

• Weitere Alternative wenn Sie zur Übung die Datei manuell erstellen wollen:
  *  Eine detailierte Anleitung mit einem, auf die GUI-Elemente der Basisklasse JSBS_StartFrame abgestimmten, Muster-Inhalt für die Datei 'DisplayStrings.xml' finden Sie unter JavaScout ProjectAssist, Start-Frame Grundlagen (Java_Fatclient_01) – Text für die GUI-Elemente von XML-Datei einlesen > Verzeichnis und Datei mit der XML-Struktur mit den sprachabhängigen Texten erstellen.
  
  *  Zuerst ein Verzeichnis 'TEXT.sprache' erstellen.
  Dabei ist sprache durch den ISO-Code der gewählten Sprache zu ersetzen.
  Für die Dateien mit deutschen Texten muß der Verzeichnisname 'TEXT.de' sein.
  
  *  Innerhalb des Verzeichnisses wird die Datei 'DisplayStrings.xml' mit der Struktur für die sprachabhängigen Texte für GUI-Elemente erstellt.
  Eine Beschreibung der Wirkungsweise der einzelnen XML-Elemente finden Sie im Dokument Datei 'DisplayStrings.xml' mit sprachabhängigen Texten für die Anzeige auf der GUI.
  Dabei sind die Wert der oben aufgezählten XML-Elemente durch jene Werte zu ersetzen, die für Ihr Anwendungsprogramm zutreffen.

▲ zum Inhaltsverzeichnis

Zuordnung der Funktionstasten zu Schaltflächen

• Innerhalb des Verzeichnisses 'TEXT.sprache' wird die Datei 'FunctionKeys.xml' mit der Zuordnung von Funktionstasten zu Schaltflächen erstellt.
  Eine Beschreibung der Wirkungsweise der einzelnen XML-Elemente finden Sie im Dokument Datei 'FunctionKeys.xml' mit Zuordnung von Funktionstasten zu Schaltflächen (Buttons).

• Ein Muster für die Datei finden Sie im Tutorial JavaScout ProjectAssist, Start-Frame Finalisierung (Java_Fatclient_01) – Einbindung von Funktionstasten > Datei mit der XML-Struktur mit der Funktionstasten-Zuordnung erstellen .
  Alternativ zum händischen Editieren der Datei kann auch JavaScout ProjectAssist für die Verwaltung und das Generieren der XML-Strukturen verwendet werden.

▲ zum Inhaltsverzeichnis

Test des CommandCenters mit sprachabhängigen Texten auf der Benutzeroberfläche

▲ zum Inhaltsverzeichnis

Leitfaden – Abschließende Schritte

Für das Finalisieren des CommandCenters sind nur mehr wenige Tätigkeiten notwendig; diese können zu jedem beliebigen späteren Zeitpunkt ausgeführt werden ohne dass der Code geändert werden müsste.

▲ zum Inhaltsverzeichnis

Leitfaden – Schritte bei einer Client/Server Version

Für die Entwicklung einer Client/Server Version des Anwendungsprogramms ist Vorbedingung, dass die Klasse und die Interfaces für das Standard-EJB vorhanden sind.
Die Schritte für die Entwicklung eines EJB sind Teil des Dokuments Leitfaden für die Entwicklung von Heavyweight-Clients mit dem JS-FCF – Alle Schritte zur Entwicklung von DBA (DataBase-Access) und BO (Business-Object) Klassen.

▲ zum Inhaltsverzeichnis

Klasse für die JASConnections eröffnen

• * 'Package' mit der Namenskonvention projektname.client.
  * Klasse mit der Namenskonvention ProjektName_CommandCenter__JASConnections.
  * Folgende Auswahlmöglichkeiten markieren bzw. nicht markieren:
    [  ] public static void main(String[]args)
    [  ] Constructors from superclass
    [  ] Inherit abstract methods

• Code von Muster-Code für die Klassen eines Start-Frames > Muster-Code für die Klasse für die Klasse für die Verbindung zu EJB oder bestehendem Projekt kopieren und anpassen.
'Angepasst' werden müssen:
* Name des Packages.
* Import-Anweisung für die Klasse des Standard-EJB.
* Name der Klasse.
* Import der Klasse für das Standard-Bean.
* Änderung des Namens für das Standard-Bean.

▲ zum Inhaltsverzeichnis

Adaptieren der Klasse für das Start-Frame (CommandCenter)

• Um die Variable für ein Objekt der Klasse für das Standard-EJB zu definieren wird der Kommentar (//) im Platzhalter gleich nach der Definition der Klasse für das 'CommandCenter' entfernt und der wirkliche Name der Klasse für die JASConnections eingesetzt.
 */
public class application_CommandCenter extends JSBS_StartFrame {
/*
 * Klasse, die die Verbindung zu EJB herstellt.
 * Entfernen Sie den Kommentar wenn Sie das Anwendungsprogramm als
 * Client-Server-Version entwickeln.
 * Eine weitere Adaptierung (entfernung des Kommentars) bei einer CS-Version
 * ist in der Methode 'initialize_after_frame' notwendig. */
//    public application_CommandCenter__JASConnections
//               structapplication_CommandCenter__JASConnections;
/*
 * CONSTRUCTOR der Klasse.

• 'Konstruiert' (initialisiert) wird die Variable innerhalb der Methode initialize_after_frame().
Dazu wird im Platzhalter der Kommentar (//) entfernt und der wirkliche Name der Klasse für die JASConnections eingesetzt.
/* 
 * METHODE mit den Initialisierungen die notwendig sind nachdem das Frame (Window)
 * angezeigt wird. */
    private void initialize_after_frame() {
/* 
. . . . . .
. . . . . .
      if ((RunVersion == CONST_FatClient) || (RunVersion == CONST_MobileClient)) {
/* Datenzugriff über JAS (Java Application Server) notwendig:
 * 'konstruieren' der Klasse mit der/den Verbindung/en zu EJB. */
//        structapplication_CommandCenter__JASConnections =
//          new application_CommandCenter__JASConnections(this);
/* Abhängig vom Design des Anwendungsprogramms kann es auch sinnvoll sein, gleich
 * Methoden des EJB auszuführen. Die Aufrufe dafür können anschließend eingefügt werden. */
      }
/*
 * Mouse-Listener zu den Listen mit den wählbaren Geschäftsanwendungen und den
 * geöffneten Geschäftsanwendungen hinzufügen.

▲ zum Inhaltsverzeichnis

Parameter für die Verbindung zum JAS in der Datei Connections.xml festlegen

Abhängig vom verwendeten JAS (Java Application Server) sind verschiedene Parameter für den Aufbau der Verbindung erforderlich.
Anschließend finden Sie zwei Muster für JAS von JBoss und SUN / Glassfish.

Die XML-Struktur wird in der Datei Connections.xml festgelegt; eine detaillierte Beschreibung dieser Datei finden Sie unter Datei 'Connections.xml' mit Parametern für Datenbank und JAS.

Dabei ist der Eintrag <SymbolicName>Standard</SymbolicName> eine im JavaScout BaseSystem festgelegte Konvention für das Standard-EJB – der Wert Standard darf nicht verändert werden.
Die Kursiv geschriebenen Werte für den JNDI-Namen des EJB und die TCP/IP-Adresse des Computers auf dem der JAS läuft sind an Ihre aktuelle Konfiguration anzupassen.

Beachten Sie bitte, dass die geladenen Dateien mit Java-Klassen für die Verbindung zum JAS im Build Path des Project enthalten sein müssen !

• Die Parameter für die Verbindung zu einem JBoss JAS:
<Connections>
. . . . . .
. . . . . .
  <JASParameter>
    <SymbolicName>Standard</SymbolicName>
    <mappedJNDIName>ejb/applicationBeanJNDI</mappedJNDIName>
    <ConnectionProperty>
      <PropertyKey>java.naming.provider.url</PropertyKey>
      <PropertyValue>127.0.0.1:1099</PropertyValue>
    </ConnectionProperty>
    <ConnectionProperty>
      <PropertyKey>java.naming.factory.initial</PropertyKey>
      <PropertyValue>org.jnp.interfaces.NamingContextFactory</PropertyValue>
    </ConnectionProperty>
    <ConnectionProperty>
      <PropertyKey>java.naming.factory.url.packages</PropertyKey>
      <PropertyValue>org.jboss.naming:org.jnp.interfaces</PropertyValue>
    </ConnectionProperty>
  </JASParameter>
</Connections>

• Die Parameter für die Verbindung zu einem SUN / Glassfish JAS:
<Connections>
. . . . . .
. . . . . .
  <JASParameter>
    <SymbolicName>Standard</SymbolicName>
    <mappedJNDIName>ejb/applicationBeanJNDI</mappedJNDIName>
    <ConnectionProperty>
      <PropertyKey>org.omg.CORBA.ORBInitialHost</PropertyKey>
      <PropertyValue>127.0.0.1</PropertyValue>
    </ConnectionProperty>
    <ConnectionProperty>
      <PropertyKey>org.omg.CORBA.ORBInitialPort</PropertyKey>
      <PropertyValue>3700</PropertyValue>
    </ConnectionProperty>
    <ConnectionProperty>
      <PropertyKey>java.naming.factory.initial</PropertyKey>
      <PropertyValue>com.sun.enterprise.naming.SerialInitContextFactory</PropertyValue>
    </ConnectionProperty>
    <ConnectionProperty>
      <PropertyKey>java.naming.factory.url.pkgs</PropertyKey>
      <PropertyValue>com.sun.enterprise.naming</PropertyValue>
    </ConnectionProperty>
    <ConnectionProperty>
      <PropertyKey>java.naming.factory.state</PropertyKey>
      <PropertyValue>com.sun.corba.ee.impl.presentation.rmi.JNDIStateFactoryImpl</PropertyValue>
    </ConnectionProperty>
  </JASParameter>
</Connections>

▲ zum Inhaltsverzeichnis

'Umschalten' auf Client-Server Version

• Das 'Umschalten' von der Einzelplatz- zur Client-Server Version erfolgt durch das Ändern des Wertes der Variable RunVersion .
Diese Variable ist in der Basisklasse JSBS_StartFrame definiert.
Für das Ändern des Wertes muss der im Muster für das aktuelle Start-Frame (CommandCenter) enthaltene 'Kommentar' entfernt werden.
/* 
 * METHODE mit den Initialisierungen die notwendig sind bevor das Frame (Window)
 * angezeigt wird. */
    private void initialize_before_frame(String parmstrLanguageCode) {
/* 
 * Festlegen mit welcher Art von Datenzugriff das Programm arbeitet.
 * Die Variable und die Konstanten sind in der geerbten Basisklasse (JSBS_StartFrame)
 * definiert. */
/*
 * Bitte versehen Sie die nicht verwendeten Möglichkeiten mit einem 'Kommentar' (//). */
      RunVersion = CONST_StandAlone;
//    RunVersion = CONST_FatClient;
//    RunVersion = CONST_MobileClient;
/* 

▲ zum Inhaltsverzeichnis

Weitere Schritte und verwandte Dokumentation

▲ zum Inhaltsverzeichnis