taskjuggler 0.0.2 → 0.0.3

data/doc/classes/TaskJuggler/Report.html

@@ -70,7 +70,11 @@
             <td><strong>Parent:</strong></td>
             <td>
 
-                Object
+                <a href="PropertyTreeNode.html">
+
+                TaskJuggler::PropertyTreeNode
+
+               </a>
 
             </td>
         </tr>
@@ -87,9 +91,7 @@
       <p>
 The <a href="Report.html">Report</a> class holds the fundamental
 description and functionality to turn the scheduled project into a user
-readable form. A report consists of one or more <a
-href="ReportElement.html">ReportElement</a> objects and some attributes
-that are global to all elements.
+readable form. A report may contain other reports.
 </p>
 
     </div>
@@ -102,15 +104,11 @@ that are global to all elements.
 
       <div class="name-list">
 
-        <a href="#M000386">addFormat</a>&nbsp;&nbsp;
-
-        <a href="#M000385">end</a>&nbsp;&nbsp;
+        <a href="#M000614">generate</a>&nbsp;&nbsp;
 
-        <a href="#M000387">generate</a>&nbsp;&nbsp;
+        <a href="#M000613">new</a>&nbsp;&nbsp;
 
-        <a href="#M000383">new</a>&nbsp;&nbsp;
-
-        <a href="#M000384">start=</a>&nbsp;&nbsp;
+        <a href="#M000615">to_html</a>&nbsp;&nbsp;
 
       </div>
     </div>
@@ -130,119 +128,7 @@ that are global to all elements.
         <table>
 
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">costAccount</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">currencyformat</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">end</td>
-
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">loadUnit</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">name</td>
-
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">now</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">numberformat</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">project</td>
-
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">resourceRoot</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">revenueAccount</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">shorttimeformat</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">sourceFileInfo</td>
-
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">start</td>
-
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">taskRoot</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">timeformat</td>
+          <td class="context-item-name">content</td>
 
           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 
@@ -250,23 +136,7 @@ that are global to all elements.
         </tr>
 
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">timezone</td>
-
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">userDefinedPeriod</td>
-
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-
-          <td class="context-item-desc"></td>
-        </tr>
-
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">weekstartsmonday</td>
+          <td class="context-item-name">typeSpec</td>
 
           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 
@@ -285,14 +155,14 @@ that are global to all elements.
       <h3 class="section-bar">Public Class methods</h3>
 
 
-      <div id="method-M000383" class="method-detail">
-        <a name="M000383"></a>
+      <div id="method-M000613" class="method-detail">
+        <a name="M000613"></a>
 
         <div class="method-heading">
 
-          <a href="#M000383" class="method-signature">
+          <a href="#M000613" class="method-signature">
 
-          <span class="method-name">new</span><span class="method-args">(project, name, format, sourceFileInfo)</span>
+          <span class="method-name">new</span><span class="method-args">(project, id, name, parent)</span>
 
           </a>
 
@@ -305,36 +175,18 @@ Create a new report object.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000383-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000383-source">
+            onclick="toggleCode('M000613-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000613-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 36</span>
-36:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">format</span>, <span class="ruby-identifier">sourceFileInfo</span>)
-37:       <span class="ruby-ivar">@project</span> = <span class="ruby-identifier">project</span>
-38:       <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
-39:       <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">addReport</span>(<span class="ruby-keyword kw">self</span>)
-40:       <span class="ruby-ivar">@outputFormats</span> = [ <span class="ruby-identifier">format</span> ]
-41:       <span class="ruby-ivar">@sourceFileInfo</span> = <span class="ruby-identifier">sourceFileInfo</span>
-42: 
-43:       <span class="ruby-comment cmt"># The following attributes determine the content and look of the report.</span>
-44:       <span class="ruby-ivar">@costAccount</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'costAccount'</span>]
-45:       <span class="ruby-ivar">@currencyformat</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'currencyformat'</span>]
-46:       <span class="ruby-ivar">@loadUnit</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'loadunit'</span>]
-47:       <span class="ruby-ivar">@end</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'end'</span>]
-48:       <span class="ruby-ivar">@now</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'now'</span>]
-49:       <span class="ruby-ivar">@numberformat</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'numberformat'</span>]
-50:       <span class="ruby-ivar">@resourceRoot</span> = <span class="ruby-keyword kw">nil</span>
-51:       <span class="ruby-ivar">@revenueAccount</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'revenueAccount'</span>]
-52:       <span class="ruby-ivar">@shorttimeformat</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'shorttimeformat'</span>]
-53:       <span class="ruby-ivar">@start</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'start'</span>]
-54:       <span class="ruby-ivar">@taskRoot</span> = <span class="ruby-keyword kw">nil</span>
-55:       <span class="ruby-ivar">@timeformat</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'timeformat'</span>]
-56:       <span class="ruby-ivar">@timezone</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'timezone'</span>]
-57:       <span class="ruby-ivar">@userDefinedPeriod</span> = <span class="ruby-keyword kw">false</span>
-58:       <span class="ruby-ivar">@weekstartsmonday</span> = <span class="ruby-ivar">@project</span>[<span class="ruby-value str">'weekstartsmonday'</span>]
-59: 
-60:       <span class="ruby-ivar">@elements</span> = []
-61:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 33</span>
+33:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">parent</span>)
+34:       <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">reports</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">parent</span>)
+35:       <span class="ruby-identifier">project</span>.<span class="ruby-identifier">addReport</span>(<span class="ruby-keyword kw">self</span>)
+36: 
+37:       <span class="ruby-comment cmt"># The type specifier must be set for every report. It tells whether this</span>
+38:       <span class="ruby-comment cmt"># is a task, resource, text or other report.</span>
+39:       <span class="ruby-ivar">@typeSpec</span> = <span class="ruby-keyword kw">nil</span>
+40:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -345,81 +197,12 @@ Create a new report object.
       <h3 class="section-bar">Public Instance methods</h3>
 
 
-      <div id="method-M000386" class="method-detail">
-        <a name="M000386"></a>
-
-        <div class="method-heading">
-
-          <a href="#M000386" class="method-signature">
-
-          <span class="method-name">addFormat</span><span class="method-args">(format)</span>
-
-          </a>
-
-        </div>
-
-        <div class="method-description">
-
-          <p>
-Add new ouput format request.
-</p>
-
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000386-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000386-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 76</span>
-76:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addFormat</span>(<span class="ruby-identifier">format</span>)
-77:       <span class="ruby-ivar">@outputFormats</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">format</span>
-78:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-
-        </div>
-      </div>
-
-
-      <div id="method-M000385" class="method-detail">
-        <a name="M000385"></a>
-
-        <div class="method-heading">
-
-          <a href="#M000385" class="method-signature">
-
-          <span class="method-name">end</span><span class="method-args">(=(date))</span>
-
-          </a>
-
-        </div>
-
-        <div class="method-description">
-
-          <p>
-Set the end <em>date</em> of the report period and mark it as user defined.
-</p>
-
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000385-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000385-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 70</span>
-70:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">end</span>=(<span class="ruby-identifier">date</span>)
-71:       <span class="ruby-ivar">@end</span> = <span class="ruby-identifier">date</span>
-72:       <span class="ruby-ivar">@userDefinedPeriod</span> = <span class="ruby-keyword kw">true</span>
-73:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-
-        </div>
-      </div>
-
-
-      <div id="method-M000387" class="method-detail">
-        <a name="M000387"></a>
+      <div id="method-M000614" class="method-detail">
+        <a name="M000614"></a>
 
         <div class="method-heading">
 
-          <a href="#M000387" class="method-signature">
+          <a href="#M000614" class="method-signature">
 
           <span class="method-name">generate</span><span class="method-args">()</span>
 
@@ -436,39 +219,49 @@ according the the requested output format(s).
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000387-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000387-source">
+            onclick="toggleCode('M000614-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000614-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 83</span>
- 83:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generate</span>
- 84:       <span class="ruby-keyword kw">begin</span>
- 85:         <span class="ruby-comment cmt"># Most output format can be generated from a common intermediate</span>
- 86:         <span class="ruby-comment cmt"># representation of the elements. We generate that IR first.</span>
- 87:         <span class="ruby-ivar">@elements</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">element</span><span class="ruby-operator">|</span>
- 88:           <span class="ruby-identifier">element</span>.<span class="ruby-identifier">generateIntermediateFormat</span>
- 89:         <span class="ruby-keyword kw">end</span>
- 90: 
- 91:         <span class="ruby-comment cmt"># Then generate the actual output format.</span>
- 92:         <span class="ruby-ivar">@outputFormats</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
- 93:           <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">format</span>
- 94:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:html</span>
- 95:             <span class="ruby-identifier">generateHTML</span>
- 96:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:csv</span>
- 97:             <span class="ruby-identifier">generateCSV</span>
- 98:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:export</span>
- 99:             <span class="ruby-identifier">generateExport</span>
-100:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:gui</span>
-101:             <span class="ruby-comment cmt"># TODO: Find a way to hook up the GUI here.</span>
-102:           <span class="ruby-keyword kw">else</span>
-103:             <span class="ruby-identifier">raise</span> <span class="ruby-value str">'Unknown report output format.'</span>
-104:           <span class="ruby-keyword kw">end</span>
-105:         <span class="ruby-keyword kw">end</span>
-106:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">TjException</span>
-107:         <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">messageHandler</span>.<span class="ruby-identifier">send</span>(<span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'reporting_failed'</span>, <span class="ruby-value str">'error'</span>,
-108:                                                  <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span>,
-109:                                                  <span class="ruby-ivar">@sourceFileInfo</span>))
-110:       <span class="ruby-keyword kw">end</span>
-111:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 45</span>
+45:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generate</span>
+46:       <span class="ruby-keyword kw">begin</span>
+47:         <span class="ruby-ivar">@content</span> = <span class="ruby-keyword kw">nil</span>
+48:         <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@typeSpec</span>
+49:         <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:export</span>
+50:           <span class="ruby-comment cmt"># Does not have an intermediate representation. Nothing to do here.</span>
+51:         <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:resourcereport</span>
+52:           <span class="ruby-ivar">@content</span> = <span class="ruby-constant">ResourceListRE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
+53:         <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:textreport</span>
+54:           <span class="ruby-ivar">@content</span> = <span class="ruby-constant">TextReport</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
+55:         <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:taskreport</span>
+56:           <span class="ruby-ivar">@content</span> = <span class="ruby-constant">TaskListRE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
+57:         <span class="ruby-keyword kw">else</span>
+58:           <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Unknown report type&quot;</span>
+59:         <span class="ruby-keyword kw">end</span>
+60: 
+61:         <span class="ruby-comment cmt"># Most output format can be generated from a common intermediate</span>
+62:         <span class="ruby-comment cmt"># representation of the elements. We generate that IR first.</span>
+63:         <span class="ruby-ivar">@content</span>.<span class="ruby-identifier">generateIntermediateFormat</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@content</span>
+64: 
+65:         <span class="ruby-comment cmt"># Then generate the actual output format.</span>
+66:         <span class="ruby-identifier">get</span>(<span class="ruby-value str">'formats'</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
+67:           <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">format</span>
+68:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:html</span>
+69:             <span class="ruby-identifier">generateHTML</span>
+70:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:csv</span>
+71:             <span class="ruby-identifier">generateCSV</span>
+72:           <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:export</span>
+73:             <span class="ruby-identifier">generateExport</span>
+74:           <span class="ruby-keyword kw">else</span>
+75:             <span class="ruby-identifier">raise</span> <span class="ruby-value str">'Unknown report output format.'</span>
+76:           <span class="ruby-keyword kw">end</span>
+77:         <span class="ruby-keyword kw">end</span>
+78:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">TjException</span>
+79:         <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">messageHandler</span>.<span class="ruby-identifier">send</span>(<span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'reporting_failed'</span>, <span class="ruby-value str">'error'</span>,
+80:                                                  <span class="ruby-identifier">$!</span>.<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span>,
+81:                                                  <span class="ruby-ivar">@sourceFileInfo</span>))
+82:       <span class="ruby-keyword kw">end</span>
+83:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -476,14 +269,14 @@ according the the requested output format(s).
       </div>
 
 
-      <div id="method-M000384" class="method-detail">
-        <a name="M000384"></a>
+      <div id="method-M000615" class="method-detail">
+        <a name="M000615"></a>
 
         <div class="method-heading">
 
-          <a href="#M000384" class="method-signature">
+          <a href="#M000615" class="method-signature">
 
-          <span class="method-name">start=</span><span class="method-args">(date)</span>
+          <span class="method-name">to_html</span><span class="method-args">()</span>
 
           </a>
 
@@ -492,19 +285,17 @@ according the the requested output format(s).
         <div class="method-description">
 
           <p>
-Set the start <em>date</em> of the report period and mark it as user
-defined.
+Render the content of the report as HTML (without the framing).
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000384-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000384-source">
+            onclick="toggleCode('M000615-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000615-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 64</span>
-64:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start=</span>(<span class="ruby-identifier">date</span>)
-65:       <span class="ruby-ivar">@start</span> = <span class="ruby-identifier">date</span>
-66:       <span class="ruby-ivar">@userDefinedPeriod</span> = <span class="ruby-keyword kw">true</span>
-67:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/reports/Report.rb, line 86</span>
+86:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_html</span>
+87:       <span class="ruby-ivar">@content</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@content</span>.<span class="ruby-identifier">to_html</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
+88:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>