doc/ajaxdev.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <section id="ajaxdev">
   3   <title>Ajax client development</title>
   4
   5   <para>
   6   Pazpar2 offers programmer a simple Web Service protocol that can be used (queried in a request/response fashion) from any, server- or client-side, programming language with an XML support. However, when programming a Web-based client to Pazpar2, to achieve certain level of interactivity and instant notification of latest changes in the result set, Ajax (Asynchronous JavaScript and XML) technology may be used. An Ajax client allows user to browse the results before the lengthy process of information retrieval from the back-end targets is finished. Blocking and waiting for usually slow back-end targets is one of the biggest functionality issues in a federated search engine.
   7   </para>
   8
   9   <para><bridgehead>Pz2.js</bridgehead></para>
  10
  11   <para>
  12   Pazpar2 comes with a small JavaScript library called pz2.js. This library is designed to simplify development of an Ajax-based pazpar2 client and alleviate programmer from the low-level details like polling the web service, fetching and parsing returned XML output or managing timers, sessions and basic state variables.
  13   </para>
  14
  15   <para>
  16   The library supports most major browsers including Firefox 1.5+, IE 6+, Safari 2+, Opera 9+ and Konqueror.
  17   </para>
  18
  19   <para>
  20   The library can work in two modes: a session-aware mode and a session-less mode.
  21   </para>
  22
  23   <para>In the session-aware mode, the library assumes that the pazpar2 daemon is contacted directly (preferably via Apache proxy to avoid security breaches) and tracks the session Ids internally.
  24   </para>
  25
  26   <para>In the session-less mode the library assumes that the client is identified on the server and the session Ids are not managed directly. This way of operation requires more sophisticated pazpar2 proxy (preferably a wrapper written in a server-side scripting language like PHP that can identify clients and relate them to open pazpar2 sessions).</para>
  27
  28   <para><bridgehead>Using pz2.js</bridgehead></para>
  29
  30   <para>
  31   Client development with the pz2.js is strongly event based and the style should be familiar to most JavaScript developers. A simple client (jsdemo) is distributed with pazpar2's source code and shows how to set-up and use pz2.js.
  32   </para>
  33
  34   <para>
  35   In short, programmer starts by instantiating the pz2 object and passing an array of parameters to the constructor. The parameter array specifies callbacks used for handling responses to the pazpar2 commands. Additionally, the parameter array is used to configure run-time parameters of the pz2.js like polling timer time-outs, session-mode and XSLT style-sheets.
  36   </para>
  37
  38   <para><bridgehead>Command callbacks</bridgehead></para>
  39
  40   <para>
  41   Callback naming is simple and follows “on” prefix plus command name scheme (like onsearch, onshow, onrecord, ... etc.). When programmer calls a function like show or record on the pz2 object, pz2.js will keep on polling pazpar2 (until the backend targets are idle) and with each command's response an assigned callback will be called. In case of pazpar2's internal error an error callback is called.
  42   </para>
  43
  44   <screen>
  45   my_paz = new pz2 (
  46   {
  47           "pazpar2path": "/pazpar2/search.pz2",
  48           "usesessions" : true,
  49
  50           // assigning command handler, turns on automatic polling
  51           "onshow": my_onshow,
  52           // polling period for each command can be specified
  53           "showtime": 500,
  54
  55           "onterm": my_onterm,
  56           // facet terms are specified as a comma separated list
  57           "termlist": "subject,author",
  58
  59           "onrecord": my_onrecord
  60           }
  61   );
  62   </screen>
  63
  64   <para>
  65   Each command callback is a user defined function that takes a hash object as a parameter. The hash object contains parsed pazpar2 responses (hash members that correspond to the elements in the response XML document). Within the handler programmer further processes the data and updates the viewed document.
  66   </para>
  67
  68   <screen>
  69     function my_onstat(data) {
  70       var stat = document.getElementById("stat");
  71       stat.innerHTML = '&lt;span&gt;Active clients: '+ data.activeclients
  72           + '/' + data.clients + ' | &lt;/span&gt;'
  73           + '&lt;span&gt;Retrieved records: ' + data.records
  74           + '/' + data.hits + '&lt;/span&gt;';
  75     }
  76
  77     function my_onshow(data) {
  78         // data contains parsed show response
  79         for (var i = 0; i &lt; data.hits[0].length; i++)
  80             // update page with the hits
  81     }
  82
  83     function on_record(data) {
  84         // if detailsstylesheet parameter was set data array
  85         // will contain raw xml and xsl data
  86         Element_appendTransformResult(someDiv, data.xmlDoc, data.xslDoc);
  87     }
  88   </screen>
  89
  90   <para><bridgehead>pz2.js on runtime</bridgehead></para>
  91
  92   <para>
  93   The search process is initiated by calling the search method on the instantiated pz2 object. To initiate short status reports and per-target status information methods stat and bytarget have to be called accordingly.
  94   </para>
  95
  96   <screen>
  97     my_paz.search (query, recPergPage, 'relevance');
  98   </screen>
  99
 100   <para>
 101   Managing the results (keeping track of the browsed results page and sorting) is up to the client's programmer. At any point the show method may be called to bring up the latest result set with a different sorting criteria or range and without re-executing the search on the back-end.
 102   </para>
 103
 104   <screen>
 105     my_paz.show (1, 10, 'relevance');
 106   </screen>
 107
 108   <para>
 109   To retrieve a detailed record the record command is called. When calling record command one may temporarily override its default callback by specifying the handler parameter. This might be useful when retrieving raw records that need to be processed differently.
 110   </para>
 111
 112   <screen>
 113     my_paz.record (recId, 2, 'opac', { “callback”: temp_callback, “args”, caller_args});
 114   </screen>
 115
 116   <variablelist>
 117
 118     <para><bridgehead>PARAMATERS ARRAY</bridgehead></para>
 119
 120     <varlistentry><term>pazpar2path</term>
 121     <listitem><para>server path to pazpar2 (relative to the portal), when pazpar2 is installed as a package this does not have to be set </para></listitem>
 122     </varlistentry>
 123
 124     <varlistentry><term>usesessions</term>
 125     <listitem><para>boolean, when set to true pz2.js will manage sessions internally otherwise it's left to the server-side script, default true</para></listitem>
 126     </varlistentry>
 127
 128     <varlistentry><term>autoInit</term>
 129     <listitem><para>bolean, sets auto initialization of pazpar2 session on the object instantiation, default true, valid only if usesession is set to true</para></listitem>
 130     </varlistentry>
 131
 132     <varlistentry><term>detailstylesheet</term>
 133     <listitem><para>path to the xsl presentation stylesheet (relative to the portal) used for the detailed record display</para></listitem></varlistentry>
 134
 135     <varlistentry><term>errorhandler</term>
 136     <listitem><para>callback function called on any, pazpar2 or pz2.js' internal, error</para></listitem></varlistentry>
 137
 138     <varlistentry><term>oninit</term>
 139     <listitem><para>specifies init response callback function</para></listitem></varlistentry>
 140
 141     <varlistentry><term>onstat</term>
 142     <listitem><para>specifies stat response callback function</para></listitem></varlistentry>
 143
 144     <varlistentry><term>onshow</term>
 145     <listitem><para>specifies show response callback function</para></listitem></varlistentry>
 146
 147     <varlistentry><term>onterm</term>
 148     <listitem><para>specifies termlist response callback function</para></listitem></varlistentry>
 149
 150     <varlistentry><term>onrecord</term>
 151     <listitem><para>specifies record response callback function</para></listitem></varlistentry>
 152
 153     <varlistentry><term>onbytarget</term>
 154     <listitem><para>specifies bytarget response callback function</para></listitem></varlistentry>
 155
 156     <varlistentry><term>onreset</term>
 157     <listitem><para>specifies reset method callback function</para></listitem></varlistentry>
 158
 159     <varlistentry><term>termlist</term>
 160     <listitem><para>comma separated list of facets</para></listitem></varlistentry>
 161
 162     <varlistentry><term>keepAlive</term>
 163     <listitem><para>ping period, should not be lower than 5000 usec</para></listitem></varlistentry>
 164
 165     <varlistentry><term>stattime</term>
 166     <listitem><para>default 1000 usec</para></listitem></varlistentry>
 167
 168     <varlistentry><term>termtime</term></varlistentry>
 169
 170     <varlistentry><term>showtime</term></varlistentry>
 171
 172     <varlistentry><term>bytargettime</term></varlistentry>
 173
 174   </variablelist>
 175
 176   <variablelist>
 177
 178     <para><bridgehead>METHODS</bridgehead></para>
 179
 180     <varlistentry><term>stop ()</term>
 181     <listitem><para>stop activity by clearing timeouts</para></listitem></varlistentry>
 182
 183     <varlistentry><term>reset ()</term>
 184     <listitem><para>reset state</para></listitem></varlistentry>
 185
 186     <varlistentry><term>init (sesionId)</term>
 187     <listitem><para>session-mode, initialize new session or pick up a session already initialized</para></listitem></varlistentry>
 188
 189     <varlistentry><term>ping ()</term>
 190     <listitem><para>session-mode, intitialize pinging </para></listitem></varlistentry>
 191
 192     <varlistentry><term>search (query, num, sort, filter, showfrom)</term>
 193     <listitem><para>execute piggy-back search and activate polling on every command specified by assigning command callback (in the pz2 constructor)</para></listitem></varlistentry>
 194
 195     <varlistentry><term>show (start, num, sort)</term>
 196     <listitem><para>start or change parameters of polling for a given window of records</para></listitem></varlistentry>
 197
 198     <varlistentry><term>record (id, offset, syntax, handler)</term>
 199     <listitem><para>retrieve detailed or raw record. handler temporarily overrides default callback function.</para></listitem></varlistentry>
 200
 201     <varlistentry><term>termlist ()</term>
 202     <listitem><para>start polling for termlists</para></listitem></varlistentry>
 203
 204     <varlistentry><term>bytarget ()</term>
 205     <listitem><para>start polling for target status</para></listitem></varlistentry>
 206
 207     <varlistentry><term>stat ()</term>
 208     <listitem><para>start polling for pazpar2 status</para></listitem></varlistentry>
 209
 210   </variablelist>
 211
 212   <para/>
 213   <para>Pz2.js comes with a set of cross-browser helper classes and functions.</para>
 214
 215   <variablelist>
 216
 217     <para><bridgehead>AJAX helper class</bridgehead></para>
 218
 219     <varlistentry><term>pzHttpRequest</term>
 220     <listitem><para>a cross-browser Ajax wrapper class</para></listitem></varlistentry>
 221
 222     <varlistentry><term>constructor (url, errorHandler)</term>
 223     <listitem><para>create new request for a given url</para></listitem></varlistentry>
 224
 225     <varlistentry><term>get (params, callback)</term>
 226     <listitem><para>asynchronous, send the request with given parameters (array) and call callback with response as parameter</para></listitem></varlistentry>
 227
 228     <varlistentry><term>post (params, data, callback)</term>
 229     <listitem><para>asychronous, post arbitrary data (may be XML doc) and call callback with response as parameter</para></listitem></varlistentry>
 230
 231     <varlistentry><term>load ()</term>
 232     <listitem><para>synchronous, returns the response for the given request</para></listitem></varlistentry>
 233
 234   </variablelist>
 235
 236   <variablelist>
 237
 238     <para><bridgehead>XML helper functions</bridgehead></para>
 239
 240     <varlistentry><term>document.newXmlDoc (root)</term>
 241     <listitem><para>create new XML document with root node as specified in parameter</para></listitem></varlistentry>
 242
 243     <varlistentry><term>document.parseXmlFromString (xmlString)</term>
 244     <listitem><para>create new XML document from string</para></listitem></varlistentry>
 245
 246     <varlistentry><term>document.transformToDoc (xmlDoc, xslDoc)</term>
 247     <listitem><para>returns new XML document as a result</para></listitem></varlistentry>
 248
 249     <varlistentry><term>Element_removeFromDoc (DOM_Element)</term>
 250     <listitem><para>remove element from the document</para></listitem></varlistentry>
 251
 252     <varlistentry><term>Element_emptyChildren (DOM_Element)</term></varlistentry>
 253
 254     <varlistentry><term>Element_appendTransformResult (DOM_Element, xmlDoc, xslDoc)</term>
 255     <listitem><para>append xsl transformation result to a DOM element</para></listitem></varlistentry>
 256
 257     <varlistentry><term>Element_appendTextNode (DOM_Element, tagName, textContent)</term>
 258     <listitem><para>append new text node to the element</para></listitem></varlistentry>
 259
 260     <varlistentry><term>Element_setTextContent (DOM_Element, textContent)</term>
 261     <listitem><para>set text content of the element</para></listitem></varlistentry>
 262
 263     <varlistentry><term>Element_getTextContent (DOM_Element)</term>
 264     <listitem><para>get text content of the element</para></listitem></varlistentry>
 265
 266     <varlistentry><term>Element_parseChildNodes (DOM_Element)</term>
 267     <listitem><para>parse all descendants into an associative array</para></listitem></varlistentry>
 268
 269   </variablelist>
 270
 271 </section>
 272
 273 <!-- Keep this comment at the end of the file
 274  Local variables:
 275  mode: sgml
 276  sgml-omittag:t
 277  sgml-shorttag:t
 278  sgml-minimize-attributes:nil
 279  sgml-always-quote-attributes:t
 280  sgml-indent-step:1
 281  sgml-indent-data:t
 282  sgml-parent-document: nil
 283  sgml-local-catalogs: nil
 284  sgml-namecase-general:t
 285  End:
 286  -->