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


Oracle OLAP Java API Reference.


Packages Contains classes that support processing in Oracle OLAP. Except for the exception classes, the interfaces and classes in this package are deprecated; use the classes in the oracle.olapi.metadata.mdm package instead of the classes in this package. Contains an implementation of the SpecifiedCursorManager interface, an extension of the DataProvider class, and ExpressSQLCursorManager, a class that returns the SQL SELECT statement specified by its Source objects. Contains an implementation of the oracle.olapi.transaction.TransactionProvider interface for Oracle OLAP. Provides support for the internationalization of the package. Provides support for the internationalization of the package. Contains classes that support the execution of OLAP DML commands in Oracle OLAP.
oracle.olapi Contains an interface, an exception, and a class that are of general use in the OLAP API. Contains interfaces and classes for retrieving and accessing the result set of a query. Contains classes and interfaces that provide, represent, and define the objects that specify queries.
oracle.olapi.metadata Contains interfaces and classes that represent metadata for a data store and that Oracle OLAP uses to make metadata objects available.
oracle.olapi.metadata.mdm Contains classes that represent data supporting the multidimensional model (MDM) for metadata.
oracle.olapi.metadata.mtm Contains classes that map objects in the multidimensional model (MDM) for metadata to the relational tables and views on which those objects are based.
oracle.olapi.metadata.resource Provides support for the internationalization of the oracle.olapi.metadata package.
oracle.olapi.transaction Contains interfaces that are not implemented by OLAP API application developers and exception classes that an application might encounter.
oracle.olapi.transaction.metadataStateManager Contains an interface to implement when you use Template objects and a class that is not used by OLAP API application developers.


Oracle OLAP Java API Reference.

This is the online reference documentation for the Oracle® OLAP API, the Java application programming interface for Oracle OLAP. For updated versions of this documentation as they become available, see the Oracle Technology Network Web site at

Intended Audience

This documentation is intended for Java programmers who are responsible for creating applications that perform online analytical processing. It assumes that you are already familiar with Java, relational database management systems, data warehousing, and online analytical processing (OLAP) concepts.

Before You Begin

Before you can use the Oracle OLAP API, you must add the Oracle OLAP API classes to your Java development environment. You must also have access to an Oracle Database instance that has the OLAP option installed. In addition, that database must include data that has been prepared as a data warehouse and supplied with OLAP Catalog metadata. For information on setting up the Oracle OLAP API client files, see Oracle OLAP Developer's Guide to the OLAP API. For information on installing an Oracle database with the OLAP option, see your Oracle Database installation documentation. For information on creating OLAP Catalog metadata, see Oracle OLAP Application Developer's Guide.

Examples of Using the OLAP API

The examples of OLAP API code in this documentation use OLAP Catalog metadata that is mapped to the tables of the Global schema, which is a sample relational schema. You can download SQL scripts that create the Global schema and OLAP Catalog metadata for it from the Oracle Technology Network Web site at

For more information on the Global schema, see Oracle OLAP Developer's Guide to the OLAP API.

For programs that include the code from some of the examples in this documentation and the examples in Oracle OLAP Application Developer's Guide, see Example Oracle OLAP Java API Programs.

Unique and Local Values in the OLAP API

The elements of an OLAP Catalog dimension are usually organized into one or more hierarchies. Some hierarchies have parent-child relationships based on levels and some have those relationships based on values. In the OLAP API a dimension always has at least one hierarchy dimension object and that hierarchy object has at least one level object. Even a nonhierarchical dimension is represented by a hierarchy dimension object with one level object.

The OLAP API uses a three-part format to specify the hierarchy, the level, and the value of a dimension element, and thus identify a unique value. The first part of a unique value is the name of the hierarchy object, the second part is the name of the level object, and the third part is the value of the element in the level. The parts of the unique value are separated by a value separation string, which by default is double colons (::). The following is an example of unique value in the YEAR level of the CALENDAR hierarchy of the TIME dimension:


The third part of a unique value is the local value. In the preceding example, the local value is 4, which is the identifier for the year 2001 in the Global schema. The OLAP API has classes and methods that you can use to get the local values of dimension elements. See the descriptions of the MdmPrimaryDimension and MdmDimensionMemberInfo classes for more information about unique and local values.

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.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle Corporation does not own or control. Oracle Corporation neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Related Documentation

The following documentation is helpful when using Oracle OLAP.

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


Copyright © 2002, 2003, Oracle. All Rights Reserved.