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