experiments/spdemo/example_client.js

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