Guide  Reference  Contents  Previous  Next  Index

About This Guide

This guide describes how to build Java applications to create and manipulate persistent objects. The guide introduces fundamental concepts and gives detailed descriptions, with examples, of the process by which you build an application.

Audience

This guide assumes that you are familiar with programming in Java.

Documentation Set

The Objectivity for Java documentation set consists of:

• The Objectivity for Java Guide (this book)

• The Objectivity for Java Reference, which contains complete descriptions of all classes and interfaces that constitute the Objectivity for Java programming interface

The Guide is available in both HTML and PDF formats; the Reference is available in HTML only.

Organization

• Part 1 begins with the Getting Started chapter, which introduces the Objectivity/DB object-oriented database management system and the Objectivity for Java programming interface to Objectivity/DB. If you are new to Objectivity/DB or Objectivity for Java, you should start by reading Getting Started. The remaining chapters describe:
  • The Objectivity for Java objects responsible for the interaction between an application and Objectivity/DB.

  • How Objectivity/DB objects are represented, created and deleted, and accessed within an Objectivity for Java application.

  • The schema of a federated database and the mechanisms provided for managing and evolving the schema.

  • Objectivity for Java mechanisms that support fault-tolerant, distributed applications.

• Part 2 chapters contain reference material relevant to developers with specific needs in the areas of general query operations and interoperability.

• Part 3 chapters expand and collect definitions and examples that appeared throughout the guide or deal with an issue that pervades the Objectivity for Java programming interface. The files for the examples are in the chapter name subdirectory of the programming samples directory. See Installation and Platform Notes for the location of the samples directory for your platform.

Conventions and Abbreviations

Navigation

All component HTML pages in this book contain links to:

• The starting page of each book in the documentation set. (The starting page of this book does not contain a link to itself; instead, it includes a link to the top-level page for the entire documentation set.)

• The table of contents

• The previous page (if any)

• The next page (if any)

• The index (the index page does not contain a link to itself)

Typographical Conventions

oobackup	Command, literal parameter, code sample, filename, pathname, output on your screen, or Objectivity-defined identifier
installDir	Variable element (such as a filename or a parameter) for which you must substitute a value
Browse FD	Graphical user-interface label for a menu item or button
lock server	New term, book title, or emphasized word

Abbreviations

(administration)	Feature intended for database administration tasks
(FTO)	Feature of the Objectivity/DB Fault Tolerant Option product
(DRO)	Feature of the Objectivity/DB Data Replication Option product
(IPLS)	Feature of the Objectivity/DB In-Process Lock Server Option product
(ODMG)	Feature conforming to the Object Database Management Group interface

Command Syntax Symbols

[...]	Optional item. You may either enter or omit the enclosed item.
{...}	Item that can be repeated.
...|...	Alternative items. You should enter only one of the items separated by this symbol.
(...)	Logical group of items. The parentheses themselves are not part of the command syntax; do not type them.

Command and Code Conventions

In code examples or commands, the continuation of a long line is indented. Omitted code is indicated with the ellipsis (...) symbol. "Enter" refers to the standard key (labelled either Enter or Return) for terminating a line of input.

Getting Help

We have done our best to make sure all the information you need to install and operate Objectivity products is provided in the product documentation. However, we also realize problems requiring special attention sometimes occur.

Technical Support Web Site

You can find answers to frequently asked questions, supported platforms, known bugs, and bug fixes on the Objectivity Technical Support web site. Send electronic mail or call Objectivity Customer Support to gain access to the site.

How to Reach Objectivity Customer Support

You can contact Objectivity Customer Support by:

• Telephone: Call 1.650.254.7100 or 1.800.SOS.OBJY (1.800.767.6259) Monday through Friday between 6:00 a.m. and 6:00 p.m. Pacific Time, and ask for Customer Support.

• Fax: Send a fax to Objectivity at 1.650.254.7171.

• Electronic Mail: Send electronic mail to help@objectivity.com.

Before You Call

If you need help from Customer Support, please have the following information ready before you contact Objectivity:

• Your name, company name, address, telephone number, fax number, and email address

• Description of your workstation environment, including the type of workstation, its operating system version, compiler or interpreter, and windowing environment

• Information about the Objectivity product you are using, including the version of the Objectivity/DB libraries

• Detailed description of the problem you have encountered

Guide  Reference  Contents  Previous  Next  Index