Introduction

In this chapter

• Introducing ObjectStore Inspector
• Inspector Features
• Editing ObjectStore Database Information
• Sharing ObjectStore Database Information
• Inspector Options

ObjectStore Inspector is a graphical tool that lets you browse, edit, query, and report on the data in an ObjectStore database.

Using Inspector, you can

• Analyze and document the logical information represented by ObjectStore database schemas. Inspector's data views let you filter and order ObjectStore collections, and you can use database views to create custom schema diagrams. You can navigate instance relationships, and save the resulting navigation path for future use.
• Create, read, update, and delete ObjectStore application data in test and production environments - you can work with ObjectStore data directly from Inspector using manual editing tools and user-defined methods.
• Analyze the physical characteristics of ObjectStore databases at the segment, page, and instance level. The Physical Database Layout window provides detailed space and free space information and enables you to look up a particular instance based on its address or segment offset. You can also review layout, segment, and binary dump information for individual instances.
• Share ObjectStore database information by creating reports based on ObjectStore application data, printing schema diagrams and data views, and exporting collections to other applications. You can also use Inspector as an OLE server in documents from OLE container applications.

Supported formats

• File
• Remote
• Rawfs (raw file storage)

Read/write access

Some Inspector operations, however, require that Inspector open a database in write mode. These operations include

• Invoking a create or update user-defined method
• Saving metaknowledge when the metaknowledge is stored with the database
• Editing a data member from within Inspector, using the Edit Data Member dialog box

How to Start Inspector

The Inspector desktop appears.

The Inspector desktop

Open the carsdemo Database

Tip: The carsdemo.db database used in this manual, and other sample databases, is located in the <install>\examples\DemoDBs directory, where <install> is the directory in which you have installed ObjectStore Inspector.

How to open carsdemo

1. Click File | Open Database on the menu bar.
   
   Alternative: Click the Open DB tool on the toolbar.

   The Open dialog box appears.

2. Select the carsdemo sample database in the <install>\examples\DemoDBs directory and click OK.
   
   The main database view window appears within the Inspector desktop.

Inspector Features

Main Database View Window

The main database view window appears in the Inspector desktop by default when you open a database.

Three panes

• The Database Roots pane - Displays the roots that exist for the database. You can use Inspector to create roots. See Chapter 8, Roots for more information.
• The schema pane - Displays a schema diagram representing the ObjectStore database using one of several popular modeling notations. The schema pane is located below the Database Roots pane. See Chapter 4, Schema Diagrams for more information.
• The instance pane - Displays instance information for the selected root or class. The instance pane is empty until you fill it with a class or collection extent. By default, instances are displayed in a grid format, though a list format is available. The instance pane is located to the right of the Database Roots pane. See Chapter 5, Classes and Instances for more information.

Data Views

A data view is similar to the instance pane in a database view: both display ObjectStore collections in either a grid or list format.

Data views provide unique filtering and ordering features that help you customize the presentation of ObjectStore collections. Any time you want to manipulate the data displayed by an ObjectStore collection, you should use data views to take advantage of these features.

For more information on working with data views, see Chapter 3, Data Views.

Instance Window

The Instance window displays the type, name, and value for every data member associated with a specific class instance.

Tip: You control the appearance of an instance - that is, which of its data members are displayed and whether or not it is associated with an icon - using the Instance Format dialog box.

See Chapter 5, Classes and Instances to learn more about working with instances.

Navigation Window

The Navigation window lets you see how instances are related to one another.

Inspector opens a Navigation window for you as you navigate from instance to instance - in the same database or across different databases. As you navigate, Inspector updates the Navigation window to record your path.

As an alternative, you can ask Inspector to navigate all relationship paths of an instance for you, using the Auto Navigation feature.

See Navigating Instances to learn more about navigation.

Physical Database Layout Window

The Physical Database Layout window displays physical information about the ObjectStore database at the segment and page level.

For any group of segments and pages you select, Inspector displays the classes stored in that part of ObjectStore's persistent memory. Once you select a class, Inspector displays the address and segment offset information for each instance in the class.

See Chapter 9, Tools for Physical Analysis for more information on the Physical Database Layout window and other features for working with physical aspects of ObjectStore databases.

Use Inspector to Create Multiple Views of the Same Database

• A database view that hides the inheritance relationships of a particular class
• A database view that displays the schema diagram using a different modeling notation
• A data view that contains an ObjectStore collection filtered using certain criteria
• Class-specific instance formats
• Data-view-specific instance formats

How information is saved

Metaknowledge

Editing ObjectStore Database Information

User-Defined Methods

• Create persistent objects
• Read persistent objects
• Update persistent objects
• Delete persistent objects

You define user-defined methods in the ObjectStore DLL schema of your ObjectStore database. Once it is defined, you register and invoke the method in Inspector.

For more information, see Chapter 7, User-Defined Methods.

Edit Data Member Dialog Box

You use the Edit Data Member dialog box to edit instances of classes you select using Inspector.

For more information, see Chapter 5, Classes and Instances.

Sharing ObjectStore Database Information

Printing

• Print database schema using several popular notations
• Print data views
• Print navigation trees

Exporting

See Exporting a Collection Grid for more information.

Using Inspector as an OLE Server

See Appendix B, Using Inspector as an OLE Server for more information.

Inspector Options

• Control the default notation used in schema diagrams
• Control whether or not external databases are opened to resolve cross-database navigation
• Tailor Inspector's grid-loading performance
• Select the font you want to use for the display of instance information

Where You Set Options

You set options using the Options dialog box.

The Options dialog box contains several tabbed pages; options are grouped by feature.

How to Set Options

1. Click Tools | Options on the menu bar.
   
   The Options dialog box appears.

2. Click the tab for the options you want to set.
   
   
3. Make your changes.
   
   
4. Click OK.
   
   

• Immediately
• The next time the database is opened
• When a database is opened without the metaknowledge saved with it previously, that is, when the metaknowledge for a database is recomputed

Updated: 05/07/99 16:42:16