Trace:
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
de:jvx:firstapp [2018/01/25 09:53] admin created |
de:jvx:firstapp [2024/11/18 10:29] (current) admin |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | In the following paragraphs, we will show you how to create your first JVx application with minimal effort and code. | + | ~~Title: Erste JVx Applikation~~ |
| - | The application's task is to display data from a database table and make the data editable. | + | In den folgenden Absätzen zeigen wir Ihnen wie Sie mit wie wenig Aufwand und Code ihre erste JVx Applikation erstellen können. |
| - | Before you start you will need the following libraries and tools: | + | Die Aufgabe der Applikation ist, die Daten aus einer Datenbanktabelle darzustellen und bearbeitbar zu machen. |
| - | * [[http://sourceforge.net/projects/jvx/files/latest/download|JVx Binary package]] | + | Vor dem Start benötigen Sie folgende Libraries und Werkzeuge: |
| - | * Eclipse IDE (>= 3.4) with JDT (recommended: Eclipse IDE for Java EE developers) | + | |
| - | * JDK 6.0 (1.6) or higher | + | |
| - | * HSQLDB library (http://www.hsqldb.org) | + | |
| - | * [[http://sourceforge.net/projects/jvxfirstapp/files/latest/download|JVx sample Eclipse project]] | + | |
| - | For our JVx sample application we need the following parts: | + | * [[http://sourceforge.net/projects/jvx/files/latest/download|JVx Binärpaket]] |
| + | * Eclipse IDE (>= 3.4) mit JDT (Empfohlen wird: Eclipse IDE für Java EE Entwickler) | ||
| + | * JDK 8.0 (1.8) oder höher | ||
| + | * HSQLDB Bibliothek (http://www.hsqldb.org) | ||
| + | * [[http://sourceforge.net/projects/jvxfirstapp/files/latest/download|JVx Beispiel Eclipse Projekt]] | ||
| - | * [[#application|Application]] | + | Für unsere JVx Beispiel Applikation benötigen wir folgende Teile: |
| - | * [[#workscreen|Work screen]] | + | |
| - | * [[#workscreen|Business object]] | + | * [[#application|Applikation]] |
| - | * [[#database|Database connection]] | + | * [[#workscreen|Workscreen]] |
| + | * [[#workscreen|Business Objekt]] | ||
| + | * [[#database|Datenbankverbindung]] | ||
| {{anchor:application:}} | {{anchor:application:}} | ||
| - | == Create an application == | + | == Erstellen einer Applikation == |
| - | We need an application as a frame for the client. Each application must implement the interface ''javax.rad.application.IApplication''. In our example, we derive from the standard implementation ''com.sibvisions.rad.application.Application'', whereby we use the following code: | + | Für den Client benötigen wir eine Applikation als Rahmen. Jede Applikation muss das Interface ''jvx.rad.application.IApplication'' implementieren. Wir leiten uns in unserem Beispiel von der Standard Implementierung ''com.sibvisions.rad.application.Application'' ab, wobei wir folgenden Code verwenden: |
| <file java FirstApplication.java> | <file java FirstApplication.java> | ||
| package apps.firstapp; | package apps.firstapp; | ||
| - | import javax.rad.application.genui.UILauncher; | + | import jvx.rad.application.genui.UILauncher; |
| - | import javax.rad.genui.UIImage; | + | import jvx.rad.genui.UIImage; |
| - | import javax.rad.genui.component.UIButton; | + | import jvx.rad.genui.component.UIButton; |
| - | import javax.rad.genui.container.UIToolBar; | + | import jvx.rad.genui.container.UIToolBar; |
| - | import javax.rad.genui.menu.UIMenu; | + | import jvx.rad.genui.menu.UIMenu; |
| - | import javax.rad.genui.menu.UIMenuItem; | + | import jvx.rad.genui.menu.UIMenuItem; |
| - | import javax.rad.remote.IConnection; | + | import jvx.rad.remote.IConnection; |
| import com.sibvisions.rad.application.Application; | import com.sibvisions.rad.application.Application; | ||
| Line 39: | Line 41: | ||
| /** | /** | ||
| * First application with JVx, Enterprise Application Framework. | * First application with JVx, Enterprise Application Framework. | ||
| - | * <p/> | + | * |
| * @author René Jahn | * @author René Jahn | ||
| */ | */ | ||
| Line 51: | Line 53: | ||
| * Creates a new instance of <code>FirstApplication</code> with a technology | * Creates a new instance of <code>FirstApplication</code> with a technology | ||
| * dependent launcher. | * dependent launcher. | ||
| - | * <p/> | + | * |
| * @param pLauncher the technology dependent launcher | * @param pLauncher the technology dependent launcher | ||
| + | * @throws Exception if initialization fails | ||
| */ | */ | ||
| - | public FirstApplication(UILauncher pLauncher) | + | public FirstApplication(UILauncher pLauncher) throws Exception |
| { | { | ||
| super(pLauncher); | super(pLauncher); | ||
| Line 122: | Line 125: | ||
| /** | /** | ||
| * Opens the edit screen. | * Opens the edit screen. | ||
| - | * <p/> | + | * |
| * @throws Throwable if the edit frame can not be opened | * @throws Throwable if the edit frame can not be opened | ||
| */ | */ | ||
| Line 137: | Line 140: | ||
| </file> | </file> | ||
| - | ^ Method ^ Description ^ | + | ^ Methode ^ Beschreibung ^ |
| - | |Constructor|A specific constructor is needed, as each application is started with a launcher which depends on the technology used. This launcher is passed over to the application in the constructor.| | + | |Konstruktor|Es wird ein eigener Konstruktor benötigt, da jede Applikation mit einem Technologieabhängigen Launcher gestartet wird. Dieser Launcher wird bereits im Konstruktor an die Applikation übergeben.| |
| - | |createConnection|The communication protocol is initialised. A ''DirectServerConnection'' is sufficient for our application, as both the client and the server are started in the same VM. However, if an application server is integrated, a ''HttpConnection'' could also be used.| | + | |createConnection|Das Kommunikationsprotokoll wird initialisiert. Für unsere Applikation ist eine ''DirectServerConnection'' ausreichend, da sowohl Client als auch Server in der selben VM gestartet werden. Wird jedoch ein Applikationsserver eingesetzt könnte alternativ eine ''HttpConnection'' verwendet werden.| |
| - | |getApplicationName|Sets the application name. This name is needed for the communication with the server, as the latter uses the appropriate application configuration depending on the application name. In our case, the application name must be firstapp as the working directory is also called ''../JVxFirstApp/rad/**firstapp**/''.| | + | |getApplicationName|Legt den Applikationsnamen fest. Dieser Name wird für die Kommunikation mit dem Server benötigt, da dieser abhängig vom Applikationsnamen die passende Applikationskonfiguration verwendet. In unserem Fall muss der Applikationsname firstapp lauten, da das Arbeitsverzeichnis ''../JVxFirstApp/rad/**firstapp**/'' ebenso lautet..| |
| - | |afterLogin|This method is called by the super class after a successful login. We use this method to extend our menu and our toolbar.\\ \\ It is not necessary to reset the changes after logout, as this is done automatically by the super class.| | + | |afterLogin|Diese Methode wird von der Superklasse aufgerufen, nachdem eine erfolgreiche Anmeldung durchgeführt wurde. Wir verwenden diese Methode um unser Menü und unsere ToolBar zu erweitern.\\ \\ Es ist nicht nötig nach der Abmeldung die Änderungen rückgängig zu machen, da dies von der Superklasse übernommen wird.| |
| - | |createMenuItem|Provided by the super class to create menu entries. The first parameter contains the name of the method which is to be called when the menu entry is selected. The second parameter contains the command (ActionCommand) which plays no role in our case. The text of the menu entry is to be defined in the third parameter, and lastly the image for the entry is passed over.| | + | |createMenuItem|Wird von der Superklasse bereitgestellt um Menü Einträge zu erstellen. Der erste Parameter enthält die Bezeichnung der Methode die aufgerufen werden soll wenn der Menü Eintrag gedrückt wird. Der zweite Parameter enthält den Befehl (ActionCommand) der in unserem Fall keine Rolle spielt. Im dritten Parameter ist der Text des Menü Eintrags zu definieren und abschließend wird das Bild für den Eintrag übergeben.| |
| - | |createToolBarButton|Similar to ''createMenuItem'', except that this method creates a button which adapts to the layout of the toolbar.| | + | |createToolBarButton|Ähnlich wie ''createMenuItem'' nur wird hierbei ein Button erzeugt, der sich dem Layout der ToolBar anpasst.| |
| - | |UIImage.getImage|Provides a predefined image from the JVx image library. For ease of use, we use a predefined image.| | + | |UIImage.getImage|Liefert ein vordefiniertes Bild aus der Bild Bibliothek von JVx. \\ Wir verwenden zwecks Komfort ein vordefiniertes Bild.| |
| - | |doOpenDBEdit|This method is called when the menu or the toolbar button are pressed and calls the corresponding work screen.| | + | |doOpenDBEdit|Diese Methode wird aufgerufen wenn das Menü oder der ToolBar Button gedrückt werden und ruft den entsprechenden Workscreen auf.| |
| - | |configureFrame|This method is provided by the super class and ensures that all frames look the same. This includes the menu icon.| | + | |configureFrame|Diese Methode wird von der Superklasse bereitgestellt und sorgt dafür, dass alle Frames einheitlich aussehen. Dazu zählt unter anderem das Menü Icon.| |
| {{anchor:workscreen:}} | {{anchor:workscreen:}} | ||
| - | == Create a work screen == | + | == Erstellen eines Workscreens == |
| - | Once we have created the application framework, we now reate our first work screen with the following code: | + | Nachdem wir den Applikationsrahmen fertig erstellt haben, erstellen wir nun unseren ersten Workscreen mit folgenden Code: |
| <file java DBEditFrame.java> | <file java DBEditFrame.java> | ||
| package apps.firstapp.frames; | package apps.firstapp.frames; | ||
| - | import javax.rad.genui.container.UIGroupPanel; | + | import jvx.rad.genui.container.UIGroupPanel; |
| - | import javax.rad.genui.container.UIInternalFrame; | + | import jvx.rad.genui.container.UIInternalFrame; |
| - | import javax.rad.genui.control.UITable; | + | import jvx.rad.genui.control.UITable; |
| - | import javax.rad.genui.layout.UIBorderLayout; | + | import jvx.rad.genui.layout.UIBorderLayout; |
| - | import javax.rad.remote.AbstractConnection; | + | import jvx.rad.remote.AbstractConnection; |
| - | import javax.rad.remote.MasterConnection; | + | import jvx.rad.remote.MasterConnection; |
| import com.sibvisions.rad.application.Application; | import com.sibvisions.rad.application.Application; | ||
| Line 169: | Line 172: | ||
| /** | /** | ||
| * A simple database table editor. | * A simple database table editor. | ||
| - | * <p/> | + | * |
| * @author René Jahn | * @author René Jahn | ||
| */ | */ | ||
| Line 196: | Line 199: | ||
| /** | /** | ||
| * Creates a new instance of DBEditFrame for a specific application. | * Creates a new instance of DBEditFrame for a specific application. | ||
| - | * <p/> | + | * |
| * @param pApp the application | * @param pApp the application | ||
| * @throws Throwable if the remote access fails | * @throws Throwable if the remote access fails | ||
| Line 212: | Line 215: | ||
| /** | /** | ||
| * Initializes the model. | * Initializes the model. | ||
| - | * <p/> | + | * |
| * @throws Throwable if the initialization throws an error | * @throws Throwable if the initialization throws an error | ||
| */ | */ | ||
| Line 234: | Line 237: | ||
| /** | /** | ||
| * Initializes the UI. | * Initializes the UI. | ||
| - | * <p/> | + | * |
| * @throws Exception if the initialization throws an error | * @throws Exception if the initialization throws an error | ||
| */ | */ | ||
| Line 259: | Line 262: | ||
| </file> | </file> | ||
| - | ^ Method ^ Description ^ | + | ^ Methode ^ Beschreibung ^ |
| - | |initializeModel|Initialises the client objects for the access to the server or the data.| | + | |initializeModel|Instanziert die Client Objekte für den Zugriff auf den Server bzw. die Daten.| |
| - | |InitializeUI|Layouting of the work screen.| | + | |InitializeUI|Layouting des WorkScreen.| |
| - | |createSubConnection|We create a separate connection to the server. This has the advantage that a separate business object is used on the server. This object contains all objects needed by the work screen. Once the work screen is closed, the used memory is released. Moreover, each connection can have special parameters and time outs. \\ The requested business object is defined with the following class: ''apps.firstapp.frames.DBEdit''. \\ \\ The class will be created later on.| | + | |createSubConnection|Wir erstellen eine eigene Verbindung zum Server. Das hat den Vorteil, dass am Server ein eigenes Business Objekt verwendet wird. Dieses Objekt hält alle Objekte, die vom WorkScreen benötigt werden. Nachdem der WorkScreen geschlossen wird, wird auch der benutzte Speicher wieder freigeben. Weiters kann jede Verbindung spezielle Parameter und Timeouts haben.. \\ Das gewünschte Business Objekt wird mit der Klassenbezeichnung definiert: ''apps.firstapp.frames.DBEdit''. \\ \\ Die Klasse erstellen wir im Anschluß.| |
| - | ^ Member ^ Description ^ | + | ^ Member ^ Beschreibung ^ |
| - | |connection|The connection to the server, specially for the work screen. A special communication protocol is used in the background. In our case, it mirrors the ''DirectServerConnection'' class.| | + | |connection|TDie Verbindung zum Server, speziell für den WorkScreen. Im Hintergrund wird ein spezielles Kommunikationsprotokoll verwendet. In unserem Fall spiegelt dieses die Klasse ''DirectServerConnection'' wieder.| |
| - | |dataSource|This is the data source and looks after the transfer of data between the client and the server. The connection is used for the transfer.| | + | |dataSource|Die DataSource ist die Datenquelle und kümmert sich um die Übertragung der Daten zwischen Client und Server. Für den Transfer wird die connection verwendet.| |
| - | |rdbContacts|The model and the controller for data display. \\ The name contacts defines under which name the server-side business object can be found.| | + | |rdbContacts|Das Model und der Controller für die Datenanzeige. \\ Der Name contacts legt fest unter welchen Namen das serverseitige Business Objekt zu finden ist.| |
| {{anchor:business:}} | {{anchor:business:}} | ||
| - | == Create a business object == | + | == Erstellen des Business Objekts == |
| - | Once we have created the client, we need the corresponding business object on the server, so as to define the source of the data more precisely. To do so, we use the following code: | + | Nachdem wir den Client fertig erstellt haben, benötigen wir am Server noch das dazugehörige Business Objekt, um die Quelle der Daten näher zu definieren. Dazu verwenden wir folgenden Code: |
| <file java DBEdit.java> | <file java DBEdit.java> | ||
| package apps.firstapp.frames; | package apps.firstapp.frames; | ||
| - | import javax.rad.persist.IStorage; | + | import jvx.rad.persist.IStorage; |
| import com.sibvisions.rad.persist.jdbc.DBStorage; | import com.sibvisions.rad.persist.jdbc.DBStorage; | ||
| Line 285: | Line 288: | ||
| /** | /** | ||
| * The LCO for the DBEdit WorkScreen. | * The LCO for the DBEdit WorkScreen. | ||
| - | * <p/> | + | * |
| * @author René Jahn | * @author René Jahn | ||
| */ | */ | ||
| Line 321: | Line 324: | ||
| </file> | </file> | ||
| - | ^ Description ^ | + | ^ Beschreibung ^ |
| - | |The class mirrors the business object for the ''DBEditFrame'' work screen. The objects can only be accessed via the SubConnection of the work screen. \\ Through the class derivation of ''apps.firstapp.Session'', it is very easy to access all objects of the Session and the ''Application''.| | + | |Die Klasse spiegelt das Business Objekt für den ''DBEditFrame'' WorkScreen wieder. Auf die Objekte kann ausschließlich über die ''SubConnection'' des WorkScreens zugegriffen werden. \\ \\ Durch die Ableitung von ''apps.firstapp.Session'' kann auf einfachste Art und Weise auf sämtliche Objekte der ''Session'' und der ''Application'' zugegriffen werden.| |
| - | ^ Method ^ Description ^ | + | ^ Methode ^ Beschreibung ^ |
| - | |getContacts|Enables the access to the database tablee ''CONTACTS''. The method name must match the object name of the RemoteDataBook: ''contacts => getContacts''. \\ \\ Exception handling is taken over by the server.| | + | |getContacts|Ermöglicht den Zugriff auf die Datenbanktabelle ''CONTACTS''. Der Methodenname muss dem Objektnamen des RemoteDataBook entsprechen: ''contacts => getContacts''. \\ \\ Das Exception Handling wird vom Server übernommen.| |
| {{anchor:database:}} | {{anchor:database:}} | ||
| - | == Create a database connection == | + | == Erstellen der Datenbankverbindung == |
| - | In the business object, we referred to the data source with the method ''getDBAccess()''. In our case we use a HyperSQL database. We define the database connection in the following class: | + | Im Business Objekt haben wir mit der Methode getDBAccess() auf die Datenquelle verwiesen. In unserem Fall verwenden wir eine HyperSQL Datenbank. In folgender Klasse definieren wir die Datenbankverbindung: |
| <file java Session.java> | <file java Session.java> | ||
| Line 340: | Line 343: | ||
| /** | /** | ||
| * The LCO for the session. | * The LCO for the session. | ||
| - | * <p/> | + | * |
| * @author René Jahn | * @author René Jahn | ||
| */ | */ | ||
| Line 377: | Line 380: | ||
| </file> | </file> | ||
| - | ^ Method ^ Description ^ | + | ^ Methode ^ Beschreibung ^ |
| - | |getDBAccess|Opens a new connection to a HSQL database, if this has not yet occurred. \\ \\ Exception handling is taken on by the server.| | + | |getDBAccess|Öffnet eine neue Verbindung zu einer HSQL Datenbank, falls dies nicht bereits geschehen ist. \\ \\ Das Exception Handling wird vom Server übernommen.| |
| \\ | \\ | ||
| - | The application is now fully implemented and ready to run. To be able to work with the application we need the database including the ''CONTACTS'' table which we want to access. It has already been created in the Eclipse project and can be started with ''../JVxFirstApp/db/startHSqlDB.bat''. | + | Die Applikation ist jetzt vollständig implementiert und lauffähig. Damit wir nun mit der Applikation arbeiten können benötigen wir die Datenbank inklusive Tabelle ''CONTACTS'' auf die wir zugreifen wollen. Diese ist im Eclipse Projekt bereits erstellt worden und kann mit ''../JVxFirstApp/db/startHSqlDB.bat'' gestartet werden. |
| - | == The first JVx application == | + | == Die erste JVx Applikation == |
| - | Once the database has been started, the application can be started via the Run menu in Eclipse. The finished application should now look as follows: | + | Nachdem die Datenbank gestartet wurde, kann die Applikation über das Run Menü von Eclipse gestartet werden. Die fertige Applikation sollte nun wie folgt aussehen: |
| {{:jvx:app_finished.png?nolink|}} | {{:jvx:app_finished.png?nolink|}} | ||
| - | You can find more details about the components of a JVx application as well as step by step instructions for Eclipse under [[jvx:firstapp_step-by-step|Step by step introductions to the JVx application]]. | + | Mehr Details zu den Bestandteilen einer JVx Applikation sowie eine Schritt für Schritt Eclipse Anleitung finden sie unter [[de:jvx:firstapp_step-by-step|Schritt für Schritt Anleitung zur JVx Applikation]]. |