=== added file 'dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/dataelement/DataElementDefaultDimensionAndTypePopulator.java' --- dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/dataelement/DataElementDefaultDimensionAndTypePopulator.java 1970-01-01 00:00:00 +0000 +++ dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/dataelement/DataElementDefaultDimensionAndTypePopulator.java 2009-11-06 10:55:39 +0000 @@ -0,0 +1,129 @@ +package org.hisp.dhis.dataelement; + +/* + * Copyright (c) 2004-2007, University of Oslo + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * * Neither the name of the HISP project nor the names of its contributors may + * be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +import java.util.Collection; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.hisp.dhis.system.startup.AbstractStartupRoutine; +import org.springframework.transaction.annotation.Transactional; + +/** + * When storing DataValues without associated dimensions there is a need to + * refer to a default dimension. This populator persists a + * DataElementCategoryCombo named by the + * DataElementCategoryCombo.DEFAULT_CATEGORY_COMBO_NAME property and a + * corresponding DataElementCatoryOptionCombo which should be used for this + * purpose. + * + * @author Lars Helge Overland + * @author Abyot Aselefew + * @version $Id$ + */ +public class DataElementDefaultDimensionAndTypePopulator + extends AbstractStartupRoutine +{ + private static final Log log = LogFactory.getLog( DataElementDefaultDimensionAndTypePopulator.class ); + + // ------------------------------------------------------------------------- + // Dependencies + // ------------------------------------------------------------------------- + + private DataElementService dataElementService; + + public void setDataElementService( DataElementService dataElementService ) + { + this.dataElementService = dataElementService; + } + + private DataElementCategoryService categoryService; + + public void setCategoryService( DataElementCategoryService categoryService ) + { + this.categoryService = categoryService; + } + + // ------------------------------------------------------------------------- + // Execute + // ------------------------------------------------------------------------- + + @Transactional + public void execute() + throws Exception + { + String defaultName = DataElementCategoryCombo.DEFAULT_CATEGORY_COMBO_NAME; + + DataElementCategoryCombo categoryCombo = categoryService.getDataElementCategoryComboByName( defaultName ); + + if ( categoryCombo == null ) + { + categoryService.generateDefaultDimension(); + + log.info( "Added default dataelement dimension" ); + + categoryCombo = categoryService.getDataElementCategoryComboByName( defaultName ); + } + + // --------------------------------------------------------------------- + // Any data elements without dimensions need to be associated at least + // with the default dimension + // --------------------------------------------------------------------- + + Collection dataElements = dataElementService.getAllDataElements(); + + boolean dataElementUpdated = false; + + for ( DataElement dataElement : dataElements ) + { + if ( dataElement.getCategoryCombo() == null ) + { + dataElement.setCategoryCombo( categoryCombo ); + + dataElementUpdated = true; + } + + if( dataElement.getType() == null ) + { + dataElement.setType( DataElement.TYPE_AGGREGATE ); + + dataElementUpdated = true; + } + + if( dataElementUpdated ) + { + dataElementService.updateDataElement( dataElement ); + } + } + + if ( dataElementUpdated ) + { + log.info( "Assigned data elements not assigned to any dimension to the default dimension" ); + } + } +}