@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Source: lib/metamodel/ManagedType.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css"> </head> <body> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="navbar-inner container">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>  <a class="navbar-brand" href="/"><img src="img/logo.png"></a> </div>  <div id="nav" class="navbar-collapse collapse">  <form class="navbar-right form-inline search-form"> <div class="form-group search-form-group"> <input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off"> <div id="search-results" class="search-results"> <p class="search-no-results">Please enter a search query ...</p> </div> <i class="search-icon fa fa-search"></i> </div> </form>  <ul class="nav navbar-nav"> <li> <a href="https://dashboard.baqend.com/">Dashboard</a> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/">Home</a></li> <li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li> <li><a href="https://www.baqend.com/guide/#platform">Platform</a></li> <li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li> <li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li> </ul> </li> <li class="active"> <a href="baqend.html">JS API</a> </li> <li> <a href="https://www.baqend.com/tutorial.html">Tutorial</a> </li> </ul> </div> </div> </nav> <div class="box gray pt-32 pb-32"> <div class="container"> <div class="row">  <div class="bs-sidebar hidden-print fixed affix" role="complementary"> <input class="filter form-control input-sm" type="text" placeholder="FILTER"/> <ul class="nav bs-sidenav"> <li class=""><a href="Acl.html" class="nav-name">Acl</a></li> <li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li> <li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li> <li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li> <li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li> <li class=""><a href="baqend.html" class="nav-name">baqend</a></li> <li class=""> <a href="binding.html" class="nav-name">binding</a> <ul class="nav"> <li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li> <li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li> <li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li> <li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li> <li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li> <li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li> <li class=""><a href="binding.File.html" class="nav-name">File</a></li> <li class=""><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li> <li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li> <li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li> <li class=""><a href="binding.Role.html" class="nav-name">Role</a></li> <li class=""><a href="binding.User.html" class="nav-name">User</a></li> <li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li> </ul> </li> <li class=""> <a href="caching.html" class="nav-name">caching</a> <ul class="nav"> <li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li> </ul> </li> <li class=""> <a href="connector.html" class="nav-name">connector</a> <ul class="nav"> <li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li> <li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li> <li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li> <li class=""><a href="connector.Message.html" class="nav-name">Message</a></li> <li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li> <li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li> <li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li> <li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li> <li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li> </ul> </li> <li class=""> <a href="error.html" class="nav-name">error</a> <ul class="nav"> <li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li> <li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li> <li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li> <li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li> <li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li> </ul> </li> <li class=""> <a href="metamodel.html" class="nav-name">metamodel</a> <ul class="nav"> <li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li> <li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li> <li class=""><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li> <li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li> <li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li> <li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li> <li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li> <li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li> <li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li> <li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li> <li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li> <li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li> <li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li> <li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li> <li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li> </ul> </li> <li class=""> <a href="model.html" class="nav-name">model</a> <ul class="nav"> <li class=""><a href="model.Device.html" class="nav-name">Device</a></li> <li class=""><a href="model.Role.html" class="nav-name">Role</a></li> <li class=""><a href="model.User.html" class="nav-name">User</a></li> </ul> </li> <li class=""> <a href="partialupdate.html" class="nav-name">partialupdate</a> <ul class="nav"> <li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li> </ul> </li> <li class=""> <a href="query.html" class="nav-name">query</a> <ul class="nav"> <li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li> <li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li> <li class=""><a href="query.Node.html" class="nav-name">Node</a></li> <li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li> <li class=""><a href="query.Query.html" class="nav-name">Query</a></li> <li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li> <li class=""><a href="query.Condition.html" class="nav-name">Condition</a></li> </ul> </li> <li class=""> <a href="util.html" class="nav-name">util</a> <ul class="nav"> <li class=""><a href="util.Code.html" class="nav-name">Code</a></li> <li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li> <li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li> <li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li> <li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li> <li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li> <li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li> <li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li> <li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li> <li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li> <li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li> </ul> </li> </ul> </div> <div class="col-md-12" id="main"> <div class="content"> <h1 class="page-title">Source: lib/metamodel/ManagedType.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>'use strict'; const Type = require('./Type'); const Permission = require('../util/Permission'); const Validator = require('../util/Validator'); const binding = require('../binding'); const deprecated = require('../util/deprecated'); const VALIDATION_CODE = Symbol('ValidationCode'); const TYPE_CONSTRUCTOR = Type.TYPE_CONSTRUCTOR; /** * @alias metamodel.ManagedType * @extends metamodel.Type */ class ManagedType extends Type { /** * @type Function */ get validationCode() { return this[VALIDATION_CODE]; } /** * @param {string=} code */ set validationCode(code) { if (!code) { this[VALIDATION_CODE] = null; } else { this[VALIDATION_CODE] = Validator.compile(this, code); } } /** * The Managed class * @type Class<binding.Managed> */ get typeConstructor() { if (!this[TYPE_CONSTRUCTOR]) { this.typeConstructor = this.createProxyClass(); } return this[TYPE_CONSTRUCTOR]; } /** * The Managed class constructor * @param {Class<binding.Managed>} typeConstructor The managed class constructor */ set typeConstructor(typeConstructor) { if (this[TYPE_CONSTRUCTOR]) { throw new Error('Type constructor has already been set.'); } const isEntity = typeConstructor.prototype instanceof binding.Entity; if (this.isEntity) { if (!isEntity) { throw new TypeError('Entity classes must extends the Entity class.'); } } else if (!(typeConstructor.prototype instanceof binding.Managed) || isEntity) { throw new TypeError('Embeddable classes must extends the Managed class.'); } this.enhancer.enhance(this, typeConstructor); this[TYPE_CONSTRUCTOR] = typeConstructor; } /** * @param {string} ref or full class name * @param {Class<binding.Managed>=} typeConstructor */ constructor(ref, typeConstructor) { super(ref.indexOf('/db/') !== 0 ? '/db/' + ref : ref, typeConstructor); /** @type binding.Enhancer */ this.enhancer = null; /** @type {metamodel.Attribute[]} */ this.declaredAttributes = []; /** @type util.Permission */ this.schemaAddPermission = new Permission(); /** @type util.Permission */ this.schemaReplacePermission = new Permission(); /** @type Object<string,string>|null */ this.metadata = null; } /** * Initialize this type * @param {binding.Enhancer} enhancer The class enhancer used to instantiate an instance of this managed class * @return {void} */ init(enhancer) { this.enhancer = enhancer; if (this[TYPE_CONSTRUCTOR] && !binding.Enhancer.getIdentifier(this[TYPE_CONSTRUCTOR])) { binding.Enhancer.setIdentifier(this[TYPE_CONSTRUCTOR], this.ref); } } /** * Creates an ProxyClass for this type * @return {Class<*>} the crated proxy class for this type * @abstract */ createProxyClass() {} /** * Creates an ObjectFactory for this type and the given EntityManager * @param {EntityManager} db The created instances will be attached to this EntityManager * @return {binding.ManagedFactory<*>} the crated object factory for the given EntityManager * @abstract */ createObjectFactory(db) {} // eslint-disable-line no-unused-vars /** * Creates a new instance of the managed type, without invoking any constructors * * This method is used to create object instances which are loaded form the backend. * * @return {object} The created instance */ create() { const instance = Object.create(this.typeConstructor.prototype); binding.Managed.init(instance); return instance; } /** * An iterator which returns all attributes declared by this type and inherited form all super types * @return {Iterator<metamodel.Attribute>} */ attributes() { let iter; let index = 0; const type = this; if (this.superType) { iter = this.superType.attributes(); } return { [Symbol.iterator]() { return this; }, /** * @return {Object} item * @return {boolean} item.done * @return {metamodel.Attribute} item.value */ next() { if (iter) { const item = iter.next(); if (!item.done) { return item; } iter = null; } if (index < type.declaredAttributes.length) { const value = type.declaredAttributes[index]; index += 1; return { value, done: false }; } return { done: true }; }, }; } /** * Adds an attribute to this type * @param {metamodel.Attribute} attr The attribute to add * @param {number=} order Position of the attribute * @return {void} */ addAttribute(attr, order) { if (this.getAttribute(attr.name)) { throw new Error('An attribute with the name ' + attr.name + ' is already declared.'); } let initOrder; if (!attr.order) { initOrder = typeof order === 'undefined' ? this.declaredAttributes.length : order; } else { initOrder = attr.order; } attr.init(this, initOrder); this.declaredAttributes.push(attr); if (this[TYPE_CONSTRUCTOR] && this.name !== 'Object') { this.enhancer.enhanceProperty(this[TYPE_CONSTRUCTOR], attr); } } /** * Removes an attribute from this type * @param {string} name The Name of the attribute which will be removed * @return {void} */ removeAttribute(name) { const length = this.declaredAttributes.length; this.declaredAttributes = this.declaredAttributes.filter(val => val.name !== name); if (length === this.declaredAttributes.length) { throw new Error('An Attribute with the name ' + name + ' is not declared.'); } } /** * @param {!string} name * @return {metamodel.Attribute} */ getAttribute(name) { let attr = this.getDeclaredAttribute(name); if (!attr && this.superType) { attr = this.superType.getAttribute(name); } return attr; } /** * @param {string|number} val Name or order of the attribute * @return {metamodel.Attribute} */ getDeclaredAttribute(val) { return this.declaredAttributes.filter(attr => attr.name === val || attr.order === val)[0] || null; } /** * @inheritDoc */ fromJsonValue(state, jsonObject, currentObject, options) { if (!jsonObject) { return null; } const iter = this.attributes(); for (let el = iter.next(); !el.done; el = iter.next()) { const attribute = el.value; if (!options.onlyMetadata || attribute.isMetadata) { attribute.setJsonValue(state, currentObject, jsonObject[attribute.name], options); } } return currentObject; } /** * @inheritDoc */ toJsonValue(state, object, options) { if (!(object instanceof this.typeConstructor)) { return null; } const value = {}; const iter = this.attributes(); for (let el = iter.next(); !el.done; el = iter.next()) { const attribute = el.value; if (!options.excludeMetadata || !attribute.isMetadata) { value[attribute.name] = attribute.getJsonValue(state, object, options); } } return value; } /** * Converts ths type schema to json * @return {json} */ toJSON() { const fields = {}; this.declaredAttributes.forEach((attribute) => { if (!attribute.isMetadata) { fields[attribute.name] = attribute; } }); const json = { class: this.ref, fields, acl: { load: this.loadPermission, schemaAdd: this.schemaAddPermission, schemaReplace: this.schemaReplacePermission, }, }; if (this.superType) { json.superClass = this.superType.ref; } if (this.isEmbeddable) { json.embedded = true; } if (this.metadata) { json.metadata = this.metadata; } return json; } /** * Returns iterator to get all referenced entities * @return {Iterator<EntityType>} */ references() { const attributes = this.attributes(); let attribute; let embeddedAttributes; return { [Symbol.iterator]() { return this; }, /** * @return {Object} item * @return {boolean} item.done * @return {Object} item.value */ next() { for (;;) { if (embeddedAttributes) { const item = embeddedAttributes.next(); if (!item.done) { return { value: { path: [attribute.name].concat(item.value.path) } }; } embeddedAttributes = null; } const item = attributes.next(); if (item.done) { return item; } attribute = item.value; const type = attribute.isCollection ? attribute.elementType : attribute.type; if (type.isEntity) { return { value: { path: [attribute.name] } }; } else if (type.isEmbeddable) { embeddedAttributes = type.references(); } } }, }; } /** * Retrieves whether this type has specific metadata * * @param {string} key * @return {boolean} */ hasMetadata(key) { return this.metadata && !!this.metadata[key]; } /** * Gets some metadata of this type * * @param {string} key * @return {null|string} */ getMetadata(key) { if (!this.hasMetadata(key)) { return null; } return this.metadata[key]; } } deprecated(ManagedType.prototype, '_enhancer', 'enhancer'); module.exports = ManagedType; </code></pre> </article> </section>  </div> </div> </div> </div> </div> <div id="footer" style="position:relative; z-index:1;"> <div class="container"> <div class="row"> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Product</h4> <a href="https://www.baqend.com/platform.html">Platform</a> <a href="https://www.baqend.com/speedkit.html">Speed Kit</a> <a href="https://www.baqend.com/features.html">Features</a> <a href="https://www.baqend.com/pricing.html">Platform Pricing</a> <a href="https://www.baqend.com/pricing_speedkit.html">Speed Kit Pricing</a> <a href="https://www.baqend.com/agencies.html">Agencies</a> <a href="https://www.baqend.com/enterprise.html">Enterprise</a> <a href="https://www.baqend.com/features.html#download">Community Edition</a> <a href="https://www.baqend.com/support.html">Support</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Company</h4> <a href="https://www.baqend.com/about.html">About us</a> <a href="https://medium.baqend.com">Baqend Blog</a> <a href="https://www.baqend.com/hiring.html">Jobs</a> <a href="https://www.baqend.com/press.html">Press</a> <a href="https://thesis.app.baqend.com/">Bachelor/Master theses</a> <a href="https://www.weblabs.hamburg/">WebLabs.Hamburg</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Developer</h4> <a href="https://dashboard.baqend.com/login">Login</a> <a href="https://dashboard.baqend.com/register">Sign Up</a> <a href="https://www.baqend.com/guide">Developer Docs</a> <a href="https://www.baqend.com/guide/roadmap/">Roadmap</a> <a href="https://www.baqend.com/guide/starter-kits">Starter Kits</a> <a href="https://www.baqend.com/js-sdk/latest/baqend.html">JS SDK</a> <a href="https://stackoverflow.com/questions/tagged/baqend/">Stackoverflow</a> </div> <div class="col-xs-6 col-sm-3 contact"> <h4>Contact</h4> <p class="contact-information"> <span> Baqend GmbH<br /> Stresemannstr. 23<br /> 22769 Hamburg<br /> Germany </span> </p> <p class="contact-information"> Email: <a style="display: inline-block" href="mailto:support@baqend.com">support@baqend.com</a> </p> <p class="contact-information"> Tel: <a style="display: inline-block" href="tel:+494060940539">+49 40 60940539</a> </p> </div> </div> <div class="row"> <div class="col-md-12 text-center social"> <a href="https://twitter.com/baqendcom"><i class="fa fa-twitter fa-fw"></i></a> <a href="https://github.com/Baqend"><i class="fa fa-github fa-fw"></i></a> <a href="https://medium.baqend.com/"><i class="fa fa-medium fa-fw"></i></a> <a href="https://www.facebook.com/baqend"><i class="fa fa-facebook fa-fw"></i></a> <a href="https://www.youtube.com/channel/UCsImg6Ts8UEp6-7LE9CP2-Q"><i class="fa fa-youtube fa-fw"></i></a> </div> </div> </div> <footer> <div class="container"> <div class="legal text-center"> <div> <strong>Baqend JavaScript SDK 2.14.1</strong><br> &copy 2019 Baqend GmbH<br> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun, 06 Jan 2019 05:00:21 GMT </div> <a href="mailto:info@baqend.com">Contact</a> - <a href="https://dashboard.baqend.com/privacy">Privacy Policy</a> - <a href="https://dashboard.baqend.com/terms">Terms of Service</a> - <a href="https://dashboard.baqend.com/imprint">Imprint</a> </div> </div> </footer> </div> <script> prettyPrint(); </script> <script src="https://code.jquery.com/jquery-1.12.1.min.js"></script> <script src="scripts/bootstrap.min.js"> </script> <script src="scripts/linenumber.js"> </script> <script src="scripts/filter.js"> </script> <script data-main="scripts/search.js" src="scripts/require.js"></script> </body> </html>