1/19

Contents

List of Examples

List of Figures

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Changes in This Release for Oracle OLAP Java API Developer's Guide

• Changes in Oracle Database 12c Release 1 (12.1)

1 Introduction to the OLAP Java API

• OLAP Java API Overview
  • What the OLAP Java API Can Do
  • Describing the Classes in the OLAP Java API
  • Describing the Dimensional Data Model
  • Implementing the Dimensional Data Model
  • Organizing the Data for OLAP
• Accessing Data Through the OLAP Java API
  • Creating Queries
  • Specifying Dimension Members
  • Creating Cursors
• Sample Schema for OLAP Java API Examples
• Tasks That an OLAP Java API Application Performs

2 Understanding OLAP Java API Metadata

• Overview of OLAP Java API Metadata Classes
• Identifying, Describing, and Classifying Metadata Objects
  • Identifying Objects
    • Getting and Setting Names
    • Describing Unique Identifiers
    • Supporting Legacy Metadata Objects
  • Using Descriptions
  • Using Classifications
• Providing Metadata Objects
  • Describing Metadata Providers
    • Getting Metadata Objects by ID
    • Exporting and Importing Metadata as XML Templates
  • Representing Schemas
    • Representing the Root Schema
    • Representing Database Schemas
    • Representing Organizational Schemas
• Providing Access to Data Sources
  • Representing Cubes and Measures
    • Representing Cubes
    • Representing Measures
  • Representing Dimensions, Levels, and Hierarchies
    • Representing Dimensions
    • Representing Dimension Levels
    • Representing Hierarchies
    • Representing Hierarchy Levels
  • Representing Dimension Attributes
    • Describing the MdmAttribute Class
    • Describing the MdmBaseAttribute Class
    • Describing the MdmDerivedAttribute Class
  • Using OLAP Views
    • Getting Cube View and View Column Names
    • Getting Dimension and Hierarchy View and View Column Names
    • Using OLAP View Columns
    • Using Source Objects

3 Discovering Metadata

• Connecting to Oracle OLAP
  • Prerequisites for Connecting
  • Establishing a Connection
    • Creating a JDBC Connection
    • Creating a DataProvider and a UserSession
  • Closing the Connection and the DataProvider
• Overview of the Procedure for Discovering Metadata
  • Purpose of Discovering the Metadata
  • Steps in Discovering the Metadata
• Creating an MdmMetadataProvider
• Getting the MdmSchema Objects
• Getting the Contents of an MdmSchema
• Getting the Objects Contained by an MdmPrimaryDimension
  • Getting the Hierarchies and Levels of an MdmPrimaryDimension
  • Getting the Attributes for an MdmPrimaryDimension
• Getting the Source for a Metadata Object

4 Creating Metadata and Analytic Workspaces

• Overview of Creating and Mapping Metadata
• Creating an Analytic Workspace
• Creating the Dimensions, Levels, and Hierarchies
  • Creating and Mapping Dimensions
  • Creating and Mapping Dimension Levels
  • Creating and Mapping Hierarchies
    • Creating and Mapping an MdmLevelHierarchy
    • Creating and Mapping an MdmValueHierarchy
• Creating Attributes
• Creating Cubes and Measures
  • Creating Cubes
  • Creating and Mapping Measures
• Committing Transactions
• Exporting and Importing XML Templates
• Building an Analytic Workspace

5 Understanding Source Objects

• Overview of Source Objects
• Kinds of Source Objects
• Characteristics of Source Objects
  • Elements and Values of a Source
  • Data Type of a Source
  • Type of a Source
  • Source Identification and SourceDefinition of a Source
• Inputs and Outputs of a Source
  • Describing the join Method
    • Describing the joined Parameter
    • Describing the comparison Parameter
    • Describing the comparisonRule Parameter
    • Describing the visible Parameter
  • Outputs of a Source
    • Producing a Source with an Output
    • Using COMPARISON_RULE_SELECT
    • Using COMPARISON_RULE_REMOVE
    • Producing a Source with Two Outputs
    • Hiding an Output
  • Inputs of a Source
    • Primary Source Objects with Inputs
    • Deriving a Source with an Input
    • Type of Inputs
  • Matching a Source with an Input
    • Matching the Input of the Source for an MdmAttribute
    • Matching the Inputs of a Measure
    • Using the value Method to Derive a Source with an Input
    • Using the value Method to Select Values of a Source
    • Using the extract Method to Combine Elements of Source Objects
• Describing Parameterized Source Objects

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
    • Selecting Elements of a Source
    • Reversing a Relation
• 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 Metadata Object or a Query in a Transaction
  • Types of Transaction Objects
  • 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 Java API Cursor Objects
  • Creating a Cursor
  • 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
• CursorInfoSpecification Classes
• CursorManager Class
  • Updating the CursorInfoSpecification for a CursorManager
• 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 Java 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