annotate js/specification.js @ 2687:66a24a6a0358

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