X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-team.js;h=7ec9c2f3b700a0fecd77ef91687953d5b1a3789d;hp=8d851a36b317b21e1060f852ff1537dc9496c273;hb=fd5d0f9300f108fd5d1b867ef6bd187d16bb05c7;hpb=b71348af037e61efcbf57ca0209b0a0ca2928ee1 diff --git a/src/mkws-team.js b/src/mkws-team.js index 8d851a3..7ec9c2f 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; @@ -26,10 +29,13 @@ function team($, teamName) { "last": $.now() }; var m_paz; // will be initialised below - var m_tempateText = {}; // widgets can register tempates to be compiled + var m_templateText = {}; // widgets can register templates to be compiled var m_template = {}; // compiled templates, from any source - var m_config = mkws.objectInheritingFrom(mkws.config); var m_widgets = {}; // Maps widget-type to array of widget objects + var m_gotRecords = false; + + var config = mkws.objectInheritingFrom(mkws.config); + that.config = config; that.toString = function() { return '[Team ' + teamName + ']'; }; @@ -38,12 +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.config = function() { return m_config; }; + that.gotRecords = function() { return m_gotRecords; }; // Accessor methods for individual widgets: writers that.set_sortOrder = function(val) { m_sortOrder = val }; @@ -57,17 +64,17 @@ 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; @@ -85,26 +92,9 @@ function team($, teamName) { log("making new widget team"); - m_sortOrder = m_config.sort_default; - m_perpage = m_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": m_config.pazpar2_url, - "usesessions" : m_config.use_service_proxy ? false : true, - "oninit": onInit, - "onbytarget": onBytarget, - "onstat": onStat, - "onterm": (m_config.facets.length ? onTerm : undefined), - "onshow": onShow, - "onrecord": onRecord, - "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "termlist": m_config.facets.join(',') - }); - log("created main pz2 object"); - + m_sortOrder = config.sort_default; + m_perpage = config.perpage_default; + // pz2.js event handlers: function onInit() { log("init"); @@ -119,8 +109,15 @@ function team($, teamName) { function onStat(data) { queue("stat").publish(data); - if (parseInt(data.activeclients[0], 10) === 0) - queue("complete").publish(parseInt(data.hits[0], 10)); + var hitcount = parseInt(data.hits[0], 10); + if (!m_gotRecords && hitcount > 0) { + m_gotRecords = true; + queue("firstrecords").publish(hitcount); + } + if (parseInt(data.activeclients[0], 10) === 0) { + log("complete"); + queue("complete").publish(hitcount); + } } function onTerm(data) { @@ -140,6 +137,7 @@ function team($, teamName) { log("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 @@ -152,15 +150,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() { + log("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; + log("setting bytarget callback"); + } + if (m_queues.stat) { + params.onstat = onStat; + log("setting stat callback"); + } + if (m_queues.termlists && config.facets.length) { + params.onterm = onTerm; + log("setting term callback"); + } + if (m_queues.records) { + log("setting show callback"); + params.onshow = onShow; + // Record callback is subscribed from records callback + log("setting record callback"); + params.onrecord = onRecord; + } + + m_paz = new pz2(params); + log("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, '_'); } @@ -241,6 +278,7 @@ function team($, teamName) { function resetPage() { m_currentPage = 1; m_totalRecordCount = 0; + m_gotRecords = false; } that.resetPage = resetPage; @@ -248,7 +286,7 @@ function team($, teamName) { function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) { log("newSearch: " + query); - if (m_config.use_service_proxy && !mkws.authenticated) { + if (config.use_service_proxy && !mkws.authenticated) { alert("searching before authentication"); return; } @@ -283,7 +321,7 @@ 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; } @@ -293,13 +331,19 @@ function team($, teamName) { 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) { + log("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,10 +390,10 @@ 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); @@ -360,50 +404,62 @@ function team($, teamName) { function widgetNode(type) { var w = that.widget(type); - return w ? w.jqnode : undefined; + return w ? w.node : undefined; } function renderDetails(data, marker) { - var template = loadTemplate("Record"); + var template = loadTemplate("details"); var details = template(data); - return '
' + details + '
'; } that.renderDetails = renderDetails; that.registerTemplate = function(name, text) { - m_tempateText[name] = text; + if(mkws._old2new.hasOwnProperty(name)) { + mkws.log("Warning: registerTemplate old widget name: " + name + " => " + mkws._old2new[name]); + name = mkws._old2new[name]; + } + m_templateText[name] = text; }; - function loadTemplate(name) { - var template = m_template[name]; + function loadTemplate(name, fallbackString) { + if(mkws._old2new.hasOwnProperty(name)) { + mkws.log("Warning loadTemplate: old widget name: " + name + " => " + mkws._old2new[name]); + name = mkws._old2new[name]; + } - if (template === undefined) { - // Fall back to generic template if there is no team-specific one + var template = m_template[name]; + if (template === undefined && Handlebars.compile) { var source; - var node = widgetNode("Template_" + name); - if (!node) { - node = widgetNode("Template_" + name, "ALL"); + var node = $(".mkws-template-" + name + " .mkws-team-" + that.name()); + if (node && node.length < 1) { + node = $(".mkws-template-" + name); } - if (node) { - source = node.html(); + if (node) source = node.html(); + if (!source) source = m_templateText[name]; + if (source) { + template = Handlebars.compile(source); + log("compiled template '" + name + "'"); } - - if (!source) { - source = m_tempateText[name]; - } - if (!source) { - source = mkws.defaultTemplate(name); - } - - template = Handlebars.compile(source); - log("compiled template '" + name + "'"); + } + //if (template === undefined) template = mkws_templatesbyteam[m_teamName][name]; + if (template === undefined && Handlebars.templates) { + template = Handlebars.templates["mkws-template-" + name]; + } + if (template === undefined && mkws.defaultTemplates) { + template = mkws.defaultTemplates[name]; + } + if (template) { m_template[name] = template; + return template; } - - return template; + else { + log("No MKWS template for " + name); + return null; + } } that.loadTemplate = loadTemplate;