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
  35 //
  36 // pz2.js event handlers:
  37 //
  38 function my_oninit() {
  39     my_paz.stat();
  40     my_paz.bytarget();
  41 }
  42
  43 function my_onshow(data) {
  44     totalRec = data.merged;
  45
  46     // move it out
  47     var pager = document.getElementById("pager");
  48     pager.innerHTML = "";
  49
  50     pager.innerHTML +='<hr/><div style="float: right">Displaying: '
  51                     + data.start + ' to ' + (data.start + data.num) +
  52                      ' of ' + data.merged + ' (found: '
  53                      + data.total + ')</div>';
  54     drawPager(pager);
  55
  56     // navi
  57     var results = document.getElementById("results");
  58     results.innerHTML = "";
  59
  60     for (var i = 0; i < data.hits.length; i++) {
  61         var hit = data.hits[i];
  62         var html = '<div class="record" id="rec_' + hit.recid + '" onclick="showDetails(this.id)">'
  63                     +'<span>' + (i + 1 + recPerPage * ( curPage - 1)) + '. </span>'
  64                     +'<a href="#"><b>' + hit["md-title"] +
  65                     ' </b></a>';
  66         if (hit["md-title-remainder"] !== undefined) {
  67             html += '<span>' + hit["md-title-remainder"] + '</span>';
  68         }
  69         if (hit["md-title-responsibility"] !== undefined) {
  70             html += '<span><i>' + hit["md-title-responsibility"] + '</i></span>';
  71         }
  72         html += '</div>';
  73         results.innerHTML += html;
  74         if ( hit.recid == curDetRecId ) {
  75             drawCurDetails();
  76         }
  77     }
  78
  79 }
  80
  81 function my_onstat(data) {
  82     var stat = document.getElementById("stat");
  83     stat.innerHTML = '<b> .:STATUS INFO</b> -- Active clients: '
  84                         + data.activeclients
  85                         + '/' + data.clients + ' -- </span>'
  86                         + '<span>Retrieved records: ' + data.records
  87                         + '/' + data.hits + ' :.</span>';
  88 }
  89
  90 function my_onterm(data) {
  91     var termlist = document.getElementById("termlist");
  92     termlist.innerHTML = "<hr/><b>TERMLISTS:</b><hr/>";
  93
  94     termlist.innerHTML += '<div class="termtitle">.::Sources</div>';
  95     for (var i = 0; i < data.xtargets.length; i++ ) {
  96         termlist.innerHTML += '<a href="#" target_id='
  97             + data.xtargets[i].id
  98             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue)">'
  99                             + data.xtargets[i].name
 100                             + ' </a><span> ('
 101                             + data.xtargets[i].freq
 102                             + ')</span><br/>';
 103     }
 104
 105     termlist.innerHTML += "<hr/>";
 106
 107     termlist.innerHTML += '<div class="termtitle">.::Subjects</div>';
 108     for (var i = 0; i < data.subject.length; i++ ) {
 109         termlist.innerHTML += '<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue)">'
 110                             + data.subject[i].name
 111                             + '</a><span>  ('
 112                             + data.subject[i].freq
 113                             + ')</span><br/>';
 114     }
 115
 116     termlist.innerHTML += "<hr/>";
 117
 118     termlist.innerHTML += '<div class="termtitle">.::Authors</div>';
 119     for (var i = 0; i < data.author.length; i++ ) {
 120         termlist.innerHTML += '<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue)">'
 121                             + data.author[i].name
 122                             + ' </a><span> ('
 123                             + data.author[i].freq
 124                             + ')</span><br/>';
 125     }
 126
 127 }
 128
 129 function my_onrecord(data) {
 130     // in case on_show was faster to redraw element
 131     var detRecordDiv = document.getElementById('det_'+data.recid);
 132     if ( detRecordDiv )
 133         return;
 134
 135     curDetRecData = data;
 136     drawCurDetails();
 137 }
 138
 139 function my_onbytarget(data) {
 140     var targetDiv = document.getElementById("bytarget");
 141     var table = '<thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
 142                          +'<td>Records</td><td>State</td></tr></thead><tbody>';
 143
 144     for (var i = 0; i < data.length; i++ ) {
 145         table += "<tr><td>" + data[i].id +
 146                     "</td><td>" + data[i].hits +
 147                     "</td><td>" + data[i].diagnostic +
 148                     "</td><td>" + data[i].records +
 149                     "</td><td>" + data[i].state + "</td></tr>";
 150     }
 151
 152     table += '</tbody>';
 153     targetDiv.innerHTML = table;
 154
 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()">'
 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         var 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     var next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 270         +'Next &#62;&#62;</a>';
 271
 272     predots = '';
 273     if (firstClkbl > 1)
 274         predots = '...';
 275
 276     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
 329     // remove current detailed view if any
 330     var detRecordDiv = document.getElementById('det_'+curDetRecId);
 331     // lovin DOM!
 332     if ( detRecordDiv )
 333             detRecordDiv.parentNode.removeChild(detRecordDiv);
 334
 335     // if the same clicked do not redraw
 336     if ( recId == curDetRecId ) {
 337         curDetRecId = '';
 338         return;
 339     }
 340
 341     curDetRecId = recId;
 342
 343     // request the record
 344     my_paz.record(recId);
 345 }
 346
 347 function drawCurDetails ()
 348 {
 349     var data = curDetRecData;
 350     var recordDiv = document.getElementById('rec_'+data.recid);
 351     var details = "";
 352     if (data["md-title"] != undefined)
 353         details += '<tr><td><b>Ttle</b></td><td><b>:</b> '+data["md-title"] + '</td></tr>';
 354     if (data["md-date"] != undefined)
 355         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 356     if (data["md-author"] != undefined)
 357         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 358     if (data["md-electronic-url"] != undefined)
 359         details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
 360     if (data["location"][0]["md-subject"] != undefined)
 361         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 362     if (data["location"][0]["@name"] != undefined)
 363         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 364     recordDiv.innerHTML += '<div class="details" id="det_'+data.recid+'"><table>' + details + '</table></div>';
 365 }
 366  //EOF