A Setting Up the Development Environment

This appendix describes the development environment for creating applications that use the OLAP Java API.

This appendix includes the following topics:


The Oracle Database installation, with the OLAP option, provides the OLAP Java API and other class libraries, as jar files, that you require to develop an OLAP Java API client application. As an application developer, you must copy the required jar files to the computer on which you develop your Java application, or otherwise make them accessible to your development environment.

Required Class Libraries

Your application development environment must have the following files:

  • The olap_api.jar file, which contains the OLAP Java API class libraries.

  • The ojdbc5.jar file, which is an Oracle JDBC (Java Database Connectivity) library that contains classes required to connect to an Oracle Database instance. The Oracle installation includes the JDBC file. You must use that JDBC file and not one from another Oracle product or from a product from another vender.

  • The xmlparserv2.jar file, which contains classes that provide XML parsing support.

  • The Java Development Kit (JDK) version 1.5. The Oracle installation does not provide the JDK. For information about obtaining and using it, see the Sun Microsystems Java Web site at


If you are using Oracle JDeveloper as your development environment, then the JDK is already installed on your computer. However, ensure that you are using the correct version of the JDK in JDeveloper.

Obtaining the Class Libraries

Table A-1 lists the OLAP Java API and other jar files that you must include in your application development environment. The table includes the locations of the files under the directory identified by the ORACLE_HOME environment variable on the system on which the Oracle Database is installed. You can copy these files to your application development computer, or otherwise include them in your development environment.

Table A-1 Required Class Libraries and Their Locations in the Oracle Installation

Class Library jar File Location under ORACLE_HOME







The ORACLE_HOME/olap/api/lib directory also contains the olap_api_doc.jar file, which contains the Oracle OLAP Java API Reference documentation. You can add the JAR file to your IDE to get context-sensitive help for the API.