| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Class: CollectionObjectType</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: CollectionObjectType</h1> |
| |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| |
| <h2><span class="attribs"><span class="type-signature"></span></span>CollectionObjectType<span class="signature">(collectionSubType, elementType<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> |
| |
| <div class="class-description"><p>Class representing a collection type of Ignite object.</p> |
| <p>It is described by COMPOSITE_TYPE.COLLECTION <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a> |
| and one of <a href="CollectionObjectType.html#.COLLECTION_SUBTYPE">CollectionObjectType.COLLECTION_SUBTYPE</a>.</p></div> |
| |
| |
| </header> |
| |
| <article> |
| <div class="container-overview"> |
| |
| |
| |
| |
| <h2>Constructor</h2> |
| |
| |
| |
| <h4 class="name" id="CollectionObjectType"><span class="type-signature"></span>new CollectionObjectType<span class="signature">(collectionSubType, elementType<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Public constructor.</p> |
| <p>Specifies a kind of collection |
| and optionally specifies a type of elements in the collection.</p> |
| <p>If the type of elements 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>Attributes</th> |
| |
| |
| |
| <th>Default</th> |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>collectionSubType</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="CollectionObjectType.html#.COLLECTION_SUBTYPE">CollectionObjectType.COLLECTION_SUBTYPE</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| |
| |
| </td> |
| |
| |
| |
| <td class="default"> |
| |
| </td> |
| |
| |
| <td class="description last"><p>collection subtype, one of the |
| <a href="CollectionObjectType.html#.COLLECTION_SUBTYPE">CollectionObjectType.COLLECTION_SUBTYPE</a> constants.</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>elementType</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="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| |
| |
| </td> |
| |
| |
| |
| <td class="default"> |
| |
| null |
| |
| </td> |
| |
| |
| <td class="description last"><p>type of elements in the collection:</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 (or not specified) that 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#line413">line 413</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">Members</h3> |
| |
| |
| |
| <h4 class="name" id=".COLLECTION_SUBTYPE"><span class="type-signature">(static, readonly) </span>COLLECTION_SUBTYPE<span class="type-signature"></span></h4> |
| |
| |
| |
| |
| <div class="description"> |
| <p>Supported kinds of collections.</p> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>USER_SET</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>1</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>USER_COL</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>0</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>ARRAY_LIST</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>1</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>LINKED_LIST</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>2</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>HASH_SET</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>3</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>LINKED_HASH_SET</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>4</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>SINGLETON_LIST</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>5</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#line382">line 382</a> |
| </li></ul></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> |
