jsdataset
Version:
DataSet (like .Net) made available for javascript and more
834 lines (540 loc) • 25.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>DataRelation - jsDataSet</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="jsDataSet" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.0.6</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AutoIncrementColumn.html">AutoIncrementColumn</a></li>
<li><a href="../classes/DataColumn.html">DataColumn</a></li>
<li><a href="../classes/DataRelation.html">DataRelation</a></li>
<li><a href="../classes/DataRow.html">DataRow</a></li>
<li><a href="../classes/DataSet.html">DataSet</a></li>
<li><a href="../classes/DataTable.html">DataTable</a></li>
<li><a href="../classes/ObjectRow.html">ObjectRow</a></li>
<li><a href="../classes/OptimisticLocking.html">OptimisticLocking</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/DataRow.html">DataRow</a></li>
<li><a href="../modules/DataSet.html">DataSet</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>DataRelation Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_jsDataSet.js.html#l2363"><code>src\jsDataSet.js:2363</code></a>
</div>
Module: <a href="../modules/DataSet.html">DataSet</a>
</div>
<div class="box intro">
<p>creates a DataRelation</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_DataRelation" class="method item">
<h3 class="name"><code>DataRelation</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>relationName</code>
</li>
<li class="arg">
<code>parentTableName</code>
</li>
<li class="arg">
<code>parentColsName</code>
</li>
<li class="arg">
<code>childTableName</code>
</li>
<li class="arg">
<code class="optional">[childColsName=parentColsName]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataRelation.html" class="crosslink">DataRelation</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2363"><code>src\jsDataSet.js:2363</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">relationName</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">parentTableName</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">parentColsName</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="param-description">
<p>array of string</p>
</div>
</li>
<li class="param">
<code class="param-name">childTableName</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[childColsName=parentColsName]</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>optional names of child columns</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataRelation.html" class="crosslink">DataRelation</a></span>:
</div>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_getChild">getChild</a>
</li>
<li class="index-item method">
<a href="#method_getChildFilter">getChildFilter</a>
</li>
<li class="index-item method">
<a href="#method_getParents">getParents</a>
</li>
<li class="index-item method">
<a href="#method_getParentsFilter">getParentsFilter</a>
</li>
<li class="index-item method">
<a href="#method_isEntityRelation">isEntityRelation</a>
</li>
<li class="index-item method">
<a href="#method_makeChild">makeChild</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_childCols">childCols</a>
</li>
<li class="index-item property">
<a href="#property_childTable">childTable</a>
</li>
<li class="index-item property">
<a href="#property_dataSet">dataSet</a>
</li>
<li class="index-item property">
<a href="#property_parentCols">parentCols</a>
</li>
<li class="index-item property">
<a href="#property_parentTable">parentTable</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_getChild" class="method item">
<h3 class="name"><code>getChild</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentRow</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow[]</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2442"><code>src\jsDataSet.js:2442</code></a>
</p>
</div>
<div class="description">
<p>Get any child of a given ObjectRow following this DataRelation</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentRow</code>
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow[]</a></span>:
</div>
</div>
</div>
<div id="method_getChildFilter" class="method item">
<h3 class="name"><code>getChildFilter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentRow</code>
</li>
<li class="arg">
<code class="optional">[alias]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2426"><code>src\jsDataSet.js:2426</code></a>
</p>
</div>
<div class="description">
<p>Gets a filter that will be applied to the child table and will find any child row of a given ObjectRow</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentRow</code>
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[alias]</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>when present is used to attach an alias for the parent table in the composed filter</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getParents" class="method item">
<h3 class="name"><code>getParents</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>childRow</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow[]</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2474"><code>src\jsDataSet.js:2474</code></a>
</p>
</div>
<div class="description">
<p>Get any parent of a given ObjectRow following this DataRelation</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">childRow</code>
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow[]</a></span>:
</div>
</div>
</div>
<div id="method_getParentsFilter" class="method item">
<h3 class="name"><code>getParentsFilter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>childRow</code>
</li>
<li class="arg">
<code class="optional">[alias]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2457"><code>src\jsDataSet.js:2457</code></a>
</p>
</div>
<div class="description">
<p>Gets a filter that will be applied to the parent table and will find any parent row of a given ObjectRow</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">childRow</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[alias]</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>when present is used to attach an alias for the parent table in the composed filter</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_isEntityRelation" class="method item">
<h3 class="name"><code>isEntityRelation</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2540"><code>src\jsDataSet.js:2540</code></a>
</p>
</div>
<div class="description">
<p>Establish if a relation links the key of a table into a subset of another table key</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
</div>
</div>
</div>
<div id="method_makeChild" class="method item">
<h3 class="name"><code>makeChild</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentRow</code>
</li>
<li class="arg">
<code>childRow</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2563"><code>src\jsDataSet.js:2563</code></a>
</p>
</div>
<div class="description">
<p>Modifies childRow in order to make it child of parentRow. Sets to null corresponding fields if
parentRow is null or undefined</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentRow</code>
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">childRow</code>
<span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"></span>:
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_childCols" class="property item">
<h3 class="name"><code>childCols</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2408"><code>src\jsDataSet.js:2408</code></a>
</p>
</div>
<div class="description">
<p>Array of child column names or comma separated column names</p>
</div>
</div>
<div id="property_childTable" class="property item">
<h3 class="name"><code>childTable</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2401"><code>src\jsDataSet.js:2401</code></a>
</p>
</div>
<div class="description">
<p>Child table name</p>
</div>
</div>
<div id="property_dataSet" class="property item">
<h3 class="name"><code>dataSet</code></h3>
<span class="type"><a href="../classes/DataSet.html" class="crosslink">DataSet</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2383"><code>src\jsDataSet.js:2383</code></a>
</p>
</div>
<div class="description">
<p>DataSet to which this DataRelation belongs to. It is used to retrieve parent and child table</p>
</div>
</div>
<div id="property_parentCols" class="property item">
<h3 class="name"><code>parentCols</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2390"><code>src\jsDataSet.js:2390</code></a>
</p>
</div>
<div class="description">
<p>Array of parent column names or comma separated column names</p>
</div>
</div>
<div id="property_parentTable" class="property item">
<h3 class="name"><code>parentTable</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l2376"><code>src\jsDataSet.js:2376</code></a>
</p>
</div>
<div class="description">
<p>Parent table name</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>