Differences

This shows you the differences between two versions of the page.

--- jvx:firstapp_step-by-step [2020/06/08 12:55]
cduncan
+++ jvx:firstapp_step-by-step [2024/11/18 10:15] (current)
admin
@@ Line 1: / Line 1: @@
-~~Title: First JVx Application (Step-by-Step)~~
+~~Title: First JVx Application (Step by Step)~~
-The aim of this tutorial is to create an application with the Enterprise Application Framework – [[https://jvx.sibvisions.com|JVx]]. Moreover, a quick overview of the framework's possibilities will be given.
+The aim of this tutorial is to create an application with the Enterprise Application Framework. Moreover, a quick overview of the framework's possibilities will be given.
-The application's task is to display the data from a database table and make them editable. The application requests authentication with user name and password.
+The application's task is to display the data from a database table and make them editable. The application requests authentication with username and password.
 The following skills and tools are needed:
@@ Line 9: / Line 9: @@
   * [[http://sourceforge.net/projects/jvx/files/latest/download|JVx Binary package]]
   * Eclipse IDE (>= 3.4) with JDT (recommended: Eclipse IDE for Java EE developers)
-  * JDK 6.0 (1.6) or higher
+  * JDK 8.0 (1.8) or higher
   * HSQLDB library (http://www.hsqldb.org)
   * Database and SQL skills
@@ Line 15: / Line 15: @@
 This documentation covers the following areas:
-  * [[#folder_structure|JVx folder structure]]
+  * [[#folder_structure|JVx Folder Structure]]
-  * [[#project_configuration|Eclipse project configuration]]
+  * [[#project_configuration|Eclipse Project Configuration]]
-  * [[#application_development|Application development]]
+  * [[#application_development|Application Development]]
       * Client
       * Server
-  * [[#create_a_work_screen|Creation of a work screen]]
+  * [[#create_a_workscreen|Creation of a Workscreen]]
-  * [[#create_database|Use of a HyperSQL database]]
+  * [[#create_database|Use of a HyperSQL Database]]
 == Folder Structure ==
@@ Line 91: / Line 91: @@
 ^Parameter^Description^
-|securitymanager/class|The security manager for verification of the user names/password when logging into the application.|
+|securitymanager/class|The security manager for verification of the usernames/password when logging into the application.|
 |securitymanager/usersfile|The file with the username/password combinations allowed.|
 |lifecycle/mastersession|The class name of the server object that is instantiated when the client performs a login or starts a new MasterSession.|
@@ Line 98: / Line 98: @@
 The server configuration file must be stored in the folder ''../JVxFirstApp/rad/server''.
-However, the folder does not appear in our Eclipse project, because it is at a higher folder level. The configuration file could be created directly in the file system, or we can create a folder link in our project:
+However, the folder does not appear in our Eclipse project because it is at a higher folder level. The configuration file could be created directly in the file system, or we can create a folder link in our project:
   * **File** / **New** / **Folder** \\ {{:jvx:server_link.png?nolink|}}
@@ Line 114: / Line 114: @@
 </server>
 </file>
-The server does not need any special parameters for our application. \\ \\ For the client, we now need a class of type ''javax.rad.application.IApplication''. A standard implementation of JVx is implemented via ''com.sibvisions.rad.application.Application''. We then derive our client from it and thereby create a class in the directory ''src.client'' with the following source code:
+The server does not need any special parameters for our application. \\ \\ For the client, we now need a class of type ''jvx.rad.application.IApplication''. A standard implementation of JVx is implemented via ''com.sibvisions.rad.application.Application''. We then derive our client from it and thereby create a class in the directory ''src.client'' with the following source code:
 <file java FirstApplication.java>
 package apps.firstapp;
-import javax.rad.application.genui.UILauncher;
+import jvx.rad.application.genui.UILauncher;
-import javax.rad.remote.IConnection;
+import jvx.rad.remote.IConnection;
 import com.sibvisions.rad.application.Application;
@@ Line 127: / Line 127: @@
 /**
  * First application with JVx, Enterprise Application Framework.
- * <p/>
+ *
  * @author René Jahn
  */
@@ Line 139: / Line 139: @@
    * Creates a new instance of <code>FirstApplication</code> with a technology
    * dependent launcher.
-   * <p/>
+   *
    * @param pLauncher the technology dependent launcher
+   * @throws Exception if initialization fails
    */
-  public FirstApplication(UILauncher pLauncher)
+  public FirstApplication(UILauncher pLauncher) throws Exception
   {
     super(pLauncher);
@@ Line 174: / Line 175: @@
 ^Method^Description^
 |Constructor|The standard constructor cannot be used, as each application is started with a technology-dependent launcher. This launcher is already passed to the application in the constructor.|
-|createConnection|The communication protocol is initialized. A ''DirectServerConnection'' is sufficient for our application, because both the client and the server are started in the same VM. However, if an application server is in use, a ''HttpConnection'' could also be used.|
+|createConnection|The communication protocol is initialized. A ''DirectServerConnection'' is sufficient for our application because both the client and the server are started in the same VM. However, if an application server is in use, a ''HttpConnection'' could also be used.|
 |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'', because the work directory is also called ''../JVxFirstApp/rad/**firstapp**/''. The application name MUST always match the directory name!|
@@ Line 213: / Line 214: @@
 == Create a Workscreen==
-Before we create a Workscreen, we prepare the application to display the Workscreen. To do so, we extend our ''FirstApplication'' class as follows:
+Before we create a workscreen, we prepare the application to display the workscreen. To do so, we extend our ''FirstApplication'' class as follows:
 <file java FirstApplication.java>
 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;
@@ Line 231: / Line 232: @@
 /**
  * First application with JVx, Enterprise Application Framework.
- * <p/>
+ *
  * @author René Jahn
  */
@@ Line 243: / Line 244: @@
    * Creates a new instance of <code>FirstApplication</code> with a technology
    * dependent launcher.
-   * <p/>
+   *
    * @param pLauncher the technology dependent launcher
    */
@@ Line 325: / Line 326: @@
 ^Method^Description^
 |afterLogin|This method is invoked form the super class after a successful login. We use this method to extend our menu and our toolbar. \\ \\ It is not necessary to undo our changes after logout as this is done by the super class.|
-|doOpenDBEdit|This method is called when the Menu or the toolbar button is selected.|
+|doOpenDBEdit|This method is called when the menu or the toolbar button is selected.|
-|createMenuItem|Provided by the super class to create menu entries. The first parameter contains the name of the method that is to be called when the menu entry is selected. The second parameter contains the command (ActionCommand) which does not play any 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.|
+|createMenuItem|Provided by the super class to create menu entries. The first parameter contains the name of the method that is to be called when the menu entry is selected. The second parameter contains the command (ActionCommand) which does not play any 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.|
 |createToolBarButton|Similar to ''createMenuItem'', except here a button is created which adjusts itself to the layout of the toolbar.|
 |UIImage.getImage|Provides a predefined image from the image library of JVx. \\ We use a predefined image for convenience.|
@@ Line 339: / Line 340: @@
 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;
@@ Line 352: / Line 353: @@
 /**
  * A simple database table editor.
- * <p/>
+ *
  * @author René Jahn
  */
@@ Line 379: / Line 380: @@
   /**
    * Creates a new instance of DBEditFrame for a specific application.
-   * <p/>
+   *
    * @param pApp the application
    * @throws Throwable if the remote access fails
@@ Line 395: / Line 396: @@
   /**
    * Initializes the model.
-   * <p/>
+   *
    * @throws Throwable if the initialization throws an error
    */
@@ Line 417: / Line 418: @@
   /**
    * Initializes the UI.
-   * <p/>
+   *
    * @throws Exception if the initialization throws an error
    */
@@ Line 469: / Line 470: @@
 |initializeModel|Instantiates the objects for access to the server or data.|
 |InitializeUI|Layout of the workscreen.|
-|dispose|Ends the connection to the server for the Workscreen and closes the frame. The connection must not be explicitly closed, as this takes place fully automatically by the GarbageCollector. This is, however, not a drawback in our first application.|
+|dispose|Ends the connection to the server for the workscreen and closes the frame. The connection must not be explicitly closed, as this takes place fully automatically by the GarbageCollector. This is, however, not a drawback in our first application.|
-|createSubConnection|We create our own connection to the server. This has the advantage that a separate lifecycle object is used on the server. This object contains all objects which are needed by the Workscreen. Once the Workscreen is closed, the used memory is released. Moreover, each connection can have special parameters and timeouts. The requested lifecycle object is defined with the class name: ''apps.firstapp.frames.DBEdit''. \\ \\ The class we will create later.|
+|createSubConnection|We create our own connection to the server. This has the advantage that a separate lifecycle object is used on the server. This object contains all objects which are needed by the workscreen. Once the workscreen is closed, the used memory is released. Moreover, each connection can have special parameters and timeouts. The requested lifecycle object is defined with the class name: ''apps.firstapp.frames.DBEdit''. \\ \\ The class we will create later.|
 ^Member^Description^
-|connection|The connection to the server, especially for the Workscreen. A special communication protocol is used in the background. In our case, it is represented by the class ''DirectServerConnection''.|
+|connection|The connection to the server, especially for the workscreen. A special communication protocol is used in the background. In our case, it is represented by the class ''DirectServerConnection''.|
-|dataSource|The datasource is independent of the communication protocol and takes care of the data transfer between client and server. The connection defines under which name the server-side object is to be found in the Lifecycle object.|
+|dataSource|The data source is independent of the communication protocol and takes care of the data transfer between client and server. The connection defines under which name the server-side object is to be found in the lifecycle object.|
 |rdbContacts|The model and the controller for data display. \\ The name ''contacts'' defines under which name the server-side business object can be found.|
 |table|The view for data display.|
-The Workscreen is now ready and can be integrated in the application. We now implement the missing call:
+The workscreen is now ready and can be integrated in the application. We now implement the missing call:
 <file java FirstApplication.java>
@@ Line 489: / Line 490: @@
   /**
    * Opens the edit screen.
-   * <p/>
+   *
    * @throws Throwable if the edit frame can not be opened
    */
@@ Line 519: / Line 520: @@
 /**
  * The LCO for the application.
- * <p/>
+ *
  * @author René Jahn
  */
@@ Line 541: / Line 542: @@
 /**
  * The LCO for the session.
- * <p/>
+ *
  * @author René Jahn
  */
@@ Line 589: / Line 590: @@
 package apps.firstapp.frames;
-import javax.rad.persist.IStorage;
+import jvx.rad.persist.IStorage;
 import com.sibvisions.rad.persist.jdbc.DBStorage;
@@ Line 597: / Line 598: @@
 /**
  * The LCO for the DBEdit WorkScreen.
- * <p/>
+ *
  * @author René Jahn
  */
@@ Line 645: / Line 646: @@
 The following steps should take place to create and start a HyperSQL DB.
-  * Copy the HyperSQL JDBC-Driver (hsqldb.jar) to the directory \\ ''../JVxFirstApp/libs/server/'
+  * Copy the HyperSQL JDBC-Driver (''hsqldb.jar'') to the directory ''../JVxFirstApp/libs/server/''
   * Add the JDBC-Driver to the CLASSPATH of the JVxFirstApp Project
   * Create a database with the alias firstappdb and the following table: \\ <file sql>create table CONTACTS
@@ Line 667: / Line 668: @@
 {{:jvx:app_finished.png?nolink|}}
-The source code and the Eclipse project can be found in the [[https://www.sibvisions.com/en/jvxmdownload|Download]] section.
+The source code and the Eclipse project can be found in the [[jvx:example_applications|Download]] section.