X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-team.js;h=7f864717d8f3f0b549edd33782dac98a44eb6bfd;hb=4893298c2f34c67e319956dfc8cbada3dd2f61f2;hp=3ac9e727a5ac1a6d4591641c7a9320bb621e757a;hpb=36721667730b5d8aae5b6df304f69d96f2c1d21d;p=mkws-moved-to-github.git diff --git a/src/mkws-team.js b/src/mkws-team.js index 3ac9e72..7f86471 100644 --- a/src/mkws-team.js +++ b/src/mkws-team.js @@ -1,3 +1,4 @@ +"use strict"; // Factory function for team objects. As much as possible, this uses // only member variables (prefixed "m_") and inner functions with // private scope. @@ -13,22 +14,30 @@ // mkws.makeTeam = function($, teamName) { var that = {}; - var m_teamName = teamName; - var m_submitted = false; - var m_query; // initially undefined + + // Member variables are separated into two categories + + // 1. Persistent state (to be coded in URL fragment) + var m_state = { + query: null // initially undefined + } var m_sortOrder; // will be set below var m_perpage; // will be set below var m_filterSet = filterSet(that); - var m_totalRecordCount = 0; var m_currentPage = 1; var m_currentRecordId = ''; + + // 2. Internal state (not to be coded) + var m_teamName = teamName; + var m_paz; // will be initialised below + var m_submitted = false; + var m_totalRecordCount = 0; var m_currentRecordData = null; var m_logTime = { // Timestamps for logging "start": $.now(), "last": $.now() }; - var m_paz; // will be initialised below var m_templateText = {}; // widgets can register templates to be compiled var m_template = {}; // compiled templates, from any source var m_widgets = {}; // Maps widget-type to array of widget objects @@ -44,7 +53,7 @@ mkws.makeTeam = function($, 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.query = function() { return m_state.query; }; that.totalRecordCount = function() { return m_totalRecordCount; }; that.currentPage = function() { return m_currentPage; }; that.currentRecordId = function() { return m_currentRecordId; }; @@ -79,31 +88,36 @@ mkws.makeTeam = function($, teamName) { 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; // 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); } @@ -115,26 +129,26 @@ mkws.makeTeam = function($, 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); @@ -154,7 +168,7 @@ mkws.makeTeam = function($, teamName) { // 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)); + that.debug("m_queues=" + $.toJSON(m_queues)); var params = { "windowid": teamName, "pazpar2path": mkws.pazpar2_url(), @@ -166,26 +180,26 @@ mkws.makeTeam = function($, teamName) { params.oninit = onInit; if (m_queues.targets) { params.onbytarget = onBytarget; - log("setting bytarget callback"); + that.info("setting bytarget callback"); } - if (m_queues.stat) { + if (m_queues.stat || m_queues.firstrecords || m_queues.complete) { params.onstat = onStat; - log("setting stat callback"); + that.info("setting stat callback"); } - if (m_queues.termlists && config.facets.length) { + if (m_queues.facets && config.facets.length) { params.onterm = onTerm; - log("setting term callback"); + that.info("setting term callback"); } if (m_queues.records) { - log("setting show callback"); + that.info("setting show callback"); params.onshow = onShow; // Record callback is subscribed from records callback - log("setting record callback"); + that.info("setting record callback"); params.onrecord = onRecord; } m_paz = new pz2(params); - log("created main pz2 object"); + that.info("created main pz2 object"); } @@ -207,44 +221,44 @@ mkws.makeTeam = function($, 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(); + if (m_state.query) triggerSearch(); return false; }; 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(); + if (m_state.query) triggerSearch(); return false; }; 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)); - if (m_query) triggerSearch(); + if (m_state.query) triggerSearch(); return false; }; 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(); + if (m_state.query) triggerSearch(); return false; }; 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(); + if (m_state.query) triggerSearch(); return false; }; @@ -284,7 +298,7 @@ mkws.makeTeam = function($, 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"); @@ -301,10 +315,9 @@ mkws.makeTeam = function($, teamName) { function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) { resetPage(); - queue("navi").publish(); // Continue to use previous query/sort-order unless new ones are specified - if (query) m_query = query; + if (query) m_state.query = query; if (sortOrder) m_sortOrder = sortOrder; if (perpage) m_perpage = perpage; if (targets) m_filterSet.add(targetFilter(targets, targets)); @@ -325,15 +338,16 @@ mkws.makeTeam = function($, teamName) { params.torusquery = torusquery; } - log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " + + that.info("triggerSearch(" + m_state.query + "): filters = " + m_filterSet.toJSON() + ", " + "pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); - m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params); + m_paz.search(m_state.query, m_perpage, m_sortOrder, pp2filter, undefined, params); + queue("searchtriggered").publish(); } // fetch record details to be retrieved from the record queue that.fetchDetails = function(recId) { - log("fetchDetails() requesting record '" + recId + "'"); + that.info("fetchDetails() requesting record '" + recId + "'"); m_paz.record(recId); }; @@ -380,7 +394,7 @@ mkws.makeTeam = function($, teamName) { return; } // request the record - log("showDetails() requesting record '" + recId + "'"); + that.info("showDetails() requesting record '" + recId + "'"); m_paz.record(recId); }; @@ -397,7 +411,7 @@ mkws.makeTeam = function($, teamName) { } var node = $(selector); - //log('findnode(' + selector + ') found ' + node.length + ' nodes'); + //that.debug('findnode(' + selector + ') found ' + node.length + ' nodes'); return node; } @@ -417,11 +431,20 @@ mkws.makeTeam = function($, teamName) { that.registerTemplate = function(name, text) { + if(mkws._old2new.hasOwnProperty(name)) { + that.warn("registerTemplate: old widget name: " + name + " => " + mkws._old2new[name]); + name = mkws._old2new[name]; + } m_templateText[name] = text; }; function loadTemplate(name, fallbackString) { + if(mkws._old2new.hasOwnProperty(name)) { + that.warn("loadTemplate: old widget name: " + name + " => " + mkws._old2new[name]); + name = mkws._old2new[name]; + } + var template = m_template[name]; if (template === undefined && Handlebars.compile) { var source; @@ -429,17 +452,11 @@ mkws.makeTeam = function($, teamName) { if (node && node.length < 1) { node = $(".mkws-template-" + name); } - if (node && node.length < 1) { - node = $(".mkws-template_" + name + " .mkws-team-" + that.name()); - } - if (node && node.length < 1) { - node = $(".mkws-template_" + name); - } if (node) source = node.html(); if (!source) source = m_templateText[name]; if (source) { template = Handlebars.compile(source); - log("compiled template '" + name + "'"); + that.info("compiled template '" + name + "'"); } } //if (template === undefined) template = mkws_templatesbyteam[m_teamName][name]; @@ -454,7 +471,7 @@ mkws.makeTeam = function($, teamName) { return template; } else { - log("No MKWS template for " + name); + that.info("No MKWS template for " + name); return null; } } @@ -491,8 +508,7 @@ mkws.makeTeam = function($, teamName) { } } return undefined; - } - + }; return that; };