Skip Headers
Oracle® OLAP Developer's Guide to the OLAP API
10g Release 2 (10.2)

Part Number B14347-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
View PDF

Index

A  B  C  D  E  F  G  H  I  J  L  M  N  O  P  Q  R  S  T  U  V  W  X 

A

addCustomMember method, 2.6
aggregate data
in a hierarchy, 5.4.1
aggregated values
supplied by materialized views, 5.4.2.2
aggregating data
for solved cubes, 5.4.2.2
for unsolved cubes, 5.4.2.1
aggregation forms
ET, 5.4.2
for cubes, 5.4.2
grouping set, 5.4.2
rollup, 5.4.2
aggregation functions, 5.4.3
aggregation steps, 5.4.3
alias method
description, 7.1
example of, 7.2.1
analytic workspaces
creating dynamic, 1.1.2
ancestors attribute
example of getting, 4.7.1
method for getting, 2.4.2.1
appendValues method
example of, 7.2.2
application
tasks performed by, 1.5
assigned values
specified by an Assignment, 6.6.1
Assignment objects
assigned value dependent on another Assignment, example of, 6.6.3
assigned value result of aggregation, example of, 6.6.4
of a Model, 6.6.1
asymmetric result set, Cursor positions in an, 9.7.2
at method, example of, 7.3.3
attributes
based on a database column, 2.2.1, 2.5.2
definition, 1.1.1
example of getting, 4.7.1
in OLAP metadata, 2.2.1
MdmAttribute objects, 2.5.2

B

base cubes
representing hierarchies, 5.1.3
base Source
definition, 6.3.2, 7.1
Boolean OLAP API data type, 2.7.1

C

Catalog
see OLAP Catalog
class libraries, obtaining, A.3
classes12.jar file, 3.1, A.3
code for examples, 1.2
color custom MdmAttribute, 2.5.2, 6.6.4
COMPARISON_RULE_ASCENDING
example of, 7.2.5, 7.3.4
COMPARISON_RULE_ASCENDING_NULLS_FIRST
example of, 7.2.5
COMPARISON_RULE_ASCENDING_NULLS_LAST
example of, 7.2.5
COMPARISON_RULE_DESCENDING
example of, 7.2.3
COMPARISON_RULE_DESCENDING_NULLS_LAST
example of, 7.2.5
COMPARISON_RULE_REMOVE
example of, 6.4.2, 6.4.2, 7.2.3, 7.2.4, 7.3.6
COMPARISON_RULE_SELECT
example of, 6.4.2, 6.4.2
CompoundCursor objects
getting children of, example, 10.1.1
navigating for a crosstab view, example, 10.2, 10.2
navigating for a table view, example, 10.2
positions of, 9.7.2
Connection objects
example of closing, 3.5
example of creating, 3.2
example of getting an existing, 3.3
connections
closing, 3.5
getting existing, 3.3
prerequisites, 3.1.2
steps for establishing, 3.2
count method, example of, 7.3.6
createCustomMeasure method, 2.6
example of, 2.8
createCustomMember method
example of, 2.6
createListSource method
example of, 6.5, 7.3.1, 7.3.7, 7.3.7
createParameterizedSource method, 6.5
example of, 6.5, 6.5, 7.3.2, 7.3.8
createRangeSource method, example of, 7.2.4
createSQLCursorManager method, 9.1, 9.5
createStandardCustomMember method, 2.6
createTimeCustomMember method, 2.6
crosstab view
example of, 7.2.1
navigating Cursor for, example, 10.2, 10.2
cubes
aggregation forms for, 5.4.2
definition, 1.1.1
example of, 7.3.2
in OLAP metadata, 2.2, 2.2.2
partitioned into base cubes, 5.1.3
recording dimensionality of MdmMeasure objects, 5.1.3
solved, 5.4.1
unsolved, 5.4.1
current position in a Cursor, definition, 9.7
Cursor class
architecture, advantages of, 9.1.1
Cursor objects
created in the current Transaction, 9.1.4
creating, example of, 7.3.2, 10.1
current position, definition, 9.7
CursorManager objects for creating, 9.5
extent calculation, example, 10.4
extent definition, 9.7.4
faster and slower varying components, 9.2.1
fetch size definition, 9.8
getting children of, example, 10.1.1
getting the values of, examples, 10.1.1
methods of creating, 9.1
parent starting and ending position, 9.7.3
position, 9.7
Source objects for which you cannot create, 9.1.3
span, definition, 9.7.3
specifying fetch size for a table view, example, 10.5
specifying the behavior of, 9.2.2, 10.3
starting and ending positions of a value, example of calculating, 10.4
structure, 9.2.1
CursorInfoSpecification interface, 9.4
CursorInput class, 9.3, 9.6.1
CursorInput objects
compared to Parameter objects, 6.5
CursorManager class, 9.5
CursorManager objects
closing before rolling back a Transaction, 8.2
creating, example of, 7.3.2, 10.1
methods of creating, 9.1
updating the CursorManagerSpecification, 9.5.1
CursorManagerSpecification class, 9.3
creating object, example of, 7.3.2, 10.1
CursorManagerUpdateEvent class, 9.6.3
CursorManagerUpdateListener class, 9.6.2
CursorSpecification class, 9.4, 9.4
CursorSpecification objects
getting from a CursorManagerSpecification, example, 10.3
custom
MdmMeasure, creating, 2.8, 5.3
MdmMeasureDimension member, creating, 2.8
metadata objects, creating, 2.8
custom dimension members
creating, 2.6, 2.6
new feature, Preface
CustomModel class, 6.6.1
CustomModel objects
example of, 6.6.2
inputs of, 6.6.1
outputs of, 6.6.1
parent Model objects of, 6.6.1

D

data store
definition, 1.1.2
exploring, 4.1.2
gaining access to data in, 4.1
scope of, 4.1
data type
of MDM metadata objects, 2.7.1
of Source objects, 6.3.1, 6.3.1
OLAP API, 2.7.1
data warehouse, 1.1.2
DataProvider objects
creating, 3.2.4
needed to create MdmMetadataProvider, 4.2
Date OLAP API data type, 2.7.1
derived Source objects
definition, 6.2
detailed data
in a hierarchy, 5.4.1
storage type, 5.4.2.2
dimension members
creating custom, 2.6
dimensioned Source
definition, 6.4.1
dimensions
creating custom members, 2.6
definition, 1.1.1
dimensioning measures, 2.4
in OLAP metadata, 2.2.1
MdmDimension objects, 2.4
value formatting, 1.3.3
distinct method
description, 7.1
example of, 7.2.2
div method, example of, 7.3.5
DML
custom dimension members not available to, 2.6
Model object, 6.6.1, 6.6.1
Double OLAP API data type, 2.7.1
drilling in a hierarchy, example of, 7.3.3
DriverManager objects, 3.2.2
dynamic analytic workspaces, 1.1.2
dynamic queries, 11.1
dynamic Source objects
definition, 6.2
example of getting, 11.3.2
produced by a Template, 11.1.1
DynamicDefinition class, 11.2.5

E

edges of a cube
definition, 1.1.1
pivoting, example of, 7.3.2
elements
of a dimension, 2.2.1
of an MdmAttribute, 2.5.2
of an MdmMeasure, 2.5.1
embedded totals (ET) storage type, 5.4.2.2
Empty OLAP API data type, 2.7.1
empty Source objects
definition, 6.2
ET aggregation form, 5.4.2
ETT tool, 1.1.2
example programs
complete code for, 1.2
new, Preface
sample schema for, 1.2
ExpressDataCursorManager class, 9.5
ExpressDataCursorManager, returned by the createCursorManager method., 9.1.2
ExpressSpecifiedCursorManager class, 9.5
ExpressSpecifiedCursorManager, returned by the createCursorManager method., 9.1.1
ExpressSQLCursorManager class, 1.5.4, 9.1, 9.5
ExpressTransactionProvider class, 8.2
extent of a Cursor
definition, 9.7.4
example of calculating, 10.4
use of, 9.7.4
extract method, 6.4.1
description, 7.3.1
example of, 6.5, 7.3.1, 7.3.7, 7.3.7
implemented as a CustomModel, 6.6.2
extraction input
definition, 6.4.1

F

faster varying Cursor components, 9.2.1
fetch size of a Cursor
definition, 9.8
example of specifying, 10.5
reasons for specifying, 9.8
Float OLAP API data type, 2.7.1
font conventions
OLAP API data types, 2.7.1
fundamental Source objects
definition, 6.2
FundamentalMetadataObject class, 2.7.1
FundamentalMetadataProvider class, 2.7.1

G

generated SQL, getting, 9.1
getAncestorsAttribute method
of an MdmHierarchy, 2.4.2.1
getDefaultMetadataProvider method
example of, 4.2
getEmptySource method, 6.2
example of, 6.4.2, 6.4.2, 6.4.3
getID method
of a Source, 6.3.3
getID method, example of, 6.5
getInputs method, 6.4.1
getLevelAttribute method, example of, 7.2.4
getOutputs method
of a Source, 6.4.2
getParentAttribute method
of an MdmHierarchy, 2.4.2.1
getRootSchema method, 4.3.2
getSource method
example of, 4.6, 7.2.4, 7.3.3
for getting Source produced by a Template, example, 11.3.2
in DynamicDefinition class, 11.1.1, 11.2.5
of an MdmSource, 2.3.4
getSubSchema method, 4.4.2
getType method
of a Source, 6.3.2
of an MdmSource, example of, 2.7.4
getVoidSource method, 6.2
GID
calculating values of, 5.4.2.2
column of fact table, 5.4.2.2
Global Schema for Documentation with OLAP Catalog Metadata
description, 1.2
discovering metadata for, 4.7
Grouping ID (GID) column of fact table, 5.4.2.2
grouping set aggregation form, 5.4.2
Grouping Set, form of materialized view for aggregating data, 5.4.2.2
gt method, example of, 7.3.6

H

hierarchical sorting, example of, 7.3.4
hierarchies
based on a database column, 2.2.1
definition, 1.1.1
in OLAP metadata, 2.2.1
level-based, 5.4.1
limit of levels in, 2.2.1, 5.4.1
solved, 5.4.1
unsolved, 5.4.1
value-based, 5.4.1
hierarchies of an MdmDimension
example of getting, 4.7.1

I

identification
of a Source, 6.3.3
inputs
of a Cursor, 9.6.1
of a CustomModel, 6.6.1
of a Model, 6.6.1
of a Source
definition, 6.4.1
matching to a Source, 6.4.2, 6.4.3
obtaining, 6.4.1
producing, 6.4.1
Integer OLAP API data type, 2.7.1
interval method, example of, 7.3.8
isSubType method, example of, 6.3.2

J

Java archive (jar) files, required, 3.1
Java Development Kit, version required, A.2
JDBC
Connection objects, 3.2.2
DriverManager objects, 3.2.2
libraries required, A.2
loading drivers, 3.2.1
join method
description, 7.1
examples of, 7.2
examples of using different comparison rules, 7.2.3
rules governing matching a Source to an input, 6.4.3

L

lag method, example of, 7.3.7
leaf-level data
in a hierarchy, 5.4.1
storage type, 5.4.2.2
level hierarchy, 2.2.1, 5.4.1
levels
based on a database column, 2.2.1
definition, 1.1.1
in OLAP metadata, 2.2.1
limit of number in a hierarchy, 2.2.1, 5.4.1
MdmLevel objects, 2.4.2.4
list Source objects
definition, 6.2
local dimension value, 1.3.3
lowest level storage type, 5.4.2.2

M

mapping
MdmSource objects to relational tables and expressions, 5.1
matching a Source to an input
example, 6.4.3
example of, 6.4.2, 6.4.3, 6.4.3
rules governing, 6.4.3
materialized views
solved cube as a, 5.4.1
supplying aggregated values, 5.4.2.2
MDM. See multidimensional metadata model
MdmAttribute objects
custom attribute, used in example, 6.6.4
description, 2.5.2
elements, 2.5.2
MdmAttributeModel class
subclass of MdmDimensionedObject, 2.3.2
MdmAttributeModel objects
not having parent Model objects, 6.6.1
MdmCustomObjectFactory object
creating custom dimension members with, 2.6
MdmCustomObjectFactory objects
creating custom metadata objects with, 2.8
using to create a custom measure, 5.3
MdmDimension objects
description, 2.4
example of getting related objects, 4.5.2
introduction, 1.3.2
related MdmAttribute objects, 2.4
MdmDimensionCalculationModel class, 2.3.2, 2.3.2
MdmDimensionCalculationModel objects
not having parent Model objects, 6.6.1
MdmDimensionedObject class
description, 2.5
MdmDimensionedObject object, 2.3.2
MdmDimensionedObjectModel class, 2.3.2
MdmHierarchy class, 2.4.2.1
MdmLevel objects
description, 2.4.2.4
members, 2.4.2.4
MdmLevelHierarchy objects
description, 2.4.2.2
MdmMeasure objects
creating custom, 2.6, 2.8, 5.3
description, 2.5.1
elements, 2.5.1
example of getting their dimensions, 4.5.1
introduction, 1.3.2
kinds of values, 2.5.1
MdmMeasureModel
subclass of MdmDimensionedObject, 2.3.2
MdmMeasureModel objects
parent Model objects of, 6.6.1
MdmMember interface
description, 2.6
MdmMetadataProvider objects
creating, 4.2
description, 4.2
introduction, 1.3.1
MdmModel class, 2.3.2
MdmObject class, 2.3
MdmPrimaryDimension objects
description, 2.4.1, 2.4.1, 2.4.2.3
MdmSchema objects
description, 2.3.3
getting contents of, 4.4
getting the root, 4.3.2
introduction, 1.3.1
root, 2.3.3, 4.3.1
MdmSource objects, 2.3.4
MdmStandardDimension objects
description, 2.4.1
MdmSubDimension class, 2.4.2
MdmTimeDimension objects
description, 2.4.1
measure folders
in OLAP metadata, 2.2, 2.2.3
mapped to MdmSchema objects, 2.3.3
measure MdmDimension objects, 4.4.4
measures
based on a database column, 2.2.2, 2.5.1
definition, 1.1.1
dimensioned by dimensions, 1.1.1, 2.4
in OLAP metadata, 2.2.2
MdmMeasure objects, 2.5.1
members
of a dimension, 2.2.1
of an MdmDimension, 2.4
of an MdmLevel, 2.4.2.4
metadata
creating a provider, 4.2
definition, 1.1.2
discovering, 4.1
distinguished from data, 1.3
mapping OLAP metadata to MDM metadata, 2.3.1
preparation for OLAP API, 1.1.2, 2.1.2
sample code for discovering, 4.7.1
metadata mapping (MTM) objects
definition, 5
MetadataState class, 11.2.3
example of implementation, 11.3.1
Model interface, 2.3.2, 6.6.1
description, 6.6.1
movingTotal method, example of, 7.3.7
MTM. See metadata mapping objects
MtmAggregationSpecification class
description, 5.4.3
MtmAggregationStep class
description, 5.4.3
MtmAttributeMap objects
storing information about columns mapped to an MdmDimension, 5.1.1
MtmBaseCube objects
description, 5.1.1
MtmColumnExpression objects
mapping an MdmSource to a column, 5.2
MtmCubeDimensionality objects
description, 5.1.1
MtmCustomExpression objects
not mapped to a specific column, 5.2
MtmDimensionMap objects
SQL statement for MdmSubDimension based on, 5.1.1
MtmDimensionOrderSpecification objects
description, 5.1.1
MtmExpression
mapping an MdmSource to a specific column, 5.2
MtmExpression objects
creating with an MdmCustomObjectFactory, 5.3
description, 5.1.1
MtmFirstLastAggregationStep class
description, 5.4.3
MtmLiteralExpression objects
not mapped to a specific column, 5.2
MtmMeasureMap objects
getting for an MdmMeasure, 5.3
SQL statement for MdmSubDimension based on, 5.1.1
MtmNoAggregationStep class
description, 5.4.3
MtmObject class
using to discover relational column mappings to MdmSource objects, 5.2
MtmPartitionedCube objects
getting for an MtmMeasureMap, 5.3
MtmSimpleAggregationStep class
description, 5.4.3
MtmSolvedCubeDimensionality class
representing aggregation forms, 5.4.2.2
MtmSolvedETCubeDimensionality class
representing an aggregation form, 5.4.2.2
MtmSolvedGroupingSetCubeDimensionality class
representing an aggregation form, 5.4.2.2
MtmSolvedRollupCubeDimensionality class
representing an aggregation form, 5.4.2.2
MtmSolveSpecification class
description, 5.4.3
MtmSourceMap objects
mapping MdmSource to relational tables and expressions, 5.1
MtmTabularSource objects
description, 5.1.1
MtmWeightedAverageStep class
description, 5.4.3
multidimensional metadata model (MDM)
description, 2.1
introduction, 1.3.1

N

nested measure folders, 2.2.3
nested outputs
getting values from a Cursor with, example, 10.1.1
of a Source, definition, 10.1.1
null Source objects
definition, 6.2
nullSource method, 6.2
Number OLAP API data type, 2.7.1
NumberParameter objects
example of, 7.3.8

O

OLAP API
definition, 1.1
required class libraries, A.2
sample schema for examples, 1.2
software components, 1.4
OLAP API data types
font conventions, 2.7.1
for MDM metadata objects, 2.7.1
OLAP Catalog, 1.1.2
OLAP metadata objects, 1.3, 2.2
olap_api.jar file, A.3
Oracle Enterprise Manager, 1.3.1
ORACLE_HOME environment variable, A.3
outputs
getting from a CompoundCursor, example, 10.1.1
getting from a CompoundCursorSpecification, example, 10.3
getting nested, example, 10.1.1
in a CompoundCursor, 9.2.1, 9.7.3, 9.7.4
positions of, 9.7.2
of a CustomModel, 6.6.1
of a Source
definition, 6.4.2
obtaining, 6.4.2
order of, 6.4.3, 7.2.1
producing, 6.4.2

P

Parameter objects
compared to CursorInput objects, 6.5, 9.6.1
description, 6.5
example of, 6.5, 7.3.2, 7.3.8
parameterized Source objects
definition, 6.2
description, 6.5
example of, 6.5, 7.3.2, 7.3.8
parent attribute
example of getting, 4.7.1
method for getting, 2.4.2.1
parent Model objects
of a CustomModel, 6.6.1
of a Model, 6.6.1
parent-child relationships
in hierarchies, 2.2.1, 2.4.2.1
in levels, 2.4.2.4
pivoting cube edges, example of, 7.3.2
placeholder Source
new feature, Preface
placeholder Source objects
definition, 6.2
example of, 6.6.3, 6.6.4
plus method, example of, 7.3.6
position method, 6.4.1
description, 7.1
example of, 7.2.4
positions
CompoundCursor, 9.7.2
Cursor, 9.7
parent starting and ending, 9.7.3
ValueCursor, 9.7.1
precedence
of an Assignment, 6.6.1
primary Source objects
definition, 6.2
from MdmSource objects, 2.3.4
result of getSource method, 4.6

Q

Qualification objects
of an Assignment, 6.6.1
queries
creating using Source methods, 7
definition, 1.1.1
dynamic, 11.1
Source objects that are not, 9.1.3
specifying with Source objects, 6
steps in retrieving results of, 10.1

R

range Source objects
definition, 6.2
ranking values, 7.3.6
read Transaction object, 8.1.1
recursiveJoin method
description, 7.1
example of, 7.2.5, 7.3.4
regular input
definition, 6.4.1
relational schema, 1.1.2, 1.3.1
Rolled Up, form of materialized view for aggregating data, 5.4.2.2
rolllup aggregation form, 5.4.2
root MdmSchema
description, 2.3.3
function of, 4.3.1
obtaining, 4.3.2
rotating cube edges, example of, 7.3.2

S

sample schemas, 1.2
schemas
relationship to the OLAP API, 1.3.1
star, 1.1.2
select method, example of, 7.3.6
SELECT statement
for an MdmDimension, 5.1.1
for an MdmMeasure, 5.1.1
selecting
by position, 7.3.8
by rank, 7.3.6
by time series, 7.3.7
selectValue method
example of, 7.2.2, 7.3.1
selectValues method
example of, 7.2.6, 7.3.2
setValue method
example of, 6.5, 7.3.2, 7.3.8
Short OLAP API data type, 2.7.1
SID (system identifier), 3.2.2
SingleSelectionTemplate class, 8.1.5, 8.2, 11.3.2, B.1
slower varying Cursor components, 9.2.1, 9.7.2
solve specification, description, 5.4.3
solved cubes, 5.4.1
aggregating data for, 5.4.2.2
solved hierarchies, 5.4.1
sorting hierarchically, example of, 7.3.4
Source class
basic methods, 7.1
Source objects
active in a Transaction object, 9.1.4
data type
definition, 6.3.1
getting, 6.3.1
dimensioned, 6.4.1
getting a modifiable Source from a DynamicDefinition, 11.2.5
identification String
obtaining, 6.3.3
inputs of
definition, 6.4.1
matching to a Source, 6.4.2, 6.4.3
obtaining, 6.4.1
producing, 6.4.1
introducing, 6
kinds of, 6.2
methods of getting, 6.2
modifiable, 11.1
outputs of
definition, 6.4.2
obtaining, 6.4.2
producing, 6.4.2
parameterized, 6.5
SourceDefinition for, 6.3.3
specifying value of an Assignment, 6.6.1
subtype
definition, 6.3.2
obtaining, 6.3.2
type
definition, 6.3.2
obtaining, 6.3.2
SourceDefinition, 6.3.3
SourceGenerator class, 11.2.4
example of implementation, 11.3.1
span of a value in a Cursor
definition, 9.7.3, 10.4
SpecifiedCursorManager objects
closing, 9.5
creating, example of, 7.3.2
returned by the createCursorManager method, 9.5
SQL
custom dimension members not available to, 2.6
getting generated, 9.1
group functions, 5.4.3
Model clause, 6.6.1, 6.6.1
SQLCursorManager class, 1.5.4
star schema, 1.1.2
String OLAP API data type, 2.7.1
StringParameter objects
example of, 6.5, 7.3.2
subschemas
description, 4.3.1
getting contents, 4.4.3
subtype of an Source object
definition, 6.3.2
obtaining, 6.3.2

T

table view
navigating Cursor for, example, 10.2
Template class, 11.2.2
designing, 11.3
example of implementation, 11.3.1
Template objects
classes used to create, 11.2
for creating modifiable Source objects, 11.1
relationship of classes producing a dynamic Source, 11.2.1
Transaction objects used in, 8.1.3
time series, selecting based on, 7.3.7
times method, example of, 7.3.5
TopBottomTemplate class, 8.1.5, 8.2, 11.3.1
Transaction objects
child read and write, 8.1.1
committing, 8.1.2
creating a Cursor in the current, 9.1.4
current, 8.1
custom metadata objects existing in, 2.8
example of using child, 8.2
getting the current, 8.1.6
preparing, 8.1.2
read, 8.1.1
rolling back, 8.1.5
setting the current, 8.1.6
using in Template classes, 8.1.3
write, 8.1.1
TransactionProvider interface, 8.2
TransactionProvider objects
creating, 3.2.3
tuple
definition, 2.5.1
in a Cursor, example, 10.1.1
specifying a measure value, 9.7.2
type of an MDM object
definition, 2.7.3
obtaining, 2.7.4
type of an Source object
definition, 6.3.2
obtaining, 6.3.2

U

unique dimension value, 1.3.3
unsolved cubes, 5.4.1
aggregating data for, 5.4.2.1
unsolved hierarchies, 5.4.1

V

value hierarchy, 2.2.1, 5.4.1
value method, 6.4.1
description, 7.1
example of, 7.2.6, 7.3.3, 7.3.6
Value OLAP API data type, 2.7.1
value separation string, 1.3.3
ValueCursor objects
getting from a parent CompoundCursor, example, 10.1.1
getting values from, example, 10.1.1, 10.1.1
position, 9.7.1
virtual Cursor
definition, 9.8
Void OLAP API data type, 2.7.1
void Source objects
definition, 6.2

W

write Transaction object, 8.1.1

X

xmlparserv2.jar file, A.3