Contents

Title and Copyright Information

Send Us Your Comments

Preface

Audience

Documentation Accessibility

Structure

Related Documents

Conventions

1 Introduction to the OLAP API

1.1 OLAP API Overview

1.1.1 Multidimensional Concepts and the OLAP API

1.1.2 What Type of Data Can an Application Access Through the OLAP API?

1.1.3 What Can an Application Do with the OLAP API?

1.1.4 Context for OLAP API Development

1.2 Sample Schema for OLAP API Examples

1.3 Access to Data and Metadata Through the OLAP API

1.3.1 MDM Model in the OLAP API

1.3.2 Access to Data Through the OLAP API

1.3.3 Unique and Local Dimension Values

1.3.4 User Connection Requirements

1.4 OLAP API Client Software

1.4.1 Requirements for Using the OLAP API Client Software

1.5 Tasks That an OLAP API Application Performs

1.5.1 Task 1: Connect to the Data Store

1.5.2 Task 2: Discover the Available Metadata

1.5.3 Task 3: Select and Calculate Data Through Queries

1.5.4 Task 4: Retrieve Query Results

2 Understanding OLAP API Metadata

2.1 Overview of the OLAP API Metadata

2.1.1 Data Preparation

2.1.2 Metadata Preparation

2.2 OLAP Metadata Objects

2.2.1 Dimensions in the OLAP Metadata

2.2.2 Measures in the OLAP Metadata

2.2.3 Measure Folders in the OLAP Metadata

2.3 Overview of MDM Metadata Objects in the OLAP API

2.3.1 Mapping of OLAP Metadata Objects to MDM objects

2.3.2 MdmSchema Class

2.3.3 MdmSource Class

2.4 MdmDimension Class

2.5 MdmPrimaryDimension Class

2.6 MdmHierarchy Class

2.6.1 MdmLevelHierarchy

2.6.2 MdmValueHierarchy

2.7 MdmLevel Class

2.8 MdmMeasure Class

2.8.1 Description of an MdmMeasure

2.8.2 Elements of an MdmMeasure

2.8.2.1 MdmMeasure Elements Are Determined by MdmDimension Elements

2.9 MdmAttribute Class

2.9.1 Description of an MdmAttribute

2.9.2 Elements of an MdmAttribute

2.10 Data Type and Type of MDM Metadata Objects

2.10.1 Data Type of MDM Metadata Objects

2.10.2 Getting the Data Type of an MdmSource

2.10.3 Type of MDM Metadata Objects

2.10.4 Getting the Type of an MdmSource

3 Connecting to a Data Store

3.1 Overview of the Connection Process

3.1.1 Connection Steps

3.1.2 Prerequisites for Connecting

3.2 Establishing a Connection

3.2.1 Step 1: Load the JDBC Driver

3.2.2 Step 2: Get a Connection from the DriverManager

3.2.3 Step 3: Create a TransactionProvider

3.2.4 Step 4: Create a DataProvider

3.3 Getting an Existing Connection

3.4 Executing DML Commands Through the Connection

3.5 Closing a Connection

4 Discovering the Available Metadata

4.1 Overview of the Procedure for Discovering Metadata

4.1.1 MDM Metadata

4.1.2 Purpose of Discovering the Metadata

4.1.3 Steps in Discovering the Metadata

4.1.4 Discovering Metadata and Making Queries

4.2 Creating an MdmMetadataProvider

4.3 Getting the Root MdmSchema

4.3.1 Function of the Root MdmSchema

4.3.2 Calling the getRootSchema Method

4.4 Getting the Contents of the Root MdmSchema

4.4.1 Getting the MdmDimension Objects in an MdmSchema

4.4.2 Getting the Subschemas in an MdmSchema

4.4.3 Getting the Contents of Subschemas

4.4.4 Getting the MdmMeasureDimension and Its Contents

4.5 Getting the Characteristics of Metadata Objects

4.5.1 Getting the MdmDimension Objects for an MdmMeasure

4.5.2 Getting the Related Objects for an MdmPrimaryDimension

4.6 Getting the Source for a Metadata Object

4.7 Sample Code for Discovering Metadata

4.7.1 Code for the SampleMetadataDiscoverer10g Program

4.7.2 Output from the SampleMetadataDiscoverer10g Program

5 Working with Metadata Mapping Objects

5.1 Overview of the MTM Classes

5.1.1 SELECT Statements for MdmSource Objects

5.1.2 Purpose of MTM Objects

5.1.3 Measures, Cubes, and Hierarchies

5.2 Discovering the Columns Mapped To an MdmSource

5.2.1 Example of Getting the Columns Mapped To an MdmLevelHierarchy

5.2.2 Example of Getting the Columns Mapped To an MdmLevel

5.2.3 Example of Getting the Columns Mapped To an MdmMeasure

5.3 Creating a Custom Measure

5.4 Understanding Solved and Unsolved Data

5.4.1 Solved Versus Unsolved Cubes and Hierarchies

5.4.2 Aggregation Forms for Cubes

5.4.2.1 Aggregation for Unsolved Cubes

5.4.2.2 Aggregation for Solved Cubes

5.4.3 Solve Specifications for Unsolved Cubes

6 Understanding Source Objects

6.1 Overview of Source Objects

6.2 Kinds of Source Objects

6.3 Characteristics of Source Objects

6.3.1 Data Type of a Source

6.3.2 Type of a Source

6.3.3 Source Identification and SourceDefinition of a Source

6.4 Inputs and Outputs of a Source

6.4.1 Inputs of a Source

6.4.2 Outputs of a Source

6.4.3 Matching a Source To an Input

6.5 Describing Parameterized Source Objects

7 Making Queries Using Source Methods

7.1 Describing the Basic Source Methods

7.2 Using the Basic Methods

7.2.1 Using the alias Method

7.2.2 Using the distinct Method

7.2.3 Using the extract Method

7.2.4 Using the join Method

7.2.5 Using the position Method

7.2.6 Using the recursiveJoin Method

7.2.7 Using the value Method

7.3 Using Other Source Methods

7.3.1 Creating a Cube and Pivoting Edges

7.3.2 Drilling Up and Down in a Hierarchy

7.3.3 Sorting Hierarchically by Measure Values

7.3.4 Using NumberSource Methods To Compute the Share of Units Sold

7.3.5 Ranking Dimension Elements by Measure Value

7.3.6 Selecting Based on Time Series Operations

7.3.7 Selecting a Set of Elements Using Parameterized Source Objects

8 Using a TransactionProvider

8.1 About Creating a Query in a Transaction

8.1.1 Types of Transaction Objects

8.1.2 Preparing and Committing a Transaction

8.1.3 About Transaction and Template Objects

8.1.4 Beginning a Child Transaction

8.1.5 About Rolling Back a Transaction

8.1.6 Getting and Setting the Current Transaction

8.2 Using TransactionProvider Objects

9 Understanding Cursor Classes and Concepts

9.1 Overview of the OLAP API Cursor Objects

9.1.1 Creating a Cursor Using a CursorManagerSpecification

9.1.2 Creating a Cursor Without a CursorManagerSpecification

9.1.3 Sources For Which You Cannot Create a Cursor

9.1.4 Cursor Objects and Transaction Objects

9.2 Cursor Classes

9.2.1 Structure of a Cursor

9.2.2 Specifying the Behavior of a Cursor

9.3 CursorManagerSpecification Class

9.4 CursorInfoSpecification Classes

9.5 CursorManager Classes

9.5.1 Updating the CursorManagerSpecification for a CursorManager

9.6 Other Classes

9.6.1 CursorInput Class

9.6.2 CursorManagerUpdateListener Class

9.6.3 CursorManagerUpdateEvent Class

9.7 About Cursor Positions and Extent

9.7.1 Positions of a ValueCursor

9.7.2 Positions of a CompoundCursor

9.7.3 About the Parent Starting and Ending Positions in a Cursor

9.7.4 What is the Extent of a Cursor?

9.8 About Fetch Sizes

10 Retrieving Query Results

10.1 Retrieving the Results of a Query

10.1.1 Getting Values from a Cursor

10.2 Navigating a CompoundCursor for Different Displays of Data

10.3 Specifying the Behavior of a Cursor

10.4 Calculating Extent and Starting and Ending Positions of a Value

10.5 Specifying a Fetch Size

11 Creating Dynamic Queries

11.1 About Template Objects

11.1.1 About Creating a Dynamic Source

11.1.2 About Translating User Interface Elements into OLAP API Objects

11.2 Overview of Template and Related Classes

11.2.1 What Is the Relationship Between the Classes That Produce a Dynamic Source?

11.2.2 Template Class

11.2.3 MetadataState Interface

11.2.4 SourceGenerator Interface

11.2.5 DynamicDefinition Class

11.3 Designing and Implementing a Template

11.3.1 Implementing the Classes for a Template

11.3.2 Implementing an Application That Uses Templates

A Setting Up the Development Environment

A.1 Overview

A.2 Required Class Libraries

A.3 Obtaining the Class Libraries

Index