experiments/spdemo/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 = true;
   8 var pazpar2path = '/pazpar2/search.pz2';
   9 var showResponseType = '';
  10 if (document.location.hash == '#useproxy') {
  11     usesessions = false;
  12     pazpar2path = '/service-proxy/';
  13     showResponseType = 'json';
  14 }
  15
  16 var my_paz = new pz2( { "onshow": my_onshow,
  17                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
  18                     "pazpar2path": pazpar2path,
  19                     "oninit": my_oninit,
  20                     "onstat": my_onstat,
  21                     "onterm": my_onterm,
  22                     "termlist": "xtargets,subject,author",
  23                     "onbytarget": my_onbytarget,
  24                     "usesessions" : usesessions,
  25                     "showResponseType": showResponseType,
  26                     "onrecord": my_onrecord } );
  27 // some state vars
  28 var curPage = 1;
  29 var recPerPage = 20;
  30 var totalRec = 0;
  31 var curDetRecId = '';
  32 var curDetRecData = null;
  33 var curSort = 'relevance';
  34 var curFilter = null;
  35 var submitted = false;
  36 var SourceMax = 16;
  37 var SubjectMax = 10;
  38 var AuthorMax = 10;
  39
  40 //
  41 // pz2.js event handlers:
  42 //
  43 function my_oninit() {
  44     my_paz.stat();
  45     my_paz.bytarget();
  46 }
  47
  48 function my_onshow(data) {
  49     totalRec = data.merged;
  50     // move it out
  51     var pager = document.getElementById("pager");
  52     pager.innerHTML = "";
  53     pager.innerHTML +='<hr/><div style="float: right">Displaying: '
  54                     + (data.start + 1) + ' to ' + (data.start + data.num) +
  55                      ' of ' + data.merged + ' (found: '
  56                      + data.total + ')</div>';
  57     drawPager(pager);
  58     // navi
  59     var results = document.getElementById("results");
  60
  61     var html = [];
  62     for (var i = 0; i < data.hits.length; i++) {
  63         var hit = data.hits[i];
  64               html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
  65             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
  66             +'<a href="#" id="rec_'+hit.recid
  67             +'" onclick="showDetails(this.id);return false;"><b>'
  68             + hit["md-title"] +' </b></a>');
  69               if (hit["md-title-remainder"] !== undefined) {
  70                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
  71               }
  72               if (hit["md-title-responsibility"] !== undefined) {
  73             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
  74         }
  75         if (hit.recid == curDetRecId) {
  76             html.push(renderDetails(curDetRecData));
  77         }
  78         html.push('</div>');
  79     }
  80     replaceHtml(results, html.join(''));
  81 }
  82
  83 function my_onstat(data) {
  84     var stat = document.getElementById("stat");
  85     if (stat == null)
  86         return;
  87
  88     stat.innerHTML = '<b> .:STATUS INFO</b> -- Active clients: '
  89                         + data.activeclients
  90                         + '/' + data.clients + ' -- </span>'
  91                         + '<span>Retrieved records: ' + data.records
  92                         + '/' + data.hits + ' :.</span>';
  93 }
  94
  95 function my_onterm(data) {
  96     var termlists = [];
  97     termlists.push('<hr/><b>TERMLISTS:</b><hr/><div class="termtitle">.::Sources</div>');
  98     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
  99         termlists.push('<a href="#" target_id='+data.xtargets[i].id
 100             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
 101         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
 102     }
 103
 104     termlists.push('<hr/><div class="termtitle">.::Subjects</div>');
 105     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
 106         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
 107               + data.subject[i].freq + ')</span><br/>');
 108     }
 109
 110     termlists.push('<hr/><div class="termtitle">.::Authors</div>');
 111     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
 112         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 113                             + data.author[i].name
 114                             + ' </a><span> ('
 115                             + data.author[i].freq
 116                             + ')</span><br/>');
 117     }
 118     var termlist = document.getElementById("termlist");
 119     replaceHtml(termlist, termlists.join(''));
 120 }
 121
 122 function my_onrecord(data) {
 123     // FIXME: record is async!!
 124     clearTimeout(my_paz.recordTimer);
 125     // in case on_show was faster to redraw element
 126     var detRecordDiv = document.getElementById('det_'+data.recid);
 127     if (detRecordDiv) return;
 128     curDetRecData = data;
 129     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
 130     var html = renderDetails(curDetRecData);
 131     recordDiv.innerHTML += html;
 132 }
 133
 134 function my_onbytarget(data) {
 135     var targetDiv = document.getElementById("bytarget");
 136     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
 137         +'<td>Records</td><td>State</td></tr></thead><tbody>';
 138
 139     for (var i = 0; i < data.length; i++ ) {
 140         table += "<tr><td>" + data[i].id +
 141             "</td><td>" + data[i].hits +
 142             "</td><td>" + data[i].diagnostic +
 143             "</td><td>" + data[i].records +
 144             "</td><td>" + data[i].state + "</td></tr>";
 145     }
 146
 147     table += '</tbody></table>';
 148     targetDiv.innerHTML = table;
 149 }
 150
 151 ////////////////////////////////////////////////////////////////////////////////
 152 ////////////////////////////////////////////////////////////////////////////////
 153
 154 // wait until the DOM is ready
 155 function domReady ()
 156 {
 157     document.search.onsubmit = onFormSubmitEventHandler;
 158     document.search.query.value = '';
 159     document.select.sort.onchange = onSelectDdChange;
 160     document.select.perpage.onchange = onSelectDdChange;
 161 }
 162
 163 // when search button pressed
 164 function onFormSubmitEventHandler()
 165 {
 166     resetPage();
 167     loadSelect();
 168     triggerSearch();
 169     submitted = true;
 170     return false;
 171 }
 172
 173 function onSelectDdChange()
 174 {
 175     if (!submitted) return false;
 176     resetPage();
 177     loadSelect();
 178     my_paz.show(0, recPerPage, curSort);
 179     return false;
 180 }
 181
 182 function resetPage()
 183 {
 184     curPage = 1;
 185     totalRec = 0;
 186 }
 187
 188 function triggerSearch ()
 189 {
 190     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
 191 }
 192
 193 function loadSelect ()
 194 {
 195     curSort = document.select.sort.value;
 196     recPerPage = document.select.perpage.value;
 197 }
 198
 199 // limit the query after clicking the facet
 200 function limitQuery (field, value)
 201 {
 202     document.search.query.value += ' and ' + field + '="' + value + '"';
 203     onFormSubmitEventHandler();
 204 }
 205
 206 // limit by target functions
 207 function limitTarget (id, name)
 208 {
 209     var navi = document.getElementById('navi');
 210     navi.innerHTML =
 211         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
 212         + name + '</a>';
 213     navi.innerHTML += '<hr/>';
 214     curFilter = 'pz:id=' + id;
 215     resetPage();
 216     loadSelect();
 217     triggerSearch();
 218     return false;
 219 }
 220
 221 function delimitTarget ()
 222 {
 223     var navi = document.getElementById('navi');
 224     navi.innerHTML = '';
 225     curFilter = null;
 226     resetPage();
 227     loadSelect();
 228     triggerSearch();
 229     return false;
 230 }
 231
 232 function drawPager (pagerDiv)
 233 {
 234     //client indexes pages from 1 but pz2 from 0
 235     var onsides = 6;
 236     var pages = Math.ceil(totalRec / recPerPage);
 237
 238     var firstClkbl = ( curPage - onsides > 0 )
 239         ? curPage - onsides
 240         : 1;
 241
 242     var lastClkbl = firstClkbl + 2*onsides < pages
 243         ? firstClkbl + 2*onsides
 244         : pages;
 245
 246     var prev = '<span id="prev">&#60;&#60; Prev</span><b> | </b>';
 247     if (curPage > 1)
 248         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
 249         +'&#60;&#60; Prev</a><b> | </b>';
 250
 251     var middle = '';
 252     for(var i = firstClkbl; i <= lastClkbl; i++) {
 253         var numLabel = i;
 254         if(i == curPage)
 255             numLabel = '<b>' + i + '</b>';
 256
 257         middle += '<a href="#" onclick="showPage(' + i + ')"> '
 258             + numLabel + ' </a>';
 259     }
 260
 261     var next = '<b> | </b><span id="next">Next &#62;&#62;</span>';
 262     if (pages - curPage > 0)
 263         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 264         +'Next &#62;&#62;</a>';
 265
 266     var predots = '';
 267     if (firstClkbl > 1)
 268         predots = '...';
 269
 270     var postdots = '';
 271     if (lastClkbl < pages)
 272         postdots = '...';
 273
 274     pagerDiv.innerHTML += '<div style="float: clear">'
 275         + prev + predots + middle + postdots + next + '</div><hr/>';
 276 }
 277
 278 function showPage (pageNum)
 279 {
 280     curPage = pageNum;
 281     my_paz.showPage( curPage - 1 );
 282 }
 283
 284 // simple paging functions
 285
 286 function pagerNext() {
 287     if ( totalRec - recPerPage*curPage > 0) {
 288         my_paz.showNext();
 289         curPage++;
 290     }
 291 }
 292
 293 function pagerPrev() {
 294     if ( my_paz.showPrev() != false )
 295         curPage--;
 296 }
 297
 298 // swithing view between targets and records
 299
 300 function switchView(view) {
 301
 302     var targets = document.getElementById('targetview');
 303     var records = document.getElementById('recordview');
 304
 305     switch(view) {
 306         case 'targetview':
 307             targets.style.display = "block";
 308             records.style.display = "none";
 309             break;
 310         case 'recordview':
 311             targets.style.display = "none";
 312             records.style.display = "block";
 313             break;
 314         default:
 315             alert('Unknown view.');
 316     }
 317 }
 318
 319 // detailed record drawing
 320 function showDetails (prefixRecId) {
 321     var recId = prefixRecId.replace('rec_', '');
 322     var oldRecId = curDetRecId;
 323     curDetRecId = recId;
 324
 325     // remove current detailed view if any
 326     var detRecordDiv = document.getElementById('det_'+oldRecId);
 327     // lovin DOM!
 328     if (detRecordDiv)
 329       detRecordDiv.parentNode.removeChild(detRecordDiv);
 330
 331     // if the same clicked, just hide
 332     if (recId == oldRecId) {
 333         curDetRecId = '';
 334         curDetRecData = null;
 335         return;
 336     }
 337     // request the record
 338     my_paz.record(recId);
 339 }
 340
 341 function replaceHtml(el, html) {
 342   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 343   /*@cc_on // Pure innerHTML is slightly faster in IE
 344     oldEl.innerHTML = html;
 345     return oldEl;
 346     @*/
 347   var newEl = oldEl.cloneNode(false);
 348   newEl.innerHTML = html;
 349   oldEl.parentNode.replaceChild(newEl, oldEl);
 350   /* Since we just removed the old element from the DOM, return a reference
 351      to the new element, which can be used to restore variable references. */
 352   return newEl;
 353 };
 354
 355 function renderDetails(data, marker)
 356 {
 357     var details = '<div class="details" id="det_'+data.recid+'"><table>';
 358     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
 359     if (data["md-title"] != undefined) {
 360         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
 361         if (data["md-title-remainder"] !== undefined) {
 362               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
 363         }
 364         if (data["md-title-responsibility"] !== undefined) {
 365               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
 366         }
 367           details += '</td></tr>';
 368     }
 369     if (data["md-date"] != undefined)
 370         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 371     if (data["md-author"] != undefined)
 372         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 373     if (data["md-electronic-url"] != undefined)
 374         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>';
 375     if (data["location"][0]["md-subject"] != undefined)
 376         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 377     if (data["location"][0]["@name"] != undefined)
 378         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 379     details += '</table></div>';
 380     return details;
 381 }
 382  //EOF