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