www/jsdemo/example_client.js

   1 /* A very simple client that shows a basic usage of the pz2.js
   2 ** $Id: example_client.js,v 1.6 2008-01-15 13:59:18 jakub Exp $
   3 */
   4
   5 // create a parameters array and pass it to the pz2's constructor
   6 // then register the form submit event with the pz2.search function
   7 // autoInit is set to true on default
   8 var usesessions = true;
   9 var pazpar2path = '/pazpar2/search.pz2';
  10 if (document.location.hash == '#nosessions') {
  11     usesessions = false;
  12     pazpar2path = '/pazpar2-proxy/';
  13 }
  14
  15 my_paz = new pz2( { "onshow": my_onshow,
  16                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
  17                     "pazpar2path": pazpar2path,
  18                     "oninit": my_oninit,
  19                     "onstat": my_onstat,
  20                     "onterm": my_onterm,
  21                     "termlist": "xtargets,subject,author",
  22                     "onbytarget": my_onbytarget,
  23                     "usesessions" : usesessions,
  24                     "onrecord": my_onrecord } );
  25 // some state vars
  26 var curPage = 1;
  27 var recPerPage = 20;
  28 var totalRec = 0;
  29 var curDetRecId = '';
  30 var curDetRecData = null;
  31 var curSort = 'relevance';
  32 var curFilter = null;
  33 var submitted = false;
  34 var SourceMax = 16;
  35 var SubjectMax = 10;
  36 var AuthorMax = 10;
  37
  38 //
  39 // pz2.js event handlers:
  40 //
  41 function my_oninit() {
  42     my_paz.stat();
  43     my_paz.bytarget();
  44 }
  45
  46 function my_onshow(data) {
  47     totalRec = data.merged;
  48     // move it out
  49     var pager = document.getElementById("pager");
  50     pager.innerHTML = "";
  51     pager.innerHTML +='<hr/><div style="float: right">Displaying: '
  52                     + (data.start + 1) + ' to ' + (data.start + data.num) +
  53                      ' of ' + data.merged + ' (found: '
  54                      + data.total + ')</div>';
  55     drawPager(pager);
  56     // navi
  57     var results = document.getElementById("results");
  58
  59     var html = [];
  60     for (var i = 0; i < data.hits.length; i++) {
  61         var hit = data.hits[i];
  62               html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
  63             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
  64             +'<a href="#" id="rec_'+hit.recid
  65             +'" onclick="showDetails(this.id);return false;"><b>'
  66             + hit["md-title"] +' </b></a>');
  67               if (hit["md-title-remainder"] !== undefined) {
  68                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
  69               }
  70               if (hit["md-title-responsibility"] !== undefined) {
  71             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
  72         }
  73         if (hit.recid == curDetRecId) {
  74             html.push(renderDetails(curDetRecData));
  75         }
  76         html.push('</div>');
  77     }
  78     replaceHtml(results, html.join(''));
  79 }
  80
  81 function my_onstat(data) {
  82     var stat = document.getElementById("stat");
  83     if (stat == null)
  84         return;
  85
  86     stat.innerHTML = '<b> .:STATUS INFO</b> -- Active clients: '
  87                         + data.activeclients
  88                         + '/' + data.clients + ' -- </span>'
  89                         + '<span>Retrieved records: ' + data.records
  90                         + '/' + data.hits + ' :.</span>';
  91 }
  92
  93 function my_onterm(data) {
  94     var termlists = [];
  95     termlists.push('<hr/><b>TERMLISTS:</b><hr/><div class="termtitle">.::Sources</div>');
  96     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
  97         termlists.push('<a href="#" target_id='+data.xtargets[i].id
  98             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
  99         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
 100     }
 101
 102     termlists.push('<hr/><div class="termtitle">.::Subjects</div>');
 103     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
 104         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
 105               + data.subject[i].freq + ')</span><br/>');
 106     }
 107
 108     termlists.push('<hr/><div class="termtitle">.::Authors</div>');
 109     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
 110         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 111                             + data.author[i].name
 112                             + ' </a><span> ('
 113                             + data.author[i].freq
 114                             + ')</span><br/>');
 115     }
 116     var termlist = document.getElementById("termlist");
 117     replaceHtml(termlist, termlists.join(''));
 118 }
 119
 120 function my_onrecord(data) {
 121     // FIXME: record is async!!
 122     clearTimeout(my_paz.recordTimer);
 123     // in case on_show was faster to redraw element
 124     var detRecordDiv = document.getElementById('det_'+data.recid);
 125     if (detRecordDiv) return;
 126     curDetRecData = data;
 127     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
 128     var html = renderDetails(curDetRecData);
 129     recordDiv.innerHTML += html;
 130 }
 131
 132 function my_onbytarget(data) {
 133     var targetDiv = document.getElementById("bytarget");
 134     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
 135         +'<td>Records</td><td>State</td></tr></thead><tbody>';
 136
 137     for (var i = 0; i < data.length; i++ ) {
 138         table += "<tr><td>" + data[i].id +
 139             "</td><td>" + data[i].hits +
 140             "</td><td>" + data[i].diagnostic +
 141             "</td><td>" + data[i].records +
 142             "</td><td>" + data[i].state + "</td></tr>";
 143     }
 144
 145     table += '</tbody></table>';
 146     targetDiv.innerHTML = table;
 147 }
 148
 149 ////////////////////////////////////////////////////////////////////////////////
 150 ////////////////////////////////////////////////////////////////////////////////
 151
 152 // wait until the DOM is ready
 153 function domReady ()
 154 {
 155     document.search.onsubmit = onFormSubmitEventHandler;
 156     document.search.query.value = '';
 157     document.select.sort.onchange = onSelectDdChange;
 158     document.select.perpage.onchange = onSelectDdChange;
 159 }
 160
 161 // when search button pressed
 162 function onFormSubmitEventHandler()
 163 {
 164     resetPage();
 165     loadSelect();
 166     triggerSearch();
 167     submitted = true;
 168     return false;
 169 }
 170
 171 function onSelectDdChange()
 172 {
 173     if (!submitted) return false;
 174     resetPage();
 175     loadSelect();
 176     my_paz.show(0, recPerPage, curSort);
 177     return false;
 178 }
 179
 180 function resetPage()
 181 {
 182     curPage = 1;
 183     totalRec = 0;
 184 }
 185
 186 function triggerSearch ()
 187 {
 188     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
 189 }
 190
 191 function loadSelect ()
 192 {
 193     curSort = document.select.sort.value;
 194     recPerPage = document.select.perpage.value;
 195 }
 196
 197 // limit the query after clicking the facet
 198 function limitQuery (field, value)
 199 {
 200     document.search.query.value += ' and ' + field + '="' + value + '"';
 201     onFormSubmitEventHandler();
 202 }
 203
 204 // limit by target functions
 205 function limitTarget (id, name)
 206 {
 207     var navi = document.getElementById('navi');
 208     navi.innerHTML =
 209         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
 210         + name + '</a>';
 211     navi.innerHTML += '<hr/>';
 212     curFilter = 'pz:id=' + id;
 213     resetPage();
 214     loadSelect();
 215     triggerSearch();
 216     return false;
 217 }
 218
 219 function delimitTarget ()
 220 {
 221     var navi = document.getElementById('navi');
 222     navi.innerHTML = '';
 223     curFilter = null;
 224     resetPage();
 225     loadSelect();
 226     triggerSearch();
 227     return false;
 228 }
 229
 230 function drawPager (pagerDiv)
 231 {
 232     //client indexes pages from 1 but pz2 from 0
 233     var onsides = 6;
 234     var pages = Math.ceil(totalRec / recPerPage);
 235
 236     var firstClkbl = ( curPage - onsides > 0 )
 237         ? curPage - onsides
 238         : 1;
 239
 240     var lastClkbl = firstClkbl + 2*onsides < pages
 241         ? firstClkbl + 2*onsides
 242         : pages;
 243
 244     var prev = '<span id="prev">&#60;&#60; Prev</span><b> | </b>';
 245     if (curPage > 1)
 246         var prev = '<a href="#" id="prev" onclick="pagerPrev();">'
 247         +'&#60;&#60; Prev</a><b> | </b>';
 248
 249     var middle = '';
 250     for(var i = firstClkbl; i <= lastClkbl; i++) {
 251         var numLabel = i;
 252         if(i == curPage)
 253             numLabel = '<b>' + i + '</b>';
 254
 255         middle += '<a href="#" onclick="showPage(' + i + ')"> '
 256             + numLabel + ' </a>';
 257     }
 258
 259     var next = '<b> | </b><span id="next">Next &#62;&#62;</span>';
 260     if (pages - curPage > 0)
 261     var next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 262         +'Next &#62;&#62;</a>';
 263
 264     predots = '';
 265     if (firstClkbl > 1)
 266         predots = '...';
 267
 268     postdots = '';
 269     if (lastClkbl < pages)
 270         postdots = '...';
 271
 272     pagerDiv.innerHTML += '<div style="float: clear">'
 273         + prev + predots + middle + postdots + next + '</div><hr/>';
 274 }
 275
 276 function showPage (pageNum)
 277 {
 278     curPage = pageNum;
 279     my_paz.showPage( curPage - 1 );
 280 }
 281
 282 // simple paging functions
 283
 284 function pagerNext() {
 285     if ( totalRec - recPerPage*curPage > 0) {
 286         my_paz.showNext();
 287         curPage++;
 288     }
 289 }
 290
 291 function pagerPrev() {
 292     if ( my_paz.showPrev() != false )
 293         curPage--;
 294 }
 295
 296 // swithing view between targets and records
 297
 298 function switchView(view) {
 299
 300     var targets = document.getElementById('targetview');
 301     var records = document.getElementById('recordview');
 302
 303     switch(view) {
 304         case 'targetview':
 305             targets.style.display = "block";
 306             records.style.display = "none";
 307             break;
 308         case 'recordview':
 309             targets.style.display = "none";
 310             records.style.display = "block";
 311             break;
 312         default:
 313             alert('Unknown view.');
 314     }
 315 }
 316
 317 // detailed record drawing
 318 function showDetails (prefixRecId) {
 319     var recId = prefixRecId.replace('rec_', '');
 320     var oldRecId = curDetRecId;
 321     curDetRecId = recId;
 322
 323     // remove current detailed view if any
 324     var detRecordDiv = document.getElementById('det_'+oldRecId);
 325     // lovin DOM!
 326     if (detRecordDiv)
 327       detRecordDiv.parentNode.removeChild(detRecordDiv);
 328
 329     // if the same clicked, just hide
 330     if (recId == oldRecId) {
 331         curDetRecId = '';
 332         curDetRecData = null;
 333         return;
 334     }
 335     // request the record
 336     my_paz.record(recId);
 337 }
 338
 339 function replaceHtml(el, html) {
 340   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 341   /*@cc_on // Pure innerHTML is slightly faster in IE
 342     oldEl.innerHTML = html;
 343     return oldEl;
 344     @*/
 345   var newEl = oldEl.cloneNode(false);
 346   newEl.innerHTML = html;
 347   oldEl.parentNode.replaceChild(newEl, oldEl);
 348   /* Since we just removed the old element from the DOM, return a reference
 349      to the new element, which can be used to restore variable references. */
 350   return newEl;
 351 };
 352
 353 function renderDetails(data, marker)
 354 {
 355     var details = '<div class="details" id="det_'+data.recid+'"><table>';
 356     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
 357     if (data["md-title"] != undefined) {
 358         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
 359         if (data["md-title-remainder"] !== undefined) {
 360               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
 361         }
 362         if (data["md-title-responsibility"] !== undefined) {
 363               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
 364         }
 365           details += '</td></tr>';
 366     }
 367     if (data["md-date"] != undefined)
 368         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 369     if (data["md-author"] != undefined)
 370         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 371     if (data["md-electronic-url"] != undefined)
 372         details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '" target="_blank">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
 373     if (data["location"][0]["md-subject"] != undefined)
 374         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 375     if (data["location"][0]["@name"] != undefined)
 376         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 377     details += '</table></div>';
 378     return details;
 379 }
 380  //EOF