Oracle9i OLAP Developer's Guide to the OLAP API -- Index

aggregation functions, creating, 6-29

aggregation methods

explanation of, 6-24

list of, 6-25

using, 6-25, 6-26

alias method

description, 5-7

example, 6-16

ancestors attributes

example of getting, 4-8

for MdmHierarchy objects, 2-12

for MdmLevel objects, 2-10

application

deployment, 1-12

development steps, 1-8

tasks performed by, 1-12

asymmetric result set, Cursor positions in an, 8-20

attributes

ancestors, 2-10, 2-12

definition, 1-3

in OLAP metadata, 2-3

MdmAttribute objects, 2-23

parent, 2-10, 2-12

region, 2-12

Source objects for, 5-7

Boolean OLAP API data type, 2-25, 5-9, 5-10

CompoundCursor objects

getting children of, example, 9-5

navigating for a crosstab view, example, 9-12, 9-14

navigating for a table view, example, 9-10

positions of, 8-17

Connection objects

example of closing, 3-5

example of creating, 3-2

example of getting an existing one, 3-4

connections

closing, 3-5

getting existing ones, 3-4

prerequisites, 3-2

steps for establishing, 3-2

constant Source objects

definition, 5-5

example, 5-8

crosstab view

navigating Cursor for, example, 9-12, 9-14

current position in a Cursor, definition, 8-16

Cursor class

architecture, advantages of, 8-2

hierarchy, 8-4

Cursor objects

created in the current Transaction, 8-4

creating, example, 9-2

current position, definition, 8-16

extent calculation, example, 9-21

extent definition, 8-25

faster and slower varying components, 8-6

fetch block definition, 8-27

fetch size definition, 8-27

getting children of, example, 9-5

getting the values of, examples, 9-3

parent starting and ending position, 8-22

position, 8-16

Source objects for which you cannot create, 8-3

span, definition, 8-22

specifying fetch size for a crosstab view, example, 9-26

specifying fetch size for a table view, example, 9-25

specifying the behavior of, 8-8, 9-19

starting and ending positions of a value, example of calculating, 9-21

structure, 8-5

CursorInput class, 8-9, 8-11

CursorManager class, 8-12

hierarchy, 8-13

CursorManager objects

closing before rolling back a Transaction, 7-9

creating, example, 9-2

updating the CursorManagerSpecification, 8-12

CursorManagerSpecification class, 8-9

creating object, example, 9-2

CursorManagerUpdateEvent class, 8-15

CursorManagerUpdateListener class, 8-15

CursorSpecification class, 8-10

CursorSpecification objects

getting from a CursorManagerSpecification, example, 9-19

data store

definition, 1-4

exploring, 4-2

scope of, 4-2

data type

of MDM metadata objects, 2-24

of MdmSource objects, 2-26

data warehouse, 1-3

DataProvider objects

creating, 3-4

needed to create MdmMetadataProvider, 4-3

Date OLAP API data type, 2-25, 5-9, 5-10

default hierarchy

example of getting, 4-8

retrieving, 6-13

derived Source objects

definition, 5-5

description, 5-8

introduced, 5-8

dimensions

definition, 1-2

in OLAP metadata, 2-3

MdmDimension objects, 2-8

Source objects for, 5-6

distinct method

description, 5-7

documentation, A-3

Double OLAP API data type, 2-25, 5-9, 5-10

drilling down a hierarchy, 6-15

DriverManager objects, 3-3

dynamic queries, 10-2

DynamicDefinition class, 10-7

elements

of a level MdmHierarchy, 2-13

of a union MdmHierarchy, 2-16

of an MdmAttribute, 2-23

of an MdmLevel, 2-11

of an MdmListDimension, 2-18

of an MdmMeasure, 2-20

ranking, 6-10 to 6-12

selecting by value, 6-2

sorting, 6-10 to 6-12

Empty OLAP API data type, 2-26, 5-9

ExpressTransactionProvider class, 7-8

extent of a Cursor

definition, 8-25

example of calculating, 9-21

use of, 8-26

extract method, description, 5-7

faster varying Cursor components, 8-6

fetch block of a Cursor

definition, 8-27

determining shape of, 8-29

sharing, 8-29

fetch size of a Cursor

definition, 8-27

example of specifying, 9-25, 9-26

reasons for specifying, 8-27

specifying, 8-27

Float OLAP API data type, 2-25, 5-9, 5-10

fundamental Source objects

creating, 5-10

definition, 5-5

FundamentalMetadataObject class, 2-24

FundamentalMetadataProvider class, 2-24

getSource method

for creating primary Source objects, 5-5 to 5-7

for getting Source produced by a Template, example, 10-14

in DynamicDefinition class, 10-2, 10-7

in MdmSource class, 2-7

simple example, 4-9

hierarchies

creating Source objects for, 6-13

definition, 1-2

drilling down, 6-15

in OLAP metadata, 2-3

MdmHierarchy objects, 2-12

node and leaf terminology, 2-16

retrieving default, 4-8, 6-13

input-output order

determining, 6-4, 6-5

effect on Source structure, 6-4, 6-5

inputs

changing to outputs, 6-3 to 6-5

installation for application development, A-2

Integer OLAP API data type, 2-25, 5-9, 5-10

Java Development Kit, version required, A-2

Javadoc, A-3

JDBC

Connection objects, 3-3

DriverManager objects, 3-3

installing, A-2

loading drivers, 3-3

join method

changing inputs to outputs, 6-3

example, 6-4 to 6-5, 6-6, 6-16

leaf in a hierarchy, 2-16

level MdmHierarchy, 2-12

levels

definition, 1-2

in OLAP metadata, 2-3

MdmLevel objects, 2-10

list Source objects, 5-5

MDM. See multidimensional metadata model

MdmAttribute objects

creating Source objects for, 5-7

description, 2-23

elements, 2-23

example of getting, 4-8

MdmDimension objects

description, 2-8

example of getting related objects, 4-7

introduction, 1-6

regions, 2-9

related MdmAttribute objects, 2-9

related MdmDimensionDefinition objects, 2-9

related MdmDimensionMemberType objects, 2-10

MdmDimensionDefinition objects

description, 2-9

example of getting, 4-8

MdmDimensionMemberType objects

description, 2-10

example of getting, 4-8

MdmHierarchy objects

creating Source objects for, 6-13

description, 2-12

elements of a level MdmHierarchy, 2-13

elements of a union MdmHierarchy, 2-16

level type description, 2-12

union type description, 2-12

value type description, 2-12

MdmLevel objects

description, 2-10

elements, 2-11

MdmListDimension objects

description, 2-18

elements, 2-18

MdmMeasure objects

description, 2-19

elements, 2-20

example of getting their dimensions, 4-7

introduction, 1-6

kinds of values, 2-20

MdmMetadataProvider objects

creating, 4-4

description, 4-3

introduction, 1-6

MdmObject class, 2-5

MdmSchema objects

description, 2-6

getting contents of, 4-6

getting the root, 4-6

introduction, 1-6

root, 2-6, 4-4

MdmSource objects, 2-7

measure folders

in OLAP metadata, 2-4

mapped to MdmSchema objects, 2-6

measure MdmDimension objects, 4-6

measures

definition, 1-2

in OLAP metadata, 2-3

MdmMeasure objects, 2-19

Source objects for, 5-7

metadata

definition, 1-3

discovering, 4-2

distinguished from data, 1-5

mapping OLAP metadata to MDM metadata, 2-6

preparation for OLAP API, 1-3, 2-2

sample code for discovering, 4-9 to 4-26

MetadataState class, 10-6

example of implementation, 10-12

multidimensional metadata model (MDM)

description, 2-2

introduction, 1-5

nested outputs

getting values from a Cursor with, example, 9-8

of a Source, definition, 9-3

node in a hierarchy, 2-16

Null OLAP API data type, 5-9

Number OLAP API data type, 2-26, 5-9, 5-10

numeric comparisons

performing, 6-22

numeric functions

creating, 6-27

numeric methods

using, 6-23 to 6-29

numeric operations

example, 6-20, 6-21

list of methods for, 6-19, 6-22

performing, 6-19 to 6-21

OLAP API

definition, 1-2

installing for application development, A-2

software components, 1-7

OLAP API data types

for MDM metadata objects, 2-24

objects that represent, 5-9, 5-10

OLAP Metadata API, 2-2

OLAP metadata objects, 2-2

outputs

changing from inputs, 6-3 to 6-5

getting from a CompoundCursor, example, 9-5

getting from a CompoundCursorSpecification, example, 9-19

getting nested, example, 9-8

in a CompoundCursor, 8-5, 8-23, 8-25

positions of, 8-17

parameterized selections

creating, 6-27

parameters

creating, 6-27

parent attributes

example of getting, 4-8

for MdmHierarchy objects, 2-12

for MdmLevel objects, 2-10

parent-child relationships

creating Source objects for, 6-14

in hierarchies, 2-3, 2-8, 2-10, 2-12, 2-16

position

parent starting and ending, 8-22

position method

description, 5-7

example, 6-8

positions

CompoundCursor, 8-17

Cursor, 8-16

of elements, 6-9

ValueCursor, 8-16

primary Source objects

definition, 5-5

for parent-child relationship, 6-14

from MdmHierarchy objects, 6-13

from MdmSource objects, 2-7

getting, 5-5 to 5-7

result of getSource method, 4-9

structure, 5-6, 5-7

primitive methods, 5-7, 5-8

queries

dynamic, 10-2

Source objects that are not, 8-3

steps in retrieving results of, 9-2

range Source objects, 5-5

ranking elements, 6-10 to 6-12

read Transaction object, 7-3

region attributes

example of getting, 4-8

for MdmHierarchy objects, 2-12

regions

example of getting, 4-8

of an MdmDimension, 2-9

relationships

Source objects for, 6-14

root MdmSchema

description, 2-6

function of, 4-4

obtaining, 4-6

Sales History schema

accessing through sample program, A-3

list of metadata objects in, 4-16

metadata discovery program, 4-9

sample program, A-3

selecting elements

based on element values, 6-2 to 6-6

based on hierarchical position, 6-12 to 6-15

based on rank, 6-6 to 6-12

selectValue method

example, 6-6

self-relation

Source object for, 6-16

Short OLAP API data type, 2-25, 5-9, 5-10

slower varying Cursor components, 8-6, 8-20

software provided, A-2

sorting elements, 6-10 to 6-12

Source class

convenience methods, 5-8

primitive methods, 5-7, 5-8

shortcut methods, 5-8

Source methods

alias, 5-7

distinct, 5-7

extract, 5-7

position, 5-7

string, 6-29 to 6-31

value, 5-7

Source objects

active in a Transaction object, 7-2, 8-4

constant, 5-5

derived, 5-5

for attributes, 5-7

for measures, 5-7

for relationships, 6-14

for self-relation, 6-16

fundamental, 5-5

getting, 5-5 to 5-7

getting a modifiable Source from a DynamicDefinition, 10-7

list, 5-5

modifiable, 10-2

primary, 5-5

range, 5-5

structure, 5-6, 5-7

SourceGenerator class, 10-6

example of implementation, 10-13

span of a value in a Cursor

definition, 8-22, 9-21

SpecifiedCursorManager objects

closing, 8-12

returned by the createCursorManager method, 8-12

string methods, 6-29 to 6-31

String OLAP API data type, 2-25, 5-9, 5-10

subschemas

description, 4-4

getting contents, 4-6

table view

navigating Cursor for, example, 9-10

Template class, 10-6

designing, 10-7

example of implementation, 10-9

Template objects

benefits of using, 1-10

classes used to create, 10-3

for creating modifiable Source objects, 10-2

introductory example, 1-11

relationship of classes producing a dynamic Source, 10-4

Transaction objects used in, 7-5

Transaction objects

child read and write, 7-3

committing, 7-3

creating a Cursor in the current, 8-4

current, 7-2

example of using child, 7-9

getting the current, 7-8

preparing, 7-3

read, 7-3

rolling back, 7-7

setting the current, 7-8

using in Template classes, 7-5

write, 7-3

TransactionProvider interface, 7-8

TransactionProvider objects

creating, 3-4

needed to create MdmMetadataProvider, 4-3

tuple

definition, 8-17

in a Cursor, example, 9-9

type of an MDM object

defined, 2-28

obtaining, 2-29

union MdmHierarchy, 2-12

value MdmHierarchy, 2-12

value method, 5-7

Value OLAP API data type, 2-26, 5-9, 5-10

ValueCursor objects

getting from a parent CompoundCursor, example, 9-5

getting values from, example, 9-4, 9-5

position, 8-16

virtual Cursor

definition, 8-27

Void OLAP API data type, 2-26

write Transaction object, 7-3

Index

A

B

C

D

E

F

G

H

I

J

L

M

N

O

P

Q

R

S

T

U

V

W