X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=src%2Fmkws-team.js;h=e4645b2651aabbef1cc0b7bb5070af805ff071c9;hb=dee321adc6b27e175de585ca35f778eeb2790e1d;hp=b2bf9744ac1f0ce9f8ceffc1e5f51a18f3a99836;hpb=403652c2b7e7c5ca39d21a2d8e35151e12bdd9a0;p=mkws-moved-to-github.git diff --git a/src/mkws-team.js b/src/mkws-team.js index b2bf974..e4645b2 100644 --- a/src/mkws-team.js +++ b/src/mkws-team.js @@ -8,7 +8,10 @@ // limitCategory(), delimitTarget(), delimitQuery(), showPage(), // pagerPrev(), pagerNext(). // -function team($, teamName) { +// Before the team can be used for searching and related operations, +// its pz2 object must be created by calling team.makePz2(). +// +mkws.makeTeam = function($, teamName) { var that = {}; var m_teamName = teamName; var m_submitted = false; @@ -41,11 +44,13 @@ function team($, teamName) { that.submitted = function() { return m_submitted; }; that.sortOrder = function() { return m_sortOrder; }; that.perpage = function() { return m_perpage; }; + that.query = function() { return m_query; }; that.totalRecordCount = function() { return m_totalRecordCount; }; that.currentPage = function() { return m_currentPage; }; that.currentRecordId = function() { return m_currentRecordId; }; that.currentRecordData = function() { return m_currentRecordData; }; that.filters = function() { return m_filterSet; }; + that.gotRecords = function() { return m_gotRecords; }; // Accessor methods for individual widgets: writers that.set_sortOrder = function(val) { m_sortOrder = val }; @@ -59,63 +64,51 @@ function team($, teamName) { // team.queue("eventName").subscribe(function(param1, param2 ...) { ... }); // team.queue("eventName").publish(arg1, arg2, ...); // - var queues = {}; + var m_queues = {}; function queue(id) { - if (!queues[id]) { + if (!m_queues[id]) { var callbacks = $.Callbacks(); - queues[id] = { + m_queues[id] = { publish: callbacks.fire, subscribe: callbacks.add, unsubscribe: callbacks.remove }; } - return queues[id]; + return m_queues[id]; }; that.queue = queue; - function log(s) { + function _log(fn, s) { var now = $.now(); var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "); m_logTime.last = now; - mkws.log(m_teamName + ": " + timestamp + s); + fn.call(mkws.log, m_teamName + ": " + timestamp + s); that.queue("log").publish(m_teamName, timestamp, s); } - that.log = log; + that.trace = function(x) { _log(mkws.trace, x) }; + that.debug = function(x) { _log(mkws.debug, x) }; + that.info = function(x) { _log(mkws.info, x) }; + that.warn = function(x) { _log(mkws.warn, x) }; + that.error = function(x) { _log(mkws.error, x) }; + that.fatal = function(x) { _log(mkws.fatal, x) }; - log("making new widget team"); + that.info("making new widget team"); m_sortOrder = config.sort_default; m_perpage = config.perpage_default; - - // create a parameters array and pass it to the pz2's constructor - // then register the form submit event with the pz2.search function - // autoInit is set to true on default - m_paz = new pz2({ "windowid": teamName, - "pazpar2path": config.pazpar2_url, - "usesessions" : config.use_service_proxy ? false : true, - "oninit": onInit, - "onbytarget": onBytarget, - "onstat": onStat, - "onterm": (config.facets.length ? onTerm : undefined), - "onshow": onShow, - "onrecord": onRecord, - "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "termlist": config.facets.join(',') - }); - log("created main pz2 object"); - + // pz2.js event handlers: function onInit() { - log("init"); + that.info("init"); m_paz.stat(); m_paz.bytarget(); } function onBytarget(data) { - log("bytarget"); + that.info("bytarget"); queue("targets").publish(data); } @@ -127,28 +120,29 @@ function team($, teamName) { queue("firstrecords").publish(hitcount); } if (parseInt(data.activeclients[0], 10) === 0) { - log("complete"); + that.info("complete"); queue("complete").publish(hitcount); } } function onTerm(data) { - log("term"); - queue("termlists").publish(data); + that.info("term"); + queue("facets").publish(data); } function onShow(data, teamName) { - log("show"); + that.info("show"); m_totalRecordCount = data.merged; - log("found " + m_totalRecordCount + " records"); + that.info("found " + m_totalRecordCount + " records"); queue("pager").publish(data); queue("records").publish(data); } function onRecord(data, args, teamName) { - log("record"); + that.info("record"); // FIXME: record is async!! clearTimeout(m_paz.recordTimer); + queue("record").publish(data); var detRecordDiv = findnode(recordDetailsId(data.recid[0])); if (detRecordDiv.length) { // in case on_show was faster to redraw element @@ -161,15 +155,54 @@ function team($, teamName) { } + // create a parameters array and pass it to the pz2's constructor + // then register the form submit event with the pz2.search function + // autoInit is set to true on default + that.makePz2 = function() { + that.debug("m_queues=" + $.toJSON(m_queues)); + var params = { + "windowid": teamName, + "pazpar2path": mkws.pazpar2_url(), + "usesessions" : config.use_service_proxy ? false : true, + "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way + "termlist": config.facets.join(',') + }; + + params.oninit = onInit; + if (m_queues.targets) { + params.onbytarget = onBytarget; + that.info("setting bytarget callback"); + } + if (m_queues.stat || m_queues.firstrecords || m_queues.complete) { + params.onstat = onStat; + that.info("setting stat callback"); + } + if (m_queues.facets && config.facets.length) { + params.onterm = onTerm; + that.info("setting term callback"); + } + if (m_queues.records) { + that.info("setting show callback"); + params.onshow = onShow; + // Record callback is subscribed from records callback + that.info("setting record callback"); + params.onrecord = onRecord; + } + + m_paz = new pz2(params); + that.info("created main pz2 object"); + } + + // Used by the Records widget and onRecord() function recordElementId(s) { - return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_'); + return 'mkws-rec_' + s.replace(/[^a-z0-9]/ig, '_'); } that.recordElementId = recordElementId; // Used by onRecord(), showDetails() and renderDetails() function recordDetailsId(s) { - return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_'); + return 'mkws-det_' + s.replace(/[^a-z0-9]/ig, '_'); } @@ -179,7 +212,7 @@ function team($, teamName) { that.limitTarget = function(id, name) { - log("limitTarget(id=" + id + ", name=" + name + ")"); + that.info("limitTarget(id=" + id + ", name=" + name + ")"); m_filterSet.add(targetFilter(id, name)); if (m_query) triggerSearch(); return false; @@ -187,7 +220,7 @@ function team($, teamName) { that.limitQuery = function(field, value) { - log("limitQuery(field=" + field + ", value=" + value + ")"); + that.info("limitQuery(field=" + field + ", value=" + value + ")"); m_filterSet.add(fieldFilter(field, value)); if (m_query) triggerSearch(); return false; @@ -195,7 +228,7 @@ function team($, teamName) { that.limitCategory = function(id) { - log("limitCategory(id=" + id + ")"); + that.info("limitCategory(id=" + id + ")"); // Only one category filter at a time m_filterSet.removeMatching(function(f) { return f.type === 'category' }); if (id !== '') m_filterSet.add(categoryFilter(id)); @@ -205,7 +238,7 @@ function team($, teamName) { that.delimitTarget = function(id) { - log("delimitTarget(id=" + id + ")"); + that.info("delimitTarget(id=" + id + ")"); m_filterSet.removeMatching(function(f) { return f.type === 'target' }); if (m_query) triggerSearch(); return false; @@ -213,7 +246,7 @@ function team($, teamName) { that.delimitQuery = function(field, value) { - log("delimitQuery(field=" + field + ", value=" + value + ")"); + that.info("delimitQuery(field=" + field + ", value=" + value + ")"); m_filterSet.removeMatching(function(f) { return f.type == 'field' && field == f.field && value == f.value }); if (m_query) triggerSearch(); @@ -256,7 +289,7 @@ function team($, teamName) { function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) { - log("newSearch: " + query); + that.info("newSearch: " + query); if (config.use_service_proxy && !mkws.authenticated) { alert("searching before authentication"); @@ -293,23 +326,29 @@ function team($, teamName) { if (maxrecs) params.maxrecs = maxrecs; if (torusquery) { if (!mkws.config.use_service_proxy) - alert("can't narrow search by torusquery when Service Proxy is not in use"); + alert("can't narrow search by torusquery when not authenticated"); params.torusquery = torusquery; } - log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " + + that.info("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " + "pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params); } + // fetch record details to be retrieved from the record queue + that.fetchDetails = function(recId) { + that.info("fetchDetails() requesting record '" + recId + "'"); + m_paz.record(recId); + }; + // switching view between targets and records function switchView(view) { - var targets = widgetNode('Targets'); - var results = widgetNode('Results') || widgetNode('Records'); - var blanket = widgetNode('Blanket'); - var motd = widgetNode('MOTD'); + var targets = widgetNode('targets'); + var results = widgetNode('results') || widgetNode('records'); + var blanket = widgetNode('blanket'); + var motd = widgetNode('motd'); switch(view) { case 'targets': @@ -346,7 +385,7 @@ function team($, teamName) { return; } // request the record - log("showDetails() requesting record '" + recId + "'"); + that.info("showDetails() requesting record '" + recId + "'"); m_paz.record(recId); }; @@ -356,14 +395,14 @@ function team($, teamName) { teamName = teamName || m_teamName; if (teamName === 'AUTO') { - selector = (selector + '.mkwsTeam_' + teamName + ',' + - selector + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])'); + selector = (selector + '.mkws-team-' + teamName + ',' + + selector + ':not([class^="mkws-team"],[class*=" mkws-team"])'); } else { - selector = selector + '.mkwsTeam_' + teamName; + selector = selector + '.mkws-team-' + teamName; } var node = $(selector); - //log('findnode(' + selector + ') found ' + node.length + ' nodes'); + //that.debug('findnode(' + selector + ') found ' + node.length + ' nodes'); return node; } @@ -374,37 +413,46 @@ function team($, teamName) { } function renderDetails(data, marker) { - var template = loadTemplate("Record"); + var template = loadTemplate("details"); var details = template(data); - return '