base-domain
Version:
simple module to help build Domain-Driven Design
1,030 lines (687 loc) • 31.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>BaseRepository</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="" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: </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/Base.html">Base</a></li>
<li><a href="../classes/BaseDict.html">BaseDict</a></li>
<li><a href="../classes/BaseFactory.html">BaseFactory</a></li>
<li><a href="../classes/BaseList.html">BaseList</a></li>
<li><a href="../classes/BaseModel.html">BaseModel</a></li>
<li><a href="../classes/BaseRepository.html">BaseRepository</a></li>
<li><a href="../classes/DictFactory.html">DictFactory</a></li>
<li><a href="../classes/DomainError.html">DomainError</a></li>
<li><a href="../classes/Entity.html">Entity</a></li>
<li><a href="../classes/Facade.html">Facade</a></li>
<li><a href="../classes/Fixture.html">Fixture</a></li>
<li><a href="../classes/FixtureModel.html">FixtureModel</a></li>
<li><a href="../classes/Includer.html">Includer</a></li>
<li><a href="../classes/ListFactory.html">ListFactory</a></li>
<li><a href="../classes/MasterRepository.html">MasterRepository</a></li>
<li><a href="../classes/PropInfo.html">PropInfo</a></li>
<li><a href="../classes/ResourceClientInterface.html">ResourceClientInterface</a></li>
<li><a href="../classes/TypeInfo.html">TypeInfo</a></li>
<li><a href="../classes/Util.html">Util</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/base-domain.html">base-domain</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>BaseRepository Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/Base.html" class="crosslink">Base</a>
</div>
<div class="foundat">
Defined in: <a href="../files/src_lib_base-repository.coffee.html#l7"><code>src/lib/base-repository.coffee:7</code></a>
</div>
Module: <a href="../modules/base-domain.html">base-domain</a>
</div>
<div class="box intro">
<p>Base repository class of DDD pattern.
Responsible for perpetuation of models.
BaseRepository has a client, which access to data resource (RDB, NoSQL, memory, etc...)</p>
<p>the parent "Base" class just simply gives a @getFacade() method.</p>
</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 extends">
<li class="index-item method protected">
<a href="#method_appendTimeStamp">appendTimeStamp</a>
</li>
<li class="index-item method public">
<a href="#method_delete">delete</a>
</li>
<li class="index-item method public">
<a href="#method_get">get</a>
</li>
<li class="index-item method public">
<a href="#method_getById">getById</a>
</li>
<li class="index-item method inherited">
<a href="#method_getFacade">getFacade</a>
</li>
<li class="index-item method">
<a href="#method_getModelClass">getModelClass</a>
</li>
<li class="index-item method public">
<a href="#method_query">query</a>
</li>
<li class="index-item method public">
<a href="#method_save">save</a>
</li>
<li class="index-item method public">
<a href="#method_singleQuery">singleQuery</a>
</li>
<li class="index-item method public">
<a href="#method_update">update</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property protected">
<a href="#property_client">client</a>
</li>
<li class="index-item property protected">
<a href="#property_modelName">modelName</a>
<span class="flag static">static</span>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_appendTimeStamp" class="method item protected">
<h3 class="name"><code>appendTimeStamp</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>data</code>
</li>
<li class="arg">
<code>isUpdate</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l196"><code>src/lib/base-repository.coffee:196</code></a>
</p>
</div>
<div class="description">
<p>add createdAt, updatedAt to given data</p>
<ul>
<li>createdAt will not be overriden if already set.</li>
<li>updatedAt will be overriden for each time</li>
</ul>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">isUpdate</code>
<span class="type">Boolean</span>
<div class="param-description">
<p>true when updating</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<p>data</p>
</div>
</div>
</div>
<div id="method_delete" class="method item public">
<h3 class="name"><code>delete</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>entity</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Boolean)</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l157"><code>src/lib/base-repository.coffee:157</code></a>
</p>
</div>
<div class="description">
<p>Destroy the given entity (which must have "id" value)</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">entity</code>
<span class="type"><a href="../classes/Entity.html" class="crosslink">Entity</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Boolean)</span>:
<p>isDeleted</p>
</div>
</div>
</div>
<div id="method_get" class="method item public">
<h3 class="name"><code>get</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Entity)</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l96"><code>src/lib/base-repository.coffee:96</code></a>
</p>
</div>
<div class="description">
<p>get object by ID.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">Any</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Entity)</span>:
<p>entity</p>
</div>
</div>
</div>
<div id="method_getById" class="method item public">
<h3 class="name"><code>getById</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Entity)</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l112"><code>src/lib/base-repository.coffee:112</code></a>
</p>
</div>
<div class="description">
<p>alias for get()</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">Any</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Entity)</span>:
<p>entity</p>
</div>
</div>
</div>
<div id="method_getFacade" class="method item inherited">
<h3 class="name"><code>getFacade</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Facade.html" class="crosslink">Facade</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Base.html#method_getFacade">Base</a>:
<a href="../files/src_lib_base.coffee.html#l32"><code>src/lib/base.coffee:32</code></a>
</p>
</div>
<div class="description">
<p>get facade</p>
<p>the implementation is in Facade#requre()</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Facade.html" class="crosslink">Facade</a></span>:
</div>
</div>
</div>
<div id="method_getModelClass" class="method item">
<h3 class="name"><code>getModelClass</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l60"><code>src/lib/base-repository.coffee:60</code></a>
</p>
</div>
<div class="description">
<p>get model class this factory handles</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
</div>
</div>
</div>
<div id="method_query" class="method item public">
<h3 class="name"><code>query</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[params]</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Array(Entity))</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l126"><code>src/lib/base-repository.coffee:126</code></a>
</p>
</div>
<div class="description">
<p>Find all model instances that match params</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[params]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>query parameters</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Array(Entity))</span>:
<p>array of entities</p>
</div>
</div>
</div>
<div id="method_save" class="method item public">
<h3 class="name"><code>save</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>entity</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Entity)</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l72"><code>src/lib/base-repository.coffee:72</code></a>
</p>
</div>
<div class="description">
<p>Update or insert a model instance</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">entity</code>
<span class="type"><a href="../classes/Entity.html" class="crosslink">Entity</a> | Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Entity)</span>:
<p>entity (the same instance from input, if entity given,)</p>
</div>
</div>
</div>
<div id="method_singleQuery" class="method item public">
<h3 class="name"><code>singleQuery</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[params]</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Entity)</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l141"><code>src/lib/base-repository.coffee:141</code></a>
</p>
</div>
<div class="description">
<p>Find one model instance that matches params, Same as query, but limited to one result</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[params]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>query parameters</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Entity)</span>:
<p>entity</p>
</div>
</div>
</div>
<div id="method_update" class="method item public">
<h3 class="name"><code>update</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>data</code>
</li>
<li class="arg">
<code class="optional">[client=@client]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise(Entity)</span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l172"><code>src/lib/base-repository.coffee:172</code></a>
</p>
</div>
<div class="description">
<p>Update set of attributes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">Any</span>
<div class="param-description">
<p>id of the entity to update</p>
</div>
</li>
<li class="param">
<code class="param-name">data</code>
<span class="type">Object</span>
<div class="param-description">
<p>key-value pair to update (notice: this must not be instance of Entity)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[client=@client]</code>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise(Entity)</span>:
<p>updated entity</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_client" class="property item protected">
<h3 class="name"><code>client</code></h3>
<span class="type"><a href="../classes/ResourceClientInterface.html" class="crosslink">ResourceClientInterface</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l32"><code>src/lib/base-repository.coffee:32</code></a>
</p>
</div>
<div class="description">
<p>client accessing to data resource (RDB, NoSQL, memory, etc...)</p>
<p>mock object is input by default.
Extenders must set this property to achieve perpetuation</p>
</div>
</div>
<div id="property_modelName" class="property item protected">
<h3 class="name"><code>modelName</code></h3>
<span class="type">String</span>
<span class="flag protected">protected</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_lib_base-repository.coffee.html#l20"><code>src/lib/base-repository.coffee:20</code></a>
</p>
</div>
<div class="description">
<p>model name to handle</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>