/*
-** $Id: pz2.js,v 1.61 2007-10-02 11:47:50 jakub Exp $
+** $Id: pz2.js,v 1.70 2008-03-12 11:36:57 jakub Exp $
** pz2.js - pazpar2's javascript client library.
*/
// at least one callback required
if ( !paramArray )
- throw new Error("Pz2.js: An array with parameters has to be suplied when instantiating a class");
+ throw new Error("Pz2.js: Array with parameters has to be suplied.");
//supported pazpar2's protocol version
this.suppProtoVer = '1';
this.errorHandler = paramArray.errorhandler || null;
// function callbacks
+ this.initCallback = paramArray.oninit || null;
this.statCallback = paramArray.onstat || null;
this.showCallback = paramArray.onshow || null;
this.termlistCallback = paramArray.onterm || null;
// current query
this.currQuery = null;
+ //current raw record offset
+ this.currRecOffset = null;
+
//timers
this.statTime = paramArray.stattime || 1000;
this.statTimer = null;
if ( data.getElementsByTagName("protocol")[0]
.childNodes[0].nodeValue
!= context.suppProtoVer )
- throw new Error("Server's protocol not supported by the client");
+ throw new Error(
+ "Server's protocol not supported by the client"
+ );
context.initStatusOK = true;
context.sessionID =
data.getElementsByTagName("session")[0]
},
context.keepAlive
);
+ if ( context.initCallback )
+ context.initCallback();
}
else
context.throwError('Init failed. Malformed WS resonse.',
{
// pinging only makes sense when using pazpar2 directly
if( !this.initStatusOK || !this.useSessions )
- throw new Error('Pz2.js: Ping not allowed (proxy mode) or session not initialized.');
- // session is not initialized code here
-
+ throw new Error(
+ 'Pz2.js: Ping not allowed (proxy mode) or session not initialized.'
+ );
var context = this;
var request = new pzHttpRequest(this.pz2String, this.errorHandler);
request.get(
show: function(start, num, sort)
{
if( !this.searchStatusOK && this.useSessions )
- throw new Error('Pz2.js: show command has to be preceded with a search command.');
+ throw new Error(
+ 'Pz2.js: show command has to be preceded with a search command.'
+ );
// if called explicitly takes precedence
clearTimeout(this.showTimer);
};
// parse all the first-level nodes for all <hit> tags
var hits = data.getElementsByTagName("hit");
- var hit = new Array();
- for (i = 0; i < hits.length; i++) {
- show.hits[i] = new Array();
- show.hits[i]['location'] = new Array();
- for ( j = 0; j < hits[i].childNodes.length; j++) {
- var locCount = 0;
- if ( hits[i].childNodes[j].nodeType
- == Node.ELEMENT_NODE ) {
- if (hits[i].childNodes[j].nodeName
- == 'location') {
- var locNode = hits[i].childNodes[j];
- var id = locNode.getAttribute('id');
- show.hits[i]['location'][id] = {
- "id": locNode.getAttribute("id"),
- "name": locNode.getAttribute("name")
- };
- }
- else {
- var nodeName =
- hits[i].childNodes[j].nodeName;
- var nodeText = 'ERROR'
- if ( hits[i].childNodes[j].firstChild )
- nodeText =
- hits[i].childNodes[j]
- .firstChild.nodeValue;
- show.hits[i][nodeName] = nodeText;
- }
- }
- }
- }
+ for (i = 0; i < hits.length; i++)
+ show.hits[i] = Element_parseChildNodes(hits[i]);
+
context.showCounter++;
var delay = context.showTime;
if (context.showCounter > context.showFastCount)
context.show();
},
delay);
-
+ global_show = show;
context.showCallback(show);
}
else
}
);
},
- record: function(id, offset, params)
+ record: function(id, offset, syntax, handler)
{
// we may call record with no previous search if in proxy mode
- if( !this.searchStatusOK && this.useSessions)
+ if(!this.searchStatusOK && this.useSessions)
throw new Error(
'Pz2.js: record command has to be preceded with a search command.'
- );
- if ( params == undefined )
- params = {};
-
- if ( params.callback != undefined ) {
- callback = params.callback;
- } else {
- callback = this.recordCallback;
- }
+ );
- // what is that?
- if ( params['handle'] == undefined )
- handle = {};
- else
- handle = params['handle'];
-
if( id !== undefined )
this.currRecID = id;
- var context = this;
- var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-
- var recordParams = { "command": "record",
- "session": this.sessionID,
- "id": this.currRecID };
+ var recordParams = {
+ "command": "record",
+ "session": this.sessionID,
+ "id": this.currRecID
+ };
- if (offset !== undefined) {
+ this.currRecOffset = null;
+ if (offset != undefined) {
recordParams["offset"] = offset;
- }
-
- if (params.syntax != undefined) {
- recordParams['syntax'] = params.syntax;
+ this.currRecOffset = offset;
}
- this.currRecOffset = offset;
+ if (syntax != undefined)
+ recordParams['syntax'] = syntax;
+
+ //overwrite default callback id needed
+ var callback = this.recordCallback;
+ var args = undefined;
+ if (handler != undefined) {
+ callback = handler['callback'];
+ args = handler['args'];
+ }
+
+ var context = this;
+ var request = new pzHttpRequest(this.pz2String, this.errorHandler);
request.get(
recordParams,
function(data) {
var recordNode;
- var record = new Array();
- record['xmlDoc'] = data;
- if (context.currRecOffset !== undefined) {
+ var record;
+ //raw record
+ if (context.currRecOffset !== null) {
+ record = new Array();
+ record['xmlDoc'] = data;
record['offset'] = context.currRecOffset;
- callback(record, handle);
+ callback(record, args);
+ //pz2 record
} else if ( recordNode =
data.getElementsByTagName("record")[0] ) {
// if stylesheet was fetched do not parse the response
if ( context.xslDoc ) {
+ record = new Array();
+ record['xmlDoc'] = data;
+ record['xslDoc'] = context.xslDoc;
record['recid'] =
recordNode.getElementsByTagName("recid")[0]
.firstChild.nodeValue;
- record['xslDoc'] =
- context.xslDoc;
+ //parse record
} else {
- for ( i = 0; i < recordNode.childNodes.length; i++) {
- if ( recordNode.childNodes[i].nodeType
- == Node.ELEMENT_NODE
- && recordNode.childNodes[i].nodeName
- != 'location' ) {
- var nodeName =
- recordNode.childNodes[i].nodeName;
- var nodeText =
- recordNode.childNodes[i]
- .firstChild.nodeValue;
- record[nodeName] = nodeText;
- }
- }
- // the location might be empty!!
- var locationNodes =
- recordNode.getElementsByTagName("location");
- record["location"] = new Array();
- for ( i = 0; i < locationNodes.length; i++ ) {
- record["location"][i] = {
- "id": locationNodes[i].getAttribute("id"),
- "name": locationNodes[i].getAttribute("name")
- };
-
- for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
- if ( locationNodes[i].childNodes[j].nodeType
- == Node.ELEMENT_NODE ) {
- var nodeName =
- locationNodes[i].childNodes[j].nodeName;
- var nodeText = '';
- if (locationNodes[i].childNodes[j]
- .firstChild)
- nodeText =
- locationNodes[i].childNodes[j]
- .firstChild.nodeValue;
- record["location"][i][nodeName] = nodeText;
- }
- }
- }
- }
-
- callback(record, handle);
+ record = Element_parseChildNodes(recordNode);
+ }
+ callback(record, args);
}
else
context.throwError('Record failed. Malformed WS resonse.',
termlist: function()
{
if( !this.searchStatusOK && this.useSessions )
- throw new Error('Pz2.js: termlist command has to be preceded with a search command.');
+ throw new Error(
+ 'Pz2.js: termlist command has to be preceded with a search command.'
+ );
// if called explicitly takes precedence
clearTimeout(this.termTimer);
bytarget: function()
{
if( !this.initStatusOK && this.useSessions )
- throw new Error('Pz2.js: bytarget command has to be preceded with a search command.');
+ throw new Error(
+ 'Pz2.js: bytarget command has to be preceded with a search command.'
+ );
// no need to continue
if( !this.searchStatusOK )
// pick up pazpr2 errors first
if ( this.request.responseXML
&& this.request.responseXML.documentElement.nodeName == 'error'
- && this.request.responseXML.getElementsByTagName("error").length ) {
+ && this.request.responseXML.getElementsByTagName("error")
+ .length ) {
var errAddInfo = '';
- if ( this.request.responseXML.getElementsByTagName("error")[0].childNodes.length )
- errAddInfo = ': ' + this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
- var errMsg = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("msg");
- var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
+ if ( this.request.responseXML.getElementsByTagName("error")[0]
+ .childNodes.length )
+ errAddInfo = ': ' +
+ this.request.responseXML
+ .getElementsByTagName("error")[0]
+ .childNodes[0].nodeValue;
+ var errMsg =
+ this.request.responseXML.getElementsByTagName("error")[0]
+ .getAttribute("msg");
+ var errCode =
+ this.request.responseXML.getElementsByTagName("error")[0]
+ .getAttribute("code");
var err = new Error(errMsg + errAddInfo);
err.code = errCode;
};
/*
-*********************************************************************************
-** XML HELPER CLASS ************************************************************
-*********************************************************************************
+********************************************************************************
+** XML HELPER FUNCTIONS ********************************************************
+********************************************************************************
*/
// DOMDocument
}
}
+Element_parseChildNodes = function (node)
+{
+ var parsed = {};
+ var hasChildElems = false;
+
+ if (node.hasChildNodes()) {
+ var children = node.childNodes;
+ for (var i = 0; i < children.length; i++) {
+ var child = children[i];
+ if (child.nodeType == Node.ELEMENT_NODE) {
+ hasChildElems = true;
+ var nodeName = child.nodeName;
+ if (!(nodeName in parsed))
+ parsed[nodeName] = [];
+ parsed[nodeName].push(Element_parseChildNodes(child));
+ }
+ }
+ }
+
+ var attrs = node.attributes;
+ for (var i = 0; i < attrs.length; i++) {
+ var attrName = '@' + attrs[i].nodeName;
+ var attrValue = attrs[i].nodeValue;
+ parsed[attrName] = attrValue;
+ }
+
+ // if no nested elements, get text content
+ if (node.hasChildNodes() && !hasChildElems) {
+ if (node.attributes.length)
+ parsed['textContent'] = node.firstChild.nodeValue;
+ else
+ parsed = node.firstChild.nodeValue;
+ }
+
+ return parsed;
+}
+
+/* do not remove trailing bracket */
}