X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=238c7d9fe171d83e79b49b9df07d33fdc9dcf8c2;hb=55119d24b44e72b7bfef2e5a67da4964c0cd16e4;hp=0460599db207d9999bea999151519fd00b6e8f0c;hpb=0604512365d9d3c223e147e416129589dabc31d4;p=yazpp-moved-to-github.git diff --git a/doc/zoom.xml b/doc/zoom.xml index 0460599..238c7d9 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -1,36 +1,34 @@ - ZOOM-C++ Introduction - ZOOM + ZOOM is the emerging standard API for information retrieval programming using the Z39.50 protocol. ZOOM's - Abstract API + Abstract API specifies semantics for classes representing key IR concepts such as connections, queries, result sets and records; and there are various - bindings + bindings specifying how those concepts should be represented in various programming languages. - The Yaz++ library includes an implementation of the C++ binding + The YAZ++ library includes an implementation of the C++ binding for ZOOM, enabling quick, easy development of client applications. 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 The Complete Dinosaur from the Library of Congress's Z39.50 server: #include <iostream> - #include <yaz++/zoom.h> + #include <yazpp/zoom.h> using namespace ZOOM; @@ -44,17 +42,19 @@ cout << rec->render() << endl; } + + + For the sake of simplicity, this program does not check + for errors: we show a more robust version of the same program + later.) + + - (Note that, for the sake of simplicity, this program does not check - for errors: we show a more robust version of the same program - later.) - - - Yaz++'s implementation of the C++ binding is a thin layer over Yaz's + YAZ++'s implementation of the C++ binding is a thin layer over YAZ's 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 - + All of the classes defined by ZOOM-C++ are in the @@ -144,24 +144,24 @@ (links below). - + References Section 3.2 (Connection) of the ZOOM Abstract API - - - - - The Connections section of the ZOOM-C documentation - - - - - + + + + + The Connections section f the ZOOM-C documentation + + + + + @@ -173,7 +173,7 @@ a specific query notation. - + <literal>ZOOM::prefixQuery</literal> class prefixQuery : public query { @@ -182,15 +182,14 @@ ~prefixQuery (); }; - - This class enables a query to be created by compiling Yaz's - cryptic but powerful - Prefix Query Notation (PQN). - - - - + + This class enables a query to be created by compiling YAZ's + cryptic but powerful + Prefix Query Notation (PQN). + + + + <literal>ZOOM::CCLQuery</literal> class CCLQuery : public query { @@ -202,10 +201,9 @@ This class enables a query to be created using the simpler but less expressive - Common Command Language (CCL). + Common Command Language (CCL). The qualifiers recognised by the CCL parser are specified in an - external configuration file in the format described by the Yaz + external configuration file in the format described by the YAZ documentation. @@ -217,7 +215,7 @@ - + Discussion It will be readily recognised that these objects have no methods @@ -244,7 +242,7 @@ - + References @@ -255,7 +253,7 @@ - The Queries section of the ZOOM-C documentation @@ -326,7 +324,7 @@ exception. - + References @@ -337,7 +335,7 @@ - The Result Sets section of the ZOOM-C documentation @@ -418,10 +416,10 @@ it apart ``by hand''. - + Memory Management - The record obejcts returned from + The record objects returned from resultSet::getRecord() are ``owned'' by the result set object: that means that the application is not responsible for deleteing them - each @@ -456,7 +454,7 @@ - + References @@ -467,7 +465,7 @@ - The Records section of the ZOOM-C documentation @@ -508,7 +506,7 @@ It has three concrete subclasses: - + <literal>ZOOM::systemException</literal> class systemException: public exception { @@ -529,7 +527,7 @@ - + <literal>ZOOM::bib1Exception</literal> class bib1Exception: public exception { @@ -558,7 +556,7 @@ - + <literal>ZOOM::queryException</literal> class queryException: public exception { @@ -592,10 +590,10 @@ to catch exceptions and report any errors: - /* 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; @@ -641,7 +639,7 @@ - + References @@ -652,10 +650,8 @@ - Bib-1 Diagnostics on the - Z39.50 Maintenance Agency site. + Bib-1 Diagnostics on the + Z39.50 Maintenance Agency site. @@ -665,7 +661,7 @@ exception class and its subclasses. The closest thing is the ZOOM_connection_error function described in - The Connections section of the documentation. @@ -682,7 +678,7 @@ 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: