123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Source: 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: entities/attribute.js</h1>
-
-
- <section>
- <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');
- /**
- * Attribute is key value pair owned by a note.
- *
- * @property {string} attributeId
- * @property {string} noteId
- * @property {string} type
- * @property {string} name
- * @property {string} value
- * @property {int} position
- * @property {boolean} isInheritable
- * @property {boolean} isDeleted
- * @property {string|null} deleteId - ID identifying delete transaction
- * @property {string} utcDateCreated
- * @property {string} utcDateModified
- *
- * @extends Entity
- */
- class Attribute extends Entity {
- static get entityName() { return "attributes"; }
- static get primaryKeyName() { return "attributeId"; }
- static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable", "isDeleted", "utcDateCreated"]; }
- constructor(row) {
- super(row);
- this.isInheritable = !!this.isInheritable;
- if (this.isDefinition()) {
- try {
- this.value = JSON.parse(this.value);
- }
- catch (e) {
- }
- }
- }
- /**
- * @returns {Promise<Note|null>}
- */
- async getNote() {
- return await repository.getNote(this.noteId);
- }
- /**
- * @returns {Promise<Note|null>}
- */
- async getTargetNote() {
- if (this.type !== 'relation') {
- throw new Error(`Attribute ${this.attributeId} is not relation`);
- }
- if (!this.value) {
- return null;
- }
- return await repository.getNote(this.value);
- }
- /**
- * @return {boolean}
- */
- isDefinition() {
- return this.type === 'label-definition' || this.type === 'relation-definition';
- }
- async 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) {
- this.position = 1 + await sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]);
- }
- if (!this.isInheritable) {
- this.isInheritable = false;
- }
- if (!this.isDeleted) {
- this.isDeleted = false;
- }
- if (!this.utcDateCreated) {
- this.utcDateCreated = dateUtils.utcNowDateTime();
- }
- super.beforeSaving();
- if (this.isChanged) {
- this.utcDateModified = dateUtils.utcNowDateTime();
- }
- }
- // cannot be static!
- updatePojo(pojo) {
- delete pojo.isOwned;
- delete pojo.__note;
- }
- createClone(type, name, value) {
- return new Attribute({
- noteId: this.noteId,
- type: type,
- name: name,
- value: value,
- position: this.position,
- isInheritable: this.isInheritable,
- isDeleted: false,
- utcDateCreated: this.utcDateCreated,
- utcDateModified: this.utcDateModified
- });
- }
- }
- module.exports = Attribute;</code></pre>
- </article>
- </section>
- </div>
- <nav>
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</a></li><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="Entity.html">Entity</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.4</a>
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|