2018-08-30 02:44:35 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: entities/branch.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/branch.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>"use strict";
|
|
|
|
|
|
|
|
|
|
const Entity = require('./entity');
|
|
|
|
|
const dateUtils = require('../services/date_utils');
|
|
|
|
|
const repository = require('../services/repository');
|
|
|
|
|
const sql = require('../services/sql');
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Branch represents note's placement in the tree - it's essentially pair of noteId and parentNoteId.
|
|
|
|
|
* Each note can have multiple (at least one) branches, meaning it can be placed into multiple places in the tree.
|
|
|
|
|
*
|
2019-11-17 02:07:32 +08:00
|
|
|
* @property {string} branchId - primary key
|
|
|
|
|
* @property {string} noteId
|
|
|
|
|
* @property {string} parentNoteId
|
|
|
|
|
* @property {int} notePosition
|
|
|
|
|
* @property {string} prefix
|
|
|
|
|
* @property {boolean} isExpanded
|
|
|
|
|
* @property {boolean} isDeleted
|
2020-02-02 18:44:08 +08:00
|
|
|
* @property {string|null} deleteId - ID identifying delete transaction
|
2019-11-17 02:07:32 +08:00
|
|
|
* @property {string} utcDateModified
|
|
|
|
|
* @property {string} utcDateCreated
|
2018-08-30 02:44:35 +08:00
|
|
|
*
|
|
|
|
|
* @extends Entity
|
|
|
|
|
*/
|
|
|
|
|
class Branch extends Entity {
|
|
|
|
|
static get entityName() { return "branches"; }
|
|
|
|
|
static get primaryKeyName() { return "branchId"; }
|
|
|
|
|
// notePosition is not part of hash because it would produce a lot of updates in case of reordering
|
2020-02-02 18:44:08 +08:00
|
|
|
static get hashedProperties() { return ["branchId", "noteId", "parentNoteId", "isDeleted", "deleteId", "prefix"]; }
|
2018-09-03 22:05:28 +08:00
|
|
|
|
|
|
|
|
/** @returns {Note|null} */
|
2018-08-30 02:44:35 +08:00
|
|
|
async getNote() {
|
|
|
|
|
return await repository.getEntity("SELECT * FROM notes WHERE noteId = ?", [this.noteId]);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async beforeSaving() {
|
|
|
|
|
if (this.notePosition === undefined) {
|
|
|
|
|
const maxNotePos = await sql.getValue('SELECT MAX(notePosition) FROM branches WHERE parentNoteId = ? AND isDeleted = 0', [this.parentNoteId]);
|
2019-10-22 03:22:53 +08:00
|
|
|
this.notePosition = maxNotePos === null ? 0 : maxNotePos + 10;
|
2018-08-30 02:44:35 +08:00
|
|
|
}
|
|
|
|
|
|
2019-11-06 04:26:54 +08:00
|
|
|
if (!this.isExpanded) {
|
|
|
|
|
this.isExpanded = false;
|
|
|
|
|
}
|
|
|
|
|
|
2018-08-30 02:44:35 +08:00
|
|
|
if (!this.isDeleted) {
|
|
|
|
|
this.isDeleted = false;
|
|
|
|
|
}
|
|
|
|
|
|
2019-03-15 03:49:10 +08:00
|
|
|
if (!this.utcDateCreated) {
|
|
|
|
|
this.utcDateCreated = dateUtils.utcNowDateTime();
|
2018-08-30 02:44:35 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
super.beforeSaving();
|
|
|
|
|
|
|
|
|
|
if (this.isChanged) {
|
2019-03-15 03:49:10 +08:00
|
|
|
this.utcDateModified = dateUtils.utcNowDateTime();
|
2018-08-30 02:44:35 +08:00
|
|
|
}
|
|
|
|
|
}
|
2018-12-23 05:28:49 +08:00
|
|
|
|
2020-02-02 18:44:08 +08:00
|
|
|
createClone(parentNoteId, notePosition) {
|
|
|
|
|
return new Branch({
|
|
|
|
|
noteId: this.noteId,
|
|
|
|
|
parentNoteId: parentNoteId,
|
|
|
|
|
notePosition: notePosition,
|
|
|
|
|
prefix: this.prefix,
|
|
|
|
|
isExpanded: this.isExpanded,
|
|
|
|
|
isDeleted: false,
|
|
|
|
|
utcDateCreated: this.utcDateCreated,
|
|
|
|
|
utcDateModified: this.utcDateModified
|
|
|
|
|
});
|
2018-12-23 05:28:49 +08:00
|
|
|
}
|
2018-08-30 02:44:35 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module.exports = Branch;</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
2019-08-21 03:40:47 +08:00
|
|
|
<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>
|
2018-08-30 02:44:35 +08:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2019-08-21 03:40:47 +08:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a>
|
2018-08-30 02:44:35 +08:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
