aad63032c2639908bf396fbed964bdce2037303c
[pazpar2-moved-to-github.git] / www / example / example_client.js
1 /* A very simple client that shows a basic usage of the pz2.js
2 ** $Id: example_client.js,v 1.4 2007-05-21 08:21:33 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
9 my_paz = new pz2( { "onshow": my_onshow,
10                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
11                     "onstat": my_onstat,
12                     "onterm": my_onterm,
13                     "termlist": "subject,author",
14                     "onbytarget": my_onbytarget,
15                     "onrecord": my_onrecord } );
16 // some state vars
17 var curPage = 1;
18 var recPerPage = 20;
19 var totalRec = 0;
20 var curDetRecId = -1;
21 var curDetRecData = null;
22
23 // wait until the DOM is ready
24 function domReady () 
25
26     document.search.onsubmit = onFormSubmitEventHandler;
27     my_paz.stat();
28     my_paz.bytarget();
29 }
30
31 // when search button pressed
32 function onFormSubmitEventHandler() 
33 {
34     curPage = 1;
35     curDetRecId = -1;
36     totalRec = 0;
37     my_paz.search(document.search.query.value, recPerPage, 'relevance');
38     return false;
39 }
40
41 //
42 // pz2.js event handlers:
43 //
44
45 function my_onshow(data) {
46     totalRec = data.merged;
47     
48     var body = document.getElementById("body");
49     body.innerHTML = "";
50
51     body.innerHTML +='<hr/><div style="float: right">Displaying: ' 
52                     + data.start + ' to ' + (data.start + data.num) +
53                      ' of ' + data.merged + ' (total not merged hits: ' 
54                      + data.total + ')</div>';
55
56     body.innerHTML += '<div style="float: clear"><span class="jslink" id="prev" onclick="pagerPrev();">'
57                     +'&#60;&#60; Prev</span> <b>|</b> ' 
58                     +'<span class="jslink" id="next" onclick="pagerNext()">'
59                     +'Next &#62;&#62;</span></div><hr/>';
60     
61     for (var i = 0; i < data.hits.length; i++) {
62         var hit = data.hits[i];
63         body.innerHTML += '<div class="record" id="rec_' + hit.recid + '" onclick="showDetails(this.id)">'
64                         +'<span>' + (i + 1 + recPerPage * ( curPage - 1)) + '. </span>'
65                         +'<span class="jslink"><b>' + hit["md-title"] +
66                         ' </b></span> by <span><i>' + hit["md-author"] + '</i></span></div>';
67
68         if ( hit.recid == curDetRecId ) {
69             drawCurDetails();
70         }
71     }
72     
73 }
74
75 function my_onstat(data) {
76     var stat = document.getElementById("stat");
77     stat.innerHTML = '<span>Active clients: '+ data.activeclients
78                         + '/' + data.clients + ' | </span>'
79                         + '<span>Retrieved records: ' + data.records
80                         + '/' + data.hits + '</span>';
81 }
82
83 function my_onterm(data) {
84     var termlist = document.getElementById("termlist");
85     termlist.innerHTML = "<hr/><b>TERMLISTS:</b><hr/>";
86     termlist.innerHTML += '<div class="termtitle">.::Subjects</div>';
87     for (var i = 0; i < data.subject.length; i++ ) {
88         termlist.innerHTML += '<span>' 
89                             + data.subject[i].name 
90                             + ' </span><span> (' 
91                             + data.subject[i].freq 
92                             + ')</span><br/>';
93     }
94     termlist.innerHTML += "<hr/>";
95     termlist.innerHTML += '<div class="termtitle">.::Authors</div>';
96     for (var i = 0; i < data.author.length; i++ ) {
97         termlist.innerHTML += '<span>' 
98                             + data.author[i].name 
99                             + ' </span><span> (' 
100                             + data.author[i].freq 
101                             + ')</span><br/>';
102     }
103
104 }
105
106 function my_onrecord(data) {
107     // in case on_show was faster to redraw element
108     var detRecordDiv = document.getElementById('det_'+data.recid);
109     if ( detRecordDiv )
110         return;
111
112     curDetRecData = data;
113     drawCurDetails();
114 }
115
116 function my_onbytarget(data) {
117     var targetDiv = document.getElementById("bytarget");
118     var table = '<thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
119                          +'<td>Records</td><td>State</td></tr></thead><tbody>';
120     
121     for (var i = 0; i < data.length; i++ ) {
122         table += "<tr><td>" + data[i].id +
123                     "</td><td>" + data[i].hits +
124                     "</td><td>" + data[i].diagnostic +
125                     "</td><td>" + data[i].records +
126                     "</td><td>" + data[i].state + "</td></tr>";
127     }
128
129     table += '</tbody>';
130     targetDiv.innerHTML = table;
131
132 }
133
134 // detailed record drawing
135 function showDetails ( prefixRecId ) {
136     var recId = Number(prefixRecId.replace('rec_', ''));
137     
138     // remove current detailed view if any
139     var detRecordDiv = document.getElementById('det_'+curDetRecId);
140     // lovin DOM!
141     if ( detRecordDiv )
142             detRecordDiv.parentNode.removeChild(detRecordDiv);
143
144     // if the same clicked do not redraw
145     if ( recId == curDetRecId ) {
146         curDetRecId = -1;
147         return;
148     }
149
150     curDetRecId = recId;
151
152     // request the record
153     my_paz.record(recId);
154 }
155
156 function drawCurDetails ()
157 {
158     var data = curDetRecData;
159     var recordDiv = document.getElementById('rec_'+data.recid);
160     recordDiv.innerHTML += '<div class="details" id="det_'+data.recid+
161                             '"><table><tr><td><b>Ttle</b></td><td><b>:</b> '+data["md-title"] +
162                             "</td></tr><tr><td><b>Date</b></td><td><b>:</b> " + data["md-date"] +
163                             "</td></tr><tr><td><b>Author</b></td><td><b>:</b> " + data["md-author"] +
164                             "</td></tr><tr><td><b>Subject</b></td><td><b>:</b> " + data["md-subject"] + 
165                             "</td></tr><tr><td><b>Location</b></td><td><b>:</b> " + data["location"][0].name + 
166                             "</td></tr></table></div>";
167 }
168
169
170 // simple paging functions
171
172 function pagerNext() {
173     if ( totalRec - recPerPage*curPage > 0) {
174         my_paz.showNext();
175         curPage++;
176     }
177 }
178
179 function pagerPrev() {
180     if ( my_paz.showPrev() != false )
181         curPage--;
182 }
183
184 // swithing view between targets and records
185
186 function switchView(view) {
187     
188     var targets = document.getElementById('targetview');
189     var records = document.getElementById('recordview');
190     
191     switch(view) {
192         case 'targetview':
193             targets.style.display = "block";            
194             records.style.display = "none";
195             break;
196         case 'recordview':
197             targets.style.display = "none";            
198             records.style.display = "block";
199             break;
200         default:
201             alert('Unknown view.');
202     }
203 }