@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Source: lib/metamodel/EntityType.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/EntityType.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>'use strict'; const binding = require('../binding'); const SingularAttribute = require('./SingularAttribute'); const BasicType = require('./BasicType'); const Type = require('./Type'); const ManagedType = require('./ManagedType'); const Permission = require('../util/Permission'); const Metadata = require('../util/Metadata'); /** * @alias metamodel.EntityType * @extends metamodel.ManagedType */ class EntityType extends ManagedType { /** * @inheritDoc * @return {Type.PersistenceType} */ get persistenceType() { return Type.PersistenceType.ENTITY; } /** * @type metamodel.SingularAttribute */ get id() { return this.declaredId || this.superType.id; } /** * @type metamodel.SingularAttribute */ get version() { return this.declaredVersion || this.superType.version; } /** * @type metamodel.SingularAttribute */ get acl() { return this.declaredAcl || this.superType.acl; } /** * @param {string} ref * @param {metamodel.EntityType} superType * @param {Class<binding.Entity>=} typeConstructor */ constructor(ref, superType, typeConstructor) { super(ref, typeConstructor); /** @type metamodel.SingularAttribute */ this.declaredId = null; /** @type metamodel.SingularAttribute */ this.declaredVersion = null; /** @type metamodel.SingularAttribute */ this.declaredAcl = null; /** @type metamodel.EntityType */ this.superType = superType; /** @type util.Permission */ this.loadPermission = new Permission(); /** @type util.Permission */ this.updatePermission = new Permission(); /** @type util.Permission */ this.deletePermission = new Permission(); /** @type util.Permission */ this.queryPermission = new Permission(); /** @type util.Permission */ this.schemaSubclassPermission = new Permission(); /** @type util.Permission */ this.insertPermission = new Permission(); } /** * @inheritDoc */ createProxyClass() { let Class = this.superType.typeConstructor; if (Class === Object) { switch (this.name) { case 'User': Class = binding.User; break; case 'Role': Class = binding.Role; break; default: Class = binding.Entity; break; } } return this.enhancer.createProxy(Class); } /** * Gets all on this class referencing attributes * * @param {EntityManager} db The instances will be found by this EntityManager * @param {Object} [options] Some options to pass * @param {Array.<string>} [options.classes] An array of class names to filter for, null for no filter * @return {Map.<metamodel.ManagedType, Set.<string>>} A map from every referencing class to a set of its referencing * attribute names */ getReferencing(db, options) { const opts = Object.assign({}, options); const entities = db.metamodel.entities; const referencing = new Map(); const names = Object.keys(entities); for (let i = 0, len = names.length; i < len; i += 1) { const name = names[i]; // Skip class if not in class filter if (!opts.classes || opts.classes.indexOf(name) !== -1) { const entity = entities[name]; const iter = entity.attributes(); for (let el = iter.next(); !el.done; el = iter.next()) { const attr = el.value; // Filter only referencing singular and collection attributes if (attr.type === this || attr.elementType === this) { const typeReferences = referencing.get(attr.declaringType) || new Set(); typeReferences.add(attr.name); referencing.set(attr.declaringType, typeReferences); } } } } return referencing; } /** * @inheritDoc */ createObjectFactory(db) { switch (this.name) { case 'User': return binding.UserFactory.create(this, db); case 'Device': return binding.DeviceFactory.create(this, db); case 'Object': return undefined; default: return binding.EntityFactory.create(this, db); } } /** * @param {util.Metadata} state The root object state, can be <code>null</code> if a currentObject is provided * @param {json} jsonObject The json data to merge * @param {*} currentObject The object where the jsonObject will be merged into, if the current object is null, * a new instance will be created * @param {Object=} options The options used to apply the json * @param {boolean} [options.persisting=false] indicates if the current state will be persisted. * Used to update the internal change tracking state of collections and mark the object persistent or dirty afterwards * @param {boolean} [options.onlyMetadata=false] Indicates if only the metadata should be updated * @return {*} The merged entity instance */ fromJsonValue(state, jsonObject, currentObject, options) { // handle references if (typeof jsonObject === 'string') { return state.db.getReference(jsonObject); } if (!jsonObject || typeof jsonObject !== 'object') { return null; } const opt = Object.assign({ persisting: false, onlyMetadata: false, }, options); let obj; let objectState; if (currentObject) { const currentObjectState = Metadata.get(currentObject); // merge state into the current object if: // 1. The provided json does not contains an id and we have an already created object for it // 2. The object was created without an id and was later fetched from the server (e.g. User/Role) // 3. The provided json has the same id as the current object, they can differ on embedded json for a reference if (!jsonObject.id || !currentObjectState.id || jsonObject.id === currentObjectState.id) { obj = currentObject; objectState = currentObjectState; } } if (!obj) { obj = state.db.getReference(this.typeConstructor, jsonObject.id); objectState = Metadata.get(obj); } // deserialize our properties objectState.enable(false); super.fromJsonValue(objectState, jsonObject, obj, opt); objectState.enable(true); if (opt.persisting) { objectState.setPersistent(); } else if (!opt.onlyMetadata) { objectState.setDirty(); } return obj; } /** * Converts the given object to json * @param {util.Metadata} state The root object state * @param {*} object The object to convert * @param {Object} [options=false] to json options by default excludes the metadata * @param {boolean} [options.excludeMetadata=false] Excludes the metadata form the serialized json * @param {number|boolean} [options.depth=0] Includes up to depth referenced objects into the serialized json * @param {boolean} [options.persisting=false] indicates if the current state will be persisted. * Used to update the internal change tracking state of collections and mark the object persistent if its true * @return {json} JSON-Object */ toJsonValue(state, object, options) { const opt = Object.assign({ excludeMetadata: false, depth: 0, persisting: false, }, options); const isInDepth = opt.depth === true || opt.depth > -1; // check if object is already loaded in state const objectState = object && Metadata.get(object); if (isInDepth && objectState && objectState.isAvailable) { // serialize our properties objectState.enable(false); const json = super.toJsonValue(objectState, object, Object.assign({}, opt, { depth: opt.depth === true ? true : opt.depth - 1, })); objectState.enable(true); return json; } if (object instanceof this.typeConstructor) { object.attach(state.db); return object.id; } return null; } toString() { return 'EntityType(' + this.ref + ')'; } toJSON() { const json = super.toJSON(); json.acl.schemaSubclass = this.schemaSubclassPermission; json.acl.insert = this.insertPermission; json.acl.update = this.updatePermission; json.acl.delete = this.deletePermission; json.acl.query = this.queryPermission; return json; } } /** * @alias metamodel.EntityType.Object * @extends metamodel.EntityType */ class ObjectType extends EntityType { static get ref() { return '/db/Object'; } constructor() { super(EntityType.Object.ref, null, Object); this.declaredId = new class extends SingularAttribute { constructor() { super('id', BasicType.String, true); } getJsonValue(state) { return state.id || undefined; } setJsonValue(state, object, jsonValue) { if (!this.id) { state.id = jsonValue; } } }(); this.declaredId.init(this, 0); this.declaredId.isId = true; this.declaredVersion = new class extends SingularAttribute { constructor() { super('version', BasicType.Integer, true); } getJsonValue(state) { return state.version || undefined; } setJsonValue(state, object, jsonValue) { if (jsonValue) { state.version = jsonValue; } } }(); this.declaredVersion.init(this, 1); this.declaredVersion.isVersion = true; this.declaredAcl = new class extends SingularAttribute { constructor() { super('acl', BasicType.JsonObject, true); } getJsonValue(state) { return state.acl.toJSON(); } setJsonValue(state, object, jsonValue) { state.acl.fromJSON(jsonValue || {}); } }(); this.declaredAcl.init(this, 2); this.declaredAcl.isAcl = true; this.declaredAttributes = [this.declaredId, this.declaredVersion, this.declaredAcl]; } } EntityType.Object = ObjectType; module.exports = EntityType; </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>