← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-devs-core/dhis2/trunk] Rev 981: Improved javadoc for report table service.

 

------------------------------------------------------------
revno: 981
committer: Lars Helge Oeverland larshelge@xxxxxxxxx
branch nick: trunk
timestamp: Thu 2009-11-05 16:09:16 +0100
message:
  Improved javadoc for report table service.
modified:
  dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java
  dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-organisationunit/src/main/java/org/hisp/dhis/oum/action/organisationunitgroup/GetOrganisationUnitGroupMembersAction.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/ReportTableService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java	2009-06-10 22:25:07 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java	2009-11-05 15:09:16 +0000
@@ -43,27 +43,37 @@
     String ID = ReportTableService.class.getName();
 
     /**
+     * Generate and set report parameters for reporting period, parent organisation 
+     * unit and organisation unit. Delegates to <code>createReportTable( ReportTable, boolean )</code> 
+     * to generate the table.
      * 
-     * @param id
-     * @param mode
-     * @param reportingPeriod
-     * @param parentOrganisationUnitId
-     * @param organisationUnitId
-     * @param format
+     * @param id the identifier.
+     * @param mode the mode, can be <li>dataelements</i>, <i>indicators</i>, and <i>datasets</i>.
+     * @param reportingPeriod the number of months back in time which will be used
+     *        as basis for the generation of relative periods.
+     * @param parentOrganisationUnitId the identifier of the parent organisation
+     *        unit of the report parameter.
+     * @param organisationUnitId the identifier of the organisation unit of the
+     *        report parameter.
+     * @param format the I18nFormat to use.
      */
     void createReportTables( int id, String mode, Integer reportingPeriod, 
         Integer parentOrganisationUnitId, Integer organisationUnitId, I18nFormat format );
     
     /**
+     * Creates a report table. Exports the relevant data to data mart, updates
+     * the existing database table name, add potential regression columns and data
+     * and generates the table. 
      * 
-     * @param reportTable
-     * @param doDataMart
+     * @param reportTable the ReportTable to create.
+     * @param doDataMart indicators whether to perform datamart before processing.
      */
     void createReportTable( ReportTable reportTable, boolean doDataMart );
     
     /**
+     * Removes a ReportTable.
      * 
-     * @param reportTable
+     * @param reportTable the ReportTable to remove.
      */
     void removeReportTable( ReportTable reportTable );
     

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-organisationunit/src/main/java/org/hisp/dhis/oum/action/organisationunitgroup/GetOrganisationUnitGroupMembersAction.java'
--- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-organisationunit/src/main/java/org/hisp/dhis/oum/action/organisationunitgroup/GetOrganisationUnitGroupMembersAction.java	2009-10-26 15:39:29 +0000
+++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-organisationunit/src/main/java/org/hisp/dhis/oum/action/organisationunitgroup/GetOrganisationUnitGroupMembersAction.java	2009-11-05 15:09:16 +0000
@@ -27,17 +27,11 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Comparator;
 import java.util.List;
 
-import org.hisp.dhis.options.displayproperty.DisplayPropertyHandler;
-import org.hisp.dhis.organisationunit.OrganisationUnit;
 import org.hisp.dhis.organisationunit.OrganisationUnitGroup;
 import org.hisp.dhis.organisationunit.OrganisationUnitGroupService;
 import org.hisp.dhis.organisationunit.OrganisationUnitLevel;
-import org.hisp.dhis.organisationunit.OrganisationUnitService;
 import org.hisp.dhis.oust.manager.SelectionTreeManager;
 
 import com.opensymphony.xwork2.Action;