
Readme File for the Oracle9i OLAP API Reference

Release 9.2.0.8
-------------------------------------------------------------

OVERVIEW

The Oracle9i OLAP 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 API Reference HTML files in a single jar file. To install the documentation, copy the jar file to a directory on your computer, and extract the HTML files that it contains, as described below.


LOCATION OF THE OLAP API REFERENCE

The OLAP API Reference HTML files are in the file olap_api_doc.jar, which is in the same directory as this readme.txt file. That directory is /olap/olapi/doc under the Oracle home directory, which was created during the installation of the Oracle database with the OLAP option.


EXPANDING THE CONTENTS OF THE JAR FILE

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/olapi directory on the computer that has the Oracle9i database installed.

2. Copy the olap_api_doc.jar file to a convenient location on your computer.

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

4. Use the jar utility that is part of a Sun Microsystems Java Development Kit (JDK) to extract the contents of the olap_api_doc.jar file 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. The extraction procedure creates a multilevel hierarchy of subdirectories under the current directory, or other directory that you specify, and populates the subdirectories with HTML files.


ACCESSING THE OLAP API REFERENCE IN YOUR WEB BROWSER

The top-level table of contents page of the OLAP API Reference is the index.html file. View 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 installation.

* Oracle9i OLAP User's Guide
* Oracle9i OLAP Developer's Guide to the OLAP API
* Oracle9i OLAP Developer's Guide to the OLAP DML
* Oracle9i Data Warehousing Guide

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

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

