annotate js/specification.js @ 2922:7fa175a37aca master

Merge branch 'master' of https://github.com/BrechtDeMan/WebAudioEvaluationTool
author www-data <www-data@sucuk.dcs.qmul.ac.uk>
date Thu, 03 Aug 2017 18:24:46 +0100
parents 2eec0c37b4cb
children cccb9c312b5d 664065577426
rev   line source
nicholas@2690 1 /* globals document, console, DOMParser */
nicholas@2224 2 function Specification() {
nicholas@2690 3 var schemaRoot;
nicholas@2690 4 var schemaString;
nicholas@2538 5 // Handles the decoding of the project specification XML into a simple JavaScript Object.
nicholas@2538 6
nicholas@2378 7 // <setup> attributes
nicholas@2688 8 this.interface = undefined;
nicholas@2688 9 this.projectReturn = undefined;
nicholas@2688 10 this.returnURL = undefined;
nicholas@2688 11 this.randomiseOrder = undefined;
nicholas@2688 12 this.poolSize = undefined;
nicholas@2688 13 this.loudness = undefined;
nicholas@2688 14 this.sampleRate = undefined;
nicholas@2688 15 this.calibration = undefined;
nicholas@2688 16 this.crossFade = undefined;
nicholas@2688 17 this.preSilence = undefined;
nicholas@2688 18 this.postSilence = undefined;
nicholas@2688 19 this.playOne = undefined;
nicholas@2822 20 this.minNumberPlays = undefined;
nicholas@2822 21 this.maxNumberPlays = undefined;
nicholas@2538 22
nicholas@2378 23 // nodes
nicholas@2854 24 this.metrics = new metricNode();
nicholas@2857 25 this.preTest = new surveyNode(this);
nicholas@2857 26 this.postTest = new surveyNode(this);
nicholas@2866 27 this.preTest.location = "pre";
nicholas@2866 28 this.postTest.location = "post";
nicholas@2538 29 this.pages = [];
nicholas@2854 30 this.interfaces = new interfaceNode(this);
nicholas@2538 31 this.errors = [];
nicholas@2224 32 this.exitText = "Thank you.";
nicholas@2538 33
nicholas@2857 34 // Creators
nicholas@2857 35 this.createNewPage = function () {
nicholas@2857 36 var newpage = new page(this);
nicholas@2857 37 this.pages.push(newpage);
nicholas@2857 38 return newpage;
nicholas@2859 39 };
nicholas@2857 40
nicholas@2687 41 var processAttribute = function (attribute, schema) {
nicholas@2538 42 // attribute is the string returned from getAttribute on the XML
nicholas@2538 43 // schema is the <xs:attribute> node
nicholas@2687 44 if (schema.getAttribute('name') === null && schema.getAttribute('ref') !== undefined) {
nicholas@2852 45 schema = schemaRoot.querySelector("[name=" + schema.getAttribute('ref') + "]");
nicholas@2538 46 }
nicholas@2538 47 var defaultOpt = schema.getAttribute('default');
nicholas@2684 48 if (attribute === null) {
nicholas@2538 49 attribute = defaultOpt;
nicholas@2538 50 }
nicholas@2538 51 var dataType = schema.getAttribute('type');
nicholas@2538 52 if (typeof dataType == "string") {
nicholas@2538 53 dataType = dataType.substr(3);
nicholas@2538 54 } else {
nicholas@2852 55 var rest = schema.querySelectorAll("restriction,enumeration");
nicholas@2224 56 if (rest.length > 0) {
nicholas@2224 57 dataType = rest[0].getAttribute("base");
nicholas@2224 58 if (typeof dataType == "string") {
nicholas@2224 59 dataType = dataType.substr(3);
nicholas@2224 60 } else {
nicholas@2224 61 dataType = "string";
nicholas@2224 62 }
nicholas@2224 63 } else {
nicholas@2224 64 dataType = "string";
nicholas@2224 65 }
nicholas@2224 66 }
nicholas@2684 67 if (attribute === null) {
nicholas@2538 68 return attribute;
nicholas@2538 69 }
nicholas@2538 70 switch (dataType) {
nicholas@2538 71 case "boolean":
nicholas@2538 72 if (attribute == 'true') {
nicholas@2538 73 attribute = true;
nicholas@2538 74 } else {
nicholas@2538 75 attribute = false;
nicholas@2538 76 }
nicholas@2538 77 break;
nicholas@2538 78 case "negativeInteger":
nicholas@2538 79 case "positiveInteger":
nicholas@2538 80 case "nonNegativeInteger":
nicholas@2538 81 case "nonPositiveInteger":
nicholas@2538 82 case "integer":
nicholas@2538 83 case "decimal":
nicholas@2538 84 case "short":
nicholas@2538 85 attribute = Number(attribute);
nicholas@2538 86 break;
nicholas@2538 87 default:
nicholas@2538 88 attribute = String(attribute);
nicholas@2538 89 break;
nicholas@2538 90 }
nicholas@2538 91 return attribute;
nicholas@2538 92 };
nicholas@2538 93
nicholas@2687 94 this.processSchema = function (schemaXSD) {
nicholas@2687 95 if (schemaRoot === undefined) {
nicholas@2687 96 schemaString = schemaXSD;
nicholas@2687 97 var parse = new DOMParser();
nicholas@2687 98 schemaRoot = parse.parseFromString(schemaString, 'text/xml');
nicholas@2687 99 Object.defineProperties(this, {
nicholas@2687 100 'schema': {
nicholas@2687 101 'value': schemaRoot
nicholas@2687 102 },
nicholas@2687 103 'schemaString': {
nicholas@2687 104 'value': schemaString
nicholas@2687 105 }
nicholas@2687 106 });
nicholas@2687 107 }
nicholas@2690 108 };
nicholas@2687 109 this.getSchema = function () {
nicholas@2687 110 return schemaRoot;
nicholas@2690 111 };
nicholas@2687 112 this.getSchemaString = function () {
nicholas@2687 113 return schemaString;
nicholas@2690 114 };
nicholas@2687 115
nicholas@2538 116 this.decode = function (projectXML) {
nicholas@2687 117 schemaRoot = this.schema;
nicholas@2538 118 this.errors = [];
nicholas@2538 119 // projectXML - DOM Parsed document
nicholas@2538 120 this.projectXML = projectXML.childNodes[0];
nicholas@2538 121 var setupNode = projectXML.getElementsByTagName('setup')[0];
nicholas@2852 122 var schemaSetup = schemaRoot.querySelector('[name=setup]');
nicholas@2538 123 // First decode the attributes
nicholas@2852 124 var attributes = schemaSetup.querySelectorAll('attribute');
nicholas@2684 125 var i;
nicholas@2684 126 for (i = 0; i < attributes.length; i++) {
nicholas@2538 127 var attributeName = attributes[i].getAttribute('name') || attributes[i].getAttribute('ref');
nicholas@2538 128 var projectAttr = setupNode.getAttribute(attributeName);
nicholas@2692 129 projectAttr = processAttribute(projectAttr, attributes[i]);
nicholas@2687 130 if (projectAttr !== null) {
nicholas@2687 131 this[attributeName] = projectAttr;
nicholas@2538 132 }
nicholas@2538 133
nicholas@2538 134 }
nicholas@2538 135
nicholas@2224 136 var exitTextNode = setupNode.getElementsByTagName('exitText');
nicholas@2224 137 if (exitTextNode.length == 1) {
nicholas@2224 138 this.exitText = exitTextNode[0].textContent;
nicholas@2224 139 }
nicholas@2538 140
nicholas@2538 141 this.metrics.decode(this, setupNode.getElementsByTagName('metric')[0]);
nicholas@2538 142
nicholas@2538 143 // Now process the survey node options
nicholas@2538 144 var survey = setupNode.getElementsByTagName('survey');
nicholas@2684 145 for (i = 0; i < survey.length; i++) {
nicholas@2538 146 var location = survey[i].getAttribute('location');
nicholas@2538 147 switch (location) {
nicholas@2257 148 case 'pre':
nicholas@2257 149 case 'before':
nicholas@2538 150 this.preTest.decode(this, survey[i]);
nicholas@2257 151 break;
nicholas@2257 152 case 'post':
nicholas@2257 153 case 'after':
nicholas@2538 154 this.postTest.decode(this, survey[i]);
nicholas@2257 155 break;
nicholas@2257 156 }
nicholas@2538 157 }
nicholas@2538 158
nicholas@2538 159 var interfaceNode = setupNode.getElementsByTagName('interface');
nicholas@2538 160 if (interfaceNode.length > 1) {
nicholas@2538 161 this.errors.push("Only one <interface> node in the <setup> node allowed! Others except first ingnored!");
nicholas@2538 162 }
nicholas@2854 163
nicholas@2684 164 if (interfaceNode.length !== 0) {
nicholas@2538 165 interfaceNode = interfaceNode[0];
nicholas@2852 166 this.interfaces.decode(this, interfaceNode, this.schema.querySelectorAll('[name=interface]')[1]);
nicholas@2538 167 }
nicholas@2538 168
nicholas@2538 169 // Page tags
nicholas@2538 170 var pageTags = projectXML.getElementsByTagName('page');
nicholas@2852 171 var pageSchema = this.schema.querySelector('[name=page]');
nicholas@2684 172 for (i = 0; i < pageTags.length; i++) {
nicholas@2854 173 var node = new page(this);
nicholas@2538 174 node.decode(this, pageTags[i], pageSchema);
nicholas@2538 175 this.pages.push(node);
nicholas@2538 176 }
nicholas@2538 177 };
nicholas@2538 178
nicholas@2538 179 this.encode = function () {
nicholas@2538 180 var RootDocument = document.implementation.createDocument(null, "waet");
nicholas@2538 181 var root = RootDocument.firstChild;
nicholas@2538 182 root.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
nicholas@2538 183 root.setAttribute("xsi:noNamespaceSchemaLocation", "test-schema.xsd");
nicholas@2538 184 // Build setup node
nicholas@2224 185 var setup = RootDocument.createElement("setup");
nicholas@2852 186 var schemaSetup = schemaRoot.querySelector('[name=setup]');
nicholas@2224 187 // First decode the attributes
nicholas@2852 188 var attributes = schemaSetup.querySelectorAll('attribute');
nicholas@2538 189 for (var i = 0; i < attributes.length; i++) {
nicholas@2224 190 var name = attributes[i].getAttribute("name");
nicholas@2895 191 if (name === null) {
nicholas@2224 192 name = attributes[i].getAttribute("ref");
nicholas@2224 193 }
nicholas@2685 194 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 195 setup.setAttribute(name, this[name]);
nicholas@2224 196 }
nicholas@2224 197 }
nicholas@2224 198 root.appendChild(setup);
nicholas@2224 199 // Survey node
nicholas@2684 200 if (this.exitText !== null) {
nicholas@2224 201 var exitTextNode = RootDocument.createElement('exitText');
nicholas@2224 202 exitTextNode.textContent = this.exitText;
nicholas@2224 203 setup.appendChild(exitTextNode);
nicholas@2224 204 }
nicholas@2224 205 setup.appendChild(this.preTest.encode(RootDocument));
nicholas@2224 206 setup.appendChild(this.postTest.encode(RootDocument));
nicholas@2224 207 setup.appendChild(this.metrics.encode(RootDocument));
nicholas@2224 208 setup.appendChild(this.interfaces.encode(RootDocument));
nicholas@2684 209 this.pages.forEach(function (page) {
nicholas@2224 210 root.appendChild(page.encode(RootDocument));
nicholas@2684 211 });
nicholas@2538 212 return RootDocument;
nicholas@2538 213 };
nicholas@2538 214
nicholas@2854 215 function surveyNode(specification) {
nicholas@2688 216 this.location = undefined;
nicholas@2538 217 this.options = [];
nicholas@2688 218 this.parent = undefined;
nicholas@2224 219 this.specification = specification;
nicholas@2538 220
nicholas@2857 221 this.addOption = function () {
nicholas@2857 222 var node = new this.OptionNode(this.specification);
nicholas@2857 223 this.options.push(node);
nicholas@2857 224 return node;
nicholas@2859 225 };
nicholas@2857 226
nicholas@2538 227 this.OptionNode = function (specification) {
nicholas@2538 228 this.type = undefined;
n@2582 229 this.schema = undefined;
nicholas@2538 230 this.id = undefined;
nicholas@2224 231 this.name = undefined;
nicholas@2538 232 this.mandatory = undefined;
nicholas@2538 233 this.statement = undefined;
nicholas@2538 234 this.boxsize = undefined;
nicholas@2538 235 this.options = [];
nicholas@2538 236 this.min = undefined;
nicholas@2538 237 this.max = undefined;
nicholas@2774 238 this.minWait = undefined;
nicholas@2538 239 this.step = undefined;
nicholas@2464 240 this.conditions = [];
nicholas@2538 241
nicholas@2538 242 this.decode = function (parent, child) {
nicholas@2852 243 this.schema = schemaRoot.querySelector("[name=" + child.nodeName + "]");
nicholas@2852 244 var attributeMap = this.schema.querySelectorAll('attribute');
nicholas@2684 245 var i;
nicholas@2684 246 for (i in attributeMap) {
nicholas@2684 247 if (isNaN(Number(i)) === true) {
nicholas@2538 248 break;
nicholas@2538 249 }
nicholas@2538 250 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 251 var projectAttr = child.getAttribute(attributeName);
nicholas@2692 252 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 253 if (projectAttr !== null) {
nicholas@2687 254 this[attributeName] = projectAttr;
nicholas@2538 255 }
nicholas@2538 256 }
n@2582 257 if (child.nodeName == 'surveyentry') {
n@2582 258 console.log("NOTE - Use of <surveyelement> is now deprecated. Whilst these will still work, newer nodes and tighter error checking will not be enforced");
n@2582 259 console.log("Please use the newer, type specifc nodes");
n@2582 260 if (!this.type) {
n@2582 261 throw ("Type not specified");
n@2582 262 }
n@2582 263 } else {
n@2582 264 this.type = child.nodeName.split('survey')[1];
n@2582 265 }
nicholas@2538 266 this.statement = child.getElementsByTagName('statement')[0].textContent;
nicholas@2538 267 if (this.type == "checkbox" || this.type == "radio") {
nicholas@2538 268 var children = child.getElementsByTagName('option');
nicholas@2684 269 if (children.length === null) {
nicholas@2538 270 console.log('Malformed' + child.nodeName + 'entry');
nicholas@2538 271 this.statement = 'Malformed' + child.nodeName + 'entry';
nicholas@2538 272 this.type = 'statement';
nicholas@2538 273 } else {
nicholas@2538 274 this.options = [];
nicholas@2684 275 for (i = 0; i < children.length; i++) {
nicholas@2538 276 this.options.push({
nicholas@2538 277 name: children[i].getAttribute('name'),
nicholas@2538 278 text: children[i].textContent
nicholas@2538 279 });
nicholas@2538 280 }
nicholas@2538 281 }
n@2582 282 } else if (this.type == "slider") {
n@2582 283 this.leftText = "";
n@2582 284 this.rightText = "";
n@2582 285 var minText = child.getElementsByTagName("minText");
n@2582 286 var maxText = child.getElementsByTagName("maxText");
n@2582 287 if (minText.length > 0) {
n@2582 288 this.leftText = minText[0].textContent;
n@2582 289 }
n@2582 290 if (maxText.length > 0) {
n@2582 291 this.rightText = maxText[0].textContent;
n@2582 292 }
nicholas@2538 293 }
nicholas@2464 294 var conditionElements = child.getElementsByTagName("conditional");
nicholas@2684 295 for (i = 0; i < conditionElements.length; i++) {
nicholas@2464 296 var condition = conditionElements[i];
nicholas@2464 297 var obj = {
nicholas@2464 298 check: condition.getAttribute("check"),
nicholas@2464 299 value: condition.getAttribute("value"),
nicholas@2464 300 jumpToOnPass: condition.getAttribute("jumpToOnPass"),
nicholas@2464 301 jumpToOnFail: condition.getAttribute("jumpToOnFail")
nicholas@2684 302 };
nicholas@2464 303 this.conditions.push(obj);
nicholas@2464 304 }
nicholas@2538 305 };
nicholas@2538 306
nicholas@2538 307 this.exportXML = function (doc) {
n@2583 308 var node = doc.createElement('survey' + this.type);
nicholas@2538 309 var statement = doc.createElement('statement');
nicholas@2538 310 statement.textContent = this.statement;
nicholas@2538 311 node.appendChild(statement);
nicholas@2224 312 node.id = this.id;
nicholas@2684 313 if (this.name !== undefined) {
nicholas@2538 314 node.setAttribute("name", this.name);
nicholas@2538 315 }
nicholas@2684 316 if (this.mandatory !== undefined) {
nicholas@2538 317 node.setAttribute("mandatory", this.mandatory);
nicholas@2538 318 }
nicholas@2224 319 node.id = this.id;
nicholas@2684 320 if (this.name !== undefined) {
nicholas@2538 321 node.setAttribute("name", this.name);
nicholas@2538 322 }
nicholas@2538 323 switch (this.type) {
nicholas@2224 324 case "checkbox":
nicholas@2684 325 if (this.min !== undefined) {
nicholas@2566 326 node.setAttribute("min", this.min);
nicholas@2566 327 } else {
nicholas@2566 328 node.setAttribute("min", "0");
nicholas@2566 329 }
nicholas@2684 330 if (this.max !== undefined) {
nicholas@2566 331 node.setAttribute("max", this.max);
nicholas@2566 332 } else {
nicholas@2573 333 node.setAttribute("max", "undefined");
nicholas@2686 334 } /* falls through */
nicholas@2224 335 case "radio":
nicholas@2538 336 for (var i = 0; i < this.options.length; i++) {
nicholas@2224 337 var option = this.options[i];
nicholas@2224 338 var optionNode = doc.createElement("option");
nicholas@2538 339 optionNode.setAttribute("name", option.name);
nicholas@2224 340 optionNode.textContent = option.text;
nicholas@2224 341 node.appendChild(optionNode);
nicholas@2224 342 }
nicholas@2562 343 break;
nicholas@2224 344 case "number":
nicholas@2684 345 if (this.min !== undefined) {
nicholas@2538 346 node.setAttribute("min", this.min);
nicholas@2538 347 }
nicholas@2684 348 if (this.max !== undefined) {
nicholas@2538 349 node.setAttribute("max", this.max);
nicholas@2538 350 }
nicholas@2562 351 break;
nicholas@2224 352 case "question":
nicholas@2684 353 if (this.boxsize !== undefined) {
nicholas@2538 354 node.setAttribute("boxsize", this.boxsize);
nicholas@2538 355 }
nicholas@2684 356 if (this.mandatory !== undefined) {
nicholas@2538 357 node.setAttribute("mandatory", this.mandatory);
nicholas@2538 358 }
nicholas@2562 359 break;
nicholas@2562 360 case "video":
nicholas@2684 361 if (this.mandatory !== undefined) {
nicholas@2573 362 node.setAttribute("mandatory", this.mandatory);
nicholas@2686 363 } /* falls through */
nicholas@2562 364 case "youtube":
nicholas@2684 365 if (this.url !== undefined) {
nicholas@2573 366 node.setAttribute("url", this.url);
nicholas@2573 367 }
nicholas@2562 368 break;
n@2583 369 case "slider":
n@2583 370 node.setAttribute("min", this.min);
n@2583 371 node.setAttribute("max", this.max);
n@2583 372 if (this.leftText) {
n@2583 373 var minText = doc.createElement("minText");
n@2583 374 minText.textContent = this.leftText;
n@2583 375 node.appendChild(minText);
n@2583 376 }
n@2583 377 if (this.rightText) {
n@2583 378 var maxText = doc.createElement("maxText");
n@2583 379 maxText.textContent = this.rightText;
n@2583 380 node.appendChild(maxText);
n@2583 381 }
nicholas@2686 382 break;
nicholas@2224 383 default:
nicholas@2224 384 break;
nicholas@2224 385 }
nicholas@2684 386 this.conditions.forEach(function (condition) {
nicholas@2465 387 var conditionDOM = doc.createElement("conditional");
nicholas@2538 388 conditionDOM.setAttribute("check", condition.check);
nicholas@2538 389 conditionDOM.setAttribute("value", condition.value);
nicholas@2538 390 conditionDOM.setAttribute("jumpToOnPass", condition.jumpToOnPass);
nicholas@2538 391 conditionDOM.setAttribute("jumpToOnFail", condition.jumpToOnFail);
nicholas@2465 392 node.appendChild(conditionDOM);
nicholas@2684 393 });
nicholas@2538 394 return node;
nicholas@2538 395 };
nicholas@2538 396 };
nicholas@2538 397 this.decode = function (parent, xml) {
nicholas@2857 398 this.schema = schemaRoot.querySelector('[name=survey]');
nicholas@2224 399 this.parent = parent;
nicholas@2538 400 this.location = xml.getAttribute('location');
nicholas@2538 401 if (this.location == 'before') {
nicholas@2538 402 this.location = 'pre';
nicholas@2538 403 } else if (this.location == 'after') {
nicholas@2538 404 this.location = 'post';
nicholas@2538 405 }
nicholas@2684 406 var child = xml.firstElementChild;
n@2582 407 while (child) {
nicholas@2538 408 var node = new this.OptionNode(this.specification);
n@2582 409 node.decode(parent, child);
nicholas@2538 410 this.options.push(node);
n@2582 411 child = child.nextElementSibling;
nicholas@2538 412 }
nicholas@2684 413 if (this.options.length === 0) {
nicholas@2257 414 console.log("Empty survey node");
nicholas@2257 415 console.log(this);
nicholas@2257 416 }
nicholas@2538 417 };
nicholas@2538 418 this.encode = function (doc) {
nicholas@2538 419 var node = doc.createElement('survey');
nicholas@2538 420 node.setAttribute('location', this.location);
nicholas@2538 421 for (var i = 0; i < this.options.length; i++) {
nicholas@2538 422 node.appendChild(this.options[i].exportXML(doc));
nicholas@2538 423 }
nicholas@2538 424 return node;
nicholas@2538 425 };
nicholas@2859 426 }
nicholas@2538 427
nicholas@2854 428 function interfaceNode(specification) {
nicholas@2688 429 this.title = undefined;
nicholas@2688 430 this.name = undefined;
nicholas@2777 431 this.image = undefined;
nicholas@2538 432 this.options = [];
nicholas@2538 433 this.scales = [];
nicholas@2854 434 this.schema = undefined;
nicholas@2538 435
nicholas@2538 436 this.decode = function (parent, xml) {
nicholas@2854 437 this.schema = schemaRoot.querySelectorAll('[name=interface]')[1];
nicholas@2538 438 this.name = xml.getAttribute('name');
nicholas@2538 439 var titleNode = xml.getElementsByTagName('title');
nicholas@2538 440 if (titleNode.length == 1) {
nicholas@2538 441 this.title = titleNode[0].textContent;
nicholas@2538 442 }
nicholas@2538 443 var interfaceOptionNodes = xml.getElementsByTagName('interfaceoption');
nicholas@2538 444 // Extract interfaceoption node schema
nicholas@2852 445 var interfaceOptionNodeSchema = this.schema.querySelector('[name=interfaceoption]');
nicholas@2852 446 var attributeMap = interfaceOptionNodeSchema.querySelectorAll('attribute');
nicholas@2684 447 var i, j;
nicholas@2684 448 for (i = 0; i < interfaceOptionNodes.length; i++) {
nicholas@2538 449 var ioNode = interfaceOptionNodes[i];
nicholas@2538 450 var option = {};
nicholas@2684 451 for (j = 0; j < attributeMap.length; j++) {
nicholas@2538 452 var attributeName = attributeMap[j].getAttribute('name') || attributeMap[j].getAttribute('ref');
nicholas@2538 453 var projectAttr = ioNode.getAttribute(attributeName);
nicholas@2692 454 projectAttr = processAttribute(projectAttr, attributeMap[j]);
nicholas@2687 455 if (projectAttr !== null) {
nicholas@2688 456 option[attributeName] = projectAttr;
nicholas@2538 457 }
nicholas@2538 458 }
n@2787 459 if (option.type == "check" && ioNode.firstElementChild) {
n@2787 460 option.errorMessage = ioNode.firstElementChild.textContent;
n@2787 461 }
nicholas@2538 462 this.options.push(option);
nicholas@2538 463 }
nicholas@2777 464 // Get the image node
nicholas@2777 465 var imageNode = xml.getElementsByTagName("image");
nicholas@2777 466 if (imageNode.length == 1) {
nicholas@2777 467 this.image = imageNode[0].getAttribute("src");
nicholas@2777 468 }
nicholas@2538 469 // Now the scales nodes
nicholas@2538 470 var scaleParent = xml.getElementsByTagName('scales');
nicholas@2538 471 if (scaleParent.length == 1) {
nicholas@2538 472 scaleParent = scaleParent[0];
nicholas@2852 473 var scalelabels = scaleParent.querySelectorAll('scalelabel');
nicholas@2684 474 for (i = 0; i < scalelabels.length; i++) {
nicholas@2538 475 this.scales.push({
nicholas@2538 476 text: scalelabels[i].textContent,
nicholas@2538 477 position: Number(scalelabels[i].getAttribute('position'))
nicholas@2538 478 });
nicholas@2538 479 }
nicholas@2538 480 }
nicholas@2538 481 };
nicholas@2538 482
nicholas@2538 483 this.encode = function (doc) {
nicholas@2538 484 var node = doc.createElement("interface");
nicholas@2684 485 if (typeof this.name == "string" && this.name.length > 0)
nicholas@2538 486 node.setAttribute("name", this.name);
nicholas@2243 487 if (typeof this.title == "string") {
nicholas@2243 488 var titleNode = doc.createElement("title");
nicholas@2243 489 titleNode.textContent = this.title;
nicholas@2243 490 node.appendChild(titleNode);
nicholas@2243 491 }
nicholas@2684 492 this.options.forEach(function (option) {
nicholas@2224 493 var child = doc.createElement("interfaceoption");
nicholas@2538 494 child.setAttribute("type", option.type);
nicholas@2538 495 child.setAttribute("name", option.name);
n@2788 496 if (option.type == "check" && option.errorMessage !== undefined) {
n@2788 497 var errorMessage = doc.createElement("errormessage");
n@2788 498 errorMessage.textContent = option.errorMessage;
n@2788 499 child.appendChild(errorMessage);
n@2788 500 }
nicholas@2224 501 node.appendChild(child);
nicholas@2684 502 });
nicholas@2780 503 if (typeof this.image == "string" && this.image.length !== 0) {
nicholas@2780 504 var imgNode = doc.createElement("image");
nicholas@2780 505 imgNode.setAttribute("src", this.image);
nicholas@2780 506 node.appendChild(imgNode);
nicholas@2780 507 }
nicholas@2684 508 if (this.scales.length !== 0) {
nicholas@2224 509 var scales = doc.createElement("scales");
nicholas@2684 510 this.scales.forEach(function (scale) {
nicholas@2224 511 var child = doc.createElement("scalelabel");
nicholas@2538 512 child.setAttribute("position", scale.position);
nicholas@2224 513 child.textContent = scale.text;
nicholas@2224 514 scales.appendChild(child);
nicholas@2684 515 });
nicholas@2224 516 node.appendChild(scales);
nicholas@2224 517 }
nicholas@2224 518 return node;
nicholas@2538 519 };
nicholas@2859 520 }
nicholas@2538 521
nicholas@2854 522 function metricNode() {
nicholas@2224 523 this.enabled = [];
nicholas@2538 524 this.decode = function (parent, xml) {
nicholas@2224 525 var children = xml.getElementsByTagName('metricenable');
nicholas@2538 526 for (var i in children) {
nicholas@2684 527 if (isNaN(Number(i)) === true) {
nicholas@2538 528 break;
nicholas@2538 529 }
nicholas@2224 530 this.enabled.push(children[i].textContent);
nicholas@2224 531 }
nicholas@2684 532 };
nicholas@2538 533 this.encode = function (doc) {
nicholas@2224 534 var node = doc.createElement('metric');
nicholas@2538 535 for (var i in this.enabled) {
nicholas@2684 536 if (isNaN(Number(i)) === true) {
nicholas@2538 537 break;
nicholas@2538 538 }
nicholas@2224 539 var child = doc.createElement('metricenable');
nicholas@2224 540 child.textContent = this.enabled[i];
nicholas@2224 541 node.appendChild(child);
nicholas@2224 542 }
nicholas@2224 543 return node;
nicholas@2684 544 };
nicholas@2859 545 }
nicholas@2538 546
nicholas@2854 547 function page(specification) {
nicholas@2538 548 this.presentedId = undefined;
nicholas@2538 549 this.id = undefined;
nicholas@2470 550 this.title = undefined;
nicholas@2538 551 this.hostURL = undefined;
nicholas@2538 552 this.randomiseOrder = undefined;
nicholas@2538 553 this.loop = undefined;
nicholas@2688 554 this.outsideReference = undefined;
nicholas@2688 555 this.loudness = undefined;
nicholas@2688 556 this.label = undefined;
nicholas@2688 557 this.labelStart = undefined;
nicholas@2857 558 this.preTest = new surveyNode(specification);
nicholas@2857 559 this.postTest = new surveyNode(specification);
nicholas@2866 560 this.preTest.location = "pre";
nicholas@2866 561 this.postTest.location = "post";
nicholas@2538 562 this.interfaces = [];
nicholas@2688 563 this.playOne = undefined;
nicholas@2688 564 this.restrictMovement = undefined;
n@2713 565 this.position = undefined;
nicholas@2538 566 this.commentBoxPrefix = "Comment on track";
nicholas@2822 567 this.minNumberPlays = undefined;
nicholas@2822 568 this.maxNumberPlays = undefined;
nicholas@2538 569 this.audioElements = [];
nicholas@2538 570 this.commentQuestions = [];
nicholas@2852 571 this.schema = schemaRoot.querySelector("[name=page]");
nicholas@2224 572 this.specification = specification;
nicholas@2688 573 this.parent = undefined;
nicholas@2538 574
nicholas@2859 575 this.addInterface = function () {
nicholas@2859 576 var node = new interfaceNode(specification);
nicholas@2859 577 this.interfaces.push(node);
nicholas@2859 578 return node;
nicholas@2859 579 };
nicholas@2859 580 this.addCommentQuestion = function () {
nicholas@2859 581 var node = new commentQuestionNode(specification);
nicholas@2859 582 this.commentQuestions.push(node);
nicholas@2859 583 return node;
nicholas@2859 584 };
nicholas@2859 585 this.addAudioElement = function () {
nicholas@2859 586 var node = new audioElementNode(specification);
nicholas@2859 587 this.audioElements.push(node);
nicholas@2859 588 return node;
nicholas@2859 589 };
nicholas@2859 590
nicholas@2538 591 this.decode = function (parent, xml) {
nicholas@2224 592 this.parent = parent;
nicholas@2852 593 var attributeMap = this.schema.querySelectorAll('attribute');
nicholas@2684 594 var i, node;
nicholas@2684 595 for (i = 0; i < attributeMap.length; i++) {
nicholas@2538 596 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 597 var projectAttr = xml.getAttribute(attributeName);
nicholas@2692 598 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 599 if (projectAttr !== null) {
nicholas@2687 600 this[attributeName] = projectAttr;
nicholas@2538 601 }
nicholas@2538 602 }
nicholas@2538 603
nicholas@2470 604 // Get the title
nicholas@2470 605 var title = xml.getElementsByTagName('title');
nicholas@2684 606 if (title.length !== 0 && title[0].parentElement == xml) {
nicholas@2470 607 this.title = title[0].textContent;
nicholas@2470 608 }
nicholas@2538 609
nicholas@2538 610 // Get the Comment Box Prefix
nicholas@2538 611 var CBP = xml.getElementsByTagName('commentboxprefix');
nicholas@2684 612 if (CBP.length !== 0 && CBP[0].parentElement == xml) {
nicholas@2538 613 this.commentBoxPrefix = CBP[0].textContent;
nicholas@2538 614 }
nicholas@2538 615
nicholas@2538 616 // Now decode the interfaces
nicholas@2854 617 var interfaceNodes = xml.getElementsByTagName('interface');
nicholas@2854 618 for (i = 0; i < interfaceNodes.length; i++) {
nicholas@2854 619 node = new interfaceNode(this.specification);
nicholas@2854 620 node.decode(this, interfaceNodes[i], parent.schema.querySelectorAll('[name=interface]')[1]);
nicholas@2538 621 this.interfaces.push(node);
nicholas@2538 622 }
nicholas@2538 623
nicholas@2538 624 // Now process the survey node options
nicholas@2538 625 var survey = xml.getElementsByTagName('survey');
nicholas@2852 626 var surveySchema = parent.schema.querySelector('[name=survey]');
nicholas@2684 627 for (i = 0; i < survey.length; i++) {
nicholas@2538 628 var location = survey[i].getAttribute('location');
nicholas@2538 629 if (location == 'pre' || location == 'before') {
nicholas@2857 630 if (this.preTest.options.length !== 0) {
nicholas@2538 631 this.errors.push("Already a pre/before test survey defined! Ignoring second!!");
nicholas@2538 632 } else {
nicholas@2538 633 this.preTest.decode(parent, survey[i], surveySchema);
nicholas@2538 634 }
nicholas@2538 635 } else if (location == 'post' || location == 'after') {
nicholas@2857 636 if (this.postTest.options.length !== 0) {
nicholas@2538 637 this.errors.push("Already a post/after test survey defined! Ignoring second!!");
nicholas@2538 638 } else {
nicholas@2538 639 this.postTest.decode(parent, survey[i], surveySchema);
nicholas@2538 640 }
nicholas@2538 641 }
nicholas@2538 642 }
nicholas@2538 643
nicholas@2538 644 // Now process the audioelement tags
nicholas@2538 645 var audioElements = xml.getElementsByTagName('audioelement');
nicholas@2684 646 for (i = 0; i < audioElements.length; i++) {
nicholas@2854 647 var audioNode = new audioElementNode(this.specification);
nicholas@2684 648 audioNode.decode(this, audioElements[i]);
nicholas@2684 649 this.audioElements.push(audioNode);
nicholas@2538 650 }
nicholas@2538 651
nicholas@2538 652 // Now decode the commentquestions
n@2579 653 var cqNode = xml.getElementsByTagName('commentquestions');
nicholas@2684 654 if (cqNode.length !== 0) {
n@2579 655 cqNode = cqNode[0];
nicholas@2644 656 var commentQuestion = cqNode.firstElementChild;
nicholas@2644 657 while (commentQuestion) {
nicholas@2854 658 node = new commentQuestionNode(this.specification);
nicholas@2644 659 node.decode(parent, commentQuestion);
n@2579 660 this.commentQuestions.push(node);
nicholas@2644 661 commentQuestion = commentQuestion.nextElementSibling;
n@2579 662 }
nicholas@2538 663 }
nicholas@2538 664 };
nicholas@2538 665
nicholas@2538 666 this.encode = function (root) {
nicholas@2538 667 var AHNode = root.createElement("page");
nicholas@2224 668 // First decode the attributes
nicholas@2852 669 var attributes = this.schema.querySelectorAll('attribute');
nicholas@2684 670 var i;
nicholas@2684 671 for (i = 0; i < attributes.length; i++) {
nicholas@2224 672 var name = attributes[i].getAttribute("name");
nicholas@2688 673 if (name === null) {
nicholas@2224 674 name = attributes[i].getAttribute("ref");
nicholas@2224 675 }
nicholas@2685 676 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 677 AHNode.setAttribute(name, this[name]);
nicholas@2224 678 }
nicholas@2224 679 }
nicholas@2224 680 // <commentboxprefix>
nicholas@2224 681 var commentboxprefix = root.createElement("commentboxprefix");
nicholas@2224 682 commentboxprefix.textContent = this.commentBoxPrefix;
nicholas@2224 683 AHNode.appendChild(commentboxprefix);
nicholas@2538 684
nicholas@2684 685 for (i = 0; i < this.interfaces.length; i++) {
nicholas@2538 686 AHNode.appendChild(this.interfaces[i].encode(root));
nicholas@2538 687 }
nicholas@2538 688
nicholas@2684 689 for (i = 0; i < this.audioElements.length; i++) {
nicholas@2538 690 AHNode.appendChild(this.audioElements[i].encode(root));
nicholas@2538 691 }
nicholas@2538 692 // Create <CommentQuestion>
nicholas@2684 693 for (i = 0; i < this.commentQuestions.length; i++) {
nicholas@2538 694 AHNode.appendChild(this.commentQuestions[i].encode(root));
nicholas@2538 695 }
nicholas@2538 696
nicholas@2538 697 AHNode.appendChild(this.preTest.encode(root));
nicholas@2224 698 AHNode.appendChild(this.postTest.encode(root));
nicholas@2538 699 return AHNode;
nicholas@2538 700 };
nicholas@2538 701
nicholas@2854 702 function commentQuestionNode(specification) {
nicholas@2688 703 this.id = undefined;
nicholas@2224 704 this.name = undefined;
nicholas@2538 705 this.type = undefined;
nicholas@2538 706 this.statement = undefined;
nicholas@2852 707 this.schema = schemaRoot.querySelector('[name=commentquestion]');
nicholas@2538 708 this.decode = function (parent, xml) {
nicholas@2538 709 this.id = xml.id;
nicholas@2224 710 this.name = xml.getAttribute('name');
nicholas@2688 711 if (this.name === null) {
nicholas@2688 712 this.name = undefined;
nicholas@2688 713 }
n@2579 714 switch (xml.nodeName) {
n@2579 715 case "commentradio":
n@2579 716 this.type = "radio";
n@2579 717 this.options = [];
n@2579 718 break;
n@2579 719 case "commentcheckbox":
n@2579 720 this.type = "checkbox";
n@2579 721 this.options = [];
n@2579 722 break;
n@2579 723 case "commentslider":
n@2579 724 this.type = "slider";
n@2579 725 this.min = undefined;
n@2579 726 this.max = undefined;
n@2579 727 this.step = undefined;
n@2579 728 break;
n@2579 729 case "commentquestion":
n@2579 730 this.type = "question";
n@2579 731 break;
nicholas@2686 732 default:
nicholas@2686 733 throw ("Unknown comment type " + xml.nodeName);
n@2579 734 }
nicholas@2538 735 this.statement = xml.getElementsByTagName('statement')[0].textContent;
n@2579 736 if (this.type == "radio" || this.type == "checkbox") {
n@2579 737 var optNodes = xml.getElementsByTagName('option');
n@2579 738 for (var i = 0; i < optNodes.length; i++) {
n@2579 739 var optNode = optNodes[i];
n@2579 740 this.options.push({
n@2579 741 name: optNode.getAttribute('name'),
n@2579 742 text: optNode.textContent
n@2579 743 });
n@2579 744 }
n@2579 745 }
n@2579 746 if (this.type == "slider") {
n@2579 747 this.min = Number(xml.getAttribute("min"));
n@2579 748 this.max = Number(xml.getAttribute("max"));
n@2579 749 this.step = Number(xml.getAttribute("step"));
nicholas@2684 750 if (this.step === undefined) {
n@2579 751 this.step = 1;
n@2579 752 }
n@2579 753 this.value = Number(xml.getAttribute("value"));
nicholas@2684 754 if (this.value === undefined) {
nicholas@2684 755 this.value = this.min;
n@2579 756 }
n@2580 757 this.leftText = xml.getElementsByTagName("minText");
n@2580 758 if (this.leftText && this.leftText.length > 0) {
n@2580 759 this.leftText = this.leftText[0].textContent;
n@2580 760 } else {
n@2580 761 this.leftText = "";
n@2580 762 }
n@2580 763 this.rightText = xml.getElementsByTagName("maxText");
n@2580 764 if (this.rightText && this.rightText.length > 0) {
n@2580 765 this.rightText = this.rightText[0].textContent;
n@2580 766 } else {
n@2580 767 this.rightText = "";
n@2580 768 }
nicholas@2538 769 }
nicholas@2538 770 };
nicholas@2538 771
nicholas@2538 772 this.encode = function (root) {
n@2579 773 var node;
n@2579 774 switch (this.type) {
n@2579 775 case "radio":
n@2579 776 node = root.createElement("commentradio");
n@2579 777 break;
n@2579 778 case "checkbox":
n@2579 779 node = root.createElement("commentcheckbox");
n@2579 780 break;
n@2579 781 case "slider":
n@2579 782 node = root.createElement("commentslider");
n@2579 783 break;
n@2579 784 case "question":
n@2579 785 node = root.createElement("commentquestion");
n@2579 786 break;
nicholas@2686 787 default:
nicholas@2686 788 throw ("Unknown type " + this.type);
n@2579 789 }
nicholas@2224 790 node.id = this.id;
nicholas@2538 791 node.setAttribute("type", this.type);
nicholas@2684 792 if (this.name !== undefined) {
nicholas@2538 793 node.setAttribute("name", this.name);
nicholas@2538 794 }
nicholas@2224 795 var statement = root.createElement("statement");
nicholas@2224 796 statement.textContent = this.statement;
nicholas@2224 797 node.appendChild(statement);
n@2579 798 if (this.type == "radio" || this.type == "checkbox") {
nicholas@2684 799 this.options.forEach(function (option) {
n@2579 800 var child = root.createElement("option");
n@2579 801 child.setAttribute("name", option.name);
n@2579 802 child.textContent = option.text;
n@2579 803 node.appendChild(child);
nicholas@2684 804 });
n@2579 805 }
n@2579 806 if (this.type == "slider") {
n@2579 807 node.setAttribute("min", this.min);
n@2579 808 node.setAttribute("max", this.max);
n@2579 809 if (this.step !== 1) {
n@2579 810 node.setAttribute("step", this.step);
n@2579 811 }
n@2579 812 if (this.value !== this.min) {
n@2579 813 node.setAttribute("value", this.value);
n@2579 814 }
n@2580 815 if (this.leftText.length > 0) {
n@2580 816 var leftText = root.createElement("minText");
n@2580 817 leftText.textContent = this.leftText;
n@2580 818 node.appendChild(leftText);
n@2580 819 }
n@2580 820 if (this.rightText.length > 0) {
n@2580 821 var rightText = root.createElement("maxText");
n@2580 822 rightText.textContent = this.rightText;
n@2580 823 node.appendChild(rightText);
n@2580 824 }
nicholas@2224 825 }
nicholas@2224 826 return node;
nicholas@2538 827 };
nicholas@2859 828 }
nicholas@2538 829
nicholas@2854 830 function audioElementNode(specification) {
nicholas@2688 831 this.url = undefined;
nicholas@2688 832 this.id = undefined;
nicholas@2688 833 this.name = undefined;
nicholas@2688 834 this.parent = undefined;
nicholas@2688 835 this.type = undefined;
nicholas@2688 836 this.marker = undefined;
nicholas@2538 837 this.enforce = false;
nicholas@2538 838 this.gain = 0.0;
nicholas@2688 839 this.label = undefined;
nicholas@2460 840 this.startTime = undefined;
nicholas@2460 841 this.stopTime = undefined;
nicholas@2614 842 this.sampleRate = undefined;
nicholas@2777 843 this.image = undefined;
nicholas@2822 844 this.minNumberPlays = undefined;
nicholas@2822 845 this.maxNumberPlays = undefined;
nicholas@2614 846 this.alternatives = [];
nicholas@2852 847 this.schema = schemaRoot.querySelector('[name=audioelement]');
nicholas@2688 848 this.parent = undefined;
nicholas@2538 849 this.decode = function (parent, xml) {
nicholas@2538 850 this.parent = parent;
nicholas@2852 851 var attributeMap = this.schema.querySelectorAll('attribute');
nicholas@2538 852 for (var i = 0; i < attributeMap.length; i++) {
nicholas@2538 853 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 854 var projectAttr = xml.getAttribute(attributeName);
nicholas@2692 855 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 856 if (projectAttr !== null) {
nicholas@2687 857 this[attributeName] = projectAttr;
nicholas@2538 858 }
nicholas@2538 859 }
nicholas@2614 860 // Get the alternative nodes
nicholas@2614 861 var child = xml.firstElementChild;
nicholas@2614 862 while (child) {
nicholas@2614 863 if (child.nodeName == "alternative") {
nicholas@2614 864 this.alternatives.push({
nicholas@2614 865 'url': child.getAttribute("url"),
nicholas@2614 866 'sampleRate': child.getAttribute("sampleRate")
nicholas@2614 867 });
nicholas@2614 868 }
nicholas@2614 869 child = child.nextElementSibling;
nicholas@2614 870 }
nicholas@2538 871
nicholas@2538 872 };
nicholas@2538 873 this.encode = function (root) {
nicholas@2538 874 var AENode = root.createElement("audioelement");
nicholas@2852 875 var attributes = this.schema.querySelectorAll('attribute');
nicholas@2538 876 for (var i = 0; i < attributes.length; i++) {
nicholas@2224 877 var name = attributes[i].getAttribute("name");
nicholas@2688 878 if (name === null) {
nicholas@2224 879 name = attributes[i].getAttribute("ref");
nicholas@2224 880 }
nicholas@2685 881 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 882 AENode.setAttribute(name, this[name]);
nicholas@2224 883 }
nicholas@2224 884 }
nicholas@2614 885 this.alternatives.forEach(function (alt) {
nicholas@2614 886 var node = root.createElement("alternative");
nicholas@2614 887 node.setAttribute("url", alt.url);
nicholas@2614 888 node.setAttribute("sampleRate", alt.sampleRate);
nicholas@2614 889 AENode.appendChild(node);
nicholas@2614 890 });
nicholas@2538 891 return AENode;
nicholas@2538 892 };
nicholas@2859 893 }
nicholas@2859 894 }
b@2437 895 }