experiments/spclient/example_client.js

   1 /* A very simple client that shows a basic usage of the pz2.js
   2 */
   3
   4 // create a parameters array and pass it to the pz2's constructor
   5 // then register the form submit event with the pz2.search function
   6 // autoInit is set to true on default
   7 var usesessions = useServiceProxy ? false : true;
   8 var pazpar2path = useServiceProxy ? '/service-proxy/' : '/pazpar2/search.pz2';
   9 var authURLServiceProxy = "/service-proxy-auth";
  10 var showResponseType = '';
  11 if (document.location.hash == '#useproxy') {
  12     usesessions = false;
  13     pazpar2path = '/service-proxy/';
  14     showResponseType = 'json';
  15 }
  16
  17 var 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
  94                         + ' -- by '
  95                         + (useServiceProxy ? 'service proxy' : 'pazpar2')
  96                         + ' :.</span>';
  97 }
  98
  99 function my_onterm(data) {
 100     var termlists = [];
 101     termlists.push('<hr/><b>TERMLISTS:</b><hr/><div class="termtitle">.::Sources</div>');
 102     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
 103         termlists.push('<a href="#" target_id='+data.xtargets[i].id
 104             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
 105         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
 106     }
 107
 108     termlists.push('<hr/><div class="termtitle">.::Subjects</div>');
 109     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
 110         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
 111               + data.subject[i].freq + ')</span><br/>');
 112     }
 113
 114     termlists.push('<hr/><div class="termtitle">.::Authors</div>');
 115     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
 116         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 117                             + data.author[i].name
 118                             + ' </a><span> ('
 119                             + data.author[i].freq
 120                             + ')</span><br/>');
 121     }
 122     var termlist = document.getElementById("termlist");
 123     replaceHtml(termlist, termlists.join(''));
 124 }
 125
 126 function my_onrecord(data) {
 127     // FIXME: record is async!!
 128     clearTimeout(my_paz.recordTimer);
 129     // in case on_show was faster to redraw element
 130     var detRecordDiv = document.getElementById('det_'+data.recid);
 131     if (detRecordDiv) return;
 132     curDetRecData = data;
 133     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
 134     var html = renderDetails(curDetRecData);
 135     recordDiv.innerHTML += html;
 136 }
 137
 138 function my_onbytarget(data) {
 139     var targetDiv = document.getElementById("bytarget");
 140     var table ='<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></table>';
 152     targetDiv.innerHTML = table;
 153 }
 154
 155 ////////////////////////////////////////////////////////////////////////////////
 156 ////////////////////////////////////////////////////////////////////////////////
 157
 158 // wait until the DOM is ready
 159 function domReady ()
 160 {
 161     document.search.onsubmit = onFormSubmitEventHandler;
 162     document.search.query.value = '';
 163     document.select.sort.onchange = onSelectDdChange;
 164     document.select.perpage.onchange = onSelectDdChange;
 165 }
 166
 167 // when search button pressed
 168 function onFormSubmitEventHandler()
 169 {
 170     resetPage();
 171     loadSelect();
 172     triggerSearch();
 173     submitted = true;
 174     return false;
 175 }
 176
 177 function onSelectDdChange()
 178 {
 179     if (!submitted) return false;
 180     resetPage();
 181     loadSelect();
 182     my_paz.show(0, recPerPage, curSort);
 183     return false;
 184 }
 185
 186 function resetPage()
 187 {
 188     curPage = 1;
 189     totalRec = 0;
 190 }
 191
 192 function triggerSearch ()
 193 {
 194     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
 195 }
 196
 197 function loadSelect ()
 198 {
 199     curSort = document.select.sort.value;
 200     recPerPage = document.select.perpage.value;
 201 }
 202
 203 // limit the query after clicking the facet
 204 function limitQuery (field, value)
 205 {
 206     document.search.query.value += ' and ' + field + '="' + value + '"';
 207     onFormSubmitEventHandler();
 208 }
 209
 210 // limit by target functions
 211 function limitTarget (id, name)
 212 {
 213     var navi = document.getElementById('navi');
 214     navi.innerHTML =
 215         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
 216         + name + '</a>';
 217     navi.innerHTML += '<hr/>';
 218     curFilter = 'pz:id=' + id;
 219     resetPage();
 220     loadSelect();
 221     triggerSearch();
 222     return false;
 223 }
 224
 225 function delimitTarget ()
 226 {
 227     var navi = document.getElementById('navi');
 228     navi.innerHTML = '';
 229     curFilter = null;
 230     resetPage();
 231     loadSelect();
 232     triggerSearch();
 233     return false;
 234 }
 235
 236 function drawPager (pagerDiv)
 237 {
 238     //client indexes pages from 1 but pz2 from 0
 239     var onsides = 6;
 240     var pages = Math.ceil(totalRec / recPerPage);
 241
 242     var firstClkbl = ( curPage - onsides > 0 )
 243         ? curPage - onsides
 244         : 1;
 245
 246     var lastClkbl = firstClkbl + 2*onsides < pages
 247         ? firstClkbl + 2*onsides
 248         : pages;
 249
 250     var prev = '<span id="prev">&#60;&#60; Prev</span><b> | </b>';
 251     if (curPage > 1)
 252         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
 253         +'&#60;&#60; Prev</a><b> | </b>';
 254
 255     var middle = '';
 256     for(var i = firstClkbl; i <= lastClkbl; i++) {
 257         var numLabel = i;
 258         if(i == curPage)
 259             numLabel = '<b>' + i + '</b>';
 260
 261         middle += '<a href="#" onclick="showPage(' + i + ')"> '
 262             + numLabel + ' </a>';
 263     }
 264
 265     var next = '<b> | </b><span id="next">Next &#62;&#62;</span>';
 266     if (pages - curPage > 0)
 267         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 268         +'Next &#62;&#62;</a>';
 269
 270     var predots = '';
 271     if (firstClkbl > 1)
 272         predots = '...';
 273
 274     var postdots = '';
 275     if (lastClkbl < pages)
 276         postdots = '...';
 277
 278     pagerDiv.innerHTML += '<div style="float: clear">'
 279         + prev + predots + middle + postdots + next + '</div><hr/>';
 280 }
 281
 282 function showPage (pageNum)
 283 {
 284     curPage = pageNum;
 285     my_paz.showPage( curPage - 1 );
 286 }
 287
 288 // simple paging functions
 289
 290 function pagerNext() {
 291     if ( totalRec - recPerPage*curPage > 0) {
 292         my_paz.showNext();
 293         curPage++;
 294     }
 295 }
 296
 297 function pagerPrev() {
 298     if ( my_paz.showPrev() != false )
 299         curPage--;
 300 }
 301
 302 // swithing view between targets and records
 303
 304 function switchView(view) {
 305
 306     var targets = document.getElementById('targetview');
 307     var records = document.getElementById('recordview');
 308
 309     switch(view) {
 310         case 'targetview':
 311             targets.style.display = "block";
 312             records.style.display = "none";
 313             break;
 314         case 'recordview':
 315             targets.style.display = "none";
 316             records.style.display = "block";
 317             break;
 318         default:
 319             alert('Unknown view.');
 320     }
 321 }
 322
 323 // detailed record drawing
 324 function showDetails (prefixRecId) {
 325     var recId = prefixRecId.replace('rec_', '');
 326     var oldRecId = curDetRecId;
 327     curDetRecId = recId;
 328
 329     // remove current detailed view if any
 330     var detRecordDiv = document.getElementById('det_'+oldRecId);
 331     // lovin DOM!
 332     if (detRecordDiv)
 333       detRecordDiv.parentNode.removeChild(detRecordDiv);
 334
 335     // if the same clicked, just hide
 336     if (recId == oldRecId) {
 337         curDetRecId = '';
 338         curDetRecData = null;
 339         return;
 340     }
 341     // request the record
 342     my_paz.record(recId);
 343 }
 344
 345 function replaceHtml(el, html) {
 346   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 347   /*@cc_on // Pure innerHTML is slightly faster in IE
 348     oldEl.innerHTML = html;
 349     return oldEl;
 350     @*/
 351   var newEl = oldEl.cloneNode(false);
 352   newEl.innerHTML = html;
 353   oldEl.parentNode.replaceChild(newEl, oldEl);
 354   /* Since we just removed the old element from the DOM, return a reference
 355      to the new element, which can be used to restore variable references. */
 356   return newEl;
 357 };
 358
 359 function renderDetails(data, marker)
 360 {
 361     var details = '<div class="details" id="det_'+data.recid+'"><table>';
 362     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
 363     if (data["md-title"] != undefined) {
 364         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
 365         if (data["md-title-remainder"] !== undefined) {
 366               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
 367         }
 368         if (data["md-title-responsibility"] !== undefined) {
 369               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
 370         }
 371           details += '</td></tr>';
 372     }
 373     if (data["md-date"] != undefined)
 374         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 375     if (data["md-author"] != undefined)
 376         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 377     if (data["md-electronic-url"] != undefined)
 378         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>';
 379     if (data["location"][0]["md-subject"] != undefined)
 380         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 381     if (data["location"][0]["@name"] != undefined)
 382         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 383     details += '</table></div>';
 384     return details;
 385 }
 386  //EOF