← Back to branch summary

~mortenoh/+junk/dhis2-detailed-import-export

« back to all changes in this revision

Viewing changes to local/in/dhis-service-aggregationengine-default/src/main/java/org/hisp/dhis/aggregation/impl/dataelement/AverageBoolDataElementAggregation.java

  • Committer: larshelge at gmail
  • Date: 2009-03-03 16:46:36 UTC
  • Revision ID: larshelge@gmail.com-20090303164636-2sjlrquo7ib1gf7r
Initial check-in

Show diffs side-by-side

added added

removed removed

Lines of Context:
local/in/dhis-service-aggregationengine-default/src/main/java/org/hisp/dhis/aggregation/impl/dataelement/AverageBoolDataElementAggregation.java
 
1
package org.hisp.dhis.aggregation.impl.dataelement;
 
2
 
 
3
/*
 
4
 * Copyright (c) 2004-2007, University of Oslo
 
5
 * All rights reserved.
 
6
 *
 
7
 * Redistribution and use in source and binary forms, with or without
 
8
 * modification, are permitted provided that the following conditions are met:
 
9
 * * Redistributions of source code must retain the above copyright notice, this
 
10
 *   list of conditions and the following disclaimer.
 
11
 * * Redistributions in binary form must reproduce the above copyright notice,
 
12
 *   this list of conditions and the following disclaimer in the documentation
 
13
 *   and/or other materials provided with the distribution.
 
14
 * * Neither the name of the HISP project nor the names of its contributors may
 
15
 *   be used to endorse or promote products derived from this software without
 
16
 *   specific prior written permission.
 
17
 *
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 
20
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
21
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 
22
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 
23
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 
24
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 
25
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
26
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
27
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
28
 */
 
29
 
 
30
import java.util.Collection;
 
31
import java.util.Date;
 
32
 
 
33
import org.hisp.dhis.aggregation.AggregationService;
 
34
import org.hisp.dhis.dataelement.DataElement;
 
35
import org.hisp.dhis.dataelement.DataElementCategoryOptionCombo;
 
36
import org.hisp.dhis.datavalue.DataValue;
 
37
import org.hisp.dhis.organisationunit.OrganisationUnit;
 
38
import org.hisp.dhis.organisationunit.OrganisationUnitHierarchy;
 
39
import org.hisp.dhis.period.Period;
 
40
 
 
41
import static org.hisp.dhis.system.util.MathUtils.getDays;
 
42
 
 
43
/**
 
44
 * @author Lars Helge Overland
 
45
 * @version $Id: AverageBoolDataElementAggregation.java 4753 2008-03-14 12:48:50Z larshelg $
 
46
 */
 
47
public class AverageBoolDataElementAggregation
 
48
    extends AbstractDataElementAggregation
 
49
{
 
50
    public double getAggregatedValue( DataElement dataElement, DataElementCategoryOptionCombo optionCombo, Date aggregationStartDate, Date aggregationEndDate,
 
51
        OrganisationUnit organisationUnit )
 
52
    {
 
53
        Collection<OrganisationUnitHierarchy> hierarchies = aggregationCache.getOrganisationUnitHierarchies(
 
54
            aggregationStartDate, aggregationEndDate );
 
55
 
 
56
        double[] sums = getSumAndRelevantDays( dataElement.getId(), optionCombo.getId(), aggregationStartDate, aggregationEndDate, 
 
57
            hierarchies, organisationUnit.getId() );
 
58
 
 
59
        if ( sums[1] > 0 )
 
60
        {
 
61
            double average = sums[0] / sums[1];
 
62
 
 
63
            return average;
 
64
        }
 
65
        else
 
66
        {
 
67
            return AggregationService.NO_VALUES_REGISTERED;
 
68
        }
 
69
    }
 
70
 
 
71
    protected Collection<DataValue> getDataValues( int dataElementId, int optionComboId, int organisationUnitId,
 
72
        OrganisationUnitHierarchy hierarchy, Date startDate, Date endDate )
 
73
    {
 
74
        Collection<Integer> children = aggregationCache.getChildren( hierarchy, organisationUnitId );
 
75
        
 
76
        Collection<Integer> periods = aggregationCache.getPeriodIds( startDate, endDate );
 
77
 
 
78
        Collection<DataValue> values = aggregationStore.getDataValues( children, dataElementId, optionComboId, periods );
 
79
        
 
80
        return values;
 
81
    }
 
82
 
 
83
    /**
 
84
     * Calculates the AVERAGE for DataValues which period is within or
 
85
     * overlapping startDate and / or endDate. This method is typically used for
 
86
     * semi-permanent DataValues. It handles the four situations where a
 
87
     * DataValue will count for the period that startDate to endDate constitutes (
 
88
     * referred to as d1 and d2 ):
 
89
     * <p>
 
90
     * 1. startDate and endDate is between d1 - d2<br>
 
91
     * 2. startDate is before d1 and endDate is between d1 - d2<br>
 
92
     * 3. startDate is between d1 - d2 and endDate is after d2<br>
 
93
     * 4. startDate is before d1 and endDate is after d2<br>
 
94
     * <p>
 
95
     * The method iterates over every DataValue in the passed Collection. The
 
96
     * number of days in each DataValue's period between d1 - d2 is summarized
 
97
     * and addded to the total sum if the value is true. The number of days in
 
98
     * each DataValue's period between d1 - d2 is summarized and returned at
 
99
     * index 1.
 
100
     * 
 
101
     * @param dataValues The datavalues to aggregate
 
102
     * @param startDate Start date of the period to aggregate over
 
103
     * @param endDate End date of the period to aggregate over
 
104
     * @param aggregationStartDate The original start date of the entire
 
105
     *        aggregation period
 
106
     * @param aggregationEndDate The original end date of the entire aggregation
 
107
     *        period
 
108
     * @return The numerator and denominator of the AVERAGE value
 
109
     */
 
110
    protected double[] getAggregateOfValues( Collection<DataValue> dataValues, Date startDate, Date endDate,
 
111
        Date aggregationStartDate, Date aggregationEndDate )
 
112
    {
 
113
        double totalSum = 0;
 
114
        double totalRelevantDays = 0;
 
115
 
 
116
        for ( DataValue dataValue : dataValues )
 
117
        {
 
118
            Period currentPeriod = aggregationCache.getPeriod( dataValue.getPeriod().getId() );
 
119
            Date currentStartDate = currentPeriod.getStartDate();
 
120
            Date currentEndDate = currentPeriod.getEndDate();
 
121
 
 
122
            long relevantDays = 0;
 
123
 
 
124
            if ( currentStartDate.compareTo( startDate ) >= 0 && currentEndDate.compareTo( endDate ) <= 0 )
 
125
            {
 
126
                relevantDays = getDays( currentEndDate ) - getDays( currentStartDate );
 
127
            }
 
128
            else if ( currentStartDate.compareTo( startDate ) <= 0 && currentEndDate.compareTo( startDate ) >= 0
 
129
                && currentEndDate.compareTo( endDate ) <= 0 )
 
130
            {
 
131
                relevantDays = getDays( currentEndDate ) - getDays( startDate );
 
132
            }
 
133
            else if ( currentStartDate.compareTo( startDate ) >= 0 && currentStartDate.compareTo( endDate ) <= 0
 
134
                && currentEndDate.compareTo( endDate ) >= 0 )
 
135
            {
 
136
                relevantDays = getDays( endDate ) - getDays( currentStartDate );
 
137
            }
 
138
            else if ( currentStartDate.compareTo( startDate ) <= 0 && currentEndDate.compareTo( endDate ) >= 0 )
 
139
            {
 
140
                relevantDays = getDays( endDate ) - getDays( startDate );
 
141
            }
 
142
 
 
143
            String stringValue = dataValue.getValue();
 
144
 
 
145
            if ( stringValue != null && stringValue.toLowerCase().equals( TRUE ) )
 
146
            {
 
147
                totalSum += relevantDays;
 
148
            }
 
149
 
 
150
            totalRelevantDays += relevantDays;
 
151
        }
 
152
 
 
153
        double[] fraction = { totalSum, totalRelevantDays };
 
154
 
 
155
        return fraction;
 
156
    }
 
157
}