← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-devs-core/dhis2/trunk] Rev 10739: Docs

 

------------------------------------------------------------
revno: 10739
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Thu 2013-05-02 15:32:45 +0200
message:
  Docs
modified:
  dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/AnalyticsService.java
  dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/data/DefaultAnalyticsService.java
  dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/datasetreport/jdbc/JdbcDataSetReportStore.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-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/AnalyticsService.java'
--- dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/AnalyticsService.java	2013-03-21 15:07:48 +0000
+++ dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/AnalyticsService.java	2013-05-02 13:32:45 +0000
@@ -37,12 +37,44 @@
 {
     final String NAMES_META_KEY = "names";
     
+    /**
+     * Generates aggregated values for the given query.
+     * 
+     * @param params the data query parameters.
+     * @return aggregated data as a Grid object.
+     */
     Grid getAggregatedDataValues( DataQueryParams params );
     
+    /**
+     * Generates aggregated values for the given query. Creates a mapping between 
+     * a dimension key and the aggregated value. The dimension key is a 
+     * concatenation of the identifiers of the dimension items separated by "-".
+     * 
+     * @param params the data query parameters.
+     * @return a mapping between a dimension key and the aggregated value.
+     */
     Map<String, Double> getAggregatedDataValueMap( DataQueryParams params );
 
+    /**
+     * Generates aggregated values for the given query. Creates a mapping between 
+     * a dimension key and the aggregated value. The dimension key is a 
+     * concatenation of the identifiers of the dimension items separated by "-".
+     * 
+     * @param params the data query parameters.
+     * @return a mapping between a dimension key and the aggregated value.
+     */
     Map<String, Double> getAggregatedCompletenessValueMap( DataQueryParams params );
     
+    /**
+     * Creates a data query parameter object from the given URL.
+     * 
+     * @param dimensionParams the dimension URL parameters.
+     * @param filterParams the filter URL parameters.
+     * @param aggregationType the aggregation type.
+     * @param measureCriteria the measure criteria.
+     * @param format the i18n format.
+     * @return a data query parameter object created based on the given URL info.
+     */
     DataQueryParams getFromUrl( Set<String> dimensionParams, Set<String> filterParams, 
         AggregationType aggregationType, String measureCriteria, I18nFormat format );
 }

=== modified file 'dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/data/DefaultAnalyticsService.java'
--- dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/data/DefaultAnalyticsService.java	2013-04-22 17:49:11 +0000
+++ dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/data/DefaultAnalyticsService.java	2013-05-02 13:32:45 +0000
@@ -119,11 +119,9 @@
     private static final String VALUE_HEADER_NAME = "Value";
     private static final int PERCENT = 100;
     private static final int MAX_QUERIES = 8;
-    
-    //TODO filter values must be merged if split
+
+    //TODO make sure data x dims are successive    
     //TODO completeness on time
-    //TODO make sure data x dims are successive
-    //TODO optimize when in and de are specified, and in-de is part of de
     
     @Autowired
     private AnalyticsManager analyticsManager;
@@ -372,7 +370,7 @@
     
     /**
      * Generates a mapping between a dimension key and the aggregated value. The
-     * dimension key is a concatenation of the identifiers in for the dimensions
+     * dimension key is a concatenation of the identifiers of the dimension items
      * separated by "-".
      */
     private Map<String, Double> getAggregatedValueMap( DataQueryParams params, String tableName )        

=== modified file 'dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/datasetreport/jdbc/JdbcDataSetReportStore.java'
--- dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/datasetreport/jdbc/JdbcDataSetReportStore.java	2013-04-29 13:26:32 +0000
+++ dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/datasetreport/jdbc/JdbcDataSetReportStore.java	2013-05-02 13:32:45 +0000
@@ -62,7 +62,7 @@
     {
         this.jdbcTemplate = jdbcTemplate;
     }
-
+    
     // -------------------------------------------------------------------------
     // DataSetReportStore implementation
     // -------------------------------------------------------------------------