dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3843
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Mon 2011-06-06 07:46:14 +0200
message:
  Javadoc
modified:
  dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/DataElementOperandList.java
  dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/CrossTabService.java
  dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/jdbc/CrossTabStore.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-datamart-default/src/main/java/org/hisp/dhis/datamart/DataElementOperandList.java'
--- dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/DataElementOperandList.java	2011-06-06 05:36:15 +0000
+++ dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/DataElementOperandList.java	2011-06-06 05:46:14 +0000
@@ -35,6 +35,9 @@
 import org.hisp.dhis.period.Period;
 
 /**
+ * Wrapper class for a list of DataElementOperands which encapsulates logic for
+ * initializing, adding values and checking the state of the list. 
+ * 
  * @author Lars Helge Overland
  */
 public class DataElementOperandList

=== modified file 'dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/CrossTabService.java'
--- dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/CrossTabService.java	2011-06-04 16:56:41 +0000
+++ dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/CrossTabService.java	2011-06-06 05:46:14 +0000
@@ -68,14 +68,26 @@
      */
     void dropCrossTabTable( String key );
     
+    /**
+     * Creates a table which functions as a cache for aggregated data element values
+     * with columns for period identifier, organisation unit identifier followed by
+     * one column for each DataElementOperand in the given list.
+     *  
+     * @param operands the list of DataElementOperands.
+     * @param key the key to use in table name.
+     */
     void createAggregatedDataCache( List<DataElementOperand> operands, String key );
     
+    /**
+     * Drops the aggregated data cache table.
+     * @param key the key used in the table name.
+     */
     void dropAggregatedDataCache( String key );
     
     /**
      * Gets all CrossTabDataValues for the given collection of period ids and source ids.
      * 
-     * @param dataElementIds the dataelement identifiers.
+     * @param dataElementIds the data element identifiers.
      * @param periodIds the period identifiers.
      * @param sourceIds the source identifiers.
      * @return collection of CrossTabDataValues.
@@ -86,7 +98,7 @@
     /**
      * Gets all CrossTabDataValues for the given collection of period ids and the source id.
      * 
-     * @param dataElementIds the dataelement identifiers.
+     * @param dataElementIds the data element identifiers.
      * @param periodIds the period identifiers.
      * @param sourceId the source identifier.
      * @return collection of CrossTabDataValues.
@@ -94,6 +106,16 @@
     Collection<CrossTabDataValue> getCrossTabDataValues( Collection<DataElementOperand> operands, Collection<Integer> periodIds, 
         int sourceId, String key );
     
+    /**
+     * Gets a map of DataElementOperands and corresponding Double aggregated data
+     * element value from the cache table.
+     * 
+     * @param operands the list of DataElementOperand to return map entries for.
+     * @param periodId the period identifier.
+     * @param sourceId the organisation unit identifier.
+     * @param key the key to use in the table name.
+     * @return a map of DataElementOperands and aggregated values.
+     */
     Map<DataElementOperand, Double> getAggregatedDataCacheValue( Collection<DataElementOperand> operands, 
         int periodId, int sourceId, String key );
 }

=== modified file 'dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/jdbc/CrossTabStore.java'
--- dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/jdbc/CrossTabStore.java	2011-06-04 16:56:41 +0000
+++ dhis-2/dhis-services/dhis-service-datamart-default/src/main/java/org/hisp/dhis/datamart/crosstab/jdbc/CrossTabStore.java	2011-06-06 05:46:14 +0000
@@ -57,15 +57,27 @@
      * Drops the crosstab table.
      */
     void dropCrossTabTable( String key );
-    
+
+    /**
+     * Creates a table which functions as a cache for aggregated data element values
+     * with columns for period identifier, organisation unit identifier followed by
+     * one column for each DataElementOperand in the given list.
+     *  
+     * @param operands the list of DataElementOperands.
+     * @param key the key to use in table name.
+     */
     void createAggregatedDataCache( List<DataElementOperand> operands, String key );
-    
+
+    /**
+     * Drops the aggregated data cache table.
+     * @param key the key used in the table name.
+     */
     void dropAggregatedDataCache( String key );
     
     /**
      * Gets all CrossTabDataValues for the given collection of period ids and source ids.
      * 
-     * @param dataElementIds the dataelement identifiers.
+     * @param dataElementIds the data element identifiers.
      * @param periodIds the period identifiers.
      * @param sourceIds the source identifiers.
      * @return collection of CrossTabDataValues.
@@ -76,13 +88,23 @@
     /**
      * Gets all CrossTabDataValues for the given collection of period ids and the source id.
      * 
-     * @param dataElementIds the dataelement identifiers.
+     * @param dataElementIds the data element identifiers.
      * @param periodIds the period identifiers.
      * @param sourceId the source identifier.
      * @return collection of CrossTabDataValues.
      */
     Collection<CrossTabDataValue> getCrossTabDataValues( Collection<DataElementOperand> operands, Collection<Integer> periodIds, 
         int sourceId, String key );
-    
+
+    /**
+     * Gets a map of DataElementOperands and corresponding Double aggregated data
+     * element value from the cache table.
+     * 
+     * @param operands the list of DataElementOperand to return map entries for.
+     * @param periodId the period identifier.
+     * @param sourceId the organisation unit identifier.
+     * @param key the key to use in the table name.
+     * @return a map of DataElementOperands and aggregated values.
+     */
     Map<DataElementOperand, Double> getAggregatedDataCacheValue( Collection<DataElementOperand> operands, int periodId, int sourceId, String key );
 }