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