Package org.z3950.zoom

This package has two roles: it is an implementation of the Java binding for ZOOM; and its documentation constitutes the specificaton for the Java binding.

See:
Description

Class Summary

CCLQuery	Represents a CCL query to be submitted to a Z39.50 Server.
Connection	Represents a connection to a Z39.50 Server, as described in the ZOOM Abstract API.
Global	This class is merely a namespace for the non-class functions described in the ZOOM Abstract API (UNSTABLE).
PrefixQuery	Represents a Prefix query to be submitted to a Z39.50 Server.
Query	Represents a query to be submitted to a Z39.50 Server, as described in the ZOOM Abstract API.
Record	Represents a records returned from a Z39.50 Server, as described in the ZOOM Abstract API (UNSTABLE).
ResultSet	Represents a result set held on a Z39.50 Server, as described in the ZOOM Abstract API.

Exception Summary

Bib1Exception	Represents an error occurring in a Z39.50 Server.
SearchException	Represents an exception occurring in the ZOOM libraries (not on the server) during a Search operation.
ZOOMException	Represents an exception occurring in a ZOOM operation.

Package org.z3950.zoom Description

This package has two roles:

• it is an implementation of the Java binding for ZOOM; and
• its documentation constitutes the specificaton for the Java binding. All other implemetations of the Java binding should conform to the descriptions in this documentation.

The primary specification of ZOOM is the Abstract API. The documentation of the classes in this package concentrates on how that abstract specification is mapped into Java. It is intended to be read in conjunction with the Abstract API documentation.

The documentation for each class, and for each method within the classes, includes a link to the relevant subsections of the abstract API specification.

A typical simple ZOOM program might look like this:

    import org.z3950.zoom.*;

    class ZoomTest {
        public static void main (String[] args) throws Exception {
            Connection conn = new Connection("localhost", 9999);
            conn.option("databaseName", "Default");
            conn.option("preferredRecordSyntax", "xml");
            Query q = new CCLQuery("ti=minerals and (ab=location or ab=place)",
                                   "qualset.properties");
            ResultSet rs = conn.search(q);
            int size = rs.size();
            System.out.println("Found " + size + " records");
            for (int i = 0; i < size; i++) {
                System.out.println("-- record " + (i+1) + "--");
                System.out.println(rs.getRecord(i).render());
            }
            conn.close();
        }
    }
 

If you have difficulty running ZOOM-based applications, see the FAQ on Running ZOOM-Java over JZKit.

Author:

Mike Taylor <mike@zoom.z3950.org>

See Also:

the ZOOM web site at zoom.z3950.org, the ZOOM Abstract API at zoom.z3950.org/api, the Java binding for ZOOM at zoom.z3950.org/bind/java