Corrected timers and counters.
[pazpar2-moved-to-github.git] / js / pz2.js
1 /*
2 ** $Id: pz2.js,v 1.19 2007-05-21 09:07:43 jakub Exp $
3 ** pz2.js - pazpar2's javascript client library.
4 */
5
6 //since explorer is flawed
7 if (!window['Node']) {
8     window.Node = new Object();
9     Node.ELEMENT_NODE = 1;
10     Node.ATTRIBUTE_NODE = 2;
11     Node.TEXT_NODE = 3;
12     Node.CDATA_SECTION_NODE = 4;
13     Node.ENTITY_REFERENCE_NODE = 5;
14     Node.ENTITY_NODE = 6;
15     Node.PROCESSING_INSTRUCTION_NODE = 7;
16     Node.COMMENT_NODE = 8;
17     Node.DOCUMENT_NODE = 9;
18     Node.DOCUMENT_TYPE_NODE = 10;
19     Node.DOCUMENT_FRAGMENT_NODE = 11;
20     Node.NOTATION_NODE = 12;
21 }
22
23 // prevent execution of more than once
24 if(typeof window.pz2 == "undefined") {
25 window.undefined = window.undefined;
26
27 var pz2 = function(paramArray) {
28     //for convenience
29     __myself = this;
30
31     //supported pazpar2's protocol version
32     __myself.suppProtoVer = '1';
33     __myself.pz2String = "search.pz2";
34     __myself.stylesheet = paramArray.detailstylesheet || null;
35
36     //load stylesheet if required in async mode
37     if( __myself.stylesheet ) {
38         var request = new pzHttpRequest( __myself.stylesheet );
39         request.get(
40                 {},
41                 function ( doc ) {
42                     __myself.xslDoc = doc;
43                 }
44         );
45     }
46
47     // at least one callback required
48     if ( !paramArray )
49         throw new Error("An array with parameters has to be suplied when instantiating a class");
50     
51     __myself.errorHandler = paramArray.errorhandler || null;
52     
53     // function callbacks
54     __myself.statCallback = paramArray.onstat || null;
55     __myself.showCallback = paramArray.onshow || null;
56     __myself.termlistCallback = paramArray.onterm || null;
57     __myself.recordCallback = paramArray.onrecord || null;
58     __myself.bytargetCallback = paramArray.onbytarget || null;
59     __myself.resetCallback = paramArray.onreset || null;
60
61     // termlist keys
62     __myself.termKeys = paramArray.termlist || "subject";
63     
64     // some configurational stuff
65     __myself.keepAlive = 50000;
66
67     __myself.sessionID = null;
68     __myself.initStatusOK = false;
69     __myself.pingStatusOK = false;
70     __myself.searchStatusOK = false;
71
72     if ( paramArray.keepAlive < __myself.keepAlive )
73         __myself.keepAlive = paramArray.keepAlive;
74
75     // for sorting
76     __myself.currentSort = "relevance";
77     // where are we?
78     __myself.currentStart = 0;
79     __myself.currentNum = 20;
80
81     // last full record retrieved
82     __myself.currRecID = null;
83     // current query
84     __myself.currQuery = null;
85
86     //timers
87     __myself.statTime = paramArray.stattime || 1000;
88     __myself.statTimer = null;
89     __myself.termTime = paramArray.termtime || 1000;
90     __myself.termTimer = null;
91     __myself.showTime = paramArray.showtime || 1000;
92     __myself.showTimer = null;
93     __myself.showFastCount = 4;
94     __myself.bytargetTime = paramArray.bytargettime || 1000;
95     __myself.bytargetTimer = null;
96
97     // counters for each command and applied delay
98     __myself.dumpFactor = 500;
99     __myself.showCounter = 0;
100     __myself.termCounter = 0;
101     __myself.statCounter = 0;
102     __myself.bytargetCounter = 0;
103
104     // active clients, updated by stat and show
105     // might be an issue since bytarget will poll accordingly
106     __myself.activeClients = 1;
107     
108     // auto init session?
109     if (paramArray.autoInit !== false)
110         __myself.init();
111 };
112 pz2.prototype = {
113     reset: function ()
114     {
115         __myself.sessionID = null;
116         __myself.initStatusOK = false;
117         __myself.pingStatusOK = false;
118         __myself.searchStatusOK = false;
119
120         clearTimeout(__myself.statTimer);
121         clearTimeout(__myself.showTimer);
122         clearTimeout(__myself.termTimer);
123         clearTimeout(__myself.bytargetTimer);
124             
125         if ( __myself.resetCallback )
126                 __myself.resetCallback();
127     },
128     init: function ( sessionId ) 
129     {
130         __myself.reset();
131         if ( sessionId != undefined ) {
132             __myself.initStatusOK = true;
133             __myself.sessionID = sessionId;
134             __myself.ping();
135
136         } else {
137             var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
138             request.get(
139                 { "command": "init" },
140                 function(data) {
141                     if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
142                         if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
143                             throw new Error("Server's protocol not supported by the client");
144                         __myself.initStatusOK = true;
145                         __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
146                         setTimeout("__myself.ping()", __myself.keepAlive);
147                     }
148                     else
149                         // if it gets here the http return code was 200 (pz2 errors are 417)
150                         // but the response was invalid, it should never occur
151                         setTimeout("__myself.init()", 1000);
152                 }
153             );
154         }
155     },
156     // no need to ping explicitly
157     ping: function () 
158     {
159         if( !__myself.initStatusOK )
160             return;
161             // session is not initialized code here
162         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
163         request.get(
164             { "command": "ping", "session": __myself.sessionID },
165             function(data) {
166                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
167                     __myself.pingStatusOK = true;
168                     setTimeout("__myself.ping()", __myself.keepAlive);
169                 }
170                 else
171                     // if it gets here the http return code was 200 (pz2 errors are 417)
172                     // but the response was invalid, it should never occur
173                     setTimeout("__myself.ping()", 1000);
174             }
175         );
176     },
177     search: function (query, num, sort, filter)
178     {
179         clearTimeout(__myself.statTimer);
180         clearTimeout(__myself.showTimer);
181         clearTimeout(__myself.termTimer);
182         clearTimeout(__myself.bytargetTimer);
183         
184         __myself.showCounter = 0;
185         __myself.termCounter = 0;
186         __myself.bytargetCounter = 0;
187         __myself.statCounter = 0;
188         
189         if( !__myself.initStatusOK )
190             return;
191         
192         if( query !== undefined )
193             __myself.currQuery = query;
194         else
195             throw new Error("You need to supply query to the search command");
196
197         if( filter !== undefined )
198             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
199         else
200             var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
201         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
202         request.get(
203             searchParams,
204             function(data) {
205                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
206                     __myself.searchStatusOK = true;
207                     //piggyback search
208                     __myself.show(0, num, sort);
209                     if ( __myself.statCallback )
210                         __myself.stat();
211                         //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
212                     if ( __myself.termlistCallback )
213                         __myself.termlist();
214                         //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
215                     if ( __myself.bytargetCallback )
216                         __myself.bytarget();
217                         //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
218                 }
219                 else
220                     // if it gets here the http return code was 200 (pz2 errors are 417)
221                     // but the response was invalid, it should never occur
222                     setTimeout("__myself.search(__myself.currQuery)", 500);
223             }
224         );
225     },
226     stat: function()
227     {
228         if( !__myself.initStatusOK )
229             return;
230         // if called explicitly takes precedence
231         clearTimeout(__myself.statTimer);
232         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
233         request.get(
234             { "command": "stat", "session": __myself.sessionID },
235             function(data) {
236                 if ( data.getElementsByTagName("stat") ) {
237                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
238                     __myself.activeClients = activeClients;
239                     var stat = {
240                     "activeclients": activeClients,
241                     "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
242                     "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
243                     "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
244                     "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
245                     "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
246                     "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
247                     "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
248                     "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
249                     "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
250                     };
251                     
252                     __myself.statCounter++;
253                     var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
254                     if ( activeClients > 0 )
255                         __myself.statTimer = setTimeout("__myself.stat()", delay);
256                     
257                     __myself.statCallback(stat);
258                 }
259                 else
260                     // if it gets here the http return code was 200 (pz2 errors are 417)
261                     // but the response was invalid, it should never occur
262                     __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
263             }
264         );
265     },
266     show: function(start, num, sort)
267     {
268         if( !__myself.searchStatusOK )
269             return;
270         // if called explicitly takes precedence
271         clearTimeout(__myself.showTimer);
272         
273         if( sort !== undefined )
274             __myself.currentSort = sort;
275         if( start !== undefined )
276             __myself.currentStart = Number( start );
277         if( num !== undefined )
278             __myself.currentNum = Number( num );
279         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
280         var context = this;
281         request.get(
282             { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
283               "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
284             function(data) {
285                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
286                     // first parse the status data send along with records
287                     // this is strictly bound to the format
288                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
289                     __myself.activeClients = activeClients; 
290                     var show = {
291                     "activeclients": activeClients,
292                     "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
293                     "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
294                     "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
295                     "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
296                     "hits": []
297                     };
298                     // parse all the first-level nodes for all <hit> tags
299                     var hits = data.getElementsByTagName("hit");
300                     var hit = new Array();
301                     for (i = 0; i < hits.length; i++) {
302                         show.hits[i] = new Array();
303                         show.hits[i]['location'] = new Array();
304                         for ( j = 0; j < hits[i].childNodes.length; j++) {
305                             var locCount = 0;
306                             if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
307                                 if (hits[i].childNodes[j].nodeName == 'location') {
308                                     var locNode = hits[i].childNodes[j];
309                                     var id = locNode.getAttribute('id');
310                                     show.hits[i]['location'][id] = {
311                                         "id": locNode.getAttribute("id"),
312                                         "name": locNode.getAttribute("name")
313                                     };
314                                 }
315                                 else {
316                                     var nodeName = hits[i].childNodes[j].nodeName;
317                                     var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
318                                     show.hits[i][nodeName] = nodeText;
319                                 }
320                             }
321                         }
322                     }
323                     __myself.showCounter++;
324                     var delay = __myself.showTime;
325                     if (__myself.showCounter > __myself.showFastCount)
326                             delay += __myself.showCounter * __myself.dumpFactor;
327                     if ( activeClients > 0 )
328                         __myself.showTimer = setTimeout("__myself.show()", delay);
329
330                     __myself.showCallback(show);
331                 }
332                 else
333                     // if it gets here the http return code was 200 (pz2 errors are 417)
334                     // but the response was invalid, it should never occur
335                     __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
336             }
337         );
338     },
339     record: function(id)
340     {
341         if( !__myself.searchStatusOK )
342             return;
343
344         if( id !== undefined )
345             __myself.currRecID = id;
346         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
347         request.get(
348             { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
349             function(data) {
350                 var recordNode;
351                 var record = new Array();
352                 if ( recordNode = data.getElementsByTagName("record")[0] ) {
353                     // if stylesheet was fetched do not parse the response
354                     if ( __myself.xslDoc ) {
355                         record['xmlDoc'] = data;
356                         record['xslDoc'] = __myself.xslDoc;
357                     } else {
358                         for ( i = 0; i < recordNode.childNodes.length; i++) {
359                             if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
360                                     && recordNode.childNodes[i].nodeName != 'location' ) {
361                                 var nodeName = recordNode.childNodes[i].nodeName;
362                                 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
363                                 record[nodeName] = nodeText;                            
364                             }
365                         }
366                         // the location might be empty!!
367                         var locationNodes = recordNode.getElementsByTagName("location");
368                         record["location"] = new Array();
369                         for ( i = 0; i < locationNodes.length; i++ ) {
370                             record["location"][i] = {
371                                 "id": locationNodes[i].getAttribute("id"),
372                                 "name": locationNodes[i].getAttribute("name")
373                             };
374                             
375                             for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
376                                 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
377                                     var nodeName = locationNodes[i].childNodes[j].nodeName;
378                                     var nodeText = '';
379                                     if (locationNodes[i].childNodes[j].firstChild)
380                                             nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
381                                     record["location"][i][nodeName] = nodeText;                            
382                                 }
383                             }
384                         }
385                     }
386                     __myself.recordCallback(record);
387                 }
388                 else
389                     // if it gets here the http return code was 200 (pz2 errors are 417)
390                     // but the response was invalid, it should never occur
391                     setTimeout("__myself.record(__myself.currRecID)", 1000);
392             }
393         );
394     },
395     termlist: function()
396     {
397         if( !__myself.searchStatusOK )
398             return;
399         // if called explicitly takes precedence
400         clearTimeout(__myself.termTimer);
401         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
402         request.get(
403             { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
404             function(data) {
405                 if ( data.getElementsByTagName("termlist") ) {
406                     var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
407                     __myself.activeClients = activeClients;
408                     var termList = { "activeclients":  activeClients };
409                     var termLists = data.getElementsByTagName("list");
410                     //for each termlist
411                     for (i = 0; i < termLists.length; i++) {
412                         var listName = termLists[i].getAttribute('name');
413                         termList[listName] = new Array();
414                         var terms = termLists[i].getElementsByTagName('term');
415                         //for each term in the list
416                         for (j = 0; j < terms.length; j++) { 
417                             var term = {
418                                 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
419                                 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
420                             };
421
422                             var termIdNode = terms[j].getElementsByTagName("id");
423                             if(terms[j].getElementsByTagName("id").length)
424                                 term["id"] = termIdNode[0].childNodes[0].nodeValue;
425
426                             termList[listName][j] = term;
427                         }
428                     }
429
430                     __myself.termCounter++;
431                     var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
432                     if ( activeClients > 0 )
433                         __myself.termTimer = setTimeout("__myself.termlist()", delay);
434                    
435                    __myself.termlistCallback(termList);
436                 }
437                 else
438                     // if it gets here the http return code was 200 (pz2 errors are 417)
439                     // but the response was invalid, it should never occur
440                     __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4); 
441             }
442         );
443
444     },
445     bytarget: function()
446     {
447         if( !__myself.searchStatusOK )
448             return;
449         // if called explicitly takes precedence
450         clearTimeout(__myself.bytargetTimer);
451         var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
452         request.get(
453             { "command": "bytarget", "session": __myself.sessionID },
454             function(data) {
455                 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
456                     var targetNodes = data.getElementsByTagName("target");
457                     var bytarget = new Array();
458                     for ( i = 0; i < targetNodes.length; i++) {
459                         bytarget[i] = new Array();
460                         for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
461                             if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
462                                 var nodeName = targetNodes[i].childNodes[j].nodeName;
463                                 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
464                                 bytarget[i][nodeName] = nodeText;
465                             }
466                         }
467                     }
468                     
469                     __myself.bytargetCounter++;
470                     var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
471                     if ( __myself.activeClients > 0 )
472                         __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
473
474                     __myself.bytargetCallback(bytarget);
475                 }
476                 else
477                     // if it gets here the http return code was 200 (pz2 errors are 417)
478                     // but the response was invalid, it should never occur
479                     __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
480             }
481         );
482     },
483     // just for testing, probably shouldn't be here
484     showNext: function(page)
485     {
486         var step = page || 1;
487         __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );     
488     },
489     showPrev: function(page)
490     {
491         if (__myself.currentStart == 0 )
492             return false;
493         var step = page || 1;
494         var newStart = __myself.currentStart - (step * __myself.currentNum );
495         __myself.show( newStart > 0 ? newStart : 0 );
496     },
497     showPage: function(pageNum)
498     {
499         //var page = pageNum || 1;
500         __myself.show(pageNum * __myself.currentNum);
501     }
502 };
503
504 /*
505 *********************************************************************************
506 ** AJAX HELPER CLASS ************************************************************
507 *********************************************************************************
508 */
509 var pzHttpRequest = function ( url, errorHandler ) {
510         this.request = null;
511         this.url = url;
512         this.errorHandler = errorHandler || null;
513         
514         if ( window.XMLHttpRequest ) {
515             this.request = new XMLHttpRequest();
516         } else if ( window.ActiveXObject ) {
517             try {
518                 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
519             } catch (err) {
520                 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
521             }
522         }
523 };
524
525 pzHttpRequest.prototype = 
526 {
527     get: function ( params, callback ) 
528     {
529         this.callback = callback;
530         
531         var getUrl = this.url;
532         var paramArr = new Array();
533
534         for ( var key in params ) {
535             paramArr.push(key + '=' + escape(params[key]));
536         }
537
538         if ( paramArr.length )
539             getUrl += '?' + paramArr.join('&');
540
541         var context = this;
542         this.request.open( 'GET', getUrl, true );
543         this.request.onreadystatechange = function () {
544             context._handleResponse();
545         }
546         this.request.send(null);
547     },
548
549     _handleResponse: function ()
550     {
551         if ( this.request.readyState == 4 ) {
552             if ( this.request.status == 200 ) {
553                 this.callback( this.request.responseXML );
554             }
555             // pz errors
556             else if ( this.request.status == 417 ) {
557                 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
558                 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
559             
560                 var err = new Error(errMsg);
561                 err.code = errCode;
562             
563                 if (this.errorHandler) {
564                     this.errorHandler(err);
565                 }
566                 else {
567                     throw err;
568                 }
569             }
570             else {
571                 var err = new Error("XMLHttpRequest error. STATUS: " 
572                             + this.request.status + " STATUS TEXT: " 
573                             + this.request.statusText );
574                 err.code = 'HTTP';
575                 
576                 if (this.errorHandler) {
577                     this.errorHandler(err);
578                 }
579                 else {
580                     throw err;
581                 }
582             }
583         }
584     }
585 };
586
587 /*
588 *********************************************************************************
589 ** QUERY CLASS ******************************************************************
590 *********************************************************************************
591 */
592 var pzQuery = function()
593 {
594     this.simpleQuery = '';
595     this.singleFilter = null;
596     this.advTerms = new Array();
597     this.filterHash = new Array();
598     this.numTerms = 0;
599     this.filterNums = 0;
600 };
601 pzQuery.prototype = {
602     reset: function()
603     {
604         this.simpleQuery = '';
605         this.advTerms = new Array();
606         this.simpleFilter = null;
607         this.numTerms = 0;
608     },
609     addTerm: function(field, value)
610     {
611         var term = {"field": field, "value": value};
612         this.advTerms[this.numTerms] = term;
613         this.numTerms++;
614     },
615     getTermValueByIdx: function(index)
616     {
617         return this.advTerms[index].value;
618     },
619     getTermFieldByIdx: function(index)
620     {
621         return this.advTerms[index].field;
622     },
623     /* semicolon separated list of terms for given field*/
624     getTermsByField: function(field)
625     {
626         var terms = '';
627         for(var i = 0; i < this.advTerms.length; i++)
628         {
629             if( this.advTerms[i].field == field )
630                 terms = terms + this.queryHas[i].value + ';';
631         }
632         return terms;
633     },
634     addTermsFromList: function(inputString, field)
635     {
636         var inputArr = inputString.split(';');
637         for(var i=0; i < inputArr.length; i++)
638         {
639             if(inputArr[i].length < 3) continue;
640             this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
641             this.numTerms++;
642         }
643     },
644     removeTermByIdx: function(index)
645     {
646         this.advTerms.splice(index, 1);
647         this.numTerms--;
648     },
649     toCCL: function()
650     {   
651         var ccl = '';
652         if( this.simpleQuery != '')
653             ccl = '"'+this.simpleQuery+'"';
654         for(var i = 0; i < this.advTerms.length; i++)
655         {
656             if (ccl != '') ccl = ccl + ' and ';
657             ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
658         }
659         return ccl;
660     },
661     addFilter: function(name, value)
662     {
663         var filter = {"name": name, "id": value };
664         this.filterHash[this.filterHash.length] = filter;
665         this.filterNums++
666         return  this.filterHash.length - 1;
667     },
668     setFilter: function(name, value)
669     {
670         this.filterHash = new Array();
671         this.filterNums = 0;
672         this.addFilter(name, value);
673     },
674     getFilter: function(index)
675     {
676         return this.filterHash[index].id;
677     },
678     getFilterName: function(index)
679     {
680         return this.filterHash[index].name;
681     },
682     removeFilter: function(index)
683     {
684         delete this.filterHash[index];
685         this.filterNums--;
686     },
687     clearFilter: function()
688     {
689         this.filterHash = new Array();
690         this.filterNums = 0;
691     },
692     getFilterString: function()
693     {
694         //temporary
695         if( this.singleFilter != null ) {
696             return 'pz:id='+this.singleFilter.id;
697         } 
698         else if( this.filterNums <= 0 ) {
699             return undefined;
700         }
701
702         var filter = 'pz:id=';
703         for(var i = 0; i < this.filterHash.length; i++)
704         {
705             if (this.filterHash[i] == undefined) continue;
706             if (filter > 'pz:id=') filter = filter + '|';            
707             filter += this.filterHash[i].id; 
708         }
709         return filter;
710     },
711     totalLength: function()
712     {
713         var simpleLength = this.simpleQuery != '' ? 1 : 0;
714         return this.advTerms.length + simpleLength;
715     },
716     clearSingleFilter: function()
717     {
718         this.singleFilter = null;
719     },
720     setSingleFilter: function(name, value)
721     {
722         this.singleFilter = {"name": name, "id": value };
723     },
724     getSingleFilterName: function()
725     {
726         return this.singleFilter.name;
727     }
728 }
729
730 }