Skip Headers
Oracle® OLAP Java API Developer's Guide
11g Release 2 (11.2)

Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
PDF · Mobi · ePub


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


access to metadata objects
addObjectClassification method, 2.2.3
aggregate levels of a hierarchy,
AggregationCommand objects
example of creating, 4.5.1
alias method
description, 6.1
example of, 6.2.1
ALL metadata reader mode,,
Analytic Workspace Manager, 1.1.5
analytic workspaces
building, 1.1.5
building, example of, 4.8
creating, 4.2
sample, 1.3
ancestors attribute
example of getting,
method for getting,
appendValues method,
example of, 6.2.2
requirements for developing, A.1
typical tasks performed by, 1.4
comparison rules in a join operation,
asymmetric result set, Cursor positions in an, 8.5.2
at method
example of, 6.3.3
AttributeMap objects
creating, 4.3.2
as dimensional data objects, 1.1.3
creating, 4.4
creating an index for,
mapping, 4.4
mapping, example of, 4.3.2
prefixes for in materialized views,
represented by MdmAttribute objects, 2.4.3
specifying language for,
specifying target dimension for,
unique key,
AW objects
creating, 4.2
AWCubeOrganization class,
AWCubeOrganization objects
example of creating, 4.5.1
AWPrimaryDimensionOrganization objects
creating, 4.3.1


base Source
definition, 5.3.3, 6.1
of a join operation, 5.4.1 example program, 1.3
BaseMetadataObject class, 2.2
basic Source methods, 6.1
bind variables
in XML templates,
Buildable interface,
building analytic workspaces, 1.1.5
example of, 4.8
BuildItem objects
creating, 4.8
BuildProcess objects
creating, 4.8


Cartesian product
result of joining unrelated Source objects,
class libraries
obtaining, A.3
classifying metadata objects, 2.2.3
ColumnExpression objects
creating, 4.3.2
committing transactions, 4.6
comparison parameter
of the join method,
example of, 6.2.5, 6.3.4
example of, 6.2.5
example of, 6.2.3
example of, 6.2.5
example of,, 6.2.4,
example of,,,,
comparisonRule parameter
of a join method,
CompoundCursor objects
getting children of, example, 9.1.1
navigating for a crosstab view, example, 9.2, 9.2
navigating for a table view, example, 9.2
positions of, 8.5.2
closing, 3.1.3
prerequisites for, 3.1.1
consistent cube,
ConsistentSolveCommand objects
contained by a ConsistentSolveSpecification,
example of creating, 4.5.1
ConsistentSolveSpecification objects
associated with an MdmCube,
of a BaseMetadataObject, 2.2 example program, 1.3
count method
example of, example program, 1.3
createCursor method, 8.1.1
example of, 6.3.7, 8.5.2, 9.1, 9.1.1
createCursorManager method, 8.1.1, 8.4
example of, 6.3.7, 8.5.2, 9.1
createListSource method
example of, 5.5, 6.3.1, 6.3.6, 6.3.6
createParameterizedSource method
example of, 5.5
createRangeSource method
example of, 6.2.4
createRootTransaction method, 7.1
createSource method, 5.5
example of, 5.5, 6.3.2, 6.3.7
createSQLCursorManager method, 8.4 example program,
crosstab view
example of, 6.2.1
navigating Cursor for, example, 9.2, 9.2
CubeDimensionalityMap objects
contained by a CubeMap,
creating, 4.5.2
CubeMap objects
creating, 4.5.2
specifying a Query for,
CubeOrganization objects
contained by an MdmCube,
as dimensional data objects, 1.1.3
creating, 4.5.1
example of, 6.3.2
metadata object representing,
current position in a Cursor, definition, 8.5
current Transaction, 7.1, 7.1.6
Cursor objects
created in the current Transaction, 8.1.3
creating, 8.1.1
creating, example of, 6.3.2, 9.1
current position, definition, 8.5
CursorManager objects for creating, 8.4
extent calculation, example, 9.4
extent, definition, 8.5.4
faster and slower varying components, 8.2.1
fetch size, definition, 8.6
getting children of, example, 9.1.1
getting the values of, examples, 9.1.1
parent starting and ending position, 8.5.3
position, 8.5
retrieving data with, 1.2.3
Source objects for which you cannot create, 8.1.2
span, definition, 8.5.3
specifying fetch size for a table view, example, 9.5
specifying the behavior of, 8.2.2, 9.3
starting and ending positions of a value, example of calculating, 9.4
structure, 8.2.1
cursor package
description, 1.1.2
CursorInfoSpecification interface, 8.3
CursorManager class, 8.4
CursorManager objects
closing before rolling back a Transaction, 7.2
creating, 8.1.1
creating, example of, 6.3.2, 9.1
updating the CursorManagerSpecification, 8.4.1 example program, 1.3
CursorSpecification class, 8.3
CursorSpecification objects
getting from a CursorManagerSpecification, example, 9.3


retrieving, 1.2.3, 8.1
specifying, 1.2.1, 5.1
data objects
first-class, 2.3.1
data store
definition, 1.1.5
exploring, 3.2.1
gaining access to data in, 1.2, 2.4, 3.2
scope of, 3.2
data types
converting, 6.1
of Source objects, 5.3.2
See also SQL data types
data warehouse, 1.1.5
database schemas
represented by MdmDatabaseSchema objects,
DataProvider objects
needed to create MdmMetadataProvider, 3.3
deployment package
description, 1.1.2
derived Source objects
definition, 5.2
comparison rules in a join operation,
metadata objects for, 2.2.2
types provided by API, 2.2.2
dimension levels
mapping, 4.3.2
metadata object for,
dimensional data model
associations between classes, 2.4
description, 1.1.3
designing an OLAP, 1.1.5
implementing, 1.1.4
objects corresponding to MDM objects, 2.1
star schema as a, 1.1.5
dimensioned Source
as dimensional data objects, 1.1.3
creating, 4.3
dimensioning measures, 2.4.2
MdmDimension classes, 2.4.2
MdmDimension objects, 4.3
member value formatting, 1.2.2
metadata objects representing,
distinct method
description, 6.1
example of, 6.2.2
div method
example of, 6.3.5
drilling in a hierarchy
example of, 6.3.3
dynamic queries, 10.1
dynamic Source objects
definition, 5.2
example of getting, 10.3.2
produced by a Template, 10.1.1
DynamicDefinition class, 10.2.5


edges of a cube
creating, 4.3
definition, 1.1.3
pivoting, example of, 6.3.2
of a Source, 5.3.1
empty Source objects
definition, 5.2 example program,
end date
of a time dimension,
ET views
embedded total views for OLAP metadata objects, 2.4.4
See also OLAP views
ETT tool
Oracle Warehouse Builder, 1.1.5
example programs
compressed file containing, 1.3
sample schema for, 1.3
executeBuild method
example of, 4.8
exportFullXML methods
example of, 4.7
exportIncrementalXML methods
exporting XML templates,, 4.7
Expression objects
creating, 4.3.2
example of, 4.5.2
extent of a Cursor
definition, 8.5.4
example of calculating, 9.4
use of, 8.5.4
extract method,
description, 6.3.1
example of, 5.5, 6.3.1, 6.3.6, 6.3.6
extraction input


faster varying Cursor components, 8.2.1
fetch size of a Cursor
definition, 8.6
example of specifying, 9.5
reasons for specifying, 8.6
findOrCreateAttributeMap method,, 4.4
example of, 4.3.2, 4.3.2
findOrCreateAW method,
example of, 4.2
findOrCreateAWCubeOrganization method
example of, 4.5.1
findOrCreateAWPrimaryDimensionOrganization method
example of, 4.3.1
findOrCreateBaseAttribute method
example of, 4.4
findOrCreateBaseMeasure method,
example of,, 4.5.2
findOrCreateCube method
example of,, 4.5.1
findOrCreateCubeDimensionalityMap method
example of, 4.5.2
findOrCreateDerivedAttribute method,
findOrCreateDerivedMeasure method,
findOrCreateDescription method, 2.2.2, 2.2.2
findOrCreateDimensionLevel method,
example of, 4.3.2, 4.3.2
findOrCreateHierarchyLevel method
example of,
findOrCreateLevelHierarchy method
example of,
findOrCreateMeasureMap method
example of, 4.5.2
findOrCreateMemberListMap method
example of, 4.3.2
findOrCreateStandardDimension method,
example of, 4.3.1
first-class data objects, 2.3.1
fromSyntax method, Preface
example of, 4.3.2
fundamental Source objects
definition, 5.2
for data types, 5.3.2
FundamentalMetadataObject class
representing data types, 5.3.2
FundamentalMetadataProvider objects
example of, 5.3.2


generated SQL, getting, 8.1
getAncestorsAttribute method,
getAttributeGroupName method,
getContainedByObject method, 2.2
getDataType method
of a Source, 5.3.2
of a Source, example of, 6.2.3, 6.2.5, 6.3.4
getEmptySource method, 5.2
example of,
getETAttributeColumn method,
getID method
example of, 5.5
of a BaseMetadataObject,
of a Source, 5.3.4
getInputs method, 5.4.3
getLevelAttribute method
example of, 6.2.4
getMdmMetadataProvider method
example of, 3.3
getMetadataObject method,
getMetadataObjects method,
getNewName method,
getOutputs method, 5.4.2
getOwner method, 2.2
getParentAttribute method,
getRootSchema method, 2.3.1
getSource method
example of, 3.7, 6.2.4, 6.3.3
for getting Source produced by a Template, example, 10.3.2
in DynamicDefinition class, 10.1.1, 10.2.5
getTopLevelObject method,
example of, 4.5.2
getType method, 5.3.3
getValidNamespaces method,
getVoidSource method, 5.2
Global schema for example programs, 1.3
GLOBAL_AWJ sample analytic workspace, 1.3
grouping attributes,
gt method
of a Source, example of, 6.2.1


hierarchical sorting
example of, 6.3.4
as dimensional data objects, 1.1.3
creating, 4.3.3
lineage in materialized views,
lineage in OLAP views,


getting metadata objects by,
of a metadata object,
of a Source, 5.3.4
See also unique identifiers
importing XML templates,, 4.7
importXML methods
for attributes,
of a derived Source,
of a primary Source,
of a Source
definition, 5.4.3
deriving with the value method,,
matching with a Source, 5.4.4
obtaining, 5.4.3
types of,
interval method
example of, 6.3.7
isSubType method
example of, 5.3.3


Java archive (JAR) files, required, A.2
Java Development Kit, version required, A.2
creating connections,
libraries required, A.2
join method
description, 5.4.1, 6.1
examples of, 6.2
full signature, 5.4.1
rules governing matching an input with a Source, 5.4.4
joined parameter
of a join method,
joinHidden method
example of,, 6.3.5, 6.3.6


lag method
example of, 6.3.6
specifying for an attribute,
leaves of a hierarchy
legacy metadata objects
namespaces for,
level-based hierarchy,
as dimensional data objects, 1.1.3
creating, 4.3.3
MdmDimensionLevel objects,
populating attribute hierarchy values,
list Source objects
definition, 5.2
example of creating, 6.2.4
local dimension member values, 1.2.2


dimension levels, 4.3.2
hierarchy levels, 4.3.3
measures, 4.5.2
objects contained by an MdmCube,
mapping package
description, 1.1.2
matching an input with a Source
example of,,
rules governing, 5.4.4
materialized views
for a cube,
for OLAP metadata,
including hierarchy lineage,
populating attribute hierarchy lineage for,
prefixes for attribute columns in,
MDM metadata model
description, 2.1
mdm package
description, 1.1.2
MdmAttribute objects
creating, 4.4
description, 2.4.3
example of the values of, 2.4.3
inputs of,
MdmBaseAttribute class
MdmBaseAttribute objects
creating,, 4.4
mapping,, 4.4
mapping, example of, 4.3.2
MdmBaseMeasure objects
creating, 4.5.2
MdmCube class
MdmCube objects
corresponding to a fact table or view,
example of creating, 4.5.1
MdmDatabaseSchema objects
creating, 4.2
owner of top-level objects, 2.3.1
MdmDerivedAttribute class
MdmDerivedMeasure objects
MdmDescription objects, 2.2.2
associations, 2.2.2
MdmDescriptionType objects
associations, 2.2.2
creating, 2.2.2
MdmDimension classes
description, 2.4.2
MdmDimension objects
creating, 4.3
example of getting related objects, 3.6.1, 3.6.2
related MdmAttribute objects, 2.4.3
MdmDimensionLevel objects
creating, 4.3.2
MdmHierarchy class,
MdmHierarchy objects
creating, 4.3.3
MdmHierarchyLevel class
MdmHierarchyLevel objects
creating, 4.3.3
mapping, 4.3.3
MdmLevelHierarchy objects
creating, 4.3.3
MdmMeasure objects
creating, 4.5.2
inputs of,
origin of values,
MdmMemberListMapOwner interface
implemented by MdmPrimaryDimension,
MdmMetadataProvider class
associations with MdmSchema subclasses,
MdmMetadataProvider objects
creating, 3.3
description, 2.3.1, 3.3
MdmObject class
10g accessor methods for descriptions, 2.2.2
11g methods for descriptions, 2.2.2
associations with descriptions, 2.2.2
MdmOrganizationalSchema objects
MdmPrimaryDimension class
interfaces implemented by,
MdmPrimaryDimension objects
creating, 4.3.1
MdmQuery interface
implemented by MdmPrimaryDimension,
MdmRootSchema class, 2.3.1
MdmRootSchema objects
MdmSchema class
associations between subclass and MdmMetadataProvider,
MdmSchema objects
getting contents of, 3.5
subclasses of, 2.3.2
MdmSingleValuedAttribute class
MdmSource class, 2.4
MdmStandardDimension objects
creating, 4.3.1
MdmSubDimension class,
MdmTable objects
getting,, 4.5.2
MdmTimeDimension objects
creating, 4.3.1
MdmValueHierarchy class
MdmValueHierarchy objects
example of,
MdmViewColumn class, 2.2
MdmViewColumn objects,
MdmViewColumnOwner interface, 2.2
implemented by MdmPrimaryDimension,
measure folders
represented by MdmOrganizationalSchema objects,
MeasureMap objects
contained by a CubeMap,
creating, 4.5.2
as dimensional data objects, 1.1.3
creating, 4.5.2
dimensioned by dimensions, 2.4.2
getting values from,
MdmMeasure objects representing,
sources of data for,
MemberListMap objects
creating, 4.3.2
of an MdmDimension, 2.4.2
of an MdmDimensionLevel,
creating, 4.1
creating a provider, 3.3
discovering, 3.2
mapping, 4.1
metadata model
implementing, 1.1.5
MDM, 2.1
metadata objects
classifying, 2.2.3
creating OLAP, 1.1.5
getting and setting names for,
getting by ID,
in example programs, 1.3
OLAP, 1.2
representing data sources, 2.4
restricting access to,
supporting legacy,
unique identifiers of,
metadata package
description, 1.1.2
subpackages, 2.1
metadata reader modes,
MetadataObject interface
implemented by MdmPrimaryDimension,
MetadataState class, 10.2.3
example of implementation, 10.3.1
movingTotal method
example of, 6.3.6
multidimensional metadata objects
corresponding to dimensional data model objects, 2.1
corresponding to relational objects, 2.1
multilingual attributes,
multiple user sessions, 1.1.1


getting and setting for metadata objects,
nested outputs
getting values from a Cursor with, example, 9.1.1
of a Source, definition, 9.1.1
null Source objects
definition, 5.2
nullSource method, 5.2
NumberParameter objects
example of, 6.3.7


ojdbc5.jar file, A.3
description, 1.1
required class libraries, A.2
sample schema for examples, 1.3
software components, A.1
uses of, 1.1.1, 1.4
OLAP metadata, 1.1.5
OLAP metadata objects, 1.2
OLAP views
description, 2.4.4
getting name of cube view,
getting name of dimension or hierarchy view,
populating attribute hierarchy lineage in,
olap_api.jar file, A.3
Oracle OLAP
database administration and management tasks related to, 1.1
Oracle Technology Network (OTN), 1.3
ORACLE_HOME environment variable, A.3
OracleConnection objects
OracleDataSource objects
getting from a CompoundCursor, example, 9.1.1
getting from a CompoundCursorSpecification, example, 9.3
getting nested, example, 9.1.1
in a CompoundCursor, 8.2.1, 8.5.4
positions of, 8.5.2
of a Source
definition, 5.4.2
obtaining, 5.4.2
order of, 6.2.1
of a BaseMetadataObject, 2.2


package attribute
MdmAttribute for the PRODUCT_AWJ dimension, 2.4.3
in the OLAP Java API, 1.1.2
metadata, 2.1
Parameter objects
description, 5.5
example of, 5.5, 6.3.2, 6.3.7
parameterized Source objects
definition, 5.2
description, 5.5
example of, 5.5, 6.3.2, 6.3.7
parent attribute
method for getting,
parent-child relationships
in a level hierarchy,
in hierarchies,
pivoting cube edges, example of, 6.3.2
position method,
description, 6.1
example of, 6.2.4
of a CompoundCursor, 8.5.2
of a Cursor, 8.5
of a ValueCursor, 8.5.1
parent starting and ending, 8.5.3
for attribute column in materialized view,
primary Source objects
definition, 5.2
result of getSource method, 3.7
specifying, 1.1.5


creating using Source methods, 6
definition, 1.1.3
dynamic, 10.1
represented by Source objects, 1.2.1, 5.1
retrieving data specified by, 1.2.3
Source objects that are not, 8.1.2
specifying data, 1.2.1
SQL, of OLAP views, 2.4.4
steps in retrieving results of, 9.1
Query class, 1.1.3
Query objects
associating with a CubeMap,
creating, 4.5.2
query rewrite,


ragged hierarchies,
range Source objects
definition, 5.2
example of creating, 6.2.4
read Transaction object, 7.1.1
recursiveJoin method
description, 6.1
example of, 6.2.5, 6.3.4
signature of, 5.1
regular input
relating Source objects
with inputs, 5.4.3
relational objects
corresponding to MDM objects, 2.1
relational schemas
for a data warehouse, 1.1.5
represented by MdmDatabaseSchema objects,
sample, 1.3
reversing with the value method,, 6.3.3
removeValue method
example of,
elements in a join operation,
resource package
description, 1.1.2
reversing relations
example of,, 6.3.3
root schema, 2.3.1,
root Transaction
definition, 7.1
rotating cube edges, example of, 6.3.2


sample analytic workspace, 1.3
sample schema
used by examples, 1.3
getting MdmDatabaseSchema for, 4.2
metadata objects representing, 2.3.2
represented by MdmDatabaseSchema objects,
sample, 1.3
star, 1.1.5
by position, 6.3.7
by time series, 6.3.6
by value, 6.2.2,, 6.3.1, 6.3.2, 6.3.5
elements to include in a join operation,
selectValue method
example of, 6.2.2, 6.3.1, 6.3.5
selectValues method
example of,,, 6.3.2
session package
description, 1.1.2
creating a UserSession object,
sharing connection, 1.1.1
setAllowAutoDataTypeChange method,,
example of, 4.4, 4.5.2
setConsistentSolveSpecification method,
example of, 4.5.1
setCreateAttributeIndex method,
setETAttrPrefix method,
setExpression method
example of, 4.3.2
setJoinCondition method,
setKeyExpression method
example of, 4.3.2
setLanguage method,
setMultiLingual method,
setName method,
setPopulateLineage method,
setQuery method
example of, 4.3.2
setShortValueDescriptionAttribute method,
setTimeSpanAttribute method,
setValue method
of a Parameter, example of, 5.5, 6.3.2, 6.3.7
of an MdmDescription, 2.2.2
setValueDescriptionAttribute method
example of, 4.4
sharing connection, 1.1.1
SID (system identifier),
SingleSelectionTemplate class, 7.1.5, 7.2, 10.3.2, B.1
skip-level hierarchies,
slower varying Cursor components, 8.2.1, 8.5.2
sort order
determined by comparisonRule parameter,
sortAscending method
example of, 6.3.5
sorting hierarchically
example of, 6.3.4
Source class
basic methods, 6.1
subclasses of, 5.2
Source objects
active in a Transaction object, 8.1.3
base of a join operation, 5.4.1
data type
definition, 5.3.2
getting, 5.3.2
elements of, 5.3.1
getting a modifiable Source from a DynamicDefinition, 10.2.5
getting ID of, 5.3.4
inputs of
a derived,
a primary,
definition, 5.4.3
matching with a Source, 5.4.4
obtaining, 5.4.3
kinds of, 5.2
methods of getting, 5.2
modifiable, 10.1
outputs of
definition, 5.4.2
obtaining, 5.4.2
parameterized, 5.5
representing queries, 1.2.1, 5.1
SourceDefinition for, 5.3.4
definition, 5.3.3
obtaining, 5.3.3
definition, 5.3.3
obtaining, 5.3.3
source package
description, 1.1.2
SourceDefinition class, 5.3.4, 10.1.1
SourceGenerator class, 10.2.4
example of implementation, 10.3.1
span of a value in a Cursor
definition, 8.5.3, 9.4
example program, 1.3
getting generated, 1.4, 8.1
queries of OLAP objects, 2.3.1,
queries of OLAP views, 2.4.4
SQL data types
allowing automatic changing of,,
specifying for an MdmBaseAttribute,
specifying for an MdmBaseMeasure,
SQLCursorManager class, 1.4, 8.4
star schema, 1.1.5
StringParameter objects
example of, 5.5, 6.3.2
subtype of a Source object
definition, 5.3.3
matching an input,
obtaining, 5.3.3
syntax package
description, 1.1.2, 1.1.2


table view
navigating Cursor for, example, 9.2
target dimension
of an attribute,
Template class, 10.2.2
designing, 10.3
example of implementation, 10.3.1
Template objects
classes used to create, 10.2
for creating modifiable Source objects, 10.1
relationship of classes producing a dynamic Source, 10.2.1
Transaction objects used in, 7.1.3
bind variables in XML,
exporting XML,, 4.7
importing XML,, 4.7
time series
selecting based on, 6.3.6
time span
of a time dimension,
times method
example of, 6.3.5
TopBottomTemplate class, 7.1.5, 7.2, 10.3.1
top-level metadata objects
defined, 2.3.1
Transaction objects
child read and write, 7.1.1
committing, 4.6, 7.1.2
creating a Cursor in the current, 8.1.3
current, 7.1
example of using child, 7.2
getting the current, 7.1.6
preparing, 7.1.2
read, 7.1.1
rolling back, 7.1.5
root, 7.1
setting the current, 7.1.6
using in Template classes, 7.1.3
write, 7.1.1
transaction package
description, 1.1.2
provided by DataProvider, 7.2
in a Cursor, example, 9.1.1
specifying a measure value, 8.5.2
type of an Source object
definition, 5.3.3
obtaining, 5.3.3


unique dimension member values, 1.2.2
unique identifiers
of a Source, 5.3.4
of dimension members, 1.2.2
of metadata objects,
unique key attributes,
UserSession objects
sharing connection, 1.1.1


Value data type, 5.2
value method,
description, 6.1
example of,,, 6.2.4, 6.2.6,, 6.3.3
value separation string, 1.2.2
value-based hierarchy,
ValueCursor objects
getting from a parent CompoundCursor, example, 9.1.1
getting values from, example, 9.1.1, 9.1.1
position, 8.5.1
of a Cursor, 8.2.1, 8.5.1
of the elements of a Source, 5.3.1
OLAP, 2.4.4
virtual Cursor
definition, 8.6
visible parameter
of a join method,
void Source objects
definition, 5.2


write Transaction object, 7.1.1


XML templates
bind variables in,
controlling attribute export,
exporting,, 4.7
importing,, 4.7
XMLParserCallback interface,
xmlparserv2.jar file, A.3
XMLWriterCallback interface,