data-restructor 3.4.0 → 3.4.2

package/docs/module-datarestructor.Transform.html

@@ -347,7 +347,7 @@
     
 
     
-    <h4 class="name" id=".applyGroupDestinationPattern"><span class="type-signature">(protected, static) </span>applyGroupDestinationPattern<span class="signature">(groupedObject)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
+    <h4 class="name" id="enableDebugMode"><span class="type-signature"></span>enableDebugMode<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a>}</span></h4>
     
 
     
@@ -355,11 +355,7 @@
 
 
 <div class="description">
-    <p>Takes already grouped <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a> objects and
-uses their &quot;_identifier.groupDestinationId&quot; (if exists)
-to move groups to the given destination.</p>
-<p>This is useful, if separately described groups like &quot;summary&quot; and &quot;detail&quot; should be put together,
-so that every summery contains a group with the regarding details.</p>
+    <p>Enables debug mode. Logs additional information.</p>
 </div>
 
 
@@ -370,55 +366,6 @@ so that every summery contains a group with the regarding details.</p>
 
 
 
-    <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>groupedObject</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>already grouped entries</p></td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-
 
 
 
@@ -452,7 +399,7 @@ so that every summery contains a group with the regarding details.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line996">line 996</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line688">line 688</a>
     </li></ul></dd>
     
 
@@ -488,7 +435,7 @@ so that every summery contains a group with the regarding details.</p>
     </dt>
     <dd>
         
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+<span class="param-type"><a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a></span>
 
 
     </dd>
@@ -506,7 +453,7 @@ so that every summery contains a group with the regarding details.</p>
     
 
     
-    <h4 class="name" id=".asIdBasedObject"><span class="type-signature">(protected, static) </span>asIdBasedObject<span class="signature">(elements, idOfElementFunction)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="processJson"><span class="type-signature"></span>processJson<span class="signature">(data)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
     
 
     
@@ -514,9 +461,7 @@ so that every summery contains a group with the regarding details.</p>
 
 
 <div class="description">
-    <p>Converts the given elements to an object, that provides these
-entries by their id. For example, [{id: A, value: 1}] becomes
-result['A'] = 1.</p>
+    <p>&quot;Assembly line&quot;, that takes the (pared JSON) data and processes it using all given descriptions in their given order.</p>
 </div>
 
 
@@ -552,36 +497,13 @@ result['A'] = 1.</p>
 
         <tr>
             
-                <td class="name"><code>elements</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>of DescribedEntry elements</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>idOfElementFunction</code></td>
+                <td class="name"><code>data</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
+<span class="param-type">object</span>
 
 
             
@@ -591,7 +513,7 @@ result['A'] = 1.</p>
 
             
 
-            <td class="description last"><p>returns the id of an DescribedEntry</p></td>
+            <td class="description last"><p>parsed JSON data or any other data object</p></td>
         </tr>
 
     
@@ -632,7 +554,7 @@ result['A'] = 1.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line890">line 890</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line735">line 735</a>
     </li></ul></dd>
     
 
@@ -660,17 +582,33 @@ result['A'] = 1.</p>
 <h5>Returns:</h5>
 
         
-<div class="param-desc">
-    <p>{module:datarestructor.DescribedEntry[] entries indexed by id</p>
-</div>
 
 
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+
+
+    </dd>
+</dl>
 
     
 
 
 
 
+    <h5>Example</h5>
+    
+    <pre class="prettyprint"><code>var allDescriptions = [];
+allDescriptions.push(summariesDescription());
+allDescriptions.push(detailsDescription());
+var result = new datarestructor.Transform(allDescriptions).processJson(jsonData);</code></pre>
+
+
 
         
             
@@ -678,7 +616,7 @@ result['A'] = 1.</p>
     
 
     
-    <h4 class="name" id=".deduplicateFlattenedData"><span class="type-signature">(protected, static) </span>deduplicateFlattenedData<span class="signature">(entries, entriesToMerge, idOfElementFunction)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="setMaxRecursionDepth"><span class="type-signature"></span>setMaxRecursionDepth<span class="signature">(value)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a>}</span></h4>
     
 
     
@@ -686,18 +624,7 @@ result['A'] = 1.</p>
 
 
 <div class="description">
-    <p>Takes two arrays of objects, e.g. [{id: B, value: 2},{id: C, value: 3}]
-and [{id: A, value: 1},{id: B, value: 4}] and merges them into one:
-[{id: C, value: 3},{id: A, value: 1},{id: B, value: 4}]</p>
-<p>Entries with the same id (&quot;duplicates&quot;) will be overwritten.
-Only the last element with the same id remains. The order is
-determined by the order of the array elements, whereas the first
-array comes before the second one. This means, that entries with the
-same id in the second array overwrite entries in the first array,
-and entries occurring later in the array overwrite earlier ones,
-if they have the same id.</p>
-<p>&quot;entriesToMerge&quot; will be returned directly, if &quot;entries&quot; is null or empty.</p>
-<p>The id is extracted from every element using their deduplication pattern (if available).</p>
+    <p>Sets the maximum recursion depth. Defaults to 8 if not set.</p>
 </div>
 
 
@@ -733,59 +660,13 @@ if they have the same id.</p>
 
         <tr>
             
-                <td class="name"><code>entries</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>entriesToMerge</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>idOfElementFunction</code></td>
+                <td class="name"><code>value</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
+<span class="param-type">number</span>
 
 
             
@@ -795,7 +676,7 @@ if they have the same id.</p>
 
             
 
-            <td class="description last"><p>returns the id of an DescribedEntry</p></td>
+            <td class="description last"><p>non negative number.</p></td>
         </tr>
 
     
@@ -836,20 +717,13 @@ if they have the same id.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line870">line 870</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line698">line 698</a>
     </li></ul></dd>
     
 
     
 
     
-    <dt class="tag-see">See:</dt>
-    <dd class="tag-see">
-        <ul>
-            <li>mergeFlattenedData</li>
-        </ul>
-    </dd>
-    
 
     
 </dl>
@@ -868,6 +742,24 @@ if they have the same id.</p>
 
 
 
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type"><a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a></span>
+
+
+    </dd>
+</dl>
+
+    
 
 
 
@@ -879,7 +771,7 @@ if they have the same id.</p>
     
 
     
-    <h4 class="name" id=".extractEntriesByDescription"><span class="type-signature">(protected, static) </span>extractEntriesByDescription<span class="signature">(flattenedData)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
+    <h4 class="name" id="setRemoveDuplicationAboveRecursionDepth"><span class="type-signature"></span>setRemoveDuplicationAboveRecursionDepth<span class="signature">(value)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a>}</span></h4>
     
 
     
@@ -887,7 +779,13 @@ if they have the same id.</p>
 
 
 <div class="description">
-    <p>Extracts entries out of &quot;flattened&quot; JSON data and provides an array of objects.</p>
+    <p>Sets the recursion depth above which duplication will be removed. Duplications below it remain unchanged.
+Defaults to 1.</p>
+<p>Since fields can contain groups of fields that can contain groups of fields..., cyclic
+data structures are possible by nature and will lead to duplications. Some of them
+might be intended e.g. to take one (sub-)field with all (duplicated) groups.
+To restrict duplications and improve performance it is beneficial to define a
+recursion depth, above which further duplication won't be used and should be removed/avoided.</p>
 </div>
 
 
@@ -923,13 +821,13 @@ if they have the same id.</p>
 
         <tr>
             
-                <td class="name"><code>flattenedData</code></td>
+                <td class="name"><code>value</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">Array.&lt;Object></span>
+<span class="param-type">number</span>
 
 
             
@@ -939,114 +837,19 @@ if they have the same id.</p>
 
             
 
-            <td class="description last"><p>flattened json from search query result</p>
-                <h6>Properties</h6>
-                
+            <td class="description last"><p>non negative number.</p></td>
+        </tr>
 
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
+    
+    </tbody>
+</table>
 
-        <th>Type</th>
 
-        
 
-        
 
-        <th class="last">Description</th>
-    </tr>
-    </thead>
 
-    <tbody>
-    
 
-        <tr>
-            
-                <td class="name"><code>name</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>name of the property in hierarchical order separated by points</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>value</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>value of the property as string</p></td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-            </td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code></code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type"><a href="module-datarestructor.html#.PropertyStructureDescription">module:datarestructor.PropertyStructureDescription</a></span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>description of structure of the entries that should be extracted</p></td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
+<dl class="details">
 
     
 
@@ -1075,7 +878,7 @@ if they have the same id.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line967">line 967</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line718">line 718</a>
     </li></ul></dd>
     
 
@@ -1111,7 +914,7 @@ if they have the same id.</p>
     </dt>
     <dd>
         
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+<span class="param-type"><a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a></span>
 
 
     </dd>
@@ -1129,7 +932,7 @@ if they have the same id.</p>
     
 
     
-    <h4 class="name" id=".fillInArrayValues"><span class="type-signature">(protected, static) </span>fillInArrayValues<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".applyGroupDestinationPattern"><span class="type-signature">(protected, static) </span>applyGroupDestinationPattern<span class="signature">(groupedObject)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
     
 
     
@@ -1137,9 +940,11 @@ if they have the same id.</p>
 
 
 <div class="description">
-    <p>Fills in extra &quot;_comma_separated_values&quot; properties into the flattened data
-for properties that end with an array. E.g. response.hits.hits.tags[0]=&quot;active&quot; and response.hits.hits.tags[0]=&quot;ready&quot;
-will lead to the extra element &quot;response.hits.hits.tags_comma_separated_values=&quot;active, ready&quot;.</p>
+    <p>Takes already grouped <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a> objects and
+uses their &quot;_identifier.groupDestinationId&quot; (if exists)
+to move groups to the given destination.</p>
+<p>This is useful, if separately described groups like &quot;summary&quot; and &quot;detail&quot; should be put together,
+so that every summery contains a group with the regarding details.</p>
 </div>
 
 
@@ -1150,6 +955,55 @@ will lead to the extra element &quot;response.hits.hits.tags_comma_separated_val
 
 
 
+    <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>groupedObject</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>already grouped entries</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
 
 
 
@@ -1183,7 +1037,7 @@ will lead to the extra element &quot;response.hits.hits.tags_comma_separated_val
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1028">line 1028</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line996">line 996</a>
     </li></ul></dd>
     
 
@@ -1211,11 +1065,19 @@ will lead to the extra element &quot;response.hits.hits.tags_comma_separated_val
 <h5>Returns:</h5>
 
         
-<div class="param-desc">
-    <p>flattened data with filled in &quot;_comma_separated_values&quot; properties</p>
-</div>
 
 
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+
+
+    </dd>
+</dl>
 
     
 
@@ -1229,7 +1091,7 @@ will lead to the extra element &quot;response.hits.hits.tags_comma_separated_val
     
 
     
-    <h4 class="name" id=".forEachGroupEntry"><span class="type-signature">(protected, static) </span>forEachGroupEntry<span class="signature">(rootEntry, onFoundEntry)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".asIdBasedObject"><span class="type-signature">(protected, static) </span>asIdBasedObject<span class="signature">(elements, idOfElementFunction)</span><span class="type-signature"></span></h4>
     
 
     
@@ -1237,8 +1099,9 @@ will lead to the extra element &quot;response.hits.hits.tags_comma_separated_val
 
 
 <div class="description">
-    <p>Traverses through all groups and their entries and calls the given function on every found entry
-with the group name and the entry itself as parameters.</p>
+    <p>Converts the given elements to an object, that provides these
+entries by their id. For example, [{id: A, value: 1}] becomes
+result['A'] = 1.</p>
 </div>
 
 
@@ -1274,13 +1137,13 @@ with the group name and the entry itself as parameters.</p>
 
         <tr>
             
-                <td class="name"><code>rootEntry</code></td>
+                <td class="name"><code>elements</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
 
             
@@ -1290,20 +1153,20 @@ with the group name and the entry itself as parameters.</p>
 
             
 
-            <td class="description last"></td>
+            <td class="description last"><p>of DescribedEntry elements</p></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>onFoundEntry</code></td>
+                <td class="name"><code>idOfElementFunction</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.onEntryFoundFunction">module:datarestructor.onEntryFoundFunction</a></span>
+<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
 
 
             
@@ -1313,7 +1176,7 @@ with the group name and the entry itself as parameters.</p>
 
             
 
-            <td class="description last"></td>
+            <td class="description last"><p>returns the id of an DescribedEntry</p></td>
         </tr>
 
     
@@ -1354,7 +1217,7 @@ with the group name and the entry itself as parameters.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1199">line 1199</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line890">line 890</a>
     </li></ul></dd>
     
 
@@ -1379,6 +1242,16 @@ with the group name and the entry itself as parameters.</p>
 
 
 
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>{module:datarestructor.DescribedEntry[] entries indexed by id</p>
+</div>
+
+
+
+    
 
 
 
@@ -1390,7 +1263,7 @@ with the group name and the entry itself as parameters.</p>
     
 
     
-    <h4 class="name" id=".groupById"><span class="type-signature">(protected, static) </span>groupById<span class="signature">(elements, groupNameOfElementFunction, groupIdOfElementFunction)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".deduplicateFlattenedData"><span class="type-signature">(protected, static) </span>deduplicateFlattenedData<span class="signature">(entries, entriesToMerge, idOfElementFunction)</span><span class="type-signature"></span></h4>
     
 
     
@@ -1398,10 +1271,18 @@ with the group name and the entry itself as parameters.</p>
 
 
 <div class="description">
-    <p>Converts the given elements into an object, that provides these
-entries by their id. For example, [{id: A, value: 1}] becomes
-result['A'] = 1. Furthermore, this function creates a group property (with the name )
-and collects all related elements (specified by their group pattern) in it.</p>
+    <p>Takes two arrays of objects, e.g. [{id: B, value: 2},{id: C, value: 3}]
+and [{id: A, value: 1},{id: B, value: 4}] and merges them into one:
+[{id: C, value: 3},{id: A, value: 1},{id: B, value: 4}]</p>
+<p>Entries with the same id (&quot;duplicates&quot;) will be overwritten.
+Only the last element with the same id remains. The order is
+determined by the order of the array elements, whereas the first
+array comes before the second one. This means, that entries with the
+same id in the second array overwrite entries in the first array,
+and entries occurring later in the array overwrite earlier ones,
+if they have the same id.</p>
+<p>&quot;entriesToMerge&quot; will be returned directly, if &quot;entries&quot; is null or empty.</p>
+<p>The id is extracted from every element using their deduplication pattern (if available).</p>
 </div>
 
 
@@ -1437,7 +1318,7 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
         <tr>
             
-                <td class="name"><code>elements</code></td>
+                <td class="name"><code>entries</code></td>
             
 
             <td class="type">
@@ -1453,20 +1334,20 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
             
 
-            <td class="description last"><p>of DescribedEntry elements</p></td>
+            <td class="description last"></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>groupNameOfElementFunction</code></td>
+                <td class="name"><code>entriesToMerge</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
 
             
@@ -1476,14 +1357,14 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
             
 
-            <td class="description last"><p>function, that returns the name of the group property that will be created inside the &quot;main&quot; element.</p></td>
+            <td class="description last"></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>groupIdOfElementFunction</code></td>
+                <td class="name"><code>idOfElementFunction</code></td>
             
 
             <td class="type">
@@ -1499,7 +1380,7 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
             
 
-            <td class="description last"><p>returns the group id of an DescribedEntry</p></td>
+            <td class="description last"><p>returns the id of an DescribedEntry</p></td>
         </tr>
 
     
@@ -1540,13 +1421,20 @@ and collects all related elements (specified by their group pattern) in it.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line937">line 937</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line870">line 870</a>
     </li></ul></dd>
     
 
     
 
     
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>mergeFlattenedData</li>
+        </ul>
+    </dd>
+    
 
     
 </dl>
@@ -1565,16 +1453,6 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
 
 
-<h5>Returns:</h5>
-
-        
-<div class="param-desc">
-    <p>{module:datarestructor.DescribedEntry[] entries indexed by id</p>
-</div>
-
-
-
-    
 
 
 
@@ -1586,7 +1464,7 @@ and collects all related elements (specified by their group pattern) in it.</p>
     
 
     
-    <h4 class="name" id=".groupFlattenedData"><span class="type-signature">(protected, static) </span>groupFlattenedData<span class="signature">(elements)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".extractEntriesByDescription"><span class="type-signature">(protected, static) </span>extractEntriesByDescription<span class="signature">(flattenedData)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
     
 
     
@@ -1594,11 +1472,7 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
 
 <div class="description">
-    <p>Converts the given elements into an object, that provides these
-entries by their id (determined by the entry's groupPattern).
-For example, [{id: A, value: 1}] becomes result['A'] = 1.</p>
-<p>Furthermore, this function creates a group property (determined by the entry's groupName)
-and collects all related elements (specified by their group pattern) in it.</p>
+    <p>Extracts entries out of &quot;flattened&quot; JSON data and provides an array of objects.</p>
 </div>
 
 
@@ -1634,13 +1508,13 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
         <tr>
             
-                <td class="name"><code>elements</code></td>
+                <td class="name"><code>flattenedData</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+<span class="param-type">Array.&lt;Object></span>
 
 
             
@@ -1650,113 +1524,153 @@ and collects all related elements (specified by their group pattern) in it.</p>
 
             
 
-            <td class="description last"><p>of DescribedEntry elements</p></td>
-        </tr>
+            <td class="description last"><p>flattened json from search query result</p>
+                <h6>Properties</h6>
+                
 
-    
-    </tbody>
-</table>
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
 
+        <th>Type</th>
 
+        
 
+        
 
+        <th class="last">Description</th>
+    </tr>
+    </thead>
 
+    <tbody>
+    
 
-<dl class="details">
+        <tr>
+            
+                <td class="name"><code>name</code></td>
+            
 
-    
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
 
-    
 
-    
+            
+            </td>
 
-    
+            
 
-    
+            
 
-    
+            <td class="description last"><p>name of the property in hierarchical order separated by points</p></td>
+        </tr>
 
     
 
-    
+        <tr>
+            
+                <td class="name"><code>value</code></td>
+            
 
-    
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
 
-    
 
-    
+            
+            </td>
 
-    
+            
 
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line912">line 912</a>
-    </li></ul></dd>
-    
+            
 
-    
+            <td class="description last"><p>value of the property as string</p></td>
+        </tr>
 
     
+    </tbody>
+</table>
+
+            </td>
+        </tr>
 
     
-</dl>
 
+        <tr>
+            
+                <td class="name"><code></code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-datarestructor.html#.PropertyStructureDescription">module:datarestructor.PropertyStructureDescription</a></span>
 
 
+            
+            </td>
 
+            
 
+            
 
+            <td class="description last"><p>description of structure of the entries that should be extracted</p></td>
+        </tr>
 
+    
+    </tbody>
+</table>
 
 
 
 
 
 
+<dl class="details">
 
+    
 
-<h5>Returns:</h5>
+    
 
-        
-<div class="param-desc">
-    <p>{module:datarestructor.DescribedEntry[] entries indexed by id</p>
-</div>
+    
 
+    
 
+    
 
     
 
+    
 
+    
 
+    
 
+    
 
-        
-            
+    
 
     
 
     
-    <h4 class="name" id=".mergeFlattenedData"><span class="type-signature">(protected, static) </span>mergeFlattenedData<span class="signature">(entries, entriesToMerge, idOfElementFunction)</span><span class="type-signature"></span></h4>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line967">line 967</a>
+    </li></ul></dd>
     
 
     
 
+    
 
+    
+</dl>
 
-<div class="description">
-    <p>Takes two arrays of objects, e.g. [{id: B, value: 2},{id: C, value: 3}]
-and [{id: A, value: 1},{id: B, value: 4}] and merges them into one:
-[{id: C, value: 3},{id: A, value: 1},{id: B, value: 4}]</p>
-<p>Entries with the same id (&quot;duplicates&quot;) will be overwritten.
-Only the last element with the same id remains. The order is
-determined by the order of the array elements, whereas the first
-array comes before the second one. This means, that entries with the
-same id in the second array overwrite entries in the first array,
-and entries that occur later in the array overwrite earlier ones,
-if they have the same id.</p>
-<p>The id is extracted from every element using the given function.</p>
-</div>
 
 
 
@@ -1766,99 +1680,59 @@ if they have the same id.</p>
 
 
 
-    <h5>Parameters:</h5>
-    
 
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
 
-        <th>Type</th>
 
-        
 
-        
 
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+<h5>Returns:</h5>
 
-    <tbody>
-    
+        
 
-        <tr>
-            
-                <td class="name"><code>entries</code></td>
-            
 
-            <td class="type">
-            
-                
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
 <span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
 
-            
-            </td>
+    </dd>
+</dl>
 
-            
+    
 
-            
 
-            <td class="description last"></td>
-        </tr>
 
-    
 
-        <tr>
-            
-                <td class="name"><code>entriesToMerge</code></td>
-            
 
-            <td class="type">
+        
             
-                
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
-
 
-            
-            </td>
+    
 
-            
+    
+    <h4 class="name" id=".fillInArrayValues"><span class="type-signature">(protected, static) </span>fillInArrayValues<span class="signature">()</span><span class="type-signature"></span></h4>
+    
 
-            
+    
 
-            <td class="description last"></td>
-        </tr>
 
-    
 
-        <tr>
-            
-                <td class="name"><code>idOfElementFunction</code></td>
-            
+<div class="description">
+    <p>Fills in extra &quot;_comma_separated_values&quot; properties into the flattened data
+for properties that end with an array. E.g. response.hits.hits.tags[0]=&quot;active&quot; and response.hits.hits.tags[0]=&quot;ready&quot;
+will lead to the extra element &quot;response.hits.hits.tags_comma_separated_values=&quot;active, ready&quot;.</p>
+</div>
 
-            <td class="type">
-            
-                
-<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
 
 
-            
-            </td>
 
-            
 
-            
 
-            <td class="description last"><p>returns the id of an DescribedEntry</p></td>
-        </tr>
 
-    
-    </tbody>
-</table>
 
 
 
@@ -1894,7 +1768,7 @@ if they have the same id.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line828">line 828</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1028">line 1028</a>
     </li></ul></dd>
     
 
@@ -1919,6 +1793,16 @@ if they have the same id.</p>
 
 
 
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>flattened data with filled in &quot;_comma_separated_values&quot; properties</p>
+</div>
+
+
+
+    
 
 
 
@@ -1930,7 +1814,7 @@ if they have the same id.</p>
     
 
     
-    <h4 class="name" id=".processJsonUsingDescriptions"><span class="type-signature">(protected, static) </span>processJsonUsingDescriptions<span class="signature">(jsonData, descriptions, config)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
+    <h4 class="name" id=".forEachGroupEntry"><span class="type-signature">(protected, static) </span>forEachGroupEntry<span class="signature">(rootEntry, onFoundEntry)</span><span class="type-signature"></span></h4>
     
 
     
@@ -1938,7 +1822,8 @@ if they have the same id.</p>
 
 
 <div class="description">
-    <p>&quot;Assembly line&quot;, that takes the jsonData and processes it using all given descriptions in their given order.</p>
+    <p>Traverses through all groups and their entries and calls the given function on every found entry
+with the group name and the entry itself as parameters.</p>
 </div>
 
 
@@ -1974,36 +1859,13 @@ if they have the same id.</p>
 
         <tr>
             
-                <td class="name"><code>jsonData</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">object</span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>parsed JSON data or any other data object</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>descriptions</code></td>
+                <td class="name"><code>rootEntry</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.PropertyStructureDescription">module:datarestructor.PropertyStructureDescription</a>></span>
+<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
 
 
             
@@ -2013,20 +1875,20 @@ if they have the same id.</p>
 
             
 
-            <td class="description last"><p>already grouped entries</p></td>
+            <td class="description last"></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>config</code></td>
+                <td class="name"><code>onFoundEntry</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.TransformConfig">module:datarestructor.TransformConfig</a></span>
+<span class="param-type"><a href="module-datarestructor.html#.onEntryFoundFunction">module:datarestructor.onEntryFoundFunction</a></span>
 
 
             
@@ -2036,7 +1898,7 @@ if they have the same id.</p>
 
             
 
-            <td class="description last"><p>configuration for the data transformation</p></td>
+            <td class="description last"></td>
         </tr>
 
     
@@ -2077,7 +1939,7 @@ if they have the same id.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line749">line 749</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1199">line 1199</a>
     </li></ul></dd>
     
 
@@ -2102,24 +1964,6 @@ if they have the same id.</p>
 
 
 
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
-
-
-    </dd>
-</dl>
-
-    
 
 
 
@@ -2131,7 +1975,7 @@ if they have the same id.</p>
     
 
     
-    <h4 class="name" id=".toDescribedField"><span class="type-signature">(protected, static) </span>toDescribedField<span class="signature">(entry, recursionContext)</span><span class="type-signature"> &rarr; {<a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a>}</span></h4>
+    <h4 class="name" id=".groupById"><span class="type-signature">(protected, static) </span>groupById<span class="signature">(elements, groupNameOfElementFunction, groupIdOfElementFunction)</span><span class="type-signature"></span></h4>
     
 
     
@@ -2139,11 +1983,10 @@ if they have the same id.</p>
 
 
 <div class="description">
-    <p>Converts a internal described entry to a newly created public described field.
-Since the structure of a described field is hierarchical, this function is called recursively.
-Because the internal described entries may very likely contain cyclic references, the depth of recursion
-needs to be limited. Therefore, the current recursion depth is taken as second parameter
-and the maximum recursion depth is taken as third parameter.</p>
+    <p>Converts the given elements into an object, that provides these
+entries by their id. For example, [{id: A, value: 1}] becomes
+result['A'] = 1. Furthermore, this function creates a group property (with the name )
+and collects all related elements (specified by their group pattern) in it.</p>
 </div>
 
 
@@ -2179,13 +2022,13 @@ and the maximum recursion depth is taken as third parameter.</p>
 
         <tr>
             
-                <td class="name"><code>entry</code></td>
+                <td class="name"><code>elements</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
 
             
@@ -2195,20 +2038,20 @@ and the maximum recursion depth is taken as third parameter.</p>
 
             
 
-            <td class="description last"><p>the internal entry that will be converted</p></td>
+            <td class="description last"><p>of DescribedEntry elements</p></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>recursionContext</code></td>
+                <td class="name"><code>groupNameOfElementFunction</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type"><a href="module-datarestructor.html#.DescribedFieldRecursionContext">module:datarestructor.DescribedFieldRecursionContext</a></span>
+<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
 
 
             
@@ -2218,7 +2061,30 @@ and the maximum recursion depth is taken as third parameter.</p>
 
             
 
-            <td class="description last"><p>context contains everything that needs to be accessible throughout the recursion.</p></td>
+            <td class="description last"><p>function, that returns the name of the group property that will be created inside the &quot;main&quot; element.</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>groupIdOfElementFunction</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>returns the group id of an DescribedEntry</p></td>
         </tr>
 
     
@@ -2259,7 +2125,7 @@ and the maximum recursion depth is taken as third parameter.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1114">line 1114</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line937">line 937</a>
     </li></ul></dd>
     
 
@@ -2287,19 +2153,11 @@ and the maximum recursion depth is taken as third parameter.</p>
 <h5>Returns:</h5>
 
         
+<div class="param-desc">
+    <p>{module:datarestructor.DescribedEntry[] entries indexed by id</p>
+</div>
 
 
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a></span>
-
-
-    </dd>
-</dl>
 
     
 
@@ -2313,7 +2171,7 @@ and the maximum recursion depth is taken as third parameter.</p>
     
 
     
-    <h4 class="name" id=".toDescribedFields"><span class="type-signature">(protected, static) </span>toDescribedFields<span class="signature">(describedEntries, config)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a>>}</span></h4>
+    <h4 class="name" id=".groupFlattenedData"><span class="type-signature">(protected, static) </span>groupFlattenedData<span class="signature">(elements)</span><span class="type-signature"></span></h4>
     
 
     
@@ -2321,9 +2179,11 @@ and the maximum recursion depth is taken as third parameter.</p>
 
 
 <div class="description">
-    <p>Converts described entries (internal data structure) to described fields (external data structure).
-Since the structure of a described field is hierarchical, every field needs to be converted
-in a recursive manner. The maximum recursion depth is taken as the second parameter.</p>
+    <p>Converts the given elements into an object, that provides these
+entries by their id (determined by the entry's groupPattern).
+For example, [{id: A, value: 1}] becomes result['A'] = 1.</p>
+<p>Furthermore, this function creates a group property (determined by the entry's groupName)
+and collects all related elements (specified by their group pattern) in it.</p>
 </div>
 
 
@@ -2359,7 +2219,7 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
         <tr>
             
-                <td class="name"><code>describedEntries</code></td>
+                <td class="name"><code>elements</code></td>
             
 
             <td class="type">
@@ -2375,42 +2235,31 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
             
 
-            <td class="description last"></td>
+            <td class="description last"><p>of DescribedEntry elements</p></td>
         </tr>
 
     
+    </tbody>
+</table>
 
-        <tr>
-            
-                <td class="name"><code>config</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type"><a href="module-datarestructor.html#.TransformConfig">module:datarestructor.TransformConfig</a></span>
 
 
-            
-            </td>
 
-            
 
-            
 
-            <td class="description last"><p>configuration for the data transformation</p></td>
-        </tr>
+<dl class="details">
 
     
-    </tbody>
-</table>
-
 
+    
 
+    
 
+    
 
+    
 
-<dl class="details">
+    
 
     
 
@@ -2424,6 +2273,11 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
     
 
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line912">line 912</a>
+    </li></ul></dd>
     
 
     
@@ -2431,24 +2285,65 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
     
 
     
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>{module:datarestructor.DescribedEntry[] entries indexed by id</p>
+</div>
+
+
 
     
 
+
+
+
+
+        
+            
+
     
 
     
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1080">line 1080</a>
-    </li></ul></dd>
+    <h4 class="name" id=".mergeFlattenedData"><span class="type-signature">(protected, static) </span>mergeFlattenedData<span class="signature">(entries, entriesToMerge, idOfElementFunction)</span><span class="type-signature"></span></h4>
     
 
     
 
-    
 
-    
-</dl>
+
+<div class="description">
+    <p>Takes two arrays of objects, e.g. [{id: B, value: 2},{id: C, value: 3}]
+and [{id: A, value: 1},{id: B, value: 4}] and merges them into one:
+[{id: C, value: 3},{id: A, value: 1},{id: B, value: 4}]</p>
+<p>Entries with the same id (&quot;duplicates&quot;) will be overwritten.
+Only the last element with the same id remains. The order is
+determined by the order of the array elements, whereas the first
+array comes before the second one. This means, that entries with the
+same id in the second array overwrite entries in the first array,
+and entries that occur later in the array overwrite earlier ones,
+if they have the same id.</p>
+<p>The id is extracted from every element using the given function.</p>
+</div>
+
+
 
 
 
@@ -2456,60 +2351,99 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
 
 
+    <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>entries</code></td>
+            
 
-<h5>Returns:</h5>
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
-        
 
+            
+            </td>
 
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">Array.&lt;<a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a>></span>
+            
 
+            
 
-    </dd>
-</dl>
+            <td class="description last"></td>
+        </tr>
 
     
 
+        <tr>
+            
+                <td class="name"><code>entriesToMerge</code></td>
+            
 
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
 
+            
+            </td>
 
-        
             
 
-    
+            
 
-    
-    <h4 class="name" id="enableDebugMode"><span class="type-signature"></span>enableDebugMode<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a>}</span></h4>
-    
+            <td class="description last"></td>
+        </tr>
 
     
 
+        <tr>
+            
+                <td class="name"><code>idOfElementFunction</code></td>
+            
 
-
-<div class="description">
-    <p>Enables debug mode. Logs additional information.</p>
-</div>
-
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-datarestructor.html#.stringFieldOfDescribedEntryFunction">module:datarestructor.stringFieldOfDescribedEntryFunction</a></span>
 
 
+            
+            </td>
 
+            
 
+            
 
+            <td class="description last"><p>returns the id of an DescribedEntry</p></td>
+        </tr>
 
+    
+    </tbody>
+</table>
 
 
 
@@ -2545,7 +2479,7 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line688">line 688</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line828">line 828</a>
     </li></ul></dd>
     
 
@@ -2570,24 +2504,6 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
 
 
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a></span>
-
-
-    </dd>
-</dl>
-
-    
 
 
 
@@ -2599,7 +2515,7 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
     
 
     
-    <h4 class="name" id="processJson"><span class="type-signature"></span>processJson<span class="signature">(data)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
+    <h4 class="name" id=".processJsonUsingDescriptions"><span class="type-signature">(protected, static) </span>processJsonUsingDescriptions<span class="signature">(jsonData, descriptions, config)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>>}</span></h4>
     
 
     
@@ -2607,7 +2523,7 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
 
 <div class="description">
-    <p>&quot;Assembly line&quot;, that takes the (pared JSON) data and processes it using all given descriptions in their given order.</p>
+    <p>&quot;Assembly line&quot;, that takes the jsonData and processes it using all given descriptions in their given order.</p>
 </div>
 
 
@@ -2643,7 +2559,7 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
         <tr>
             
-                <td class="name"><code>data</code></td>
+                <td class="name"><code>jsonData</code></td>
             
 
             <td class="type">
@@ -2663,6 +2579,52 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>descriptions</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.PropertyStructureDescription">module:datarestructor.PropertyStructureDescription</a>></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>already grouped entries</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>config</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-datarestructor.html#.TransformConfig">module:datarestructor.TransformConfig</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>configuration for the data transformation</p></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -2700,7 +2662,7 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line735">line 735</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line749">line 749</a>
     </li></ul></dd>
     
 
@@ -2747,14 +2709,6 @@ in a recursive manner. The maximum recursion depth is taken as the second parame
 
 
 
-    <h5>Example</h5>
-    
-    <pre class="prettyprint"><code>var allDescriptions = [];
-allDescriptions.push(summariesDescription());
-allDescriptions.push(detailsDescription());
-var result = new datarestructor.Transform(allDescriptions).processJson(jsonData);</code></pre>
-
-
 
         
             
@@ -2762,7 +2716,7 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
     
 
     
-    <h4 class="name" id="setMaxRecursionDepth"><span class="type-signature"></span>setMaxRecursionDepth<span class="signature">(value)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a>}</span></h4>
+    <h4 class="name" id=".toDescribedField"><span class="type-signature">(protected, static) </span>toDescribedField<span class="signature">(entry, recursionContext)</span><span class="type-signature"> &rarr; {<a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a>}</span></h4>
     
 
     
@@ -2770,7 +2724,11 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
 
 
 <div class="description">
-    <p>Sets the maximum recursion depth. Defaults to 8 if not set.</p>
+    <p>Converts a internal described entry to a newly created public described field.
+Since the structure of a described field is hierarchical, this function is called recursively.
+Because the internal described entries may very likely contain cyclic references, the depth of recursion
+needs to be limited. Therefore, the current recursion depth is taken as second parameter
+and the maximum recursion depth is taken as third parameter.</p>
 </div>
 
 
@@ -2806,13 +2764,13 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
 
         <tr>
             
-                <td class="name"><code>value</code></td>
+                <td class="name"><code>entry</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">number</span>
+<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
 
 
             
@@ -2822,7 +2780,30 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
 
             
 
-            <td class="description last"><p>non negative number.</p></td>
+            <td class="description last"><p>the internal entry that will be converted</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>recursionContext</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-datarestructor.html#.DescribedFieldRecursionContext">module:datarestructor.DescribedFieldRecursionContext</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>context contains everything that needs to be accessible throughout the recursion.</p></td>
         </tr>
 
     
@@ -2863,7 +2844,7 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line698">line 698</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1114">line 1114</a>
     </li></ul></dd>
     
 
@@ -2899,7 +2880,7 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
     </dt>
     <dd>
         
-<span class="param-type"><a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a></span>
+<span class="param-type"><a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a></span>
 
 
     </dd>
@@ -2917,7 +2898,7 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
     
 
     
-    <h4 class="name" id="setRemoveDuplicationAboveRecursionDepth"><span class="type-signature"></span>setRemoveDuplicationAboveRecursionDepth<span class="signature">(value)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a>}</span></h4>
+    <h4 class="name" id=".toDescribedFields"><span class="type-signature">(protected, static) </span>toDescribedFields<span class="signature">(describedEntries, config)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a>>}</span></h4>
     
 
     
@@ -2925,13 +2906,9 @@ var result = new datarestructor.Transform(allDescriptions).processJson(jsonData)
 
 
 <div class="description">
-    <p>Sets the recursion depth above which duplication will be removed. Duplications below it remain unchanged.
-Defaults to 1.</p>
-<p>Since fields can contain groups of fields that can contain groups of fields..., cyclic
-data structures are possible by nature and will lead to duplications. Some of them
-might be intended e.g. to take one (sub-)field with all (duplicated) groups.
-To restrict duplications and improve performance it is beneficial to define a
-recursion depth, above which further duplication won't be used and should be removed/avoided.</p>
+    <p>Converts described entries (internal data structure) to described fields (external data structure).
+Since the structure of a described field is hierarchical, every field needs to be converted
+in a recursive manner. The maximum recursion depth is taken as the second parameter.</p>
 </div>
 
 
@@ -2967,13 +2944,13 @@ recursion depth, above which further duplication won't be used and should be rem
 
         <tr>
             
-                <td class="name"><code>value</code></td>
+                <td class="name"><code>describedEntries</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">number</span>
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
 
 
             
@@ -2983,7 +2960,30 @@ recursion depth, above which further duplication won't be used and should be rem
 
             
 
-            <td class="description last"><p>non negative number.</p></td>
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>config</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-datarestructor.html#.TransformConfig">module:datarestructor.TransformConfig</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>configuration for the data transformation</p></td>
         </tr>
 
     
@@ -3024,7 +3024,7 @@ recursion depth, above which further duplication won't be used and should be rem
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line718">line 718</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1080">line 1080</a>
     </li></ul></dd>
     
 
@@ -3060,7 +3060,7 @@ recursion depth, above which further duplication won't be used and should be rem
     </dt>
     <dd>
         
-<span class="param-type"><a href="module-datarestructor.Transform.html">module:datarestructor.Transform</a></span>
+<span class="param-type">Array.&lt;<a href="module-described_field.html#.DescribedDataField">module:described_field.DescribedDataField</a>></span>
 
 
     </dd>
@@ -3094,7 +3094,7 @@ recursion depth, above which further duplication won't be used and should be rem
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Oct 20 2023 21:28:55 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>