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