Contents

List of Examples

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

What's New

• What's New in 10.2.0.3
• What's New in 10.2

1 Introduction to the OLAP API

• OLAP API Overview
  • Multidimensional Concepts and the OLAP API
  • What Type of Data Can an Application Access Through the OLAP API?
  • What Can an Application Do with the OLAP API?
  • Context for OLAP API Development
• Sample Schema for OLAP API Examples
• Access to Data and Metadata Through the OLAP API
  • MDM Model in the OLAP API
  • Access to Data Through the OLAP API
  • Unique and Local Dimension Values
  • User Connection Requirements
• OLAP API Client Software
  • Requirements for Using the OLAP API Client Software
• Tasks That an OLAP API Application Performs
  • Task 1: Connect to the Data Store
  • Task 2: Discover the Available Metadata
  • Task 3: Select and Calculate Data Through Queries
  • Task 4: Retrieve Query Results

2 Understanding OLAP API Metadata

• Overview of the OLAP API Metadata
  • Data Preparation
  • Metadata Preparation
• OLAP Metadata Objects
  • Dimensions in the OLAP Metadata
  • Measures in the OLAP Metadata
  • Measure Folders in the OLAP Metadata
• Overview of MDM Metadata Objects in the OLAP API
  • Mapping of OLAP Metadata Objects to MDM objects
  • MdmModel Class
  • MdmSchema Class
  • MdmSource Class
• MdmDimension Classes
  • MdmPrimaryDimension Classes
  • MdmSubDimension Classes
    • MdmHierarchy
    • MdmLevelHierarchy
    • MdmValueHierarchy
    • MdmLevel
• MdmDimensionedObject Classes
  • MdmMeasure
  • MdmAttribute Class
• MdmMember Classes
• Data Type and Type of MDM Metadata Objects
  • Data Type of MDM Metadata Objects
  • Getting the Data Type of an MdmSource
  • Type of MDM Metadata Objects
  • Getting the Type of an MdmSource
• Creating Custom Metadata Objects

3 Connecting to a Data Store

• Overview of the Connection Process
  • Connection Steps
  • Prerequisites for Connecting
• Establishing a Connection
  • Step 1: Load the JDBC Driver
  • Step 2: Get a Connection from the DriverManager
  • Step 3: Create a TransactionProvider
  • Step 4: Create a DataProvider
• Getting an Existing Connection
• Closing a Connection

4 Discovering the Available Metadata

• Overview of the Procedure for Discovering Metadata
  • MDM Metadata
  • Purpose of Discovering the Metadata
  • Steps in Discovering the Metadata
  • Discovering Metadata and Making Queries
• Creating an MdmMetadataProvider
• Getting the Root MdmSchema
  • Function of the Root MdmSchema
  • Calling the getRootSchema Method
• Getting the Contents of the Root MdmSchema
  • Getting the MdmDimension Objects in an MdmSchema
  • Getting the Subschemas in an MdmSchema
  • Getting the Contents of Subschemas
  • Getting the MdmMeasureDimension
• Getting the Characteristics of Metadata Objects
  • Getting the MdmDimension Objects for an MdmMeasure
  • Getting the Related Objects for an MdmPrimaryDimension
• Getting the Source for a Metadata Object
• Sample Code for Discovering Metadata
  • Code for the SampleMetadataDiscoverer10g Program
  • Output from the SampleMetadataDiscoverer10g Program

5 Understanding Source Objects

• Overview of Source Objects
• Kinds of Source Objects
• Characteristics of Source Objects
  • Data Type of a Source
  • Type of a Source
  • Source Identification and SourceDefinition of a Source
• Inputs and Outputs of a Source
  • Inputs of a Source
  • Outputs of a Source
  • Matching a Source To an Input
• Describing Parameterized Source Objects
• Model Objects and Source Objects
  • Describing the Model for a Source
  • Creating a CustomModel - Example
  • Dependent Assignment Values - Example
  • A Custom Member That Specifies an Aggregated Value - Example

6 Making Queries Using Source Methods

• Describing the Basic Source Methods
• Using the Basic Methods
  • Using the alias Method
  • Using the distinct Method
  • Using the join Method
  • Using the position Method
  • Using the recursiveJoin Method
  • Using the value Method
• Using Other Source Methods
  • Using the extract Method
  • Creating a Cube and Pivoting Edges
  • Drilling Up and Down in a Hierarchy
  • Sorting Hierarchically by Measure Values
  • Using NumberSource Methods To Compute the Share of Units Sold
  • Selecting Based on Time Series Operations
  • Selecting a Set of Elements Using Parameterized Source Objects

7 Using a TransactionProvider

• About Creating a Query in a Transaction
  • Types of Transaction Objects
  • Preparing and Committing a Transaction
  • About Transaction and Template Objects
  • Beginning a Child Transaction
  • About Rolling Back a Transaction
  • Getting and Setting the Current Transaction
• Using TransactionProvider Objects

8 Understanding Cursor Classes and Concepts

• Overview of the OLAP API Cursor Objects
  • Creating a Cursor Using a CursorManagerSpecification
  • Creating a Cursor Without a CursorManagerSpecification
  • Sources For Which You Cannot Create a Cursor
  • Cursor Objects and Transaction Objects
• Cursor Classes
  • Structure of a Cursor
  • Specifying the Behavior of a Cursor
• CursorManagerSpecification Class
• CursorInfoSpecification Classes
• CursorManager Classes
  • Updating the CursorManagerSpecification for a CursorManager
• Other Classes
  • CursorInput Class
  • CursorManagerUpdateListener Class
  • CursorManagerUpdateEvent Class
• About Cursor Positions and Extent
  • Positions of a ValueCursor
  • Positions of a CompoundCursor
  • About the Parent Starting and Ending Positions in a Cursor
  • What is the Extent of a Cursor?
• About Fetch Sizes

9 Retrieving Query Results

• Retrieving the Results of a Query
  • Getting Values from a Cursor
• Navigating a CompoundCursor for Different Displays of Data
• Specifying the Behavior of a Cursor
• Calculating Extent and Starting and Ending Positions of a Value
• Specifying a Fetch Size

10 Creating Dynamic Queries

• About Template Objects
  • About Creating a Dynamic Source
  • About Translating User Interface Elements into OLAP API Objects
• Overview of Template and Related Classes
  • What Is the Relationship Between the Classes That Produce a Dynamic Source?
  • Template Class
  • MetadataState Interface
  • SourceGenerator Interface
  • DynamicDefinition Class
• Designing and Implementing a Template
  • Implementing the Classes for a Template
  • Implementing an Application That Uses Templates

A Setting Up the Development Environment

• Overview
• Required Class Libraries
• Obtaining the Class Libraries

B SingleSelectionTemplate Class

• Code for the SingleSelectionTemplate Class

Index