dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1197
committer: Lars Helge Oeverland larshelge@xxxxxxxxx
branch nick: trunk
timestamp: Wed 2009-12-09 18:32:26 +0100
message:
  Added javadoc for reporttable.
modified:
  dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportParams.java
  dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTable.java
  dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableColumn.java


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription.

=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportParams.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportParams.java	2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportParams.java	2009-12-09 17:32:26 +0000
@@ -30,6 +30,10 @@
 import java.io.Serializable;
 
 /**
+ * The ReportParams object represents report parameters for a ReportTable. Report
+ * parameters are meant to make ReportTables more generic, as it can avoid having
+ * dynamic, selectable parameters rather than static.
+ * 
  * @author Lars Helge Overland
  * @version $Id$
  */

=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTable.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTable.java	2009-11-30 15:32:55 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTable.java	2009-12-09 17:32:26 +0000
@@ -49,6 +49,9 @@
 import org.hisp.dhis.period.Period;
 
 /**
+ * The ReportTable object represents a customizable database table. It has features
+ * like crosstabulation, relative periods, parameters, and display columns.
+ * 
  * @author Lars Helge Overland
  * @version $Id$
  */
@@ -90,44 +93,104 @@
     // Persisted properties
     // -------------------------------------------------------------------------
 
+    /**
+     * The internal identifier.
+     */
     private int id;
     
+    /**
+     * The name of the ReportTable object.
+     */
     private String name;
 
+    /**
+     * The name of the database table corresponding to the ReportTable object name.
+     */
     private String tableName;
     
+    /**
+     * The name of the existing database table.
+     */
     private String existingTableName;
     
+    /**
+     * The ReportTable mode, can be dataelement, indicators, datasets.
+     */
     private String mode;
     
+    /**
+     * Whether the ReportTable contains regression columns.
+     */
     private Boolean regression;
 
+    /**
+     * The list of DataElements the ReportTable contains.
+     */
     private List<DataElement> dataElements = new ArrayList<DataElement>();
     
+    /**
+     * The list of Indicators the ReportTable contains.
+     */
     private List<Indicator> indicators = new ArrayList<Indicator>();
     
+    /**
+     * The list of DataSets the ReportTable contains.
+     */
     private List<DataSet> dataSets = new ArrayList<DataSet>();
     
+    /**
+     * The list of Periods the ReportTable contains.
+     */
     private List<Period> periods = new ArrayList<Period>();
     
+    /**
+     * The list of OrganisationUnits the ReportTable contains.
+     */
     private List<OrganisationUnit> units = new ArrayList<OrganisationUnit>();
     
+    /**
+     * The <a>org.hisp.dhis.dimension.DimensionType</a> for the ReportTable.
+     */
     private DimensionType dimensionType;
     
+    /**
+     * The DataElementCategoryCombo for the ReportTable.
+     */
     private DimensionSet categoryCombo;
     
+    /**
+     * The DataElementGropSets for the ReportTable.
+     */
     private List<? extends Dimension> dataElementGroupSets = new ArrayList<Dimension>();
     
+    /**
+     * Whether to crosstabulate on the Indicator dimension, which also represents DataElements and DataSets.
+     */
     private Boolean doIndicators;
     
+    /**
+     * Whether to crosstabulate on the Period dimension.
+     */
     private Boolean doPeriods;
     
+    /**
+     * Whether to crosstabulate on the OrganisationUnit dimension.
+     */
     private Boolean doUnits;
 
+    /**
+     * The RelativePeriods of the ReportTable.
+     */
     private RelativePeriods relatives;
 
+    /**
+     * The ReportParams of the ReportTable.
+     */
     private ReportParams reportParams;
 
+    /**
+     * The list of ReportTableColumns for the ReportTable.
+     */
     private List<ReportTableColumn> displayColumns = new ArrayList<ReportTableColumn>();
     
     // -------------------------------------------------------------------------

=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableColumn.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableColumn.java	2009-07-08 18:14:14 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableColumn.java	2009-12-09 17:32:26 +0000
@@ -28,6 +28,10 @@
  */
 
 /**
+ * The ReportTableColumn objec represents a customziable column header for a
+ * ReportTable, including a more meaningful name and the ability to hide it in a
+ * view.
+ * 
  * @author Lars Helge Overland
  * @version $Id$
  */