Cursor Example
Prev | Chapter 9. Using Cursors | Next

## Cursor Example

In Database Example we wrote an application that loaded two `Database` objects with vendor and inventory information. In this example, we will use those databases to display all of the items in the inventory database. As a part of showing any given inventory item, we will look up the vendor who can provide the item and show the vendor's contact information.

To do this, we create the `ExampleInventoryRead` application. This application reads and displays all inventory records by:

1. Opening the environment and then the inventory, vendor, and class catalog `Database` objects. We do this using the `MyDbEnv` class. See Stored Class Catalog Management with MyDbEnv for a description of this class.

2. Obtaining a cursor from the inventory `Database`.

3. Steps through the `Database`, displaying each record as it goes.

4. To display the Inventory record, the custom tuple binding that we created in InventoryBinding.java is used.

5. `Database.get()` is used to obtain the vendor that corresponds to the inventory item.

6. A serial binding is used to convert the `DatabaseEntry` returned by the `get()` to a Vendor object.

7. The contents of the Vendor object are displayed.

We implemented the `Vendor` class in Vendor.java. We implemented the `Inventory` class in Inventory.java.

The full implementation of `ExampleInventoryRead` can be found in:

    JE_HOME/examples/je/gettingStarted/ExampleInventoryRead.java

where `JE_HOME` is the location where you placed your JE distribution.

Example 9.1 ExampleInventoryRead.java

To begin, we import the necessary classes:

    // file ExampleInventoryRead.java
    package je.gettingStarted;

    import com.sleepycat.bind.EntryBinding;
    import com.sleepycat.bind.serial.SerialBinding;
    import com.sleepycat.bind.tuple.TupleBinding;

    import com.sleepycat.je.Cursor;
    import com.sleepycat.je.DatabaseEntry;
    import com.sleepycat.je.DatabaseException;
    import com.sleepycat.je.LockMode;
    import com.sleepycat.je.OperationStatus;

    import java.io.File;
    import java.io.IOException;

Next we declare our class and set up some global variables. Note a `MyDbEnv` object is instantiated here. We can do this because its constructor never throws an exception. See Database Example for its implementation details.

    public class ExampleInventoryRead {

            private static File myDbEnvPath =
                new File("/tmp/JEDB");

            // Encapsulates the database environment and databases.
            private static MyDbEnv myDbEnv = new MyDbEnv();

            private static TupleBinding inventoryBinding;
            private static EntryBinding vendorBinding;

Next we create the `ExampleInventoryRead.usage()` and `ExampleInventoryRead.main()` methods. We perform almost all of our exception handling from `ExampleInventoryRead.main()`, and so we must catch `DatabaseException` because the `com.sleepycat.je.*` APIs throw them.

       private static void usage() {
            System.out.println("ExampleInventoryRead [-h <env directory>]");
            System.exit(0);
        }

        public static void main(String args[]) {
            ExampleInventoryRead eir = new ExampleInventoryRead();
            try {
                eir.run(args);
            } catch (DatabaseException dbe) {
                System.err.println("ExampleInventoryRead: " + dbe.toString());
                dbe.printStackTrace();
            } finally {
                myDbEnv.close();
            }
            System.out.println("All done.");
        }

In `ExampleInventoryRead.run()`, we call `MyDbEnv.setup()` to open our environment and databases. Then we create the bindings that we need for using our data objects with `DatabaseEntry` objects.

        private void run(String args[]) throws DatabaseException {
            // Parse the arguments list
            parseArgs(args);

            myDbEnv.setup(myDbEnvPath, // path to the environment home
                          true);       // is this environment read-only?

            // Setup our bindings.
            inventoryBinding = new InventoryBinding();
            vendorBinding =
                 new SerialBinding(myDbEnv.getClassCatalog(),
                                   Vendor.class);
            showAllInventory();
        }

Now we write the loop that displays the `Inventory` records. We do this by opening a cursor on the inventory database and iterating over all its contents, displaying each as we go.

        private void showAllInventory()
            throws DatabaseException {
            // Get a cursor
            Cursor cursor = myDbEnv.getInventoryDB().openCursor(null, null);

            // DatabaseEntry objects used for reading records
            DatabaseEntry foundKey = new DatabaseEntry();
            DatabaseEntry foundData = new DatabaseEntry();

            try { // always want to make sure the cursor gets closed.
                while (cursor.getNext(foundKey, foundData,
                            LockMode.DEFAULT) == OperationStatus.SUCCESS) {
                    Inventory theInventory =
                        (Inventory)inventoryBinding.entryToObject(foundData);
                    displayInventoryRecord(foundKey, theInventory);
                }
            } catch (Exception e) {
                System.err.println("Error on inventory cursor:");
                System.err.println(e.toString());
                e.printStackTrace();
            } finally {
                cursor.close();
            }

        }

We use `ExampleInventoryRead.displayInventoryRecord()` to actually show the record. This method first displays all the relevant information from the retrieved Inventory object. It then uses the vendor database to retrieve and display the vendor. Because the vendor database is keyed by vendor name, and because each inventory object contains this key, it is trivial to retrieve the appropriate vendor record.

       private void displayInventoryRecord(DatabaseEntry theKey,
                                            Inventory theInventory)
            throws DatabaseException {

            DatabaseEntry searchKey = null;
            try {
                String theSKU = new String(theKey.getData(), "UTF-8");
                System.out.println(theSKU + ":");
                System.out.println("\t " + theInventory.getItemName());
                System.out.println("\t " + theInventory.getCategory());
                System.out.println("\t " + theInventory.getVendor());
                System.out.println("\t\tNumber in stock: " +
                theInventory.getVendorInventory());
                System.out.println("\t\tPrice per unit:  " +
                    theInventory.getVendorPrice());
                System.out.println("\t\tContact: ");

                searchKey =
                 new DatabaseEntry(theInventory.getVendor().getBytes("UTF-8"));
            } catch (IOException willNeverOccur) {}
            DatabaseEntry foundVendor = new DatabaseEntry();

            if (myDbEnv.getVendorDB().get(null, searchKey, foundVendor,
                    LockMode.DEFAULT) != OperationStatus.SUCCESS) {
                System.out.println("Could not find vendor: " +
                    theInventory.getVendor() + ".");
                System.exit(-1);
            } else {
                Vendor theVendor =
                    (Vendor)vendorBinding.entryToObject(foundVendor);
                System.out.println("\t\t " + theVendor.getAddress());
                System.out.println("\t\t " + theVendor.getCity() + ", " +
                    theVendor.getState() + " " + theVendor.getZipcode());
                System.out.println("\t\t Business Phone: " +
                    theVendor.getBusinessPhoneNumber());
                System.out.println("\t\t Sales Rep: " +
                                    theVendor.getRepName());
                System.out.println("\t\t            " +
                    theVendor.getRepPhoneNumber());
           }
        }

The remainder of this application provides a utility method used to parse the command line options. From the perspective of this document, this is relatively uninteresting. You can see how this is implemented by looking at:

    JE_HOME/examples/je/gettingStarted/ExampleInventoryRead.java

where `JE_HOME` is the location where you placed your JE distribution.

Prev | Up | Next
Replacing Records Using Cursors | Home | Chapter 10. Secondary Databases