Orindasoft

Using JDBCWizard as an Eclipse Plugin

The JDBCWizard PL/SQL Plugin for Eclipse 3.3.

    Topics

  1. Capabilities
  2. Installation
  3. Starting JDBCWizard from within Eclipse
  4. Using The JDBCWizard Wizard
  5. Next Steps

Capabilities

The JDBCWizard PL/SQL Plugin for Eclipse 3.3 has the following characteristics:

  • TickThe plugin uses the ".pb2" file extension to store information on the contents of your Oracle databases
  • TickWhen you open or create a ".pb2" file you get a wizard that allows you to:
    • TickTickLog into an Oracle database.
    • TickTickSelect PL/SQL Procedures, Functions and Packages you wish to call from Java.
    • TickTickChoose Tables you wish to access from Java.
    • TickTickList SQL statements you want to be able to run from Java.
  • TickYou can then generate all the Java classes you need to access the database objects you've selected.
  • TickJDBCWizard also adds the correct JDBC driver and library class to your project.
  • TickJDBCWizard comes with a full built in help system.
  • TickThe demo version expires every few weeks, but unlimited replacement downloads are allowed.
  • TickJDBCWizard has far better support for PL/SQL than hibernate or JPublisher:
  • TickFull support for %ROWTYPE parameters.
  • TickNo restrictions on parameter data types or order.
  • TickFull support for arrays of records as parameters.
  • TickAll required supporting classes generated with human readable Java.
  • TickNo equirement to change your PL/SQL or DDL.
  • TickWorks on 99% of all PL/SQL procedures.

Installation

There are two ways to install the JDBCWizard extension for Eclipse 3.3:

1. Use our update site.

The easiest way for Eclipse users to download JDBCWizard is to add this site to the "Update Sites To Visit" page:

http://www.orinda.sofware/public/ec33/site.xml

To get to the "Update Sites To Visit" page select "Help", "Software Updates", "Find and Install", "Search for new features to Install" and then add the site above as a "New Remote Site".

2. Use the JDBCWizard install program.

As a first step you'll need to download and run the install program from our web site.

when you run the program the installer will always copy the plugin to your installation directory but will also allow you to place an additional copy in your Eclipse plugins directory.


Installing the JDBCWizard Addin for Oracle JDeveloper 10G
 
Clicking on "Find Eclipse 3.0" allows you to specify where the extension is to be copied.
If you have already installed JDBCWizard you can copy the JDBCWizard Plugin from JDBCWizard.s install directory to Eclipse's plugins directory:

Eclipse Install Directory


3 Post Installation

Once you have installed the Plugin you will need to restart Eclipse 3.3.

Note: You should delete any old versions of the JDBCWizard Plugin before restarting Eclipse.

You can verify that the Plugin has been installed by starting Eclipse and selecting 'Help/About Eclipse Platform/Plug-in Details'. Scroll down to the bottom of the screen. If the plugin is correctly installed you will see a line like this:

Verify your eclipse installation

Starting JDBCWizard from within Eclipse

JDBCWizard is loosely coupled with Eclipse. It runs within the same JVM but has its own window. When you start JDBCWizard from within Eclipse it will ensure that any code generated is within your project. As part of the code generation process JDBCWizard associates the correct com.orindasoft.pub library with the project.

To start JDBCWizard from within Eclipse either click on an existing Configuration File or create one using the File/New/Other Dialog Screen:

Create a new JDBCWizard JDBC Code Generation File With Eclipse

Selecting 'File/New/Other' brings up the New file Wizard. By choosing JDBCWizard Config File you will launch JDBCWizard.

JDBCWizard in the Eclipse new file wizard

You will then be asked to pick a container and file name for your JDBCWizard file. The Filename will default to 'orindabuild' plus the date and time.

JDBCWizard Code Generator For Eclipse Editor Page

When you click on Finish the JDBCWizard GUI will be started.

Using The JDBCWizard Wizard

The JDBCWizard Wizard has 5 pages:
1. Log In
Is used to identify and connect to an Oracle database. JDBCWizard works against all versions of Oracle from V8.1.5 onwards. You will need to know the hostname, username, password, port and SID (database name).
2. Select Objects
Is used to select database object to generate code for. It has differnt tabs for Procedures, Tables, Sequences and also one for SQL statements.
3. Code Options
Is used to specify things like comments and numeric data types to use.
4. File Options
This screen has two fields. The top field is the base directory for the generated code. If you are calling JDBCWizard from Eclipse this will always be the Container for the project.
5. Generate Code
Pressing the 'generate' button leads to classes being generated and automaticly being added to your project.

When you generate code the wizard adds the com.orindasoft.pub library for your chosen version to the project. If you are using the demo version of JDBCWizard the wizard will add a demo version of the library. Once finished generating code exit the wizard using the 'File/Exit' menu.

In order to use the generated code you will need to have an Oracle JDBC driver in your build path.

Next Steps

The JDBCWizard Manual is the core reference document and will help you get the most out of the product. The chapters relevent to Eclipse users are:

TickUsing the DAO Factory Class: Using the DAO Factory Class - Advantages of the DAO Factory Class - Log File Management - Database Connection Management - Java Session Bean Support - Working with the DAO Factory class - Creating an instance of the class - Obtaining and using a database access class - Releasing and reaquiring resouces - Extending the DAO Factory class - DAO Factory class methods
Tick Using the Web Service Classes:Purpose of generated web service classes - Description of generated web service classes - Altering Web Service Class Behaviour - DAOFactoryServiceImpl class Methods - Web Services with CLOBS, BLOBS and BFILES
Tick Running JDBCWizard. Logging in - Selecting Database Objects and SQL files - Code Options - File Options - Generating Code
Tick Using Generated Code: required imports - implementing LogInterface - Create Instances of Generated Classes - set methods - execute methods - get methods - sequences - cursors - other generated methods - table persistance methods - table navigation methods
Tick Command Line JDBCWizard. Using the command line version of JDBCWizard 5.0 to generate Java source as part of a build process
Tick Orindasoft's com.orindasoft.pub Library: com.orindasoft.pub Java Class Libraries - JDBC Driver - Cursors - QueryStatement class - ReadOnlyRowSet class - StatsInterface - LogInterface - OracleResourceUser
Tick PL/SQL Records: Using JDBCWizard to call stored procedures that have %ROWTYPE, %TYPE, PL/SQL Package records, INDEX BY tables, VARRAYS and Object TYPE's as parameters
Tick LOB's: Generating JDBC access code for PL/SQL procedures and functions that have CLOB, BLOB or BFILE parameters - transparent support for inserting CLOB and BLOB columns in tables
Tick Configuration File: what it is - what you can safely edit by hand
Tick Limitations: Known Limitations - Composite Objects REF Objects - VARRAYS - Oracle 8.1.6 Limitations - Oracle 8.1.7 Limitations - Supported PL/SQL Datatypes
Tick Code Sample: demoClass.java - create an instance of a generated class - set parameters - call execute method - get cursor - get sequence value
Logo