2023-02-17 16:30:14 +01:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: entities/fattribute.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/fattribute.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>import promotedAttributeDefinitionParser from '../services/promoted_attribute_definition_parser.js';
|
|
|
|
|
|
2023-08-21 04:17:16 -04:00
|
|
|
/**
|
|
|
|
|
* There are currently only two types of attributes, labels or relations.
|
|
|
|
|
* @typedef {"label" | "relation"} AttributeType
|
|
|
|
|
*/
|
|
|
|
|
|
2023-02-17 16:30:14 +01:00
|
|
|
/**
|
|
|
|
|
* 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 FAttribute {
|
|
|
|
|
constructor(froca, row) {
|
2023-07-27 23:22:08 +02:00
|
|
|
/** @type {Froca} */
|
2023-02-17 16:30:14 +01:00
|
|
|
this.froca = froca;
|
|
|
|
|
|
|
|
|
|
this.update(row);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
update(row) {
|
|
|
|
|
/** @type {string} */
|
|
|
|
|
this.attributeId = row.attributeId;
|
|
|
|
|
/** @type {string} */
|
|
|
|
|
this.noteId = row.noteId;
|
2023-08-21 04:17:16 -04:00
|
|
|
/** @type {AttributeType} */
|
2023-02-17 16:30:14 +01:00
|
|
|
this.type = row.type;
|
|
|
|
|
/** @type {string} */
|
|
|
|
|
this.name = row.name;
|
|
|
|
|
/** @type {string} */
|
|
|
|
|
this.value = row.value;
|
2023-07-15 12:07:45 +02:00
|
|
|
/** @type {int} */
|
2023-02-17 16:30:14 +01:00
|
|
|
this.position = row.position;
|
|
|
|
|
/** @type {boolean} */
|
|
|
|
|
this.isInheritable = !!row.isInheritable;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** @returns {FNote} */
|
|
|
|
|
getNote() {
|
|
|
|
|
return this.froca.notes[this.noteId];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** @returns {Promise<FNote>} */
|
|
|
|
|
async getTargetNote() {
|
|
|
|
|
const targetNoteId = this.targetNoteId;
|
|
|
|
|
|
|
|
|
|
return await this.froca.getNote(targetNoteId, true);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
get targetNoteId() { // alias
|
|
|
|
|
if (this.type !== 'relation') {
|
|
|
|
|
throw new Error(`Attribute ${this.attributeId} is not a relation`);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return this.value;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
get isAutoLink() {
|
|
|
|
|
return this.type === 'relation' && ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
get toString() {
|
|
|
|
|
return `FAttribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
isDefinition() {
|
|
|
|
|
return this.type === 'label' && (this.name.startsWith('label:') || this.name.startsWith('relation:'));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
getDefinition() {
|
|
|
|
|
return promotedAttributeDefinitionParser.parse(this.value);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
isDefinitionFor(attr) {
|
|
|
|
|
return this.type === 'label' && this.name === `${attr.type}:${attr.name}`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
get dto() {
|
|
|
|
|
const dto = Object.assign({}, this);
|
|
|
|
|
delete dto.froca;
|
|
|
|
|
|
|
|
|
|
return dto;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export default FAttribute;
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
2023-08-21 04:17:16 -04:00
|
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
|
2023-02-17 16:30:14 +01:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2023-05-31 14:35:08 +02:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
|
2023-02-17 16:30:14 +01:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
