<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: becca/entities/attribute.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Source: becca/entities/attribute.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>"use strict"; const Note = require('./note'); const AbstractEntity = require("./abstract_entity"); const sql = require("../../services/sql"); const dateUtils = require("../../services/date_utils"); const promotedAttributeDefinitionParser = require("../../services/promoted_attribute_definition_parser"); /** * Attribute is an abstract concept which has two real uses - label (key - value pair) * and relation (representing named relationship between source and target note) */ class Attribute extends AbstractEntity { static get entityName() { return "attributes"; } static get primaryKeyName() { return "attributeId"; } static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable"]; } constructor(row) { super(); if (!row) { return; } this.updateFromRow(row); this.init(); } updateFromRow(row) { this.update([ row.attributeId, row.noteId, row.type, row.name, row.value, row.isInheritable, row.position, row.utcDateModified ]); } update([attributeId, noteId, type, name, value, isInheritable, position, utcDateModified]) { /** @type {string} */ this.attributeId = attributeId; /** @type {string} */ this.noteId = noteId; /** @type {string} */ this.type = type; /** @type {string} */ this.name = name; /** @type {int} */ this.position = position; /** @type {string} */ this.value = value || ""; /** @type {boolean} */ this.isInheritable = !!isInheritable; /** @type {string} */ this.utcDateModified = utcDateModified; return this; } init() { if (this.attributeId) { this.becca.attributes[this.attributeId] = this; } if (!(this.noteId in this.becca.notes)) { // entities can come out of order in sync, create skeleton which will be filled later this.becca.addNote(this.noteId, new Note({noteId: this.noteId})); } this.becca.notes[this.noteId].ownedAttributes.push(this); const key = `${this.type}-${this.name.toLowerCase()}`; this.becca.attributeIndex[key] = this.becca.attributeIndex[key] || []; this.becca.attributeIndex[key].push(this); const targetNote = this.targetNote; if (targetNote) { targetNote.targetRelations.push(this); } } get isAffectingSubtree() { return this.isInheritable || (this.type === 'relation' && this.name === 'template'); } get targetNoteId() { // alias return this.type === 'relation' ? this.value : undefined; } isAutoLink() { return this.type === 'relation' && ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name); } get note() { return this.becca.notes[this.noteId]; } get targetNote() { if (this.type === 'relation') { return this.becca.notes[this.value]; } } /** * @returns {Note|null} */ getNote() { return this.becca.getNote(this.noteId); } /** * @returns {Note|null} */ getTargetNote() { if (this.type !== 'relation') { throw new Error(`Attribute ${this.attributeId} is not relation`); } if (!this.value) { return null; } return this.becca.getNote(this.value); } /** * @return {boolean} */ isDefinition() { return this.type === 'label' && (this.name.startsWith('label:') || this.name.startsWith('relation:')); } getDefinition() { return promotedAttributeDefinitionParser.parse(this.value); } getDefinedName() { if (this.type === 'label' && this.name.startsWith('label:')) { return this.name.substr(6); } else if (this.type === 'label' && this.name.startsWith('relation:')) { return this.name.substr(9); } else { return this.name; } } get isDeleted() { return !(this.attributeId in this.becca.attributes); } beforeSaving() { if (!this.value) { if (this.type === 'relation') { throw new Error(`Cannot save relation ${this.name} since it does not target any note.`); } // null value isn't allowed this.value = ""; } if (this.position === undefined) { // TODO: can be calculated from becca this.position = 1 + sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]); } if (!this.isInheritable) { this.isInheritable = false; } this.utcDateModified = dateUtils.utcNowDateTime(); super.beforeSaving(); this.becca.attributes[this.attributeId] = this; } getPojo() { return { attributeId: this.attributeId, noteId: this.noteId, type: this.type, name: this.name, position: this.position, value: this.value, isInheritable: this.isInheritable, utcDateModified: this.utcDateModified, isDeleted: false }; } createClone(type, name, value, isInheritable) { return new Attribute({ noteId: this.noteId, type: type, name: name, value: value, position: this.position, isInheritable: isInheritable, utcDateModified: this.utcDateModified }); } } module.exports = Attribute; </code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>