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     // move it out
  46     var pager = document.getElementById("pager");
  47     pager.innerHTML = "";
  48     pager.innerHTML +='<hr/><div style="float: right">Displaying: '
  49                     + data.start + ' to ' + (data.start + data.num) +
  50                      ' of ' + data.merged + ' (found: '
  51                      + data.total + ')</div>';
  52     drawPager(pager);
  53     // navi
  54     var results = document.getElementById("results");
  55     results.innerHTML = "";
  56
  57     for (var i = 0; i < data.hits.length; i++) {
  58         var hit = data.hits[i];
  59         var html = '<div class="record" id="recdiv_'+hit.recid+'" >'
  60             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
  61             +'<a href="#" id="rec_'+hit.recid
  62             +'" onclick="showDetails(this.id);return false;"><b>'
  63             + hit["md-title"] +' </b></a>';
  64         if (hit["md-title-remainder"] !== undefined) {
  65             html += '<span>' + hit["md-title-remainder"] + ' </span>';
  66         }
  67         if (hit["md-title-responsibility"] !== undefined) {
  68             html += '<span><i>'+ hit["md-title-responsibility"] +'</i></span>';
  69         }
  70         html += '</div>';
  71         results.innerHTML += html;
  72         if (hit.recid == curDetRecId) {
  73             drawCurDetails();
  74         }
  75     }
  76 }
  77
  78 function my_onstat(data) {
  79     var stat = document.getElementById("stat");
  80     stat.innerHTML = '<b> .:STATUS INFO</b> -- Active clients: '
  81                         + data.activeclients
  82                         + '/' + data.clients + ' -- </span>'
  83                         + '<span>Retrieved records: ' + data.records
  84                         + '/' + data.hits + ' :.</span>';
  85 }
  86
  87 function my_onterm(data) {
  88     var termlist = document.getElementById("termlist");
  89     termlist.innerHTML = "<hr/><b>TERMLISTS:</b><hr/>";
  90
  91     termlist.innerHTML += '<div class="termtitle">.::Sources</div>';
  92     for (var i = 0; i < data.xtargets.length; i++ ) {
  93         termlist.innerHTML += '<a href="#" target_id='
  94             + data.xtargets[i].id
  95             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">'
  96                             + data.xtargets[i].name
  97                             + ' </a><span> ('
  98                             + data.xtargets[i].freq
  99                             + ')</span><br/>';
 100     }
 101
 102     termlist.innerHTML += "<hr/>";
 103
 104     termlist.innerHTML += '<div class="termtitle">.::Subjects</div>';
 105     for (var i = 0; i < data.subject.length; i++ ) {
 106         termlist.innerHTML += '<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">'
 107                             + data.subject[i].name
 108                             + '</a><span>  ('
 109                             + data.subject[i].freq
 110                             + ')</span><br/>';
 111     }
 112
 113     termlist.innerHTML += "<hr/>";
 114
 115     termlist.innerHTML += '<div class="termtitle">.::Authors</div>';
 116     for (var i = 0; i < data.author.length; i++ ) {
 117         termlist.innerHTML += '<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 118                             + data.author[i].name
 119                             + ' </a><span> ('
 120                             + data.author[i].freq
 121                             + ')</span><br/>';
 122     }
 123
 124 }
 125
 126 function my_onrecord(data) {
 127     // in case on_show was faster to redraw element
 128     var detRecordDiv = document.getElementById('det_'+data.recid);
 129     if ( detRecordDiv )
 130         return;
 131     curDetRecData = data;
 132     drawCurDetails();
 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
 324     // remove current detailed view if any
 325     var detRecordDiv = document.getElementById('det_'+curDetRecId);
 326     // lovin DOM!
 327     if ( detRecordDiv )
 328             detRecordDiv.parentNode.removeChild(detRecordDiv);
 329
 330     // if the same clicked do not redraw
 331     if ( recId == curDetRecId ) {
 332         curDetRecId = '';
 333         return;
 334     }
 335
 336     curDetRecId = recId;
 337     // request the record
 338     my_paz.record(recId);
 339 }
 340
 341 function drawCurDetails ()
 342 {
 343     var data = curDetRecData;
 344     var recordDiv = document.getElementById('recdiv_'+data.recid);
 345     var details = "";
 346     if (data["md-title"] != undefined)
 347         details += '<tr><td><b>Ttle</b></td><td><b>:</b> '+data["md-title"] + '</td></tr>';
 348     if (data["md-date"] != undefined)
 349         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 350     if (data["md-author"] != undefined)
 351         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 352     if (data["md-electronic-url"] != undefined)
 353         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>';
 354     if (data["location"][0]["md-subject"] != undefined)
 355         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 356     if (data["location"][0]["@name"] != undefined)
 357         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 358     recordDiv.innerHTML += '<div class="details" id="det_'+data.recid+'"><table>' + details + '</table></div>';
 359 }
 360  //EOF