Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\overview-summary.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
Overview (Oracle OLAP Java API Reference)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="Overview (Oracle OLAP Java API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Overview&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> Package&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Oracle&reg; OLAP Java API Reference 11g Release 2 (11.2) E10794-01 Beta Draft
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;PREV&nbsp;
&nbsp;NEXT</TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="index.html?overview-summary.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="overview-summary.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>
Oracle&reg; OLAP Java API Reference

See:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#overview_description">Description</A>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Packages</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/express/package-summary.html">oracle.express</A></TD>
<TD>Contains classes that support processing in Oracle OLAP.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/express/olapi/data/full/package-summary.html">oracle.express.olapi.data.full</A></TD>
<TD>Contains an <CODE>Exception</CODE> class that might be encountered by a client application.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/express/spl/package-summary.html">oracle.express.spl</A></TD>
<TD>Contains classes that support the execution of OLAP DML commands in Oracle OLAP.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/package-summary.html">oracle.olapi</A></TD>
<TD>Contains an interface, a class, and exceptions that are of general use in the Oracle OLAP Java API.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/data/cursor/package-summary.html">oracle.olapi.data.cursor</A></TD>
<TD>Contains interfaces and classes for retrieving and accessing the result set of a query.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/data/source/package-summary.html">oracle.olapi.data.source</A></TD>
<TD>Contains classes that construct a query of the data in an Oracle Database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/metadata/package-summary.html">oracle.olapi.metadata</A></TD>
<TD>Contains interfaces and classes that represent Oracle OLAP metadata objects and that provide those objects to an application.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/metadata/deployment/package-summary.html">oracle.olapi.metadata.deployment</A></TD>
<TD>Contains classes that specify the deployment of a logical OLAP model as relational OLAP (ROLAP) objects or as analytic workspace (AW) objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/metadata/mapping/package-summary.html">oracle.olapi.metadata.mapping</A></TD>
<TD>Contains classes that map the <CODE>MdmObject</CODE> objects of a logical OLAP model to physical storage structures in the Oracle Database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/metadata/mdm/package-summary.html">oracle.olapi.metadata.mdm</A></TD>
<TD>Contains classes that represent data supporting the multidimensional model (MDM) for metadata.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/resource/package-summary.html">oracle.olapi.resource</A></TD>
<TD>Provides support for the internationalization of messages for <CODE>Exception</CODE> classes in the Oracle OLAP Java API.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/session/package-summary.html">oracle.olapi.session</A></TD>
<TD>Contains a class that represents a session that is associated with a specific connection to an Oracle Database instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/syntax/package-summary.html">oracle.olapi.syntax</A></TD>
<TD>Contains classes that represent data types, functions, commands, and data objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/transaction/package-summary.html">oracle.olapi.transaction</A></TD>
<TD>Contains interfaces that define classes that are involved in transactions between Oracle OLAP and an OLAP client application and <CODE>Exception</CODE> classes that an application might encounter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="20%"><A HREF="oracle/olapi/transaction/metadataStateManager/package-summary.html">oracle.olapi.transaction.metadataStateManager</A></TD>
<TD>Contains an interface to implement and associate with a <code>Template</code> object.</TD>
</TR>
</TABLE>

&nbsp;<A NAME="overview_description"></A>

Oracle&reg; OLAP Java API Reference

<center>March 25, 2009</center>

This is the reference documentation for the Oracle OLAP Java API,
the Java application programming interface for Oracle OLAP.
This overview contains the following topics.

<UL>
 <LI><a href="#changes">Changes to the API
 <LI><a href="#audience">Intended Audience
 <LI><a href="#before">Before You Begin
 <LI><a href="#jdkreq">JDK Version Required
 <LI><a href="#examples">Examples of Using the Oracle OLAP Java API
 <LI><a href="#compat">Compatibility with Previous Releases
 <LI><a href="#vals">Unique and Local Values in the Oracle OLAP Java AP
 <LI><a href="#accessdoc">Documentation Accessibility
 <LI><a href="#accesscode">Accessibility of Code Examples in Documentation
 <LI><a href="#accesslinks">Accessibility of Links to External Web Sites in Documentation
 <LI><a href="#reldoc">Related Documentation
</UL>

<a name="changes"></a>
Changes to the API

For a description of the new features of the Oracle OLAP Java API for this release, see <a href="./doc-files/whatsnew.html">New Features</a>.

<a name="audience"></a>
Intended Audience

This documentation assumes that you are already familiar with Java, relational database management systems, data warehousing, and online analytical processing (OLAP) concepts. 
It is intended for Java programmers who are responsible for creating applications that create and maintain OLAP objects, build and maintain analytic workspaces, and perform online analytical processing.

<a name="before"></a>
Before You Begin

To use the Oracle OLAP Java API, you must have access to an Oracle Database instance that has the OLAP option installed. An Oracle Database with the OLAP option provides the Oracle OLAP Java API classes, and other required classes, in JAR files. Before you can compile an Oracle OLAP Java API program, you must get the required JAR files and add them to your Java development environment.

The following table lists the required JAR files and their location under the <code>ORACLE_HOME</code> directory in an Oracle Database installation.

<table summary="List of required class libraries and their locations." border=1 cellspacing=0 cellpadding=3 hspace=10 width=300>
 <tr>
 <th id="c1">File Name</th>
 <th id="c2">Location</th>
 </tr>
 <tr>
 <td headers="c1"><CODE>&nbsp;&nbsp;olap_api.jar</CODE></td>
 <td headers="c2"><CODE>&nbsp;&nbsp;/olap/api/lib</CODE></td>
 </tr>
 <tr>
 <td headers="c1"><CODE>&nbsp;&nbsp;ojdbc5.jar</CODE></td>
 <td headers="c2"><CODE>&nbsp;&nbsp;/jdbc/lib</CODE></td>
 </tr>
 <tr>
 <td headers="c1"><CODE>&nbsp;&nbsp;xmlparserv2.jar</CODE></td>
 <td headers="c2"><CODE>&nbsp;&nbsp;/lib</CODE></td>
 </tr>
</table>

You must use the JDBC files included in your Oracle Database installation and not those from another Oracle product or from another vendor.

For information on installing an Oracle Database with the OLAP option, see your Oracle Database installation documentation. For more information on administering the OLAP option, see Oracle OLAP User's Guide.

<a name="jdkreq"></a>
JDK Version Required

This release of the Oracle OLAP Java API requires J2SE Development Kit 5.0 (JDK 5.0).

<a name="examples"></a>
Examples of Using the Oracle OLAP Java API

In the examples of the Oracle OLAP Java API code in this documentation, the metadata objects are mapped to columns of the tables of the Global sample schema. You can download SQL scripts that create the Global schema from the Documentation section of the Oracle Technology Network (OTN) Web site at

<a href="http://www.oracle.com/technology/products/bi/olap/olap.html">http://www.oracle.com/technology/bi/olap/olap.html</a>

To download the sample schema, in the Download section select Sample Code and Schemas and then select Global Schema 11g.

From the OTN Web site You can also download a compressed file that contains example programs that include the code from the examples in this documentation
and the examples in Oracle OLAP Java API Developer's Guide.
To download the example programs, in the Download section select Sample Code and Schemas and then select Example Programs for Documentation.

For more information on the example programs, see <a href="./doc-files/ExamplePrograms.html">Example Oracle OLAP Java API Programs</a>.

<a name="compat"></a>
Compatibility with Previous Releases

Programs that use previous releases of the Oracle OLAP Java API can run on Oracle Database, 11g Release 1 (11.1), depending on the metadata reader mode. You can specify the metadata reader mode when you create a <CODE>DataProvider</CODE>, or a <CODE>UserSession</CODE> for a <CODE>DataProvider</CODE>. The mode specifies the type of metadata that Oracle OLAP recognizes and makes available to the client application. By default, Oracle OLAP recognizes all types of metadata. For information about setting the metadata reader mode, see the <CODE>DataProvider</CODE> class description. For information about using namespaces to specify an Oracle OLAP metadata object that was created in a 10g release see <a href="./oracle/olapi/metadata/mdm/MdmMetadataProvider.html#namespaces">Using Namespaces</a> in the description of <CODE>MdmMetadataProvider</CODE>.

You can use 10g metadata objects to query data but you cannot modify the metadata objects or create new persistent objects.

<a name="vals"></a>
Unique and Local Values in the Oracle OLAP Java API

The members of an Oracle OLAP dimension are often organized into one or more hierarchies.
Some hierarchies have parent-child relationships based on levels and some have those relationships based on values.
The Oracle OLAP Java API uses a three-part format to specify the hierarchy, the level, and the value of a dimension member, and thereby identify a unique value.
The first part of a unique value is the name of the hierarchy object, the second part is the name of the level object, and the third part is the value of the member in the level.
The parts of the unique value are separated by a value separation string, which by default is double colons (<code>::</code>).
The following is an example of unique value in the <CODE>YEAR</CODE> level of the
<CODE>CALENDAR</CODE> hierarchy of the <CODE>TIME</CODE> dimension:

<CODE>CALENDAR_YEAR::YEAR::CY2001</CODE>

The third part of a unique value is the local value.
In the preceding example, the local value is <CODE>CY2001</CODE>, which is the identifier for the year 2001 in the Global schema. 
The Oracle OLAP Java API has classes and methods that you can use to get the local values of dimension members. 
See the descriptions of the <CODE>MdmPrimaryDimension</CODE> and
<CODE>MdmDimensionMemberInfo</CODE> classes for more information about unique and local values.

An application can specify that Oracle OLAP use unique or local dimension hierarchy values by setting the <CODE>HierarchyValueType</CODE> property in a <CODE>java.util.Properties</CODE> object and using the <CODE>Properties</CODE> object to construct an <CODE>DataProvider</CODE>. 
The use of <CODE>Model</CODE> objects requires unique hierarchy values.

The selection of dimension members in the query must match the setting of the property.
For a complex query, using unique dimension hierarchy values generally provides faster performance when Oracle OLAP fetches the data.

<a name="accessdoc"></a>
Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

<a href="http://www.oracle.com/accessibility/">http://www.oracle.com/accessibility/</a>.

<a name="accesscode"></a>
Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

<a name="accesslinks"></a>
Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

<a name="reldoc"></a>
Related Documentation

The following documentation is helpful when using Oracle OLAP.

<UL>
<LI>Oracle OLAP Java API Developer's Guide &#8211; Introduces the Oracle OLAP Java API, a Java application programming interface for defining, building, and maintaining Oracle OLAP analytic workspaces, and for performing online analytical processing of the data stored in an Oracle Database instance. Describes the API and how to create or discover Oracle OLAP metadata, create and maintain OLAP objects and analytic workspaces, and create queries and retrieve data.

<LI>Oracle OLAP User's Guide &#8211; Explains how SQL and Java applications can extend their analytic processing capabilities by using the OLAP option in the Enterprise Edition of Oracle Database.

<LI>Oracle OLAP DML Reference &#8211; Describes the OLAP Data Manipulation Language (OLAP DML), which is the native language for defining and manipulating analytic workspace objects.

<LI>Oracle Warehouse Builder Concepts &#8211; Discusses the database structures, concepts, and issues involved in creating a data warehouse to support online analytical processing solutions.
</UL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Overview&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> Package&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
<center>Copyright &copy; 2002, 2009, Oracle. All rights reserved.</center>
</TD>
</TR>

</TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de