The OrindaBuild PL/SQL Plugin for Eclipse 3.3.

Topics

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

Capabilities

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

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

Installation

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

1. Use our update site.

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

http://www.orindasoft.com/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 OrindaBuild install program.

 

3 Post Installation

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


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:

Starting OrindaBuild from within Eclipse

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

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



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



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



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

Using The OrindaBuild Wizard

The OrindaBuild Wizard has 5 pages:
1. Log In
Is used to identify and connect to an Oracle database. OrindaBuild 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 OrindaBuild 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 OrindaBuild 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 OrindaBuild Manual is the core reference document and will help you get the most out of the product. The chapters relevent to Eclipse users are:

Using 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

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

Running OrindaBuild: Logging in - Selecting Database Objects and SQL files - Code Options - File Options - Generating Code

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

Command Line OrindaBuild: Using the command line version of OrindaBuild 5.0 to generate Java source as part of a build process

Orindasoft's com.orindasoft.pub Library: com.orindasoft.pub Java Class Libraries - JDBC Driver - Cursors - QueryStatement class - ReadOnlyRowSet class - StatsInterface - LogInterface - OracleResourceUser

PL/SQL Records: Using OrindaBuild to call stored procedures that have %ROWTYPE, %TYPE, PL/SQL Package records, INDEX BY tables, VARRAYS and Object TYPE's as parameters

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

Configuration File: what it is - what you can safely edit by hand

Limitations: Known Limitations - Composite Objects REF Objects - VARRAYS - Oracle 8.1.6 Limitations - Oracle 8.1.7 Limitations - Supported PL/SQL Datatypes

Code Sample: demoClass.java - create an instance of a generated class - set parameters - call execute method - get cursor - get sequence value