ObjectStore Java API User Guide

Preface

Purpose

The ObjectStore Java API User Guide provides information and instructions for using the Java interface to ObjectStore. The Java interface allows you to write Java applications that store and retrieve data in ObjectStore databases.

Audience

This book is for experienced Java programmers who want to write applications that use the Java interface to ObjectStore.

Scope

This book does not provide information for developing ObjectStore applications that use C++ and Java. See Developing ObjectStore Java Applications That Access C++.

This book supports Release 3.0 of the Java interface to ObjectStore. See the README.htm file in the directory in which you installed ObjectStore for specific ObjectStore release numbers.

How This Book Is Organized

This book is organized as follows:

Chapter 1, Introducing ObjectStore describes what ObjectStore does, shows the application architecture, and defines some important terms.
Chapter 2, Example of Using ObjectStore describes the components your application must include to use ObjectStore.
Chapter 3, Using Sessions to Manage Threads discusses how to initialize threads to use ObjectStore and how to use threads with ObjectStore sessions.
Chapter 4, Managing Databases provides instructions for creating, opening, closing, garbage collecting, and upgrading 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, Working with Collections provides information about eachhows how to create collections of objects and run queries over the collections.
Chapter 8, Automatically Generating Persistence-Capable Classes describes how to use the class file postprocessor to create persistence-capable classes.
Chapter 9, Manually Generating Persistence-Capable Classes describes how to manually annotate classes you define so they are persistence-capable.
Chapter 10, Controlling Concurrency, describes the APIs you can use to ensure your application's access to data.
Chapter 11, Using the Notification Facility, discusses the system you can set up to notify sessions when a previously defined event has taken place.
Chapter 12, Miscellaneous Information discusses serialization, String literals, storage layout, differences from C++ interface, and Java-supplied persistence-capable classes.
Chapter 13, Tools Reference provides reference information for the ObjectStore utilities: osgc, osjcfp, osjcgen, osjcheckdb, osjshowdb, and osjversion.
Appendix, Packaging Your Application for End Users provides instructions for which files you must include when you distribute your application.

Documentation Conventions

This document uses the following conventions:


Convention	Meaning
Bold	Bold typeface in text indicates user input, code fragments, file names, and object, field, and method names.
Courier	Courier typeface identifies lines of code and method signatures.
Magenta	Magenta typeface indicates a variable for which you must supply a value. This most often appears in a syntax line or table.
Italic	In text, italic typeface indicates the first use of an important term.
[ ]	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.READONLY)

instead of

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

Internet Sources of More Information

Email discussion list

There is a majordomo discussion list called osji-discussion. The purpose of this list is to facilitate discussion about the Java interface to ObjectStore. .

Support

Object Design's support organization provides a number of information resources and services. Their home page is at http://support.objectdesign.com/WWW/Welcome.html. From the support home page, you can learn about support policies, product discussion groups, and the different ways Object Design can keep you informed about the latest release information - including the Web, ftp, and email services.

Training

You can obtain information about training courses from the Object Design Web site (http://www.objectdesign.com). From the home page, select Services and then Education.

If you are in North America, for information about Object Design's educational offerings, call 781.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 feedback to support@objectdesign.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 781.674.5440.

Copyright Notice

ObjectStore Java API User Guide

Java interface 3.0 to ObjectStore, October 1998

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 1998 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

Updated: 10/07/98 05:08:37

Preface

Purpose

Documentation Conventions

Internet Sources of More Information

World Wide Web