annotate js/specification.js @ 2777:72604c3a3ed9

Added schema layouts for #138
author Nicholas Jillings <nicholas.jillings@mail.bcu.ac.uk>
date Fri, 21 Apr 2017 14:46:16 +0100
parents 2fc62a50d593
children 9c031a976321
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@2538 20
nicholas@2378 21 // nodes
nicholas@2688 22 this.metrics = undefined;
nicholas@2378 23 this.preTest = undefined;
nicholas@2378 24 this.postTest = undefined;
nicholas@2538 25 this.pages = [];
nicholas@2688 26 this.interfaces = undefined;
nicholas@2538 27 this.errors = [];
nicholas@2224 28 this.exitText = "Thank you.";
nicholas@2538 29
nicholas@2687 30 var processAttribute = function (attribute, schema) {
nicholas@2538 31 // attribute is the string returned from getAttribute on the XML
nicholas@2538 32 // schema is the <xs:attribute> node
nicholas@2687 33 if (schema.getAttribute('name') === null && schema.getAttribute('ref') !== undefined) {
nicholas@2538 34 schema = schemaRoot.getAllElementsByName(schema.getAttribute('ref'))[0];
nicholas@2538 35 }
nicholas@2538 36 var defaultOpt = schema.getAttribute('default');
nicholas@2684 37 if (attribute === null) {
nicholas@2538 38 attribute = defaultOpt;
nicholas@2538 39 }
nicholas@2538 40 var dataType = schema.getAttribute('type');
nicholas@2538 41 if (typeof dataType == "string") {
nicholas@2538 42 dataType = dataType.substr(3);
nicholas@2538 43 } else {
nicholas@2224 44 var rest = schema.getAllElementsByTagName("xs:restriction").concat(schema.getAllElementsByTagName("xs:enumeration"));
nicholas@2224 45 if (rest.length > 0) {
nicholas@2224 46 dataType = rest[0].getAttribute("base");
nicholas@2224 47 if (typeof dataType == "string") {
nicholas@2224 48 dataType = dataType.substr(3);
nicholas@2224 49 } else {
nicholas@2224 50 dataType = "string";
nicholas@2224 51 }
nicholas@2224 52 } else {
nicholas@2224 53 dataType = "string";
nicholas@2224 54 }
nicholas@2224 55 }
nicholas@2684 56 if (attribute === null) {
nicholas@2538 57 return attribute;
nicholas@2538 58 }
nicholas@2538 59 switch (dataType) {
nicholas@2538 60 case "boolean":
nicholas@2538 61 if (attribute == 'true') {
nicholas@2538 62 attribute = true;
nicholas@2538 63 } else {
nicholas@2538 64 attribute = false;
nicholas@2538 65 }
nicholas@2538 66 break;
nicholas@2538 67 case "negativeInteger":
nicholas@2538 68 case "positiveInteger":
nicholas@2538 69 case "nonNegativeInteger":
nicholas@2538 70 case "nonPositiveInteger":
nicholas@2538 71 case "integer":
nicholas@2538 72 case "decimal":
nicholas@2538 73 case "short":
nicholas@2538 74 attribute = Number(attribute);
nicholas@2538 75 break;
nicholas@2538 76 default:
nicholas@2538 77 attribute = String(attribute);
nicholas@2538 78 break;
nicholas@2538 79 }
nicholas@2538 80 return attribute;
nicholas@2538 81 };
nicholas@2538 82
nicholas@2687 83 this.processSchema = function (schemaXSD) {
nicholas@2687 84 if (schemaRoot === undefined) {
nicholas@2687 85 schemaString = schemaXSD;
nicholas@2687 86 var parse = new DOMParser();
nicholas@2687 87 schemaRoot = parse.parseFromString(schemaString, 'text/xml');
nicholas@2687 88 Object.defineProperties(this, {
nicholas@2687 89 'schema': {
nicholas@2687 90 'value': schemaRoot
nicholas@2687 91 },
nicholas@2687 92 'schemaString': {
nicholas@2687 93 'value': schemaString
nicholas@2687 94 }
nicholas@2687 95 });
nicholas@2687 96 }
nicholas@2690 97 };
nicholas@2687 98 this.getSchema = function () {
nicholas@2687 99 return schemaRoot;
nicholas@2690 100 };
nicholas@2687 101 this.getSchemaString = function () {
nicholas@2687 102 return schemaString;
nicholas@2690 103 };
nicholas@2687 104
nicholas@2538 105 this.decode = function (projectXML) {
nicholas@2687 106 schemaRoot = this.schema;
nicholas@2538 107 this.errors = [];
nicholas@2538 108 // projectXML - DOM Parsed document
nicholas@2538 109 this.projectXML = projectXML.childNodes[0];
nicholas@2538 110 var setupNode = projectXML.getElementsByTagName('setup')[0];
nicholas@2687 111 var schemaSetup = schemaRoot.getAllElementsByName('setup')[0];
nicholas@2538 112 // First decode the attributes
nicholas@2538 113 var attributes = schemaSetup.getAllElementsByTagName('xs:attribute');
nicholas@2684 114 var i;
nicholas@2684 115 for (i = 0; i < attributes.length; i++) {
nicholas@2538 116 var attributeName = attributes[i].getAttribute('name') || attributes[i].getAttribute('ref');
nicholas@2538 117 var projectAttr = setupNode.getAttribute(attributeName);
nicholas@2692 118 projectAttr = processAttribute(projectAttr, attributes[i]);
nicholas@2687 119 if (projectAttr !== null) {
nicholas@2687 120 this[attributeName] = projectAttr;
nicholas@2538 121 }
nicholas@2538 122
nicholas@2538 123 }
nicholas@2538 124
nicholas@2224 125 var exitTextNode = setupNode.getElementsByTagName('exitText');
nicholas@2224 126 if (exitTextNode.length == 1) {
nicholas@2224 127 this.exitText = exitTextNode[0].textContent;
nicholas@2224 128 }
nicholas@2538 129
nicholas@2538 130 this.metrics = new this.metricNode();
nicholas@2538 131
nicholas@2538 132 this.metrics.decode(this, setupNode.getElementsByTagName('metric')[0]);
nicholas@2538 133
nicholas@2538 134 // Now process the survey node options
nicholas@2538 135 var survey = setupNode.getElementsByTagName('survey');
nicholas@2684 136 for (i = 0; i < survey.length; i++) {
nicholas@2538 137 var location = survey[i].getAttribute('location');
nicholas@2538 138 switch (location) {
nicholas@2257 139 case 'pre':
nicholas@2257 140 case 'before':
nicholas@2538 141 this.preTest = new this.surveyNode(this);
nicholas@2538 142 this.preTest.decode(this, survey[i]);
nicholas@2257 143 break;
nicholas@2257 144 case 'post':
nicholas@2257 145 case 'after':
b@2437 146 this.postTest = new this.surveyNode(this);
nicholas@2538 147 this.postTest.decode(this, survey[i]);
nicholas@2257 148 break;
nicholas@2257 149 }
nicholas@2538 150 }
nicholas@2538 151
nicholas@2538 152 var interfaceNode = setupNode.getElementsByTagName('interface');
nicholas@2538 153 if (interfaceNode.length > 1) {
nicholas@2538 154 this.errors.push("Only one <interface> node in the <setup> node allowed! Others except first ingnored!");
nicholas@2538 155 }
nicholas@2538 156 this.interfaces = new this.interfaceNode(this);
nicholas@2684 157 if (interfaceNode.length !== 0) {
nicholas@2538 158 interfaceNode = interfaceNode[0];
nicholas@2538 159 this.interfaces.decode(this, interfaceNode, this.schema.getAllElementsByName('interface')[1]);
nicholas@2538 160 }
nicholas@2538 161
nicholas@2538 162 // Page tags
nicholas@2538 163 var pageTags = projectXML.getElementsByTagName('page');
nicholas@2538 164 var pageSchema = this.schema.getAllElementsByName('page')[0];
nicholas@2684 165 for (i = 0; i < pageTags.length; i++) {
nicholas@2538 166 var node = new this.page(this);
nicholas@2538 167 node.decode(this, pageTags[i], pageSchema);
nicholas@2538 168 this.pages.push(node);
nicholas@2538 169 }
nicholas@2538 170 };
nicholas@2538 171
nicholas@2538 172 this.encode = function () {
nicholas@2538 173 var RootDocument = document.implementation.createDocument(null, "waet");
nicholas@2538 174 var root = RootDocument.firstChild;
nicholas@2538 175 root.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
nicholas@2538 176 root.setAttribute("xsi:noNamespaceSchemaLocation", "test-schema.xsd");
nicholas@2538 177 // Build setup node
nicholas@2224 178 var setup = RootDocument.createElement("setup");
nicholas@2687 179 var schemaSetup = schemaRoot.getAllElementsByName('setup')[0];
nicholas@2224 180 // First decode the attributes
nicholas@2224 181 var attributes = schemaSetup.getAllElementsByTagName('xs:attribute');
nicholas@2538 182 for (var i = 0; i < attributes.length; i++) {
nicholas@2224 183 var name = attributes[i].getAttribute("name");
nicholas@2684 184 if (name === undefined) {
nicholas@2224 185 name = attributes[i].getAttribute("ref");
nicholas@2224 186 }
nicholas@2685 187 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 188 setup.setAttribute(name, this[name]);
nicholas@2224 189 }
nicholas@2224 190 }
nicholas@2224 191 root.appendChild(setup);
nicholas@2224 192 // Survey node
nicholas@2684 193 if (this.exitText !== null) {
nicholas@2224 194 var exitTextNode = RootDocument.createElement('exitText');
nicholas@2224 195 exitTextNode.textContent = this.exitText;
nicholas@2224 196 setup.appendChild(exitTextNode);
nicholas@2224 197 }
nicholas@2224 198 setup.appendChild(this.preTest.encode(RootDocument));
nicholas@2224 199 setup.appendChild(this.postTest.encode(RootDocument));
nicholas@2224 200 setup.appendChild(this.metrics.encode(RootDocument));
nicholas@2224 201 setup.appendChild(this.interfaces.encode(RootDocument));
nicholas@2684 202 this.pages.forEach(function (page) {
nicholas@2224 203 root.appendChild(page.encode(RootDocument));
nicholas@2684 204 });
nicholas@2538 205 return RootDocument;
nicholas@2538 206 };
nicholas@2538 207
nicholas@2538 208 this.surveyNode = function (specification) {
nicholas@2688 209 this.location = undefined;
nicholas@2538 210 this.options = [];
nicholas@2688 211 this.parent = undefined;
nicholas@2687 212 this.schema = schemaRoot.getAllElementsByName('survey')[0];
nicholas@2224 213 this.specification = specification;
nicholas@2538 214
nicholas@2538 215 this.OptionNode = function (specification) {
nicholas@2538 216 this.type = undefined;
n@2582 217 this.schema = undefined;
nicholas@2538 218 this.id = undefined;
nicholas@2224 219 this.name = undefined;
nicholas@2538 220 this.mandatory = undefined;
nicholas@2538 221 this.statement = undefined;
nicholas@2538 222 this.boxsize = undefined;
nicholas@2538 223 this.options = [];
nicholas@2538 224 this.min = undefined;
nicholas@2538 225 this.max = undefined;
nicholas@2774 226 this.minWait = 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@2692 240 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 241 if (projectAttr !== null) {
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@2688 416 this.title = undefined;
nicholas@2688 417 this.name = undefined;
nicholas@2777 418 this.image = undefined;
nicholas@2538 419 this.options = [];
nicholas@2538 420 this.scales = [];
nicholas@2687 421 this.schema = schemaRoot.getAllElementsByName('interface')[1];
nicholas@2538 422
nicholas@2538 423 this.decode = function (parent, xml) {
nicholas@2538 424 this.name = xml.getAttribute('name');
nicholas@2538 425 var titleNode = xml.getElementsByTagName('title');
nicholas@2538 426 if (titleNode.length == 1) {
nicholas@2538 427 this.title = titleNode[0].textContent;
nicholas@2538 428 }
nicholas@2538 429 var interfaceOptionNodes = xml.getElementsByTagName('interfaceoption');
nicholas@2538 430 // Extract interfaceoption node schema
nicholas@2538 431 var interfaceOptionNodeSchema = this.schema.getAllElementsByName('interfaceoption')[0];
nicholas@2538 432 var attributeMap = interfaceOptionNodeSchema.getAllElementsByTagName('xs:attribute');
nicholas@2684 433 var i, j;
nicholas@2684 434 for (i = 0; i < interfaceOptionNodes.length; i++) {
nicholas@2538 435 var ioNode = interfaceOptionNodes[i];
nicholas@2538 436 var option = {};
nicholas@2684 437 for (j = 0; j < attributeMap.length; j++) {
nicholas@2538 438 var attributeName = attributeMap[j].getAttribute('name') || attributeMap[j].getAttribute('ref');
nicholas@2538 439 var projectAttr = ioNode.getAttribute(attributeName);
nicholas@2692 440 projectAttr = processAttribute(projectAttr, attributeMap[j]);
nicholas@2687 441 if (projectAttr !== null) {
nicholas@2688 442 option[attributeName] = projectAttr;
nicholas@2538 443 }
nicholas@2538 444 }
nicholas@2538 445 this.options.push(option);
nicholas@2538 446 }
nicholas@2777 447 // Get the image node
nicholas@2777 448 var imageNode = xml.getElementsByTagName("image");
nicholas@2777 449 if (imageNode.length == 1) {
nicholas@2777 450 this.image = imageNode[0].getAttribute("src");
nicholas@2777 451 }
nicholas@2538 452 // Now the scales nodes
nicholas@2538 453 var scaleParent = xml.getElementsByTagName('scales');
nicholas@2538 454 if (scaleParent.length == 1) {
nicholas@2538 455 scaleParent = scaleParent[0];
nicholas@2252 456 var scalelabels = scaleParent.getAllElementsByTagName('scalelabel');
nicholas@2684 457 for (i = 0; i < scalelabels.length; i++) {
nicholas@2538 458 this.scales.push({
nicholas@2538 459 text: scalelabels[i].textContent,
nicholas@2538 460 position: Number(scalelabels[i].getAttribute('position'))
nicholas@2538 461 });
nicholas@2538 462 }
nicholas@2538 463 }
nicholas@2538 464 };
nicholas@2538 465
nicholas@2538 466 this.encode = function (doc) {
nicholas@2538 467 var node = doc.createElement("interface");
nicholas@2684 468 if (typeof this.name == "string" && this.name.length > 0)
nicholas@2538 469 node.setAttribute("name", this.name);
nicholas@2243 470 if (typeof this.title == "string") {
nicholas@2243 471 var titleNode = doc.createElement("title");
nicholas@2243 472 titleNode.textContent = this.title;
nicholas@2243 473 node.appendChild(titleNode);
nicholas@2243 474 }
nicholas@2684 475 this.options.forEach(function (option) {
nicholas@2224 476 var child = doc.createElement("interfaceoption");
nicholas@2538 477 child.setAttribute("type", option.type);
nicholas@2538 478 child.setAttribute("name", option.name);
nicholas@2224 479 node.appendChild(child);
nicholas@2684 480 });
nicholas@2684 481 if (this.scales.length !== 0) {
nicholas@2224 482 var scales = doc.createElement("scales");
nicholas@2684 483 this.scales.forEach(function (scale) {
nicholas@2224 484 var child = doc.createElement("scalelabel");
nicholas@2538 485 child.setAttribute("position", scale.position);
nicholas@2224 486 child.textContent = scale.text;
nicholas@2224 487 scales.appendChild(child);
nicholas@2684 488 });
nicholas@2224 489 node.appendChild(scales);
nicholas@2224 490 }
nicholas@2224 491 return node;
nicholas@2538 492 };
nicholas@2538 493 };
nicholas@2538 494
nicholas@2538 495 this.metricNode = function () {
nicholas@2224 496 this.enabled = [];
nicholas@2538 497 this.decode = function (parent, xml) {
nicholas@2224 498 var children = xml.getElementsByTagName('metricenable');
nicholas@2538 499 for (var i in children) {
nicholas@2684 500 if (isNaN(Number(i)) === true) {
nicholas@2538 501 break;
nicholas@2538 502 }
nicholas@2224 503 this.enabled.push(children[i].textContent);
nicholas@2224 504 }
nicholas@2684 505 };
nicholas@2538 506 this.encode = function (doc) {
nicholas@2224 507 var node = doc.createElement('metric');
nicholas@2538 508 for (var i in this.enabled) {
nicholas@2684 509 if (isNaN(Number(i)) === true) {
nicholas@2538 510 break;
nicholas@2538 511 }
nicholas@2224 512 var child = doc.createElement('metricenable');
nicholas@2224 513 child.textContent = this.enabled[i];
nicholas@2224 514 node.appendChild(child);
nicholas@2224 515 }
nicholas@2224 516 return node;
nicholas@2684 517 };
nicholas@2684 518 };
nicholas@2538 519
nicholas@2538 520 this.page = function (specification) {
nicholas@2538 521 this.presentedId = undefined;
nicholas@2538 522 this.id = undefined;
nicholas@2470 523 this.title = undefined;
nicholas@2538 524 this.hostURL = undefined;
nicholas@2538 525 this.randomiseOrder = undefined;
nicholas@2538 526 this.loop = undefined;
nicholas@2688 527 this.outsideReference = undefined;
nicholas@2688 528 this.loudness = undefined;
nicholas@2688 529 this.label = undefined;
nicholas@2688 530 this.labelStart = undefined;
nicholas@2688 531 this.preTest = undefined;
nicholas@2688 532 this.postTest = undefined;
nicholas@2538 533 this.interfaces = [];
nicholas@2688 534 this.playOne = undefined;
nicholas@2688 535 this.restrictMovement = undefined;
n@2713 536 this.position = undefined;
nicholas@2538 537 this.commentBoxPrefix = "Comment on track";
nicholas@2538 538 this.audioElements = [];
nicholas@2538 539 this.commentQuestions = [];
nicholas@2687 540 this.schema = schemaRoot.getAllElementsByName("page")[0];
nicholas@2224 541 this.specification = specification;
nicholas@2688 542 this.parent = undefined;
nicholas@2538 543
nicholas@2538 544 this.decode = function (parent, xml) {
nicholas@2224 545 this.parent = parent;
nicholas@2538 546 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nicholas@2684 547 var i, node;
nicholas@2684 548 for (i = 0; i < attributeMap.length; i++) {
nicholas@2538 549 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 550 var projectAttr = xml.getAttribute(attributeName);
nicholas@2692 551 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 552 if (projectAttr !== null) {
nicholas@2687 553 this[attributeName] = projectAttr;
nicholas@2538 554 }
nicholas@2538 555 }
nicholas@2538 556
nicholas@2470 557 // Get the title
nicholas@2470 558 var title = xml.getElementsByTagName('title');
nicholas@2684 559 if (title.length !== 0 && title[0].parentElement == xml) {
nicholas@2470 560 this.title = title[0].textContent;
nicholas@2470 561 }
nicholas@2538 562
nicholas@2538 563 // Get the Comment Box Prefix
nicholas@2538 564 var CBP = xml.getElementsByTagName('commentboxprefix');
nicholas@2684 565 if (CBP.length !== 0 && CBP[0].parentElement == xml) {
nicholas@2538 566 this.commentBoxPrefix = CBP[0].textContent;
nicholas@2538 567 }
nicholas@2538 568
nicholas@2538 569 // Now decode the interfaces
nicholas@2538 570 var interfaceNode = xml.getElementsByTagName('interface');
nicholas@2684 571 for (i = 0; i < interfaceNode.length; i++) {
nicholas@2684 572 node = new parent.interfaceNode(this.specification);
nicholas@2538 573 node.decode(this, interfaceNode[i], parent.schema.getAllElementsByName('interface')[1]);
nicholas@2538 574 this.interfaces.push(node);
nicholas@2538 575 }
nicholas@2538 576
nicholas@2538 577 // Now process the survey node options
nicholas@2538 578 var survey = xml.getElementsByTagName('survey');
nicholas@2538 579 var surveySchema = parent.schema.getAllElementsByName('survey')[0];
nicholas@2684 580 for (i = 0; i < survey.length; i++) {
nicholas@2538 581 var location = survey[i].getAttribute('location');
nicholas@2538 582 if (location == 'pre' || location == 'before') {
nicholas@2688 583 if (this.preTest !== undefined) {
nicholas@2538 584 this.errors.push("Already a pre/before test survey defined! Ignoring second!!");
nicholas@2538 585 } else {
nicholas@2538 586 this.preTest = new parent.surveyNode(this.specification);
nicholas@2538 587 this.preTest.decode(parent, survey[i], surveySchema);
nicholas@2538 588 }
nicholas@2538 589 } else if (location == 'post' || location == 'after') {
nicholas@2688 590 if (this.postTest !== undefined) {
nicholas@2538 591 this.errors.push("Already a post/after test survey defined! Ignoring second!!");
nicholas@2538 592 } else {
nicholas@2538 593 this.postTest = new parent.surveyNode(this.specification);
nicholas@2538 594 this.postTest.decode(parent, survey[i], surveySchema);
nicholas@2538 595 }
nicholas@2538 596 }
nicholas@2538 597 }
nicholas@2538 598
nicholas@2538 599 // Now process the audioelement tags
nicholas@2538 600 var audioElements = xml.getElementsByTagName('audioelement');
nicholas@2684 601 for (i = 0; i < audioElements.length; i++) {
nicholas@2684 602 var audioNode = new this.audioElementNode(this.specification);
nicholas@2684 603 audioNode.decode(this, audioElements[i]);
nicholas@2684 604 this.audioElements.push(audioNode);
nicholas@2538 605 }
nicholas@2538 606
nicholas@2538 607 // Now decode the commentquestions
n@2579 608 var cqNode = xml.getElementsByTagName('commentquestions');
nicholas@2684 609 if (cqNode.length !== 0) {
n@2579 610 cqNode = cqNode[0];
nicholas@2644 611 var commentQuestion = cqNode.firstElementChild;
nicholas@2644 612 while (commentQuestion) {
nicholas@2684 613 node = new this.commentQuestionNode(this.specification);
nicholas@2644 614 node.decode(parent, commentQuestion);
n@2579 615 this.commentQuestions.push(node);
nicholas@2644 616 commentQuestion = commentQuestion.nextElementSibling;
n@2579 617 }
nicholas@2538 618 }
nicholas@2538 619 };
nicholas@2538 620
nicholas@2538 621 this.encode = function (root) {
nicholas@2538 622 var AHNode = root.createElement("page");
nicholas@2224 623 // First decode the attributes
nicholas@2224 624 var attributes = this.schema.getAllElementsByTagName('xs:attribute');
nicholas@2684 625 var i;
nicholas@2684 626 for (i = 0; i < attributes.length; i++) {
nicholas@2224 627 var name = attributes[i].getAttribute("name");
nicholas@2688 628 if (name === null) {
nicholas@2224 629 name = attributes[i].getAttribute("ref");
nicholas@2224 630 }
nicholas@2685 631 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 632 AHNode.setAttribute(name, this[name]);
nicholas@2224 633 }
nicholas@2224 634 }
nicholas@2224 635 // <commentboxprefix>
nicholas@2224 636 var commentboxprefix = root.createElement("commentboxprefix");
nicholas@2224 637 commentboxprefix.textContent = this.commentBoxPrefix;
nicholas@2224 638 AHNode.appendChild(commentboxprefix);
nicholas@2538 639
nicholas@2684 640 for (i = 0; i < this.interfaces.length; i++) {
nicholas@2538 641 AHNode.appendChild(this.interfaces[i].encode(root));
nicholas@2538 642 }
nicholas@2538 643
nicholas@2684 644 for (i = 0; i < this.audioElements.length; i++) {
nicholas@2538 645 AHNode.appendChild(this.audioElements[i].encode(root));
nicholas@2538 646 }
nicholas@2538 647 // Create <CommentQuestion>
nicholas@2684 648 for (i = 0; i < this.commentQuestions.length; i++) {
nicholas@2538 649 AHNode.appendChild(this.commentQuestions[i].encode(root));
nicholas@2538 650 }
nicholas@2538 651
nicholas@2538 652 AHNode.appendChild(this.preTest.encode(root));
nicholas@2224 653 AHNode.appendChild(this.postTest.encode(root));
nicholas@2538 654 return AHNode;
nicholas@2538 655 };
nicholas@2538 656
nicholas@2538 657 this.commentQuestionNode = function (specification) {
nicholas@2688 658 this.id = undefined;
nicholas@2224 659 this.name = undefined;
nicholas@2538 660 this.type = undefined;
nicholas@2538 661 this.statement = undefined;
nicholas@2687 662 this.schema = schemaRoot.getAllElementsByName('commentquestion')[0];
nicholas@2538 663 this.decode = function (parent, xml) {
nicholas@2538 664 this.id = xml.id;
nicholas@2224 665 this.name = xml.getAttribute('name');
nicholas@2688 666 if (this.name === null) {
nicholas@2688 667 this.name = undefined;
nicholas@2688 668 }
n@2579 669 switch (xml.nodeName) {
n@2579 670 case "commentradio":
n@2579 671 this.type = "radio";
n@2579 672 this.options = [];
n@2579 673 break;
n@2579 674 case "commentcheckbox":
n@2579 675 this.type = "checkbox";
n@2579 676 this.options = [];
n@2579 677 break;
n@2579 678 case "commentslider":
n@2579 679 this.type = "slider";
n@2579 680 this.min = undefined;
n@2579 681 this.max = undefined;
n@2579 682 this.step = undefined;
n@2579 683 break;
n@2579 684 case "commentquestion":
n@2579 685 this.type = "question";
n@2579 686 break;
nicholas@2686 687 default:
nicholas@2686 688 throw ("Unknown comment type " + xml.nodeName);
n@2579 689 }
nicholas@2538 690 this.statement = xml.getElementsByTagName('statement')[0].textContent;
n@2579 691 if (this.type == "radio" || this.type == "checkbox") {
n@2579 692 var optNodes = xml.getElementsByTagName('option');
n@2579 693 for (var i = 0; i < optNodes.length; i++) {
n@2579 694 var optNode = optNodes[i];
n@2579 695 this.options.push({
n@2579 696 name: optNode.getAttribute('name'),
n@2579 697 text: optNode.textContent
n@2579 698 });
n@2579 699 }
n@2579 700 }
n@2579 701 if (this.type == "slider") {
n@2579 702 this.min = Number(xml.getAttribute("min"));
n@2579 703 this.max = Number(xml.getAttribute("max"));
n@2579 704 this.step = Number(xml.getAttribute("step"));
nicholas@2684 705 if (this.step === undefined) {
n@2579 706 this.step = 1;
n@2579 707 }
n@2579 708 this.value = Number(xml.getAttribute("value"));
nicholas@2684 709 if (this.value === undefined) {
nicholas@2684 710 this.value = this.min;
n@2579 711 }
n@2580 712 this.leftText = xml.getElementsByTagName("minText");
n@2580 713 if (this.leftText && this.leftText.length > 0) {
n@2580 714 this.leftText = this.leftText[0].textContent;
n@2580 715 } else {
n@2580 716 this.leftText = "";
n@2580 717 }
n@2580 718 this.rightText = xml.getElementsByTagName("maxText");
n@2580 719 if (this.rightText && this.rightText.length > 0) {
n@2580 720 this.rightText = this.rightText[0].textContent;
n@2580 721 } else {
n@2580 722 this.rightText = "";
n@2580 723 }
nicholas@2538 724 }
nicholas@2538 725 };
nicholas@2538 726
nicholas@2538 727 this.encode = function (root) {
n@2579 728 var node;
n@2579 729 switch (this.type) {
n@2579 730 case "radio":
n@2579 731 node = root.createElement("commentradio");
n@2579 732 break;
n@2579 733 case "checkbox":
n@2579 734 node = root.createElement("commentcheckbox");
n@2579 735 break;
n@2579 736 case "slider":
n@2579 737 node = root.createElement("commentslider");
n@2579 738 break;
n@2579 739 case "question":
n@2579 740 node = root.createElement("commentquestion");
n@2579 741 break;
nicholas@2686 742 default:
nicholas@2686 743 throw ("Unknown type " + this.type);
n@2579 744 }
nicholas@2224 745 node.id = this.id;
nicholas@2538 746 node.setAttribute("type", this.type);
nicholas@2684 747 if (this.name !== undefined) {
nicholas@2538 748 node.setAttribute("name", this.name);
nicholas@2538 749 }
nicholas@2224 750 var statement = root.createElement("statement");
nicholas@2224 751 statement.textContent = this.statement;
nicholas@2224 752 node.appendChild(statement);
n@2579 753 if (this.type == "radio" || this.type == "checkbox") {
nicholas@2684 754 this.options.forEach(function (option) {
n@2579 755 var child = root.createElement("option");
n@2579 756 child.setAttribute("name", option.name);
n@2579 757 child.textContent = option.text;
n@2579 758 node.appendChild(child);
nicholas@2684 759 });
n@2579 760 }
n@2579 761 if (this.type == "slider") {
n@2579 762 node.setAttribute("min", this.min);
n@2579 763 node.setAttribute("max", this.max);
n@2579 764 if (this.step !== 1) {
n@2579 765 node.setAttribute("step", this.step);
n@2579 766 }
n@2579 767 if (this.value !== this.min) {
n@2579 768 node.setAttribute("value", this.value);
n@2579 769 }
n@2580 770 if (this.leftText.length > 0) {
n@2580 771 var leftText = root.createElement("minText");
n@2580 772 leftText.textContent = this.leftText;
n@2580 773 node.appendChild(leftText);
n@2580 774 }
n@2580 775 if (this.rightText.length > 0) {
n@2580 776 var rightText = root.createElement("maxText");
n@2580 777 rightText.textContent = this.rightText;
n@2580 778 node.appendChild(rightText);
n@2580 779 }
nicholas@2224 780 }
nicholas@2224 781 return node;
nicholas@2538 782 };
nicholas@2538 783 };
nicholas@2538 784
nicholas@2538 785 this.audioElementNode = function (specification) {
nicholas@2688 786 this.url = undefined;
nicholas@2688 787 this.id = undefined;
nicholas@2688 788 this.name = undefined;
nicholas@2688 789 this.parent = undefined;
nicholas@2688 790 this.type = undefined;
nicholas@2688 791 this.marker = undefined;
nicholas@2538 792 this.enforce = false;
nicholas@2538 793 this.gain = 0.0;
nicholas@2688 794 this.label = undefined;
nicholas@2460 795 this.startTime = undefined;
nicholas@2460 796 this.stopTime = undefined;
nicholas@2614 797 this.sampleRate = undefined;
nicholas@2777 798 this.image = undefined;
nicholas@2614 799 this.alternatives = [];
nicholas@2687 800 this.schema = schemaRoot.getAllElementsByName('audioelement')[0];
nicholas@2688 801 this.parent = undefined;
nicholas@2538 802 this.decode = function (parent, xml) {
nicholas@2538 803 this.parent = parent;
nicholas@2538 804 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nicholas@2538 805 for (var i = 0; i < attributeMap.length; i++) {
nicholas@2538 806 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nicholas@2538 807 var projectAttr = xml.getAttribute(attributeName);
nicholas@2692 808 projectAttr = processAttribute(projectAttr, attributeMap[i]);
nicholas@2687 809 if (projectAttr !== null) {
nicholas@2687 810 this[attributeName] = projectAttr;
nicholas@2538 811 }
nicholas@2538 812 }
nicholas@2614 813 // Get the alternative nodes
nicholas@2614 814 var child = xml.firstElementChild;
nicholas@2614 815 while (child) {
nicholas@2614 816 if (child.nodeName == "alternative") {
nicholas@2614 817 this.alternatives.push({
nicholas@2614 818 'url': child.getAttribute("url"),
nicholas@2614 819 'sampleRate': child.getAttribute("sampleRate")
nicholas@2614 820 });
nicholas@2614 821 }
nicholas@2614 822 child = child.nextElementSibling;
nicholas@2614 823 }
nicholas@2538 824
nicholas@2538 825 };
nicholas@2538 826 this.encode = function (root) {
nicholas@2538 827 var AENode = root.createElement("audioelement");
nicholas@2538 828 var attributes = this.schema.getAllElementsByTagName('xs:attribute');
nicholas@2538 829 for (var i = 0; i < attributes.length; i++) {
nicholas@2224 830 var name = attributes[i].getAttribute("name");
nicholas@2688 831 if (name === null) {
nicholas@2224 832 name = attributes[i].getAttribute("ref");
nicholas@2224 833 }
nicholas@2685 834 if (this[name] !== undefined || attributes[i].getAttribute("use") == "required") {
nicholas@2685 835 AENode.setAttribute(name, this[name]);
nicholas@2224 836 }
nicholas@2224 837 }
nicholas@2614 838 this.alternatives.forEach(function (alt) {
nicholas@2614 839 var node = root.createElement("alternative");
nicholas@2614 840 node.setAttribute("url", alt.url);
nicholas@2614 841 node.setAttribute("sampleRate", alt.sampleRate);
nicholas@2614 842 AENode.appendChild(node);
nicholas@2614 843 });
nicholas@2538 844 return AENode;
nicholas@2538 845 };
nicholas@2538 846 };
nicholas@2538 847 };
b@2437 848 }