Source: models/Node.js

  1. require('../polyfill');
  3. /**
  4.  * Mixin type that allows path items (Depot, Dir, and File) to operate like a
  5.  * tree easily.
  6.  *
  7.  * A node requires that the implementing class provide certain basic properties:
  8.  *
  9.  * 1. `this.children`: If the node contains children, this should be defined as an
  10.  *    empty array.
  11.  *
  12.  * 2. `this.pathId`: This should be an array of path names indicating the
  13.  *    absolute location in an easily comparable way.
  14.  *
  15.  * 3. `this.name`: The comparable string 'name' of the item
  16.  *
  17.  * @mixin
  18.  */
  19. var Node = {
  21.   /**
  22.    *
  23.    */
  24.   sortChildren: function() {
  25.     this.children.sort(function(a, b) { return a.name.localeCompare(b.name); });
  26.   },
  28.   /**
  29.    * Inserts the child into the tree, if it belongs.
  30.    *
  31.    * @param child
  32.    * @return {boolean} Returns true if the child is inserted
  33.    */
  34.   insert: function (child) {
  35.     if (!this.children) {
  36.       return false;
  37.     }
  39.     if (child.isChildRelation(this)) {
  40.       this.children.push(child);
  41.       return true;
  42.     }
  44.     for (var index = 0; index < this.children.length; index++) {
  45.       if (this.children[index].insert(child)) {
  46.         return true;
  47.       }
  48.     }
  50.     return false;
  51.   },
  53.   /**
  54.    * Validates that the current node could be a child of the indicated parent.
  55.    *
  56.    * @param parent The potential parent
  57.    */
  58.   isChildRelation: function (parent) {
  59.     return (this.pathId.length == (parent.pathId.length + 1)) &&
  60.       (this.getParentName() == parent.name);
  61.   },
  63.   /**
  64.    * Returns the parent name of this node.
  65.    *
  66.    * @return {string}
  67.    */
  68.   getParentName: function () {
  69.     if (this.pathId.length > 1) {
  70.       return this.pathId[this.pathId.length - 2];
  71.     }
  72.     return undefined;
  73.   }
  74. };
  76. module.exports = Node;