<chapter id="zoom">
- <!-- $Id: zoom.xml,v 1.10 2002-10-23 12:22:19 mike Exp $ -->
<title>ZOOM-C++</title>
<sect1 id="zoom-introduction">
<title>Introduction</title>
<para>
- <ulink url="http://zoom.z3950.org/">ZOOM</ulink>
+ <ulink url="&url.zoom;">ZOOM</ulink>
is the emerging standard API for information retrieval programming
using the Z39.50 protocol. ZOOM's
- <ulink url="http://zoom.z3950.org/api/">Abstract API</ulink>
+ <ulink url="&url.zoom.api;">Abstract API</ulink>
specifies semantics for classes representing key IR concepts such as
connections, queries, result sets and records; and there are various
- <ulink url="http://zoom.z3950.org/bind/">bindings</ulink>
+ <ulink url="&url.zoom.bind;">bindings</ulink>
specifying how those concepts should be represented in various
programming languages.
</para>
<para>
The YAZ++ library includes an implementation of the <ulink
- url="http://zoom.z3950.org/bind/cplusplus/"
- >C++ binding</ulink>
+ url="&url.zoom.bind.cplusplus;">C++ binding</ulink>
for ZOOM, enabling quick, easy development of client applications.
</para>
<para>
For example, here is a tiny Z39.50 client that fetches and displays
- the MARC record for Farlow & Brett Surman's
+ the MARC record for Farlow & Brett Surman's
<citetitle>The Complete Dinosaur</citetitle>
from the Library of Congress's Z39.50 server:
</para>
<programlisting>
#include <iostream>
- #include <yaz++/zoom.h>
+ #include <yazpp/zoom.h>
using namespace ZOOM;
implementation of the C binding. For information on the supported
options and other such details, see the ZOOM-C documentation, which
can be found on-line at
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.php"/>
+ <ulink url="&url.yaz.zoom;"/>
</para>
<para>
All of the classes defined by ZOOM-C++ are in the
(links below).
</para>
- <sect2>
+ <sect2 id="connection.references">
<title>References</title>
<itemizedlist>
<listitem>
<para>
<ulink url="http://zoom.z3950.org/api/zoom-1.3.html#3.2"
>Section 3.2 (Connection) of the ZOOM Abstract API</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.php#zoom.connections"
- >The Connections section of the ZOOM-C documentation</ulink>
- </para>
- </listitem>
- </itemizedlist>
- </sect2>
- </sect1>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="&url.yaz.zoom.connections;"
+ >The Connections section f the ZOOM-C documentation</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
<sect1 id="zoom-query">
a specific query notation.
</para>
- <sect2>
+ <sect2 id="ZOOM::prefixQuery">
<title><literal>ZOOM::prefixQuery</literal></title>
<synopsis>
class prefixQuery : public query {
~prefixQuery ();
};
</synopsis>
- <para>
- This class enables a query to be created by compiling YAZ's
- cryptic but powerful
- <ulink url="http://www.indexdata.dk/yaz/doc/tools.php#PQF"
- >Prefix Query Notation (PQN)</ulink>.
- </para>
- </sect2>
-
- <sect2>
+ <para>
+ This class enables a query to be created by compiling YAZ's
+ cryptic but powerful
+ <ulink url="&url.yaz.pqf;">Prefix Query Notation (PQN)</ulink>.
+ </para>
+ </sect2>
+
+ <sect2 id="ZOOM::CCLQuery">
<title><literal>ZOOM::CCLQuery</literal></title>
<synopsis>
class CCLQuery : public query {
<para>
This class enables a query to be created using the simpler but
less expressive
- <ulink url="http://www.indexdata.dk/yaz/doc/tools.php#CCL"
- >Common Command Language (CCL)</ulink>.
+ <ulink url="&url.yaz.ccl;">Common Command Language (CCL)</ulink>.
The qualifiers recognised by the CCL parser are specified in an
external configuration file in the format described by the YAZ
documentation.
</para>
</sect2>
- <sect2>
+ <sect2 id="queries.discussion">
<title>Discussion</title>
<para>
It will be readily recognised that these objects have no methods
</screen>
</sect2>
- <sect2>
+ <sect2 id="query.references">
<title>References</title>
<itemizedlist>
<listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.query.php"
+ <ulink url="&url.yaz.zoom.query;"
>The Queries section of the ZOOM-C documentation</ulink>
</para>
</listitem>
<link linkend="zoom-exception"><literal>exception</literal></link>.
</para>
- <sect2>
+ <sect2 id="resultset.references">
<title>References</title>
<itemizedlist>
<listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.resultsets.php"
+ <ulink url="&url.yaz.zoom.resultsets;"
>The Result Sets section of the ZOOM-C documentation</ulink>
</para>
</listitem>
it apart ``by hand''.
</para>
- <sect2>
+ <sect2 id="zoom.memory.management">
<title>Memory Management</title>
<para>
- The <literal>record</literal> obejcts returned from
+ The <literal>record</literal> objects returned from
<literal>resultSet::getRecord()</literal> are ``owned'' by the
result set object: that means that the application is not
responsible for <literal>delete</literal>ing them - each
</programlisting>
</sect2>
- <sect2>
+ <sect2 id="record.references">
<title>References</title>
<itemizedlist>
<listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.records.php"
+ <ulink url="&url.yaz.zoom.records;"
>The Records section of the ZOOM-C documentation</ulink>
</para>
</listitem>
It has three concrete subclasses:
</para>
- <sect2>
+ <sect2 id="ZOOM::systemException">
<title><literal>ZOOM::systemException</literal></title>
<synopsis>
class systemException: public exception {
</para>
</sect2>
- <sect2>
+ <sect2 id="ZOOM::bib1Exception">
<title><literal>ZOOM::bib1Exception</literal></title>
<synopsis>
class bib1Exception: public exception {
</para>
</sect2>
- <sect2>
+ <sect2 id="ZOOM::queryException">
<title><literal>ZOOM::queryException</literal></title>
<synopsis>
class queryException: public exception {
to catch exceptions and report any errors:
</para>
<programlisting>
- /* g++ -o zoom-c++-hw zoom-c++-hw.cpp -lyaz++ -lyaz */
+ /* g++ -o zoom-c++-hw zoom-c++-hw.cpp -lzoompp -lyaz */
#include <iostream>
- #include <yaz++/zoom.h>
+ #include <yazpp/zoom.h>
using namespace ZOOM;
</para>
</sect2>
- <sect2>
+ <sect2 id="exception.references">
<title>References</title>
<itemizedlist>
<listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/bib1diag.html"
- >Bib-1 Diagnostics</ulink> on the
- <ulink url="http://lcweb.loc.gov/z3950/agency/"
- >Z39.50 Maintenance Agency</ulink> site.
+ <ulink url="&url.z39.50.diagnostics;">Bib-1 Diagnostics</ulink> on the
+ <ulink url="&url.z39.50;">Z39.50 Maintenance Agency</ulink> site.
</para>
</listitem>
</itemizedlist>
<literal>exception</literal> class and its subclasses. The
closest thing is the <literal>ZOOM_connection_error</literal>
function described in
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.php#zoom.connections"
+ <ulink url="&url.yaz.zoom.connections;"
>The Connections section</ulink> of the documentation.
</para>
</sect2>
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
- sgml-parent-document: "yaz++.xml"
+ sgml-parent-document: "yazpp.xml"
sgml-local-catalogs: nil
sgml-namecase-general:t
End:
projects / yazpp-moved-to-github.git / blobdiff