// 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;
"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 + ']'; };
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 };
// 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;
that.log = log;
- log("start running MKWS");
-
- m_sortOrder = m_config.sort_default;
- m_perpage = m_config.perpage_default;
-
- log("Create main pz2 object");
- // 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("making new widget team");
+ m_sortOrder = config.sort_default;
+ m_perpage = config.perpage_default;
+
// pz2.js event handlers:
function onInit() {
log("init");
}
function onBytarget(data) {
- log("target");
+ log("bytarget");
queue("targets").publish(data);
}
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) {
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
}
+ // 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, '_');
}
function resetPage() {
m_currentPage = 1;
m_totalRecordCount = 0;
+ m_gotRecords = false;
}
that.resetPage = resetPage;
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;
}
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;
}
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':
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);
function widgetNode(type) {
var w = that.widget(type);
- return w ? $(w.node) : undefined;
+ return w ? w.node : undefined;
}
function renderDetails(data, marker) {
- var template = loadTemplate("Record");
+ var template = loadTemplate("details");
var details = template(data);
- return '<div class="mkwsDetails mkwsTeam_' + m_teamName + '" ' +
+ return '<div class="mkws-details mkwsDetails mkwsTeam_' + m_teamName + '" ' +
'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
}
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;
that.addWidget = function(w) {
if (m_widgets[w.type] === undefined) {
m_widgets[w.type] = [ w ];
- log("Added '" + w.type + "' widget to team '" + m_teamName + "'");
} else {
m_widgets[w.type].push(w);
- log("Added '" + w.type + "' widget #" + m_widgets[w.type].length + "' to team '" + m_teamName + "'");
}
}
projects / mkws-moved-to-github.git / blobdiff