Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)


Oracle OLAP Analytic Workspace Java API Reference.


oracle.AWAction Contains classes that assign a basic action to an object model and load data into an analytic workspace.
oracle.AWXML Contains classes that define an object model and instantiate it in a standard form analytic workspace.


Oracle OLAP Analytic Workspace Java API Reference.

This is the online reference documentation for the Oracle® OLAP Analytic Workspace Java API. For the most recent version of this reference documentation, visit the Oracle Technology Network Web site at


You can use the OLAP Analytic Workspace API to build applications that create and maintain standard form analytic workspaces within the Database. The API supports a multidimensional object model and provides tools for instantiating the model in an analytic workspace.

The Analytic Workspace API uses the SPLExecutor class in the Oracle OLAP API to wrap OLAP DML commands for execution within the Database. The OLAP API is a companion Java API for generating OLAP queries of analytic workspaces and relational data warehouses. (For information on the OLAP API, see the Oracle OLAP Developer's Guide to the OLAP API.)

Two Deployment Modes

The Analytic Workspace API supports two deployment modes. It can be embedded in a Java application, or it can be used to generate XML that is executable by a PL/SQL function. The XML storage capability makes the API available to any application that can connect to the Database and execute a stored procedure.

The functionality of the API is identical whether executed through Java or through PL/SQL. The same Java code that runs on the client and executes through JDBC also runs within the Database JVM and executes directly within the Database. When you install the Database with the OLAP option, the Analytic Workspace Java API is automatically loaded along with all the other OLAP server-side components.

Advantages of the OLAP Analytic Workspace API

Applications created with the Analytic Workspace API offer several advantages:

Using the OLAP Analytic Workspace API in a Java Application

You can use the Analytic Workspace API to build Java client applications that interact with the Database through JDBC. Both thick and thin connections are supported.

The oracle.AWXML package provides the classes that build an OLAP object model. Many of the classes have methods for generating XML. These are not needed in Java applications, however you can use them if you want your application to save the object definitions in addition to (or instead of) executing them dynamically. If you choose to create XML, use the oracle.AWAction package to assemble the XML definitions into logical units of work. The oracle.AWXML package includes a class you can use to parse the stored XML and restore the objects in memory.

Use the following links to view the .java files for two sample applications that use the Analytic Workspace API. This sample code is provided to illustrate the use of the API. It is subject to change and is not intended to provide application solutions.

OLAP Analytic Workspace API Sample Program

OLAP Analytic Workspace API Sample Program

Using the OLAP Analytic Workspace API to Generate XML

You can use the Analytic Workspace API to generate XML documents that serialize the object model for execution by a PL/SQL function. In this case, the Database commands generated by the API execute directly within the Database, and not through a Database connection.

To create XML for execution in the Database, use the oracle.AWXML package to build the object model and generate the XML that represents the object model. Use the oracle.AWAction package to build logical units of work into the XML. To instantiate the XML, load it into a CLOB and provide the CLOB as input to the interactionexecute PL/SQL function.

function interactionexecute(input CLOB) return varchar2

The interactionexecute function passes the input to the Analytic Workspace API running within the Database JVM. The API parses the string and restores the Java objects in memory.

Creating Your Own XML

If you prefer to create your own XML, use an XML development environment such as XMLSpy© and validate your XML against the Oracle OLAP XML schema defined in AWXML.xsd. Once you have validated the OLAP XML, you can execute it with the interactionexecute function. In this case, you do not need to use the Java API at all.

Use the following link to obtain AWXML.xsd.

XML Schema for OLAP

You can generate the documentation for AWXML.xsd within your XML development environment.

Intended Audience

This documentation is intended for Java programmers who are responsible for creating applications that build and maintain analytic workspaces. It assumes that you are already familiar with Java, Oracle OLAP, and data warehousing concepts.

Before You Begin

To use the OLAP Analytic Workspace Java API, you need a Java development environment such as Oracle® JDeveloper. Copy the jar file for the API into your development environment. You also need access to an Oracle Database that includes the OLAP option.

For information on installing an Oracle database with the OLAP option, see your Oracle Database installation documentation.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

Related Documentation

For more information about Oracle OLAP and Oracle data warehousing, refer to the following manuals:

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)


Copyright © 2003, Oracle. All Rights Reserved.