annotate js/specification.js @ 2941:cccb9c312b5d

#241 Fixed repeatCount inactive
author Nicholas Jillings <nicholas.jillings@mail.bcu.ac.uk>
date Mon, 25 Sep 2017 09:35:00 +0100
parents 2eec0c37b4cb
children 192538967e67
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@2941 176 for (var r = 0; r < node.repeatCount; r++) {
nicholas@2941 177 var repeat = new page(this);
nicholas@2941 178 repeat.decode(this, pageTags[i], pageSchema);
nicholas@2941 179 repeat.id += "-repeat-" + r;
nicholas@2941 180 this.pages.push(repeat);
nicholas@2941 181 }
nicholas@2538 182 }
nicholas@2538 183 };
nicholas@2538 184
nicholas@2538 185 this.encode = function () {
nicholas@2538 186 var RootDocument = document.implementation.createDocument(null, "waet");
nicholas@2538 187 var root = RootDocument.firstChild;
nicholas@2538 188 root.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
nicholas@2538 189 root.setAttribute("xsi:noNamespaceSchemaLocation", "test-schema.xsd");
nicholas@2538 190 // Build setup node
nicholas@2224 191 var setup = RootDocument.createElement("setup");
nicholas@2852 192 var schemaSetup = schemaRoot.querySelector('[name=setup]');
nicholas@2224 193 // First decode the attributes
nicholas@2852 194 var attributes = schemaSetup.querySelectorAll('attribute');
nicholas@2538 195 for (var i = 0; i < attributes.length; i++) {
nicholas@2224 196 var name = attributes[i].getAttribute("name");
nicholas@2895 197 if (name === null) {
nicholas@2224 198 name = attributes[i].getAttribute("ref");
nicholas@2224 199 }
nicholas@2685 200 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 201 setup.setAttribute(name, this[name]);
nicholas@2224 202 }
nicholas@2224 203 }
nicholas@2224 204 root.appendChild(setup);
nicholas@2224 205 // Survey node
nicholas@2684 206 if (this.exitText !== null) {
nicholas@2224 207 var exitTextNode = RootDocument.createElement('exitText');
nicholas@2224 208 exitTextNode.textContent = this.exitText;
nicholas@2224 209 setup.appendChild(exitTextNode);
nicholas@2224 210 }
nicholas@2224 211 setup.appendChild(this.preTest.encode(RootDocument));
nicholas@2224 212 setup.appendChild(this.postTest.encode(RootDocument));
nicholas@2224 213 setup.appendChild(this.metrics.encode(RootDocument));
nicholas@2224 214 setup.appendChild(this.interfaces.encode(RootDocument));
nicholas@2684 215 this.pages.forEach(function (page) {
nicholas@2224 216 root.appendChild(page.encode(RootDocument));
nicholas@2684 217 });
nicholas@2538 218 return RootDocument;
nicholas@2538 219 };
nicholas@2538 220
nicholas@2854 221 function surveyNode(specification) {
nicholas@2688 222 this.location = undefined;
nicholas@2538 223 this.options = [];
nicholas@2688 224 this.parent = undefined;
nicholas@2224 225 this.specification = specification;
nicholas@2538 226
nicholas@2857 227 this.addOption = function () {
nicholas@2857 228 var node = new this.OptionNode(this.specification);
nicholas@2857 229 this.options.push(node);
nicholas@2857 230 return node;
nicholas@2859 231 };
nicholas@2857 232
nicholas@2538 233 this.OptionNode = function (specification) {
nicholas@2538 234 this.type = undefined;
n@2582 235 this.schema = undefined;
nicholas@2538 236 this.id = undefined;
nicholas@2224 237 this.name = undefined;
nicholas@2538 238 this.mandatory = undefined;
nicholas@2538 239 this.statement = undefined;
nicholas@2538 240 this.boxsize = undefined;
nicholas@2538 241 this.options = [];
nicholas@2538 242 this.min = undefined;
nicholas@2538 243 this.max = undefined;
nicholas@2774 244 this.minWait = undefined;
nicholas@2538 245 this.step = undefined;
nicholas@2464 246 this.conditions = [];
nicholas@2538 247
nicholas@2538 248 this.decode = function (parent, child) {
nicholas@2852 249 this.schema = schemaRoot.querySelector("[name=" + child.nodeName + "]");
nicholas@2852 250 var attributeMap = this.schema.querySelectorAll('attribute');
nicholas@2684 251 var i;
nicholas@2684 252 for (i in attributeMap) {
nicholas@2684 253 if (isNaN(Number(i)) === true) {
nicholas@2538 254 break;
nicholas@2538 255 }
nicholas@2538 256 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 257 var projectAttr = child.getAttribute(attributeName);
nicholas@2692 258 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 259 if (projectAttr !== null) {
nicholas@2687 260 this[attributeName] = projectAttr;
nicholas@2538 261 }
nicholas@2538 262 }
n@2582 263 if (child.nodeName == 'surveyentry') {
n@2582 264 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 265 console.log("Please use the newer, type specifc nodes");
n@2582 266 if (!this.type) {
n@2582 267 throw ("Type not specified");
n@2582 268 }
n@2582 269 } else {
n@2582 270 this.type = child.nodeName.split('survey')[1];
n@2582 271 }
nicholas@2538 272 this.statement = child.getElementsByTagName('statement')[0].textContent;
nicholas@2538 273 if (this.type == "checkbox" || this.type == "radio") {
nicholas@2538 274 var children = child.getElementsByTagName('option');
nicholas@2684 275 if (children.length === null) {
nicholas@2538 276 console.log('Malformed' + child.nodeName + 'entry');
nicholas@2538 277 this.statement = 'Malformed' + child.nodeName + 'entry';
nicholas@2538 278 this.type = 'statement';
nicholas@2538 279 } else {
nicholas@2538 280 this.options = [];
nicholas@2684 281 for (i = 0; i < children.length; i++) {
nicholas@2538 282 this.options.push({
nicholas@2538 283 name: children[i].getAttribute('name'),
nicholas@2538 284 text: children[i].textContent
nicholas@2538 285 });
nicholas@2538 286 }
nicholas@2538 287 }
n@2582 288 } else if (this.type == "slider") {
n@2582 289 this.leftText = "";
n@2582 290 this.rightText = "";
n@2582 291 var minText = child.getElementsByTagName("minText");
n@2582 292 var maxText = child.getElementsByTagName("maxText");
n@2582 293 if (minText.length > 0) {
n@2582 294 this.leftText = minText[0].textContent;
n@2582 295 }
n@2582 296 if (maxText.length > 0) {
n@2582 297 this.rightText = maxText[0].textContent;
n@2582 298 }
nicholas@2538 299 }
nicholas@2464 300 var conditionElements = child.getElementsByTagName("conditional");
nicholas@2684 301 for (i = 0; i < conditionElements.length; i++) {
nicholas@2464 302 var condition = conditionElements[i];
nicholas@2464 303 var obj = {
nicholas@2464 304 check: condition.getAttribute("check"),
nicholas@2464 305 value: condition.getAttribute("value"),
nicholas@2464 306 jumpToOnPass: condition.getAttribute("jumpToOnPass"),
nicholas@2464 307 jumpToOnFail: condition.getAttribute("jumpToOnFail")
nicholas@2684 308 };
nicholas@2464 309 this.conditions.push(obj);
nicholas@2464 310 }
nicholas@2538 311 };
nicholas@2538 312
nicholas@2538 313 this.exportXML = function (doc) {
n@2583 314 var node = doc.createElement('survey' + this.type);
nicholas@2538 315 var statement = doc.createElement('statement');
nicholas@2538 316 statement.textContent = this.statement;
nicholas@2538 317 node.appendChild(statement);
nicholas@2224 318 node.id = this.id;
nicholas@2684 319 if (this.name !== undefined) {
nicholas@2538 320 node.setAttribute("name", this.name);
nicholas@2538 321 }
nicholas@2684 322 if (this.mandatory !== undefined) {
nicholas@2538 323 node.setAttribute("mandatory", this.mandatory);
nicholas@2538 324 }
nicholas@2224 325 node.id = this.id;
nicholas@2684 326 if (this.name !== undefined) {
nicholas@2538 327 node.setAttribute("name", this.name);
nicholas@2538 328 }
nicholas@2538 329 switch (this.type) {
nicholas@2224 330 case "checkbox":
nicholas@2684 331 if (this.min !== undefined) {
nicholas@2566 332 node.setAttribute("min", this.min);
nicholas@2566 333 } else {
nicholas@2566 334 node.setAttribute("min", "0");
nicholas@2566 335 }
nicholas@2684 336 if (this.max !== undefined) {
nicholas@2566 337 node.setAttribute("max", this.max);
nicholas@2566 338 } else {
nicholas@2573 339 node.setAttribute("max", "undefined");
nicholas@2686 340 } /* falls through */
nicholas@2224 341 case "radio":
nicholas@2538 342 for (var i = 0; i < this.options.length; i++) {
nicholas@2224 343 var option = this.options[i];
nicholas@2224 344 var optionNode = doc.createElement("option");
nicholas@2538 345 optionNode.setAttribute("name", option.name);
nicholas@2224 346 optionNode.textContent = option.text;
nicholas@2224 347 node.appendChild(optionNode);
nicholas@2224 348 }
nicholas@2562 349 break;
nicholas@2224 350 case "number":
nicholas@2684 351 if (this.min !== undefined) {
nicholas@2538 352 node.setAttribute("min", this.min);
nicholas@2538 353 }
nicholas@2684 354 if (this.max !== undefined) {
nicholas@2538 355 node.setAttribute("max", this.max);
nicholas@2538 356 }
nicholas@2562 357 break;
nicholas@2224 358 case "question":
nicholas@2684 359 if (this.boxsize !== undefined) {
nicholas@2538 360 node.setAttribute("boxsize", this.boxsize);
nicholas@2538 361 }
nicholas@2684 362 if (this.mandatory !== undefined) {
nicholas@2538 363 node.setAttribute("mandatory", this.mandatory);
nicholas@2538 364 }
nicholas@2562 365 break;
nicholas@2562 366 case "video":
nicholas@2684 367 if (this.mandatory !== undefined) {
nicholas@2573 368 node.setAttribute("mandatory", this.mandatory);
nicholas@2686 369 } /* falls through */
nicholas@2562 370 case "youtube":
nicholas@2684 371 if (this.url !== undefined) {
nicholas@2573 372 node.setAttribute("url", this.url);
nicholas@2573 373 }
nicholas@2562 374 break;
n@2583 375 case "slider":
n@2583 376 node.setAttribute("min", this.min);
n@2583 377 node.setAttribute("max", this.max);
n@2583 378 if (this.leftText) {
n@2583 379 var minText = doc.createElement("minText");
n@2583 380 minText.textContent = this.leftText;
n@2583 381 node.appendChild(minText);
n@2583 382 }
n@2583 383 if (this.rightText) {
n@2583 384 var maxText = doc.createElement("maxText");
n@2583 385 maxText.textContent = this.rightText;
n@2583 386 node.appendChild(maxText);
n@2583 387 }
nicholas@2686 388 break;
nicholas@2224 389 default:
nicholas@2224 390 break;
nicholas@2224 391 }
nicholas@2684 392 this.conditions.forEach(function (condition) {
nicholas@2465 393 var conditionDOM = doc.createElement("conditional");
nicholas@2538 394 conditionDOM.setAttribute("check", condition.check);
nicholas@2538 395 conditionDOM.setAttribute("value", condition.value);
nicholas@2538 396 conditionDOM.setAttribute("jumpToOnPass", condition.jumpToOnPass);
nicholas@2538 397 conditionDOM.setAttribute("jumpToOnFail", condition.jumpToOnFail);
nicholas@2465 398 node.appendChild(conditionDOM);
nicholas@2684 399 });
nicholas@2538 400 return node;
nicholas@2538 401 };
nicholas@2538 402 };
nicholas@2538 403 this.decode = function (parent, xml) {
nicholas@2857 404 this.schema = schemaRoot.querySelector('[name=survey]');
nicholas@2224 405 this.parent = parent;
nicholas@2538 406 this.location = xml.getAttribute('location');
nicholas@2538 407 if (this.location == 'before') {
nicholas@2538 408 this.location = 'pre';
nicholas@2538 409 } else if (this.location == 'after') {
nicholas@2538 410 this.location = 'post';
nicholas@2538 411 }
nicholas@2684 412 var child = xml.firstElementChild;
n@2582 413 while (child) {
nicholas@2538 414 var node = new this.OptionNode(this.specification);
n@2582 415 node.decode(parent, child);
nicholas@2538 416 this.options.push(node);
n@2582 417 child = child.nextElementSibling;
nicholas@2538 418 }
nicholas@2684 419 if (this.options.length === 0) {
nicholas@2257 420 console.log("Empty survey node");
nicholas@2257 421 console.log(this);
nicholas@2257 422 }
nicholas@2538 423 };
nicholas@2538 424 this.encode = function (doc) {
nicholas@2538 425 var node = doc.createElement('survey');
nicholas@2538 426 node.setAttribute('location', this.location);
nicholas@2538 427 for (var i = 0; i < this.options.length; i++) {
nicholas@2538 428 node.appendChild(this.options[i].exportXML(doc));
nicholas@2538 429 }
nicholas@2538 430 return node;
nicholas@2538 431 };
nicholas@2859 432 }
nicholas@2538 433
nicholas@2854 434 function interfaceNode(specification) {
nicholas@2688 435 this.title = undefined;
nicholas@2688 436 this.name = undefined;
nicholas@2777 437 this.image = undefined;
nicholas@2538 438 this.options = [];
nicholas@2538 439 this.scales = [];
nicholas@2854 440 this.schema = undefined;
nicholas@2538 441
nicholas@2538 442 this.decode = function (parent, xml) {
nicholas@2854 443 this.schema = schemaRoot.querySelectorAll('[name=interface]')[1];
nicholas@2538 444 this.name = xml.getAttribute('name');
nicholas@2538 445 var titleNode = xml.getElementsByTagName('title');
nicholas@2538 446 if (titleNode.length == 1) {
nicholas@2538 447 this.title = titleNode[0].textContent;
nicholas@2538 448 }
nicholas@2538 449 var interfaceOptionNodes = xml.getElementsByTagName('interfaceoption');
nicholas@2538 450 // Extract interfaceoption node schema
nicholas@2852 451 var interfaceOptionNodeSchema = this.schema.querySelector('[name=interfaceoption]');
nicholas@2852 452 var attributeMap = interfaceOptionNodeSchema.querySelectorAll('attribute');
nicholas@2684 453 var i, j;
nicholas@2684 454 for (i = 0; i < interfaceOptionNodes.length; i++) {
nicholas@2538 455 var ioNode = interfaceOptionNodes[i];
nicholas@2538 456 var option = {};
nicholas@2684 457 for (j = 0; j < attributeMap.length; j++) {
nicholas@2538 458 var attributeName = attributeMap[j].getAttribute('name') || attributeMap[j].getAttribute('ref');
nicholas@2538 459 var projectAttr = ioNode.getAttribute(attributeName);
nicholas@2692 460 projectAttr = processAttribute(projectAttr, attributeMap[j]);
nicholas@2687 461 if (projectAttr !== null) {
nicholas@2688 462 option[attributeName] = projectAttr;
nicholas@2538 463 }
nicholas@2538 464 }
n@2787 465 if (option.type == "check" && ioNode.firstElementChild) {
n@2787 466 option.errorMessage = ioNode.firstElementChild.textContent;
n@2787 467 }
nicholas@2538 468 this.options.push(option);
nicholas@2538 469 }
nicholas@2777 470 // Get the image node
nicholas@2777 471 var imageNode = xml.getElementsByTagName("image");
nicholas@2777 472 if (imageNode.length == 1) {
nicholas@2777 473 this.image = imageNode[0].getAttribute("src");
nicholas@2777 474 }
nicholas@2538 475 // Now the scales nodes
nicholas@2538 476 var scaleParent = xml.getElementsByTagName('scales');
nicholas@2538 477 if (scaleParent.length == 1) {
nicholas@2538 478 scaleParent = scaleParent[0];
nicholas@2852 479 var scalelabels = scaleParent.querySelectorAll('scalelabel');
nicholas@2684 480 for (i = 0; i < scalelabels.length; i++) {
nicholas@2538 481 this.scales.push({
nicholas@2538 482 text: scalelabels[i].textContent,
nicholas@2538 483 position: Number(scalelabels[i].getAttribute('position'))
nicholas@2538 484 });
nicholas@2538 485 }
nicholas@2538 486 }
nicholas@2538 487 };
nicholas@2538 488
nicholas@2538 489 this.encode = function (doc) {
nicholas@2538 490 var node = doc.createElement("interface");
nicholas@2684 491 if (typeof this.name == "string" && this.name.length > 0)
nicholas@2538 492 node.setAttribute("name", this.name);
nicholas@2243 493 if (typeof this.title == "string") {
nicholas@2243 494 var titleNode = doc.createElement("title");
nicholas@2243 495 titleNode.textContent = this.title;
nicholas@2243 496 node.appendChild(titleNode);
nicholas@2243 497 }
nicholas@2684 498 this.options.forEach(function (option) {
nicholas@2224 499 var child = doc.createElement("interfaceoption");
nicholas@2538 500 child.setAttribute("type", option.type);
nicholas@2538 501 child.setAttribute("name", option.name);
n@2788 502 if (option.type == "check" && option.errorMessage !== undefined) {
n@2788 503 var errorMessage = doc.createElement("errormessage");
n@2788 504 errorMessage.textContent = option.errorMessage;
n@2788 505 child.appendChild(errorMessage);
n@2788 506 }
nicholas@2224 507 node.appendChild(child);
nicholas@2684 508 });
nicholas@2780 509 if (typeof this.image == "string" && this.image.length !== 0) {
nicholas@2780 510 var imgNode = doc.createElement("image");
nicholas@2780 511 imgNode.setAttribute("src", this.image);
nicholas@2780 512 node.appendChild(imgNode);
nicholas@2780 513 }
nicholas@2684 514 if (this.scales.length !== 0) {
nicholas@2224 515 var scales = doc.createElement("scales");
nicholas@2684 516 this.scales.forEach(function (scale) {
nicholas@2224 517 var child = doc.createElement("scalelabel");
nicholas@2538 518 child.setAttribute("position", scale.position);
nicholas@2224 519 child.textContent = scale.text;
nicholas@2224 520 scales.appendChild(child);
nicholas@2684 521 });
nicholas@2224 522 node.appendChild(scales);
nicholas@2224 523 }
nicholas@2224 524 return node;
nicholas@2538 525 };
nicholas@2859 526 }
nicholas@2538 527
nicholas@2854 528 function metricNode() {
nicholas@2224 529 this.enabled = [];
nicholas@2538 530 this.decode = function (parent, xml) {
nicholas@2224 531 var children = xml.getElementsByTagName('metricenable');
nicholas@2538 532 for (var i in children) {
nicholas@2684 533 if (isNaN(Number(i)) === true) {
nicholas@2538 534 break;
nicholas@2538 535 }
nicholas@2224 536 this.enabled.push(children[i].textContent);
nicholas@2224 537 }
nicholas@2684 538 };
nicholas@2538 539 this.encode = function (doc) {
nicholas@2224 540 var node = doc.createElement('metric');
nicholas@2538 541 for (var i in this.enabled) {
nicholas@2684 542 if (isNaN(Number(i)) === true) {
nicholas@2538 543 break;
nicholas@2538 544 }
nicholas@2224 545 var child = doc.createElement('metricenable');
nicholas@2224 546 child.textContent = this.enabled[i];
nicholas@2224 547 node.appendChild(child);
nicholas@2224 548 }
nicholas@2224 549 return node;
nicholas@2684 550 };
nicholas@2859 551 }
nicholas@2538 552
nicholas@2854 553 function page(specification) {
nicholas@2538 554 this.presentedId = undefined;
nicholas@2538 555 this.id = undefined;
nicholas@2470 556 this.title = undefined;
nicholas@2538 557 this.hostURL = undefined;
nicholas@2538 558 this.randomiseOrder = undefined;
nicholas@2538 559 this.loop = undefined;
nicholas@2688 560 this.outsideReference = undefined;
nicholas@2688 561 this.loudness = undefined;
nicholas@2688 562 this.label = undefined;
nicholas@2688 563 this.labelStart = undefined;
nicholas@2857 564 this.preTest = new surveyNode(specification);
nicholas@2857 565 this.postTest = new surveyNode(specification);
nicholas@2866 566 this.preTest.location = "pre";
nicholas@2866 567 this.postTest.location = "post";
nicholas@2538 568 this.interfaces = [];
nicholas@2688 569 this.playOne = undefined;
nicholas@2688 570 this.restrictMovement = undefined;
n@2713 571 this.position = undefined;
nicholas@2538 572 this.commentBoxPrefix = "Comment on track";
nicholas@2822 573 this.minNumberPlays = undefined;
nicholas@2822 574 this.maxNumberPlays = undefined;
nicholas@2538 575 this.audioElements = [];
nicholas@2538 576 this.commentQuestions = [];
nicholas@2852 577 this.schema = schemaRoot.querySelector("[name=page]");
nicholas@2224 578 this.specification = specification;
nicholas@2688 579 this.parent = undefined;
nicholas@2538 580
nicholas@2859 581 this.addInterface = function () {
nicholas@2859 582 var node = new interfaceNode(specification);
nicholas@2859 583 this.interfaces.push(node);
nicholas@2859 584 return node;
nicholas@2859 585 };
nicholas@2859 586 this.addCommentQuestion = function () {
nicholas@2859 587 var node = new commentQuestionNode(specification);
nicholas@2859 588 this.commentQuestions.push(node);
nicholas@2859 589 return node;
nicholas@2859 590 };
nicholas@2859 591 this.addAudioElement = function () {
nicholas@2859 592 var node = new audioElementNode(specification);
nicholas@2859 593 this.audioElements.push(node);
nicholas@2859 594 return node;
nicholas@2859 595 };
nicholas@2859 596
nicholas@2538 597 this.decode = function (parent, xml) {
nicholas@2224 598 this.parent = parent;
nicholas@2852 599 var attributeMap = this.schema.querySelectorAll('attribute');
nicholas@2684 600 var i, node;
nicholas@2684 601 for (i = 0; i < attributeMap.length; i++) {
nicholas@2538 602 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 603 var projectAttr = xml.getAttribute(attributeName);
nicholas@2692 604 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 605 if (projectAttr !== null) {
nicholas@2687 606 this[attributeName] = projectAttr;
nicholas@2538 607 }
nicholas@2538 608 }
nicholas@2538 609
nicholas@2470 610 // Get the title
nicholas@2470 611 var title = xml.getElementsByTagName('title');
nicholas@2684 612 if (title.length !== 0 && title[0].parentElement == xml) {
nicholas@2470 613 this.title = title[0].textContent;
nicholas@2470 614 }
nicholas@2538 615
nicholas@2538 616 // Get the Comment Box Prefix
nicholas@2538 617 var CBP = xml.getElementsByTagName('commentboxprefix');
nicholas@2684 618 if (CBP.length !== 0 && CBP[0].parentElement == xml) {
nicholas@2538 619 this.commentBoxPrefix = CBP[0].textContent;
nicholas@2538 620 }
nicholas@2538 621
nicholas@2538 622 // Now decode the interfaces
nicholas@2854 623 var interfaceNodes = xml.getElementsByTagName('interface');
nicholas@2854 624 for (i = 0; i < interfaceNodes.length; i++) {
nicholas@2854 625 node = new interfaceNode(this.specification);
nicholas@2854 626 node.decode(this, interfaceNodes[i], parent.schema.querySelectorAll('[name=interface]')[1]);
nicholas@2538 627 this.interfaces.push(node);
nicholas@2538 628 }
nicholas@2538 629
nicholas@2538 630 // Now process the survey node options
nicholas@2538 631 var survey = xml.getElementsByTagName('survey');
nicholas@2852 632 var surveySchema = parent.schema.querySelector('[name=survey]');
nicholas@2684 633 for (i = 0; i < survey.length; i++) {
nicholas@2538 634 var location = survey[i].getAttribute('location');
nicholas@2538 635 if (location == 'pre' || location == 'before') {
nicholas@2857 636 if (this.preTest.options.length !== 0) {
nicholas@2538 637 this.errors.push("Already a pre/before test survey defined! Ignoring second!!");
nicholas@2538 638 } else {
nicholas@2538 639 this.preTest.decode(parent, survey[i], surveySchema);
nicholas@2538 640 }
nicholas@2538 641 } else if (location == 'post' || location == 'after') {
nicholas@2857 642 if (this.postTest.options.length !== 0) {
nicholas@2538 643 this.errors.push("Already a post/after test survey defined! Ignoring second!!");
nicholas@2538 644 } else {
nicholas@2538 645 this.postTest.decode(parent, survey[i], surveySchema);
nicholas@2538 646 }
nicholas@2538 647 }
nicholas@2538 648 }
nicholas@2538 649
nicholas@2538 650 // Now process the audioelement tags
nicholas@2538 651 var audioElements = xml.getElementsByTagName('audioelement');
nicholas@2684 652 for (i = 0; i < audioElements.length; i++) {
nicholas@2854 653 var audioNode = new audioElementNode(this.specification);
nicholas@2684 654 audioNode.decode(this, audioElements[i]);
nicholas@2684 655 this.audioElements.push(audioNode);
nicholas@2538 656 }
nicholas@2538 657
nicholas@2538 658 // Now decode the commentquestions
n@2579 659 var cqNode = xml.getElementsByTagName('commentquestions');
nicholas@2684 660 if (cqNode.length !== 0) {
n@2579 661 cqNode = cqNode[0];
nicholas@2644 662 var commentQuestion = cqNode.firstElementChild;
nicholas@2644 663 while (commentQuestion) {
nicholas@2854 664 node = new commentQuestionNode(this.specification);
nicholas@2644 665 node.decode(parent, commentQuestion);
n@2579 666 this.commentQuestions.push(node);
nicholas@2644 667 commentQuestion = commentQuestion.nextElementSibling;
n@2579 668 }
nicholas@2538 669 }
nicholas@2538 670 };
nicholas@2538 671
nicholas@2538 672 this.encode = function (root) {
nicholas@2538 673 var AHNode = root.createElement("page");
nicholas@2224 674 // First decode the attributes
nicholas@2852 675 var attributes = this.schema.querySelectorAll('attribute');
nicholas@2684 676 var i;
nicholas@2684 677 for (i = 0; i < attributes.length; i++) {
nicholas@2224 678 var name = attributes[i].getAttribute("name");
nicholas@2688 679 if (name === null) {
nicholas@2224 680 name = attributes[i].getAttribute("ref");
nicholas@2224 681 }
nicholas@2685 682 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 683 AHNode.setAttribute(name, this[name]);
nicholas@2224 684 }
nicholas@2224 685 }
nicholas@2224 686 // <commentboxprefix>
nicholas@2224 687 var commentboxprefix = root.createElement("commentboxprefix");
nicholas@2224 688 commentboxprefix.textContent = this.commentBoxPrefix;
nicholas@2224 689 AHNode.appendChild(commentboxprefix);
nicholas@2538 690
nicholas@2684 691 for (i = 0; i < this.interfaces.length; i++) {
nicholas@2538 692 AHNode.appendChild(this.interfaces[i].encode(root));
nicholas@2538 693 }
nicholas@2538 694
nicholas@2684 695 for (i = 0; i < this.audioElements.length; i++) {
nicholas@2538 696 AHNode.appendChild(this.audioElements[i].encode(root));
nicholas@2538 697 }
nicholas@2538 698 // Create <CommentQuestion>
nicholas@2684 699 for (i = 0; i < this.commentQuestions.length; i++) {
nicholas@2538 700 AHNode.appendChild(this.commentQuestions[i].encode(root));
nicholas@2538 701 }
nicholas@2538 702
nicholas@2538 703 AHNode.appendChild(this.preTest.encode(root));
nicholas@2224 704 AHNode.appendChild(this.postTest.encode(root));
nicholas@2538 705 return AHNode;
nicholas@2538 706 };
nicholas@2538 707
nicholas@2854 708 function commentQuestionNode(specification) {
nicholas@2688 709 this.id = undefined;
nicholas@2224 710 this.name = undefined;
nicholas@2538 711 this.type = undefined;
nicholas@2538 712 this.statement = undefined;
nicholas@2852 713 this.schema = schemaRoot.querySelector('[name=commentquestion]');
nicholas@2538 714 this.decode = function (parent, xml) {
nicholas@2538 715 this.id = xml.id;
nicholas@2224 716 this.name = xml.getAttribute('name');
nicholas@2688 717 if (this.name === null) {
nicholas@2688 718 this.name = undefined;
nicholas@2688 719 }
n@2579 720 switch (xml.nodeName) {
n@2579 721 case "commentradio":
n@2579 722 this.type = "radio";
n@2579 723 this.options = [];
n@2579 724 break;
n@2579 725 case "commentcheckbox":
n@2579 726 this.type = "checkbox";
n@2579 727 this.options = [];
n@2579 728 break;
n@2579 729 case "commentslider":
n@2579 730 this.type = "slider";
n@2579 731 this.min = undefined;
n@2579 732 this.max = undefined;
n@2579 733 this.step = undefined;
n@2579 734 break;
n@2579 735 case "commentquestion":
n@2579 736 this.type = "question";
n@2579 737 break;
nicholas@2686 738 default:
nicholas@2686 739 throw ("Unknown comment type " + xml.nodeName);
n@2579 740 }
nicholas@2538 741 this.statement = xml.getElementsByTagName('statement')[0].textContent;
n@2579 742 if (this.type == "radio" || this.type == "checkbox") {
n@2579 743 var optNodes = xml.getElementsByTagName('option');
n@2579 744 for (var i = 0; i < optNodes.length; i++) {
n@2579 745 var optNode = optNodes[i];
n@2579 746 this.options.push({
n@2579 747 name: optNode.getAttribute('name'),
n@2579 748 text: optNode.textContent
n@2579 749 });
n@2579 750 }
n@2579 751 }
n@2579 752 if (this.type == "slider") {
n@2579 753 this.min = Number(xml.getAttribute("min"));
n@2579 754 this.max = Number(xml.getAttribute("max"));
n@2579 755 this.step = Number(xml.getAttribute("step"));
nicholas@2684 756 if (this.step === undefined) {
n@2579 757 this.step = 1;
n@2579 758 }
n@2579 759 this.value = Number(xml.getAttribute("value"));
nicholas@2684 760 if (this.value === undefined) {
nicholas@2684 761 this.value = this.min;
n@2579 762 }
n@2580 763 this.leftText = xml.getElementsByTagName("minText");
n@2580 764 if (this.leftText && this.leftText.length > 0) {
n@2580 765 this.leftText = this.leftText[0].textContent;
n@2580 766 } else {
n@2580 767 this.leftText = "";
n@2580 768 }
n@2580 769 this.rightText = xml.getElementsByTagName("maxText");
n@2580 770 if (this.rightText && this.rightText.length > 0) {
n@2580 771 this.rightText = this.rightText[0].textContent;
n@2580 772 } else {
n@2580 773 this.rightText = "";
n@2580 774 }
nicholas@2538 775 }
nicholas@2538 776 };
nicholas@2538 777
nicholas@2538 778 this.encode = function (root) {
n@2579 779 var node;
n@2579 780 switch (this.type) {
n@2579 781 case "radio":
n@2579 782 node = root.createElement("commentradio");
n@2579 783 break;
n@2579 784 case "checkbox":
n@2579 785 node = root.createElement("commentcheckbox");
n@2579 786 break;
n@2579 787 case "slider":
n@2579 788 node = root.createElement("commentslider");
n@2579 789 break;
n@2579 790 case "question":
n@2579 791 node = root.createElement("commentquestion");
n@2579 792 break;
nicholas@2686 793 default:
nicholas@2686 794 throw ("Unknown type " + this.type);
n@2579 795 }
nicholas@2224 796 node.id = this.id;
nicholas@2538 797 node.setAttribute("type", this.type);
nicholas@2684 798 if (this.name !== undefined) {
nicholas@2538 799 node.setAttribute("name", this.name);
nicholas@2538 800 }
nicholas@2224 801 var statement = root.createElement("statement");
nicholas@2224 802 statement.textContent = this.statement;
nicholas@2224 803 node.appendChild(statement);
n@2579 804 if (this.type == "radio" || this.type == "checkbox") {
nicholas@2684 805 this.options.forEach(function (option) {
n@2579 806 var child = root.createElement("option");
n@2579 807 child.setAttribute("name", option.name);
n@2579 808 child.textContent = option.text;
n@2579 809 node.appendChild(child);
nicholas@2684 810 });
n@2579 811 }
n@2579 812 if (this.type == "slider") {
n@2579 813 node.setAttribute("min", this.min);
n@2579 814 node.setAttribute("max", this.max);
n@2579 815 if (this.step !== 1) {
n@2579 816 node.setAttribute("step", this.step);
n@2579 817 }
n@2579 818 if (this.value !== this.min) {
n@2579 819 node.setAttribute("value", this.value);
n@2579 820 }
n@2580 821 if (this.leftText.length > 0) {
n@2580 822 var leftText = root.createElement("minText");
n@2580 823 leftText.textContent = this.leftText;
n@2580 824 node.appendChild(leftText);
n@2580 825 }
n@2580 826 if (this.rightText.length > 0) {
n@2580 827 var rightText = root.createElement("maxText");
n@2580 828 rightText.textContent = this.rightText;
n@2580 829 node.appendChild(rightText);
n@2580 830 }
nicholas@2224 831 }
nicholas@2224 832 return node;
nicholas@2538 833 };
nicholas@2859 834 }
nicholas@2538 835
nicholas@2854 836 function audioElementNode(specification) {
nicholas@2688 837 this.url = undefined;
nicholas@2688 838 this.id = undefined;
nicholas@2688 839 this.name = undefined;
nicholas@2688 840 this.parent = undefined;
nicholas@2688 841 this.type = undefined;
nicholas@2688 842 this.marker = undefined;
nicholas@2538 843 this.enforce = false;
nicholas@2538 844 this.gain = 0.0;
nicholas@2688 845 this.label = undefined;
nicholas@2460 846 this.startTime = undefined;
nicholas@2460 847 this.stopTime = undefined;
nicholas@2614 848 this.sampleRate = undefined;
nicholas@2777 849 this.image = undefined;
nicholas@2822 850 this.minNumberPlays = undefined;
nicholas@2822 851 this.maxNumberPlays = undefined;
nicholas@2614 852 this.alternatives = [];
nicholas@2852 853 this.schema = schemaRoot.querySelector('[name=audioelement]');
nicholas@2688 854 this.parent = undefined;
nicholas@2538 855 this.decode = function (parent, xml) {
nicholas@2538 856 this.parent = parent;
nicholas@2852 857 var attributeMap = this.schema.querySelectorAll('attribute');
nicholas@2538 858 for (var i = 0; i < attributeMap.length; i++) {
nicholas@2538 859 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 860 var projectAttr = xml.getAttribute(attributeName);
nicholas@2692 861 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 862 if (projectAttr !== null) {
nicholas@2687 863 this[attributeName] = projectAttr;
nicholas@2538 864 }
nicholas@2538 865 }
nicholas@2614 866 // Get the alternative nodes
nicholas@2614 867 var child = xml.firstElementChild;
nicholas@2614 868 while (child) {
nicholas@2614 869 if (child.nodeName == "alternative") {
nicholas@2614 870 this.alternatives.push({
nicholas@2614 871 'url': child.getAttribute("url"),
nicholas@2614 872 'sampleRate': child.getAttribute("sampleRate")
nicholas@2614 873 });
nicholas@2614 874 }
nicholas@2614 875 child = child.nextElementSibling;
nicholas@2614 876 }
nicholas@2538 877
nicholas@2538 878 };
nicholas@2538 879 this.encode = function (root) {
nicholas@2538 880 var AENode = root.createElement("audioelement");
nicholas@2852 881 var attributes = this.schema.querySelectorAll('attribute');
nicholas@2538 882 for (var i = 0; i < attributes.length; i++) {
nicholas@2224 883 var name = attributes[i].getAttribute("name");
nicholas@2688 884 if (name === null) {
nicholas@2224 885 name = attributes[i].getAttribute("ref");
nicholas@2224 886 }
nicholas@2685 887 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 888 AENode.setAttribute(name, this[name]);
nicholas@2224 889 }
nicholas@2224 890 }
nicholas@2614 891 this.alternatives.forEach(function (alt) {
nicholas@2614 892 var node = root.createElement("alternative");
nicholas@2614 893 node.setAttribute("url", alt.url);
nicholas@2614 894 node.setAttribute("sampleRate", alt.sampleRate);
nicholas@2614 895 AENode.appendChild(node);
nicholas@2614 896 });
nicholas@2538 897 return AENode;
nicholas@2538 898 };
nicholas@2859 899 }
nicholas@2859 900 }
b@2437 901 }