| 
									
										
										
										
											2018-12-22 22:28:49 +01: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> | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |             <pre class="prettyprint source linenums"><code>import promotedAttributeDefinitionParser from '../services/promoted_attribute_definition_parser.js'; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +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) | 
					
						
							|  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  | class Attribute { | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |     constructor(froca, row) { | 
					
						
							|  |  |  |         this.froca = froca; | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  |         this.update(row); | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     update(row) { | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.attributeId = row.attributeId; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.noteId = row.noteId; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.type = row.type; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.name = row.name; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {string} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.value = row.value; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {int} */ | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         this.position = row.position; | 
					
						
							| 
									
										
										
										
											2021-11-10 21:30:54 +01:00
										 |  |  |         /** @type {boolean} */ | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |         this.isInheritable = !!row.isInheritable; | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** @returns {NoteShort} */ | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     getNote() { | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |         return this.froca.notes[this.noteId]; | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-11 23:15:16 +02:00
										 |  |  |     /** @returns {Promise<NoteShort>} */ | 
					
						
							|  |  |  |     async getTargetNote() { | 
					
						
							|  |  |  |         const targetNoteId = this.targetNoteId; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return await this.froca.getNote(targetNoteId, true); | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     get targetNoteId() { // alias | 
					
						
							| 
									
										
										
										
											2022-07-11 23:15:16 +02:00
										 |  |  |         if (this.type !== 'relation') { | 
					
						
							|  |  |  |             throw new Error(`Attribute ${this.attributeId} is not a relation`); | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return this.value; | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     get isAutoLink() { | 
					
						
							|  |  |  |         return this.type === 'relation' && ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name); | 
					
						
							| 
									
										
										
										
											2020-04-07 19:19:20 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     get toString() { | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  |         return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`; | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     } | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  |     isDefinition() { | 
					
						
							|  |  |  |         return this.type === 'label' && (this.name.startsWith('label:') || this.name.startsWith('relation:')); | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     getDefinition() { | 
					
						
							|  |  |  |         return promotedAttributeDefinitionParser.parse(this.value); | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2021-02-17 23:55:51 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  |     isDefinitionFor(attr) { | 
					
						
							|  |  |  |         return this.type === 'label' && this.name === `${attr.type}:${attr.name}`; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     get dto() { | 
					
						
							|  |  |  |         const dto = Object.assign({}, this); | 
					
						
							| 
									
										
										
										
											2021-04-16 22:57:37 +02:00
										 |  |  |         delete dto.froca; | 
					
						
							| 
									
										
										
										
											2021-02-17 23:55:51 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  |         return dto; | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2019-02-20 22:24:51 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  | export default Attribute; | 
					
						
							|  |  |  | </code></pre> | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         </article> | 
					
						
							|  |  |  |     </section> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </div> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <nav> | 
					
						
							| 
									
										
										
										
											2022-11-07 21:26:13 +01:00
										 |  |  |     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  | </nav> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <br class="clear"> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <footer> | 
					
						
							| 
									
										
										
										
											2022-11-07 21:26:13 +01:00
										 |  |  |     Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  | </footer> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <script> prettyPrint(); </script> | 
					
						
							|  |  |  | <script src="scripts/linenumber.js"> </script> | 
					
						
							|  |  |  | </body> | 
					
						
							|  |  |  | </html> |