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 + ' :.</span>';
 102 }
 103
 104 function my_onterm(data) {
 105     var termlists = [];
 106     termlists.push('<hr/><b>TERMLISTS:</b><hr/><div class="termtitle">.::Sources</div>');
 107     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
 108         termlists.push('<a href="#" target_id='+data.xtargets[i].id
 109             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
 110         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
 111     }
 112
 113     termlists.push('<hr/><div class="termtitle">.::Subjects</div>');
 114     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
 115         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
 116               + data.subject[i].freq + ')</span><br/>');
 117     }
 118
 119     termlists.push('<hr/><div class="termtitle">.::Authors</div>');
 120     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
 121         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 122                             + data.author[i].name
 123                             + ' </a><span> ('
 124                             + data.author[i].freq
 125                             + ')</span><br/>');
 126     }
 127     var termlist = document.getElementById("termlist");
 128     replaceHtml(termlist, termlists.join(''));
 129 }
 130
 131 function my_onrecord(data) {
 132     // FIXME: record is async!!
 133     clearTimeout(my_paz.recordTimer);
 134     // in case on_show was faster to redraw element
 135     var detRecordDiv = document.getElementById('det_'+data.recid);
 136     if (detRecordDiv) return;
 137     curDetRecData = data;
 138     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
 139     var html = renderDetails(curDetRecData);
 140     recordDiv.innerHTML += html;
 141 }
 142
 143 function my_onbytarget(data) {
 144     var targetDiv = document.getElementById("bytarget");
 145     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
 146         +'<td>Records</td><td>State</td></tr></thead><tbody>';
 147
 148     for (var i = 0; i < data.length; i++ ) {
 149         table += "<tr><td>" + data[i].id +
 150             "</td><td>" + data[i].hits +
 151             "</td><td>" + data[i].diagnostic +
 152             "</td><td>" + data[i].records +
 153             "</td><td>" + data[i].state + "</td></tr>";
 154     }
 155
 156     table += '</tbody></table>';
 157     targetDiv.innerHTML = table;
 158 }
 159
 160 ////////////////////////////////////////////////////////////////////////////////
 161 ////////////////////////////////////////////////////////////////////////////////
 162
 163 // wait until the DOM is ready
 164 function domReady ()
 165 {
 166     document.search.onsubmit = onFormSubmitEventHandler;
 167     document.search.query.value = '';
 168     document.select.sort.onchange = onSelectDdChange;
 169     document.select.perpage.onchange = onSelectDdChange;
 170 }
 171
 172 // when search button pressed
 173 function onFormSubmitEventHandler()
 174 {
 175     resetPage();
 176     loadSelect();
 177     triggerSearch();
 178     submitted = true;
 179     return false;
 180 }
 181
 182 function onSelectDdChange()
 183 {
 184     if (!submitted) return false;
 185     resetPage();
 186     loadSelect();
 187     my_paz.show(0, recPerPage, curSort);
 188     return false;
 189 }
 190
 191 function resetPage()
 192 {
 193     curPage = 1;
 194     totalRec = 0;
 195 }
 196
 197 function triggerSearch ()
 198 {
 199     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
 200 }
 201
 202 function loadSelect ()
 203 {
 204     curSort = document.select.sort.value;
 205     recPerPage = document.select.perpage.value;
 206 }
 207
 208 // limit the query after clicking the facet
 209 function limitQuery (field, value)
 210 {
 211     document.search.query.value += ' and ' + field + '="' + value + '"';
 212     onFormSubmitEventHandler();
 213 }
 214
 215 // limit by target functions
 216 function limitTarget (id, name)
 217 {
 218     var navi = document.getElementById('navi');
 219     navi.innerHTML =
 220         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
 221         + name + '</a>';
 222     navi.innerHTML += '<hr/>';
 223     curFilter = 'pz:id=' + id;
 224     resetPage();
 225     loadSelect();
 226     triggerSearch();
 227     return false;
 228 }
 229
 230 function delimitTarget ()
 231 {
 232     var navi = document.getElementById('navi');
 233     navi.innerHTML = '';
 234     curFilter = null;
 235     resetPage();
 236     loadSelect();
 237     triggerSearch();
 238     return false;
 239 }
 240
 241 function drawPager (pagerDiv)
 242 {
 243     //client indexes pages from 1 but pz2 from 0
 244     var onsides = 6;
 245     var pages = Math.ceil(totalRec / recPerPage);
 246
 247     var firstClkbl = ( curPage - onsides > 0 )
 248         ? curPage - onsides
 249         : 1;
 250
 251     var lastClkbl = firstClkbl + 2*onsides < pages
 252         ? firstClkbl + 2*onsides
 253         : pages;
 254
 255     var prev = '<span id="prev">&#60;&#60; Prev</span><b> | </b>';
 256     if (curPage > 1)
 257         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
 258         +'&#60;&#60; Prev</a><b> | </b>';
 259
 260     var middle = '';
 261     for(var i = firstClkbl; i <= lastClkbl; i++) {
 262         var numLabel = i;
 263         if(i == curPage)
 264             numLabel = '<b>' + i + '</b>';
 265
 266         middle += '<a href="#" onclick="showPage(' + i + ')"> '
 267             + numLabel + ' </a>';
 268     }
 269
 270     var next = '<b> | </b><span id="next">Next &#62;&#62;</span>';
 271     if (pages - curPage > 0)
 272         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 273         +'Next &#62;&#62;</a>';
 274
 275     var predots = '';
 276     if (firstClkbl > 1)
 277         predots = '...';
 278
 279     var postdots = '';
 280     if (lastClkbl < pages)
 281         postdots = '...';
 282
 283     pagerDiv.innerHTML += '<div style="float: clear">'
 284         + prev + predots + middle + postdots + next + '</div><hr/>';
 285 }
 286
 287 function showPage (pageNum)
 288 {
 289     curPage = pageNum;
 290     my_paz.showPage( curPage - 1 );
 291 }
 292
 293 // simple paging functions
 294
 295 function pagerNext() {
 296     if ( totalRec - recPerPage*curPage > 0) {
 297         my_paz.showNext();
 298         curPage++;
 299     }
 300 }
 301
 302 function pagerPrev() {
 303     if ( my_paz.showPrev() != false )
 304         curPage--;
 305 }
 306
 307 // swithing view between targets and records
 308
 309 function switchView(view) {
 310
 311     var targets = document.getElementById('targetview');
 312     var records = document.getElementById('recordview');
 313
 314     switch(view) {
 315         case 'targetview':
 316             targets.style.display = "block";
 317             records.style.display = "none";
 318             break;
 319         case 'recordview':
 320             targets.style.display = "none";
 321             records.style.display = "block";
 322             break;
 323         default:
 324             alert('Unknown view.');
 325     }
 326 }
 327
 328 // detailed record drawing
 329 function showDetails (prefixRecId) {
 330     var recId = prefixRecId.replace('rec_', '');
 331     var oldRecId = curDetRecId;
 332     curDetRecId = recId;
 333
 334     // remove current detailed view if any
 335     var detRecordDiv = document.getElementById('det_'+oldRecId);
 336     // lovin DOM!
 337     if (detRecordDiv)
 338       detRecordDiv.parentNode.removeChild(detRecordDiv);
 339
 340     // if the same clicked, just hide
 341     if (recId == oldRecId) {
 342         curDetRecId = '';
 343         curDetRecData = null;
 344         return;
 345     }
 346     // request the record
 347     my_paz.record(recId);
 348 }
 349
 350 function replaceHtml(el, html) {
 351   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 352   /*@cc_on // Pure innerHTML is slightly faster in IE
 353     oldEl.innerHTML = html;
 354     return oldEl;
 355     @*/
 356   var newEl = oldEl.cloneNode(false);
 357   newEl.innerHTML = html;
 358   oldEl.parentNode.replaceChild(newEl, oldEl);
 359   /* Since we just removed the old element from the DOM, return a reference
 360      to the new element, which can be used to restore variable references. */
 361   return newEl;
 362 };
 363
 364 function renderDetails(data, marker)
 365 {
 366     var details = '<div class="details" id="det_'+data.recid+'"><table>';
 367     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
 368     if (data["md-title"] != undefined) {
 369         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
 370         if (data["md-title-remainder"] !== undefined) {
 371               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
 372         }
 373         if (data["md-title-responsibility"] !== undefined) {
 374               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
 375         }
 376           details += '</td></tr>';
 377     }
 378     if (data["md-date"] != undefined)
 379         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 380     if (data["md-author"] != undefined)
 381         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 382     if (data["md-electronic-url"] != undefined)
 383         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>';
 384     if (data["location"][0]["md-subject"] != undefined)
 385         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 386     if (data["location"][0]["@name"] != undefined)
 387         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 388     details += '</table></div>';
 389     return details;
 390 }
 391  //EOF