1. The Apache Derby database

Transcription

1 1. The Apache Derby database In these instructions the directory jdk_1.8.0_102 is named after the version 'number' of the distribution. Oracle tend to issue many new versions of the JDK/ JRE each year. It is highly likely that any version you download will have a higher version number. Apache Derby is an open source relational database implemented entirely in Java. It now forms part of the normal JDK distribution. The Apache Derby database is installed in the directory db in the top level of the Java JDK directory hierarchy. For example on windows 7 (64 bit) as used at the University: The 64 bit version of the JDK has Apache Derby at: c:\program Files\Java\jdk_1.8.0_102\db If you run a 32 bit version of windows then when you install the 32 bit version of the JDK then Apache Derby will also be at: c:\program Files\Java\jdk_1.8.0_102\db Note: Apache Derby is not part of the JRE. M A Smith University of Brighton October 31, 2016 Page 1

2 1.1 32/ 64 bit versions of Java Some points Do remember, the 64 bit version of Java will not run (directly) on a 32 bit operating system. Many web browsers currently only come in a 32 bit version, so you would need to separately install the 32 bit version of the JRE for the browser, if you install the 64 bit version of the JDK. Of course this will change as more machines run a 64 bit operating system and 64 bit software. M A Smith University of Brighton October 31, 2016 Page 2

3 2. Using the Apache Derby database 2.1 Using BlueJ on Windows To use the Apache Derby database, unzip the BlueJ project jd3.zip into an empty directory in your file system. This will be the project directory that you will open in BlueJ (Project -> Open Project). In the resultant file hierarchy created, the file DataBase.txt is used to select at runtime the appropriate driver, to connect to the database. In this 'version of the CatShop system it contains a single line with the text Derby. When the CatShop system is run code in the system will read this file and know to select the Derby database drive to use to connect to the database. Then in Tools -> Preferences -> Libraries add the following library DERBY_HOME\lib\derby.jar Replacing DERBY_HOME with the path to the base of the Derby database. This is in the Java JDK installed files. For example at the University on windows 7 (64 bit) it will be at: c:\program Files\Java\jdk_1.8.0_102\db M A Smith University of Brighton October 31, 2016 Page 3

4 2.2 Using Eclipse on Windows To use the Apache Derby database, after importing the jd3.tgz archive into the src directory of an empty project. Copy (^C) the file DataBase.txt (At package level) and then Paste (^V) into the top level directory of your project (This level contains the 'directories' src and the JRE System library). In the resultant file hierarchy created, the file DataBase.txt is used at run time to select the appropriate driver, to connect to the database. In this 'version of the CatShop system it contains a single line with the text Derby. When the CatShop system is run code in the system will read this file and know to select the Derby database drive to connect to the database. Copy (^C) the directory Images (in the directory src) and Paste (^V) into the same top level directory as DataBase.txt Instruction to add an external jar if not at the University. Select your project (Top level) then: Project -> Properties -> Java Build Path -> Libraries Select Add external JARs and add the library DERBY_HOME\lib\derby.jar Replacing DERBY_HOME with the path to the base of the Derby database. This is in the Java JDK installed files. For example at the University on windows 7 (64 bit) it will be at: c:\program Files\Java\jdk_1.8.0_102\db M A Smith University of Brighton October 31, 2016 Page 4

5 Instruction to add an external jar at the University (In a teaching lab) Select your project (Top level) then: Project -> Properties -> Java Build Path -> Libraries Select Add external JARs and add the library DERBY_HOME\lib\derby.jar To do this you will need to: Right click on project, select properties -> Java Build Path -> libraries -> add external Jars. Now within the dialogue box that allows you to select the location of the external jar derby.jar. Right click on desktop (folder icon) -> Open File Location Right click on Applications (folder icon) -> Open File Location Navigate to: DERBY_HOME\lib\derby.jar Which at the University is at: c:\program Files\Java\jdk_1.8.0_102\db\ derby.jar This is because at the University you are sometimes prevented from accessing the c: drive. M A Smith University of Brighton October 31, 2016 Page 5

6 2.3 Project not compiling - file OrderTest.java In the package orders is the JUnit test OrderTest.java Eclipse will not recognise this initially as a JUnit test. Copy (^C) the contents of the file OrderTest.java and then delete this file (OrderTest.java ) Now create a JUnit test in the same package orders. Select orders (click on package orders) Right click and select new -> JUnit Test Case call this OrderTest. Now paste the code that you previously copied over the default code in this Java class file. M A Smith University of Brighton October 31, 2016 Page 6

7 2.4 Using BlueJ/Eclipse on Linux Follow the appropriate instructions for the IDE you are using as above. Except, use the appropriate Linux path for installing the Jar file. DERBY_HOME/lib/derby.jar Replacing DERBY_HOME with the path to the base of the Apache Derby database M A Smith University of Brighton October 31, 2016 Page 7

8 2.5 To run the CatShop application (BlueJ & Eclipse) Start-up BlueJ/ Eclipse First run Setup (In package clients) This will create a database (or overwrite an existing database) and populated with example data to use in the CatShop application. You can of course modify the program Setup to change the initial values held in the database. Now exit and close BlueJ/ Eclipse Start-up BlueJ/ Eclipse Now run Main (In package clients) This will run the CatShop application. Remember, you only need to run Setup (In package clients) if you want to create a new copy of the database that the CatShop application uses. Running the application Setup will delete any previous held data. M A Smith University of Brighton October 31, 2016 Page 8

9 3. Running from the command line This assumes that the Apache Derby database is installed on your computer. That the Java JDK is installed on your computer. That you can run java & javac by typing there names in any directory. This means that the bin directory for the JDK is set in the PATH variable. That you have unpacked the CatShop distribution jd3.tgz into your file system. M A Smith University of Brighton October 31, 2016 Page 9

10 3.1 Using Windows The file cat_defs.bat will need editing to set the environment variables DERBY_HOME and JUNIT to where the JDK and JUnit files are respectively. The file cat_compile.bat will compile the applications and applet. The file cat_database.bat will create and populate the database used by the application. The file cat_run.bat will run the system as a single application. The file cat_run_dist.bat will run the system as a distributed system. This is simulated on a single machine with multiple independent windows. Press return only after the server has started The file webcustomerclient.html when loaded in a web browser will run the applet. M A Smith University of Brighton October 31, 2016 Page 10

11 3.2 Using Unix/ Linux / cygwin The Makefile will need editing to set the environment variables DERBY_HOME and JUNIT to where the JDK and JUnit files are respectively. In addition SEP should be set to the appropriate separator. make compile Will compile the applications and applet. make database Will create and populate the database used by the system. make run Will run the system as a single application. make distributed Will run the system as a distributed system. This is simulated on a single machine with multiple independent windows. Networking is used to communicate between the separately executing applications. The file webcustomerclient.html when loaded in a web browser will run the applet. M A Smith University of Brighton October 31, 2016 Page 11

12 4. Using the Microsoft Access database NOT RECOMMENDED/ DO NOT USE From the Windows menu select the Control Panel Select ODBC Driver If the ODBC Driver can not be found then you can run it directly, its name is: odbcad32 Press Button Add Select Microsoft access driver Press Button Finish Set Data Source name to be: cshop Database area Press Button Select and select the file cshop.mdb The file cshop.mdb is included in the archive. Press OK Press OK The file DataBase.txt must contain a single line that only contains the word Access. 4.1 To run the CatShop application (BlueJ & Eclipse) Start-up BlueJ/ Eclipse Now run Main.java (In package Clients) This will run the CatShop application If you want to re-populate the database Run Setup.java (In package clients) This will re-populate the database with suitable data to run the CatShop application. You can modify Setup.java to change the values that will re-populate the database. M A Smith University of Brighton October 31, 2016 Page 12