updated API docs

docs/backend_api/entities_attribute.js.html

@@ -28,21 +28,22 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
+
 const Entity = require('./entity');
-const repository = require('../services/repository');
 const dateUtils = require('../services/date_utils');
 const sql = require('../services/sql');
+const promotedAttributeDefinitionParser = require("../services/promoted_attribute_definition_parser");
 
 /**
  * Attribute is key value pair owned by a note.
  *
- * @property {string} attributeId
- * @property {string} noteId
- * @property {string} type
- * @property {string} name
+ * @property {string} attributeId - immutable
+ * @property {string} noteId - immutable
+ * @property {string} type - immutable
+ * @property {string} name - immutable
  * @property {string} value
  * @property {int} position
- * @property {boolean} isInheritable
+ * @property {boolean} isInheritable - immutable
  * @property {boolean} isDeleted
  * @property {string|null} deleteId - ID identifying delete transaction
  * @property {string} utcDateCreated
@@ -59,27 +60,19 @@ class Attribute extends Entity {
         super(row);
 
         this.isInheritable = !!this.isInheritable;
-
-        if (this.isDefinition()) {
-            try {
-                this.value = JSON.parse(this.value);
-            }
-            catch (e) {
-            }
-        }
     }
 
     /**
-     * @returns {Promise&lt;Note|null>}
+     * @returns {Note|null}
      */
-    async getNote() {
-        return await repository.getNote(this.noteId);
+    getNote() {
+        return this.repository.getNote(this.noteId);
     }
 
     /**
-     * @returns {Promise&lt;Note|null>}
+     * @returns {Note|null}
      */
-    async getTargetNote() {
+    getTargetNote() {
         if (this.type !== 'relation') {
             throw new Error(`Attribute ${this.attributeId} is not relation`);
         }
@@ -88,17 +81,31 @@ class Attribute extends Entity {
             return null;
         }
 
-        return await repository.getNote(this.value);
+        return this.repository.getNote(this.value);
     }
 
     /**
      * @return {boolean}
      */
     isDefinition() {
-        return this.type === 'label-definition' || this.type === 'relation-definition';
+        return this.type === 'label' &amp;&amp; (this.name.startsWith('label:') || this.name.startsWith('relation:'));
     }
 
-    async beforeSaving() {
+    getDefinition() {
+        return promotedAttributeDefinitionParser.parse(this.value);
+    }
+
+    getDefinedName() {
+        if (this.type === 'label' &amp;&amp; this.name.startsWith('label:')) {
+            return this.name.substr(6);
+        } else if (this.type === 'label' &amp;&amp; this.name.startsWith('relation:')) {
+            return this.name.substr(9);
+        } else {
+            return this.name;
+        }
+    }
+
+    beforeSaving() {
         if (!this.value) {
             if (this.type === 'relation') {
                 throw new Error(`Cannot save relation ${this.name} since it does not target any note.`);
@@ -109,7 +116,7 @@ class Attribute extends Entity {
         }
 
         if (this.position === undefined) {
-            this.position = 1 + await sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]);
+            this.position = 1 + sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]);
         }
 
         if (!this.isInheritable) {
@@ -131,20 +138,14 @@ class Attribute extends Entity {
         }
     }
 
-    // cannot be static!
-    updatePojo(pojo) {
-        delete pojo.isOwned;
-        delete pojo.__note;
-    }
-
-    createClone(type, name, value) {
+    createClone(type, name, value, isInheritable) {
         return new Attribute({
             noteId: this.noteId,
             type: type,
             name: name,
             value: value,
             position: this.position,
-            isInheritable: this.isInheritable,
+            isInheritable: isInheritable,
             isDeleted: false,
             utcDateCreated: this.utcDateCreated,
             utcDateModified: this.utcDateModified
@@ -152,7 +153,8 @@ class Attribute extends Entity {
     }
 }
 
-module.exports = Attribute;</code></pre>
+module.exports = Attribute;
+</code></pre>
         </article>
     </section>
 
@@ -168,7 +170,7 @@ module.exports = Attribute;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a>
 </footer>
 
 <script> prettyPrint(); </script>