2018-08-29 20:44:35 +02:00
|
|
|
<!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";
|
|
|
|
|
|
2020-09-30 22:48:30 +02:00
|
|
|
|
2018-08-29 20:44:35 +02:00
|
|
|
const Entity = require('./entity');
|
|
|
|
|
const dateUtils = require('../services/date_utils');
|
|
|
|
|
const sql = require('../services/sql');
|
2020-09-30 22:48:30 +02:00
|
|
|
const promotedAttributeDefinitionParser = require("../services/promoted_attribute_definition_parser");
|
2018-08-29 20:44:35 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Attribute is key value pair owned by a note.
|
|
|
|
|
*
|
2020-09-30 22:48:30 +02:00
|
|
|
* @property {string} attributeId - immutable
|
|
|
|
|
* @property {string} noteId - immutable
|
|
|
|
|
* @property {string} type - immutable
|
|
|
|
|
* @property {string} name - immutable
|
2019-11-18 23:01:31 +01:00
|
|
|
* @property {string} value
|
|
|
|
|
* @property {int} position
|
2020-09-30 22:48:30 +02:00
|
|
|
* @property {boolean} isInheritable - immutable
|
2019-11-18 23:01:31 +01:00
|
|
|
* @property {boolean} isDeleted
|
2020-02-02 11:44:08 +01:00
|
|
|
* @property {string|null} deleteId - ID identifying delete transaction
|
2019-11-18 23:01:31 +01:00
|
|
|
* @property {string} utcDateModified
|
2018-08-29 20:44:35 +02:00
|
|
|
*
|
|
|
|
|
* @extends Entity
|
|
|
|
|
*/
|
|
|
|
|
class Attribute extends Entity {
|
|
|
|
|
static get entityName() { return "attributes"; }
|
|
|
|
|
static get primaryKeyName() { return "attributeId"; }
|
2021-02-17 23:55:51 +01:00
|
|
|
static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable", "isDeleted"]; }
|
2018-08-29 20:44:35 +02:00
|
|
|
|
|
|
|
|
constructor(row) {
|
|
|
|
|
super(row);
|
|
|
|
|
|
|
|
|
|
this.isInheritable = !!this.isInheritable;
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-17 23:55:51 +01:00
|
|
|
isAutoLink() {
|
|
|
|
|
return this.type === 'relation' && ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name);
|
|
|
|
|
}
|
|
|
|
|
|
2018-11-13 12:50:08 +01:00
|
|
|
/**
|
2020-09-30 22:48:30 +02:00
|
|
|
* @returns {Note|null}
|
2018-11-13 12:50:08 +01:00
|
|
|
*/
|
2020-09-30 22:48:30 +02:00
|
|
|
getNote() {
|
|
|
|
|
return this.repository.getNote(this.noteId);
|
2018-08-29 20:44:35 +02:00
|
|
|
}
|
|
|
|
|
|
2018-11-13 12:50:08 +01:00
|
|
|
/**
|
2020-09-30 22:48:30 +02:00
|
|
|
* @returns {Note|null}
|
2018-11-13 12:50:08 +01:00
|
|
|
*/
|
2020-09-30 22:48:30 +02:00
|
|
|
getTargetNote() {
|
2018-08-29 20:44:35 +02:00
|
|
|
if (this.type !== 'relation') {
|
|
|
|
|
throw new Error(`Attribute ${this.attributeId} is not relation`);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!this.value) {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
|
2020-09-30 22:48:30 +02:00
|
|
|
return this.repository.getNote(this.value);
|
2018-08-29 20:44:35 +02:00
|
|
|
}
|
|
|
|
|
|
2018-11-13 12:50:08 +01:00
|
|
|
/**
|
|
|
|
|
* @return {boolean}
|
|
|
|
|
*/
|
2018-08-29 20:44:35 +02:00
|
|
|
isDefinition() {
|
2020-09-30 22:48:30 +02:00
|
|
|
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;
|
|
|
|
|
}
|
2018-08-29 20:44:35 +02:00
|
|
|
}
|
|
|
|
|
|
2020-09-30 22:48:30 +02:00
|
|
|
beforeSaving() {
|
2018-08-29 20:44:35 +02:00
|
|
|
if (!this.value) {
|
2019-11-18 23:01:31 +01:00
|
|
|
if (this.type === 'relation') {
|
|
|
|
|
throw new Error(`Cannot save relation ${this.name} since it does not target any note.`);
|
|
|
|
|
}
|
|
|
|
|
|
2018-08-29 20:44:35 +02:00
|
|
|
// null value isn't allowed
|
|
|
|
|
this.value = "";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (this.position === undefined) {
|
2020-09-30 22:48:30 +02:00
|
|
|
this.position = 1 + sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]);
|
2018-08-29 20:44:35 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!this.isInheritable) {
|
|
|
|
|
this.isInheritable = false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!this.isDeleted) {
|
|
|
|
|
this.isDeleted = false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
super.beforeSaving();
|
|
|
|
|
|
2021-02-17 23:55:51 +01:00
|
|
|
this.utcDateModified = dateUtils.utcNowDateTime();
|
2018-08-29 20:44:35 +02:00
|
|
|
}
|
2018-12-22 22:28:49 +01:00
|
|
|
|
2020-09-30 22:48:30 +02:00
|
|
|
createClone(type, name, value, isInheritable) {
|
2020-02-02 11:44:08 +01:00
|
|
|
return new Attribute({
|
|
|
|
|
noteId: this.noteId,
|
|
|
|
|
type: type,
|
|
|
|
|
name: name,
|
|
|
|
|
value: value,
|
|
|
|
|
position: this.position,
|
2020-09-30 22:48:30 +02:00
|
|
|
isInheritable: isInheritable,
|
2020-02-02 11:44:08 +01:00
|
|
|
isDeleted: false,
|
|
|
|
|
utcDateModified: this.utcDateModified
|
|
|
|
|
});
|
|
|
|
|
}
|
2018-08-29 20:44:35 +02:00
|
|
|
}
|
|
|
|
|
|
2020-09-30 22:48:30 +02:00
|
|
|
module.exports = Attribute;
|
|
|
|
|
</code></pre>
|
2018-08-29 20:44:35 +02:00
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
2021-04-07 22:01:52 +02:00
|
|
|
<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="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>
|
2018-08-29 20:44:35 +02:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2020-09-30 22:48:30 +02:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a>
|
2018-08-29 20:44:35 +02:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
