PSE/PSE Pro for Java API User Guide

Preface

Purpose

ObjectStore PSE/PSE Pro for Java API User Guide provides information and instructions for using ObjectStore PSE and ObjectStore PSE Pro. PSE/PSE Pro allows you to write Java applications that create and access persistent data.

Audience

This book is for experienced Java programmers who want to write applications that use PSE/PSE Pro for Java.

This book supports Release 1.1 of PSE and PSE Pro for Java.

How This Book Is Organized

Chapter 1, Introducing PSE/PSE Pro, describes what PSE/PSE Pro does, shows the application architecture, and defines some important terms. Chapter 2, Example of Using PSE/PSE Pro, describes the components your application must include to use PSE/PSE Pro. Chapter 3, Managing Threads, discusses how to initialize threads to use PSE/PSE Pro. Chapter 4, Managing Databases, provides instructions for creating, opening, and closing databases. Chapter 5, Working with Transactions, describes how to start and end transactions.

Chapter 6, Storing, Retrieving, and Updating Objects, discusses the steps for storing, retrieving, and updating data. Chapter 7, Storing Objects in Persistent Collections, shows how to create PSE/PSE Pro utility collections. Chapter 8, Using Miscellaneous Features, provides information about concurrent access, checking the version of PSE/PSE Pro, serialization, and Java-supplied persistence-capable classes. Chapter 9, Automatically Generating Persistence-Capable Classes, describes how to use the class file postprocessor to create persistence-capable classes. Chapter 10, Manually Generating Persistence-Capable Classes describes how to manually annotate classes you define so they are persistence-capable.

Documentation Conventions

This document uses the following conventions:

Convention Meaning
Bold Bold typeface indicates user input, code fragments, file names, and object, field, and method names.
Sans serif Sans serif typeface indicates system output.
Italic sans serif Italic sans serif typeface indicates a variable for which you must supply a value. This most often appears in a syntax line or table.
Italic serif In text, italic serif typeface indicates the first use of an important term.
Fixed width Fixed-width typeface is used for lines of code.
[ ] Brackets enclose optional arguments.
{ a | b | c } Braces enclose two or more items. You can specify only one of the enclosed items. Vertical bars represent OR separators. For example, you can specify a or b or c.
... Three consecutive periods indicate that you can repeat the immediately previous item. In examples, they also indicate omissions.

Examples in the documentation

Examples in the documentation assume that COM.odi.* is imported. This allows specification of, for example,

db.open(ObjectStore.OPEN_READONLY)
instead of

db.open(COM.odi.ObjectStore.OPEN_READONLY)

Training

If you are in North America, for information about Object Design's educational offerings, or to order documents, call (617) 674- 5000, Monday through Friday from 8:30 AM to 5:30 PM Eastern Time.

If you are outside North America, call your Object Design sales representative.

Your Comments

Object Design welcomes your comments about ObjectStore documentation. Send your feedback to support@odi.com. To expedite your message, begin the subject with Doc:. For example:

Subject: Doc: Incorrect message on page 76 of reference manual
You can also fax your comments to (617) 674-5440.

Copyright Notice

PSE/PSE Pro for Java API User Guide

PSE/PSE Pro for Java Release 1.1, May 1997

ObjectStore, Object Design, the Object Design logo, LEADERSHIP BY DESIGN, and Object Exchange are registered trademarks of Object Design, Inc. ObjectForms and Object Manager are trademarks of Object Design, Inc.

All other trademarks are the property of their respective owners.

Copyright © 1989 to 1997 Object Design, Inc. All rights reserved. Printed in the United States of America. Except as permitted under the Copyright Act of 1976, no part of this publication may be reproduced or distributed in any form or by any means, or stored in a database or retrieval system, without the prior written permission of the publisher.

COMMERCIAL ITEM - The Programs are Commercial Computer Software, as defined in the Federal Acquisition Regulations and Department of Defense FAR Supplement, and are delivered to the United States Government with only those rights set forth in Object Design's software license agreement.

Data contained herein are proprietary to Object Design, Inc., or its licensors, and may not be used, disclosed, reproduced, modified, performed or displayed without the prior written approval of Object Design, Inc.

This document contains proprietary Object Design information and is licensed for use pursuant to a Software License Services Agreement between Object Design, Inc., and Customer.

The information in this document is subject to change without notice. Object Design, Inc., assumes no responsibility for any errors that may appear in this document.

Object Design, Inc.
Twenty Five Mall Road
Burlington, MA 01803-4194

Part number:



[next]

doc@odi.com
Copyright © 1997 Object Design, Inc. All rights reserved.

Updated: 05/13/97 12:16:46