Skip Headers

Oracle® OLAP Developer's Guide to the OLAP API
10g Release 1 (10.1)

Part Number B10335-02
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 

A

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
ancestors attribute
example of getting, 4.7.1
method for getting, 2.6
appendValues method
example of, 7.2.2
application
tasks performed by, 1.5
asymmetric result set, Cursor positions in an, 9.7.2
at method, example of, 7.3.2
attributes
based on a database column, 2.2.1, 2.9.1
definition, 1.1.1
example of getting, 4.7.1
in OLAP metadata, 2.2.1
MdmAttribute objects, 2.9.1

B

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

C

Catalog
see OLAP Catalog
class libraries, obtaining, A.3
classes12.jar file, 3.1, A.3
code for examples, 1.2
COMPARISON_RULE_ASCENDING
example of, 7.2.6, 7.3.3
COMPARISON_RULE_ASCENDING_NULLS_FIRST
example of, 7.2.6
COMPARISON_RULE_ASCENDING_NULLS_LAST
example of, 7.2.6
COMPARISON_RULE_DESCENDING
example of, 7.2.4
COMPARISON_RULE_DESCENDING_NULLS_LAST
example of, 7.2.6
COMPARISON_RULE_REMOVE
example of, 6.4.2, 6.4.2, 7.2.4, 7.2.5, 7.3.5
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 one, 3.3
connections
closing, 3.5
getting existing ones, 3.3
prerequisites, 3.1.2
steps for establishing, 3.2
count method, example of, 7.3.5
createListSource method
example of, 6.5, 7.2.3, 7.3.6, 7.3.6
createParameterizedSource method
example of, 6.5, 7.3.1, 7.3.7
createRangeSource method, example of, 7.2.5
createSQLCursorManager method, 9.1, 9.5
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.1
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.1, 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.1, 10.1
methods of creating, 9.1
updating the CursorManagerSpecification, 9.5.1
CursorManagerSpecification class, 9.3
creating object, example of, 7.3.1, 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, 5.3

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.10.1
of MdmSource objects, 2.10.2
of Source objects, 6.3.1, 6.3.1
data warehouse, 1.1.2
DataProvider objects
creating, 3.2.4
needed to create MdmMetadataProvider, 4.2
Date OLAP API data type, 2.10.1
derived Source objects
definition, 6.2
detailed data
in a hierarchy, 5.4.1
storage type, 5.4.2.2
dimensions
definition, 1.1.1
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.4
Double OLAP API data type, 2.10.1
drilling in a hierarchy, example of, 7.3.2
DriverManager objects, 3.2.2
dynamic queries, 11.1
DynamicDefinition class, 11.2.5

E

edges of a cube
definition, 1.1.1
pivoting, example of, 7.3.1
elements
of an MdmAttribute, 2.9.2
of an MdmLevel, 2.7
of an MdmMeasure, 2.8.2
embedded totals (ET) storage type, 5.4.2.2
Empty OLAP API data type, 2.10.1
ET aggregation form, 5.4.2
ETT tool, 1.1.2
example programs
complete code for, 1.2
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.1
example of, 6.5, 7.2.3, 7.3.6, 7.3.6
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.10.1
font conventions
general, Preface
OLAP API data types, 2.10.1
fundamental Source objects
definition, 6.2
FundamentalMetadataObject class, 2.10.1
FundamentalMetadataProvider class, 2.10.1

G

generated SQL, getting, 9.1
getAncestorsAttribute method
of an MdmHierarchy, 2.6
getDefaultMetadataProvider method
example of, 4.2
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.5
getOutputs method
of a Source, 6.4.2
getParentAttribute method
of an MdmHierarchy, 2.6
getRootSchema method, 4.3.2
getSource method
example of, 4.6, 7.2.5, 7.3.2
for getting Source produced by a Template, example, 11.3.2
in DynamicDefinition class, 11.1.1, 11.2.5
in MdmSource class, 2.3.3
getSubSchema method, 4.4.2
getType method
of a Source, 6.3.2
of an MdmSource, example of, 2.10.4
GID
calculating values of, 5.4.2.2
column of fact table, 5.4.2.2
Global schema
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.5

H

hierarchical sorting, example of, 7.3.3
hierarchies
based on a database column, 2.2.1
definition, 1.1.1
in OLAP metadata, 2.2.1
level-based, 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 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.10.1
interval method, example of, 7.3.7
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.4
rules governing matching a Source to an input, 6.4.3

L

lag method, example of, 7.3.6
leaf-level data
in a hierarchy, 5.4.1
storage type, 5.4.2.2
level hierarchy, 5.4.1
levels
based on a database column, 2.2.1
definition, 1.1.1
in OLAP metadata, 2.2.1
MdmLevel objects, 2.7
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.2, 6.4.3, 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
description, 2.9.1
elements, 2.9.2
MdmCustomObjectFactory, 5.3
MdmDimension objects
description, 2.4
example of getting related objects, 4.5.2
introduction, 1.3.2
related MdmAttribute objects, 2.4
MdmLevel objects
description, 2.7
elements, 2.7
MdmLevelHierarchy objects
description, 2.6.1
MdmMeasure
creating custom, 5.3
MdmMeasure objects
description, 2.8.1
elements, 2.8.2
example of getting their dimensions, 4.5.1
introduction, 1.3.2
kinds of values, 2.8.2.1
MdmMetadataProvider objects
creating, 4.2
description, 4.2
introduction, 1.3.1
MdmObject class, 2.3
MdmPrimaryDimension objects
description, 2.5, 2.5, 2.6.2
MdmSchema objects
description, 2.3.2
getting contents of, 4.4
getting the root, 4.3.2
introduction, 1.3.1
root, 2.3.2, 4.3.1
MdmSource objects, 2.3.3
MdmStandardDimension objects
description, 2.5
MdmSubDimension, 2.6
MdmTimeDimension objects
description, 2.5
measure folders
in OLAP Catalog, 2.2
in OLAP metadata, 2.2.3
mapped to MdmSchema objects, 2.3.2
measure MdmDimension objects, 4.4.4
measures
based on a database column, 2.2.2, 2.8.2
definition, 1.1.1
in OLAP metadata, 2.2.2
MdmMeasure objects, 2.8.1
metadata
creating a provider, 4.2
definition
discovering, 4.1
distinguished from data, 1.3
mapping OLAP metadata to MDM metadata, 2.3.1
preparation for OLAP API, 2.1.2
sample code for discovering, 4.7.1
metadata mapping (MTM) objects
definition
MetadataState class, 11.2.3
example of implementation, 11.3.1
movingTotal method, example of, 7.3.6
MTM. See metadata mapping objects
MtmAggregationSpecification, 5.4.3
MtmAggregationStep, 5.4.3
MtmAttributeMap, 5.1.1
MtmColumnExpression, 5.2
MtmCube, 5.1.1, 5.3
MtmCubeDimensionality, 5.1.1
MtmCustomExpression, 5.2
MtmDimensionMap, 5.1.1
MtmDimensionOrderSpecification, 5.1.1
MtmExpression, 5.1.1, 5.3
MtmFirstLastAggregationStep, 5.4.3
MtmLiteralExpression, 5.2
MtmMeasureMap, 5.1.1, 5.3
MtmNoAggregationStep, 5.4.3
MtmObject
classes, using to discover relational columns, 5.2
MtmSimpleAggregationStep, 5.4.3
MtmSolvedCubeDimensionality, 5.4.2.2
MtmSolvedETCubeDimensionality, 5.4.2.2
MtmSolvedGroupingSetCubeDimensionality, 5.4.2.2
MtmSolvedRollupCubeDimensionality, 5.4.2.2
MtmSolveSpecification, 5.4.3
MtmSourceMap
mapping MdmSource to relational tables and expressions, 5.1
MtmTabularSource, 5.1.1
MtmWeightedAverageStep, 5.4.3
multidimensional metadata model (MDM)
description, 2.1
introduction, 1.3.1

N

nested outputs
getting values from a Cursor with, example, 10.1.1
of a Source, definition, 10.1.1
nls_charset12.jar file, A.3
Number OLAP API data type, 2.10.1
NumberParameter objects
example of, 7.3.7

O

OLAP API
definition, 1.1
required class libaries, A.2
sample schema for examples, 1.2
software components, 1.4
OLAP API data types
font conventions, 2.10.1
for MDM metadata objects, 2.10.1
OLAP Catalog, 1.3, 2.2
OLAP metadata objects, 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 Source
definition, 6.4.2
obtaining, 6.4.2
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.1, 7.3.7
parameterized Source objects
description, 6.5
example of, 6.5, 7.3.1, 7.3.7
parent attribute
example of getting, 4.7.1
method for getting, 2.6
parent-child relationships
in hierarchies, 2.2.1, 2.6
in levels, 2.7
pivoting cube edges, example of, 7.3.1
plus method, example of, 7.3.5
position method, 6.4.1
description, 7.1
example of, 7.2.5
positions
CompoundCursor, 9.7.2
Cursor, 9.7
parent starting and ending, 9.7.3
ValueCursor, 9.7.1
primary Source objects
definition, 6.2
from MdmSource objects, 2.3.3
result of getSource method, 4.6

Q

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

ranking values, 7.3.5
read Transaction object, 8.1.1
recursiveJoin method
description, 7.1
example of, 7.2.6, 7.3.3
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.2
function of, 4.3.1
obtaining, 4.3.2
rotating cube edges, example of, 7.3.1

S

sample schemas, 1.2
schemas
relationship to the OLAP API, 1.3.1
star, 1.1.2
select method, example of, 7.3.5
SELECT statement
for an MdmDimension, 5.1.1
for an MdmMeasure, 5.1.1
selecting
by position, 7.3.7
by rank, 7.3.5
by time series, 7.3.6
selectValue method
example of, 7.2.2, 7.2.3
selectValues method
example of, 7.2.7, 7.3.1
setValue method
example of, 6.5, 7.3.1, 7.3.7
Short OLAP API data type, 2.10.1
SID (system identifier), 3.2.2
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.3
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
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
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
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.1
returned by the createCursorManager method, 9.5
SQL group functions, 5.4.3
SQL, getting generated, 9.1
SQLCursorManager class, 1.5.4
star schema, 1.1.2
String OLAP API data type, 2.10.1
StringParameter objects
example of, 6.5, 7.3.1
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.6
times method, example of, 7.3.4
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
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, 9.7.2
in a Cursor, example, 10.1.1
type of an MDM object
definition, 2.10.3
obtaining, 2.10.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, 5.4.1
value method, 6.4.1
description, 7.1
example of, 7.2.7, 7.3.2, 7.3.5
Value OLAP API data type, 2.10.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.10.1

W

write Transaction object, 8.1.1