Contents

Title and Copyright Information

Send Us Your Comments

Preface

Intended Audience

Documentation Accessibility

Structure

Related Documents

Conventions

1 Understanding the Workbench

Starting the Mapping Workbench

Working with the Workbench

Using the Menus

Menu Bar Menus

Pop-up Menus

Using the Toolbars

Standard Toolbar

Mapping Toolbar

Using the Project Tree Pane

Using the Properties Pane

Working with Workbench Preferences

Changing the Look and Feel

Specifying a Web Browser

Specifying Class Import Options

Setting EJB Preferences

Working with the Mapping Workbench in a Team Environment

Using a Source Control Management System

Merging Files

Merging a Root File

Merging an Aggregate File

Sharing Project Objects

Managing the ejb-jar.xml File

2 Understanding Projects

Working with Projects

Creating new Projects

Opening Existing Projects

Saving Projects

Refreshing the Project Tree

Working with Project Properties

Working with General Project Properties

Mapping EJB 2.0 Entities

Working with Default Properties

Renaming Packages

Working with Sequencing Properties

Working with Table Generation Properties

Setting Default Advanced Properties

Working with Classes

Creating Classes

Exporting Projects

Exporting Project to Java Source

Exporting Table Creator Files

Generating Deployment XML

Working with the ejb-jar.xml File

Writing to the ejb-jar.xml File

Reading from the ejb-jar.xml File

3 Understanding Databases

Working with Databases

Database Properties

Logging into the Database

Working with Database Tables in the Project Tree Pane

Creating New Tables

Importing Tables from Database

JDBC Driver Requirements

Removing Tables

Renaming Tables

Working with Database Tables in the Properties Pane

Working with Field Properties

Setting a Primary Key for Database Tables

Working with Reference Properties

Creating table references

Creating Field References

Generating Data from Database Tables

Generating SQL Creation Scripts

Generating Descriptors and Classes from Database Tables

Generating Tables on the Database

Generating EJB Entities from Database Tables

4 Understanding Descriptors

Working with Descriptors

Understanding Persistent Classes

Specifying Descriptor Types

Mapping Descriptors

Automapping Descriptors

Generating Java Code for Descriptors

Working with Descriptor Properties

Setting Descriptor Information

Setting Class Information

Class Tab

Attributes Tab

Methods Tab

Query Keys

Specifying Query Keys

Specifying Queries

SQL Queries

Named Queries

Displaying EJB descriptor Information

Working with Advanced Properties

Amending Descriptors After Loading

Specifying Events

Specifying Identity Mapping

Specifying Inheritance

Creating a Root Class

Creating Branch and Leaf Classes

Specifying Optimistic Locking

Specifying an Interface Alias

Working with Primary Keys

Setting a Primary Key for Descriptors

Working with Sequencing

Using Sequence Numbers with Entity Beans

Using Native Sequencing

Using Sequence Tables

Pre-allocating Sequence Numbers

Creating the Sequence Table on the Database

Working with Inheritance

Using Inheritance with EJBs

Mapping Inherited Attributes in One Descriptor

Supporting Inheritance Using One Table

Supporting Inheritance Using Multiple Tables

Finding Subclasses

Providing a Class Indicator Field

Understanding Root, Branch, and Leaf Classes in an Inheritance Hierarchy

Specifying Primary Keys in an Inheritance Hierarchy

Mapping Inherited Attributes in a Subclass

Working with Interfaces

Understanding Interface Descriptors

Single Implementor Interfaces

Implementing an Interface

Working with Multiple Tables

Specifying Multi-table Info

Primary Keys Match

Primary Keys are Named Differently

Tables are Related by Foreign Key in Primary Table

Working with a Copy Policy

Setting the Copy Policy

Working with Instantiation Policy

Setting Instantiation Policy

Working with a Wrapper Policy

Setting the Wrapper Policy Using Java Code

Working with Optimistic Locking

Using Version Locking Policies

Using Field Locking Policies

Specifying Advanced Optimistic Locking Policies

Working with Identity Maps

Identity Map Size

Design Guidelines

Using Object Identity

Caching Objects

Working with Query Keys

Automatically-generating Query Keys

Creating a User-defined Query Key

Using Query Keys in Interface Descriptors

Relationship Query Keys

Defining Relationship Query Keys by Amending a Descriptor

Working with Events

Registering an Event with a Descriptor

Supported Events

Working with Finders

Working with Object-relational Descriptors

Effect on TopLink

Databases Supported

Defining Object-relational Descriptors

Working with Mappings

Working with Common Mapping Properties

Specifying Direct Access and Method Access

Setting the Access Type

Specifying Read-only Settings

Defaulting Null Values

Maintaining Bidirectional Relationships

Specifying Field Names and Multiple Tables

Specifying Collection Properties

Specifying Mapping information in ejb-jar.xml File

5 Understanding Direct Mappings

Working with Direct Mappings

Working with Direct-to-field Mappings

Creating Direct-to-field Mappings

Working with Type Conversion Mappings

Creating Type Conversion Mappings

Working with Object Type Mappings

Creating Object Type Mappings

Working with Serialized Object Mappings

Creating Serialized Object Mappings

Working with Transformation Mappings

Creating Transformation Mappings

Specifying Advanced Features Available by Amending the Descriptor

6 Understanding Relationship Mappings

Working with Relationship Mappings

Specifying Private or Independent Relationships

Working with Foreign Keys

Understanding Foreign Keys

Specifying Foreign Keys

Working with a Container Policy

Overriding the Default Container Policy

Working with Indirection

Understanding Indirection

Using Value Holder Indirection

Specifying Indirection

Changing Java Classes to Use Indirection

Working with Transparent Indirection

Specifying Transparent Indirection

Working with Proxy Indirection

Implementing Proxy Indirection in Java

Optimizing for Queries

Working with Aggregate Object Mappings

Creating a Target Descriptor

Creating an Aggregate Object Mapping

Working with One-to-one Mappings

Creating One-to-one Mappings

Specifying Advanced Features Available by Amending the Descriptor

Working with Variable One-to-one Mappings

Specifying Class Indicator

Specifying Unique Primary Key

Creating Variable One-to-one Mappings

Working with Direct Collection Mappings

Creating Direct Collection Mappings

Working with Aggregate Collection Mappings

Working with One-to-many Mappings

Creating One-to-many Mappings

Working with Many-to-many Mappings

Creating many-to-many Mappings

Specifying Advanced Features by Amending the Descriptor

Working with Custom Relationship Mappings

Creating Custom Mapping Queries in Java Code

7 Understanding Object Relational Mappings

Working with Object Relational Mappings

Working with Array Mappings

Implementing Array Mappings in Java

Reference

Working with Object Array Mappings

Implementing Object Array Mappings in Java

Reference

Working with Structure Mappings

Implementing Structure Mappings in Java

Reference

Working with Reference Mappings

Implementing Reference Mappings in Java

Reference

Working with Nested Table Mappings

Implementing Nested Table Mappings in Java

Reference

A Object Model Requirements

Persistent Class Requirements

Constructor Requirements

Remote Session Requirements

Index