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