Preface

This guide includes the concepts necessary for using the Oracle Application Server TopLink Mapping Workbench, a standalone application that creates and manages your descriptors and mappings for a project. This document includes information on each OracleAS TopLink Mapping Workbench function and option.

This preface contains the following topics:

Intended Audience

This document is intended for OracleAS TopLink users who are familiar with the object-oriented programming and Java development environments.

This document assumes that you are familiar with the concepts of object-oriented programming, the Enterprise JavaBeans (EJB) specification, and with your own particular Java development environment.

The document also assumes that you are familiar with your particular operating system (such as Windows, UNIX, or other). The general operation of any operating system is described in the user documentation for that system, and is not repeated in this manual.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. 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. Standards will continue to evolve over time, and Oracle Corporation 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 additional information, visit the Oracle Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, 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, JAWS may not always read a line of text that consists solely of a bracket or brace.

Organization

This document includes the following chapters:

Chapter 1, "Understanding the OracleAS TopLink Mapping Workbench"

This chapter introduces the OracleAS TopLink Mapping Workbench - a tool to graphically configure descriptors and map your OracleAS TopLink project.

Chapter 2, "Understanding Projects"

This chapter contains instructions for creating and maintaining OracleAS TopLink project files, including workbench preferences and team development.

Chapter 3, "Understanding Databases"

This chapter describes how to create database sessions and import/export database tables to and from your OracleAS TopLink project.

Chapter 4, "Understanding Descriptors"

This chapter summarizes OracleAS TopLink descriptors, including standard and advanced properties and mappings.

Chapter 5, "Understanding Direct Mappings"

This chapter summarizes the direct mapping types supported by OracleAS TopLink.

Chapter 6, "Understanding Relationship Mappings"

This chapter summarizes the relational mapping types supported by OracleAS TopLink.

Chapter 7, "Understanding Object-Relational Mappings"

This chapter summarizes the object relational mapping types supported in OracleAS TopLink.

Chapter 8, "Understanding the OracleAS TopLink Sessions Editor"

This chapter contains information on using the OracleAS TopLink Sessions Editor to create and maintain OracleAS TopLink sessions.

Appendix A, "Object Model Requirements"

This section summarizes OracleAS TopLink object model requirements.

Appendix B, "Tutorials"

This section includes a basic and advanced tutorials that provide step-by-step instructions for using the OracleAS TopLink Mapping Workbench.

Appendix C, "Troubleshooting"

This section contains information on the types of errors that may occur and how to correct them.

Conventions

This section describes the conventions used in the text and code examples of this documentation set. It describes:

Conventions in Text

We use various conventions in text to help you more quickly identify special terms. The following table describes those conventions and provides examples of their use.

Convention	Meaning	Example
Bold	Bold typeface indicates terms that are defined in the text or terms that appear in a glossary, or both.	When you specify this clause, you create an index-organized table.
Italics	Italic typeface indicates book titles or emphasis.	Oracle9i Database Concepts Ensure that the recovery catalog and target database do not reside on the same disk.
`UPPERCASE monospace (fixed-width) font`	Uppercase monospace typeface indicates elements supplied by the system. Such elements include parameters, privileges, datatypes, RMAN keywords, SQL keywords, SQL*Plus or utility commands, packages and methods, as well as system-supplied column names, database objects and structures, usernames, and roles.	You can specify this clause only for a `NUMBER` column. You can back up the database by using the `BACKUP` command. Query the `TABLE_NAME` column in the `USER_TABLES` data dictionary view. Use the `DBMS_STATS`.`GENERATE_STATS` procedure.
`lowercase monospace (fixed-width) font`	Lowercase monospace typeface indicates executables, filenames, directory names, and sample user-supplied elements. Such elements include computer and database names, net service names, and connect identifiers, as well as user-supplied database objects and structures, column names, packages and classes, usernames and roles, program units, and parameter values. Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown.	Enter `sqlplus` to open SQL*Plus. The password is specified in the `orapwd` file. Back up the datafiles and control files in the `/disk1/oracle/dbs` directory. The `department_id`, `department_name`, and `location_id` columns are in the `hr.departments` table. Set the `QUERY_REWRITE_ENABLED` initialization parameter to `true.` Connect as `oe` user. The `JRepUtil` class implements these methods.
`lowercase italic monospace (fixed-width) font`	Lowercase italic monospace font represents placeholders or variables.	You can specify the `parallel_clause`. Run `U``old_release``.SQL` where `old_release` refers to the release you installed prior to upgrading.

Conventions in Code Examples

Code examples illustrate SQL, PL/SQL, SQL*Plus, or other command-line statements. They are displayed in a monospace (fixed-width) font and separated from normal text as shown in this example:

SELECT username FROM dba_users WHERE username = 'MIGRATE';

The following table describes typographic conventions used in code examples and provides examples of their use.

Convention	Meaning	Example
[ ]	Brackets enclose one or more optional items. Do not enter the brackets.	`DECIMAL (``digits` `[ ,` `precision` `])`
{ }	Braces enclose two or more items, one of which is required. Do not enter the braces.	`{ENABLE \| DISABLE}`
\|	A vertical bar represents a choice of two or more options within brackets or braces. Enter one of the options. Do not enter the vertical bar.	`{ENABLE \| DISABLE}` `[COMPRESS \| NOCOMPRESS]`
`...`	Horizontal ellipsis points indicate either: That we have omitted parts of the code that are not directly related to the example That you can repeat a portion of the code	`CREATE TABLE ... AS` `subquery``;` `SELECT` `col1``,` `col2``, ... ,` `coln` `FROM employees;`
. . .	Vertical ellipsis points indicate that we have omitted several lines of code not directly related to the example.
Other notation	You must enter symbols other than brackets, braces, vertical bars, and ellipsis points as shown.	`acctbal NUMBER(11,2);` `acct CONSTANT NUMBER(4) := 3;`
`Italics`	Italicized text indicates placeholders or variables for which you must supply particular values.	`CONNECT SYSTEM/``system_password` `DB_NAME =` `database_name`
`UPPERCASE`	Uppercase typeface indicates elements supplied by the system. We show these terms in uppercase in order to distinguish them from terms you define. Unless terms appear in brackets, enter them in the order and with the spelling shown. However, because these terms are not case sensitive, you can enter them in lowercase.	`SELECT last_name, employee_id FROM employees;` `SELECT * FROM USER_TABLES;` `DROP TABLE hr.employees;`
`lowercase`	Lowercase typeface indicates programmatic elements that you supply. For example, lowercase indicates names of tables, columns, or files. Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown.	`SELECT last_name, employee_id FROM employees;` `sqlplus hr/hr` `CREATE USER mjones IDENTIFIED BY ty3MU9;`