
Readme File for the Oracle OLAP Java API Reference

Release 1 (10.2.0.3)

-------------------------------------------------------------

OVERVIEW

The Oracle OLAP Java API Reference provides documentation for the classes in the Oracle OLAP API. This reference documentation is in HTML format, and was created using the javadoc tool that is distributed by Sun Microsystems.

Oracle provides the OLAP Java API Reference HTML files in a single jar file,  olap_api_doc.jar.
The jar file is in the <oracle_home>/olap/api/doc directory, where <oracle_home> is the Oracle home directory created in an Oracle installation. This readme.txt file is in the same location.

To have access to the documentation, extract the HTML files that the jar file contains, as described below.


EXTRACTING THE HTML FILES

To install the documentation on your application development computer, complete the following steps:

1. Locate the /doc subdirectory that is under the <oracle_home>/olap/api directory on which the Oracle database with the OLAP option is installed.

2. Copy the /doc directory to a convenient location on your computer. This step also copies the files that reside in the directory.

3. Make the /doc directory on your computer the current directory.

4. Use the jar utility that is part of the JDK 1.4 from Sun Microsystems to extract the contents of the olap_api_doc.jar file to the current directory with a command such as the following:

   jar -xf olap_api_doc.jar

   You can also use some other tool, such as WinZip, to extract the contents of the olap_api_doc.jar file. Extracting the contents creates a multilevel hierarchy of subdirectories under the /doc directory and populates the subdirectories with HTML files.


ACCESSING THE OLAP JAVA API REFERENCE IN YOUR WEB BROWSER

The table of contents page of the OLAP Java API Reference is the following file in the top-level directory of the files extracted from the olap_api_doc.jar file.

   /doc/index.html

Open this file in your browser to begin exploring the information about the OLAP API classes.


RELATED DOCUMENTATION

The following related documentation is provided with the Oracle Database, and is also available from the Oracle Technology Network (OTN) Web site.

* Oracle OLAP Developer's Guide to the OLAP API
* Oracle OLAP Reference
* Oracle OLAP DML Reference
* Oracle10i Data Warehousing Guide
* Oracle10i JDBC Developer's Guide and Reference

-------------------------------------------------------------

Copyright  2002, 2004, Oracle Corporation. All rights reserved. 


