| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Class: ComplexObjectType</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">Class: ComplexObjectType</h1> |
| |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| |
| <h2><span class="attribs"><span class="type-signature"></span></span>ComplexObjectType<span class="signature">(jsObject, typeName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> |
| |
| <div class="class-description"><p>Class representing a complex type of Ignite object.</p> |
| <p>It is described by COMPOSITE_TYPE.COMPLEX_OBJECT <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a>, |
| by a name of the complex type and by a JavaScript Object which is mapped to/from the Ignite complex type.</p></div> |
| |
| |
| </header> |
| |
| <article> |
| <div class="container-overview"> |
| |
| |
| |
| |
| <h2>Constructor</h2> |
| |
| |
| |
| <h4 class="name" id="ComplexObjectType"><span class="type-signature"></span>new ComplexObjectType<span class="signature">(jsObject, typeName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Public constructor.</p> |
| <p>Specifies a JavaScript Object type which will be mapped to/from the complex type. |
| This specification is done using an instance of the JavaScript Object.</p> |
| <p>If an object of the complex type is going to be received (deserialized), |
| the JavaScript Object must have a constructor without parameters or with optional parameters only.</p> |
| <p>The JavaScript Object defines a set of fields of the complex type.</p> |
| <p>By default, the fields have no types specified. It means during operations the Ignite client |
| will try to make automatic mapping between JavaScript types and Ignite object types - |
| according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p> |
| <p>A type of any field may be specified later by setFieldType() method.</p> |
| <p>By default, the name of the complex type is the name of the JavaScript Object. |
| The name may be explicitely specified using optional typeName parameter in the constructor.</p> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Parameters:</h5> |
| |
| |
| <table class="params"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| <th>Default</th> |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>jsObject</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">object</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| |
| |
| </td> |
| |
| |
| |
| <td class="default"> |
| |
| </td> |
| |
| |
| <td class="description last"><p>instance of JavaScript Object which will be mapped to/from this complex type.</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>typeName</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| |
| |
| </td> |
| |
| |
| |
| <td class="default"> |
| |
| null |
| |
| </td> |
| |
| |
| <td class="description last"><p>name of the complex type.</p></td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line511">line 511</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| <h3 class="subsection-title">Extends</h3> |
| |
| |
| |
| |
| <ul> |
| <li><a href="CompositeType.html">CompositeType</a></li> |
| </ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Methods</h3> |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="setFieldType"><span class="type-signature"></span>setFieldType<span class="signature">(fieldName, fieldType)</span><span class="type-signature"> → {<a href="ComplexObjectType.html">ComplexObjectType</a>}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Specifies a type of the field in the complex type.</p> |
| <p>If the type is not specified then during operations the Ignite client |
| will try to make automatic mapping between JavaScript types and Ignite object types - |
| according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Parameters:</h5> |
| |
| |
| <table class="params"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>fieldName</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>name of the field.</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>fieldType</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a></span> |
| | |
| |
| <span class="param-type"><a href="CompositeType.html">CompositeType</a></span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>type of the field:</p> |
| <ul> |
| <li>either a type code of primitive (simple) type</li> |
| <li>or an instance of class representing non-primitive (composite) type</li> |
| <li>or null (means the type is not specified).</li> |
| </ul></td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line574">line 574</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Throws:</h5> |
| |
| |
| |
| <dl> |
| <dt> |
| <div class="param-desc"> |
| <p>if error.</p> |
| </div> |
| </dt> |
| <dd></dd> |
| <dt> |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> |
| |
| |
| </dd> |
| </dl> |
| </dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| <ul> |
| <li>the same instance of the ComplexObjectType.</li> |
| </ul> |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type"><a href="ComplexObjectType.html">ComplexObjectType</a></span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| </section> |
| |
| |
| |
| |
| </div> |
| |
| <nav> |
| <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> |
| </nav> |
| |
| <br class="clear"> |
| |
| <footer> |
| Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time) |
| </footer> |
| |
| <script> prettyPrint(); </script> |
| <script src="scripts/linenumber.js"> </script> |
| </body> |
| </html> |