| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Module: odata/metadata</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">Module: odata/metadata</h1> |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| <h2> |
| odata/metadata |
| </h2> |
| |
| </header> |
| |
| <article> |
| <div class="container-overview"> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line21">line 21</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Methods</h3> |
| |
| <dl> |
| |
| <dt> |
| <h4 class="name" id="getChildSchema"><span class="type-signature"><inner> </span>getChildSchema<span class="signature">(parentSchema, candidateName)</span><span class="type-signature"> → {Object}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Gets the schema node for the specified element. |
| </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>parentSchema</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Schema of the parent XML node of 'element'.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>candidateName</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">XML element name to consider.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line392">line 392</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| The schema that describes the specified element; null if not found. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="isEdmNamespace"><span class="type-signature"><inner> </span>isEdmNamespace<span class="signature">(nsURI)</span><span class="type-signature"> → {Boolean}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Checks whether the specifies namespace URI is one of the known CSDL namespace URIs. |
| </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>nsURI</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Namespace URI to check.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line421">line 421</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| true if nsURI is a known CSDL namespace; false otherwise. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="metadataParser"><span class="type-signature"><inner> </span>metadataParser<span class="signature">(handler, text)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Parses a metadata document. |
| </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>handler</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">This handler.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>text</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata text.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line508">line 508</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| An object representation of the conceptual model. |
| </div> |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="parseConceptualModelElement"><span class="type-signature"><inner> </span>parseConceptualModelElement<span class="signature">(element)</span><span class="type-signature"> → {Object}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Parses a CSDL document. |
| </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>element</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">DOM element to parse.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line430">line 430</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| An object describing the parsed element. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="schemaElement"><span class="type-signature"><inner> </span>schemaElement<span class="signature">(attributes, elements, text, ns)</span><span class="type-signature"> → {Object}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Creates an object that describes an element in an schema. |
| </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>attributes</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">List containing the names of the attributes allowed for this element.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>elements</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">List containing the names of the child elements allowed for this element.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>text</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating if the element's text value is of interest or not.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>ns</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Namespace to which the element belongs to.
If a child element name ends with * then it is understood by the schema that that child element can appear 0 or more times.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line59">line 59</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Object with attributes, elements, text, and ns fields. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="scriptCase"><span class="type-signature"><inner> </span>scriptCase<span class="signature">(text)</span><span class="type-signature"> → {String}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Converts a Pascal-case identifier into a camel-case identifier. |
| </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>text</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Text to convert.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="metadata.js.html">odata/metadata.js</a>, <a href="metadata.js.html#line369">line 369</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Converted text.
If the text starts with multiple uppercase characters, it is left as-is. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">String</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| </dl> |
| |
| |
| |
| |
| |
| </article> |
| |
| </section> |
| |
| |
| |
| |
| </div> |
| |
| <nav> |
| <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cache.html">cache</a></li><li><a href="source.html">cache/source</a></li><li><a href="module-odata.html">odata</a></li><li><a href="batch.html">odata/batch</a></li><li><a href="handler.html">odata/handler</a></li><li><a href="json.html">odata/json</a></li><li><a href="metadata.html">odata/metadata</a></li><li><a href="net.html">odata/net</a></li><li><a href="utils.html">odata/utils</a></li><li><a href="deferred.html">odatajs/deferred</a></li><li><a href="utils_.html">odatajs/utils</a></li><li><a href="xml.html">odatajs/xml</a></li><li><a href="module-store.html">store</a></li><li><a href="dom.html">store/dom</a></li><li><a href="indexeddb.html">store/indexeddb</a></li><li><a href="memory.html">store/memory</a></li></ul><h3>Classes</h3><ul><li><a href="DataCache.html">DataCache</a></li><li><a href="DataCacheOperation.html">DataCacheOperation</a></li><li><a href="DjsDeferred.html">DjsDeferred</a></li><li><a href="dom-DomStore.html">DomStore</a></li><li><a href="indexeddb-IndexedDBStore.html">IndexedDBStore</a></li><li><a href="memory-MemoryStore.html">MemoryStore</a></li><li><a href="ODataCacheSource.html">ODataCacheSource</a></li></ul><h3><a href="global.html">Global</a></h3> |
| </nav> |
| |
| <br clear="both"> |
| |
| <footer> |
| Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Apr 09 2015 08:31:26 GMT+0200 (MESZ) |
| </footer> |
| |
| <script> prettyPrint(); </script> |
| <script src="scripts/linenumber.js"> </script> |
| </body> |
| </html> |
