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