IndicatorHome.java

/*
 * Copyright (c) 2002-2015, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' 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 HOLDERS 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.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.indicator.business;

import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.service.spring.SpringContextService;

import java.util.Collection;


/**
 * This class provides instances management methods (create, find, ...) for Indicator objects
 */
public final class IndicatorHome
{
    // Static variable pointed at the DAO instance
    private static IIndicatorDAO _dao = SpringContextService.getBean( "indicator.indicatorDAO" );
    private static Plugin _plugin = PluginService.getPlugin( "indicator" );

    /**
     * Private constructor - this class need not be instantiated
     */
    private IndicatorHome(  )
    {
    }

    /**
     * Create an instance of the indicator class
     * @param indicator The instance of the Indicator which contains the informations to store
     * @return The  instance of indicator which has been created with its primary key.
     */
    public static Indicator create( Indicator indicator )
    {
        _dao.insert( indicator, _plugin );

        return indicator;
    }

    /**
     * Update of the indicator which is specified in parameter
     * @param indicator The instance of the Indicator which contains the data to store
     * @return The instance of the  indicator which has been updated
     */
    public static Indicator update( Indicator indicator )
    {
        _dao.store( indicator, _plugin );

        return indicator;
    }

    /**
     * Update of the indicator which is specified in parameter
     * @param indicator The instance of the Indicator which contains the data to store
     * @return The instance of the  indicator which has been updated
     */
    public static Indicator updateValue( Indicator indicator )
    {
        _dao.updateValue( indicator.getIndKey(  ), indicator.getValue(  ), _plugin );

        return indicator;
    }

    /**
     * Remove the indicator whose identifier is specified in parameter
     * @param nKey The indicator Id
     */
    public static void remove( int nKey )
    {
        _dao.delete( nKey, _plugin );
    }

    ///////////////////////////////////////////////////////////////////////////
    // Finders

    /**
     * Returns an instance of a indicator whose identifier is specified in parameter
     * @param nKey The indicator primary key
     * @return an instance of Indicator
     */
    public static Indicator findByPrimaryKey( int nKey )
    {
        return _dao.load( nKey, _plugin );
    }

    /**
     * Returns an instance of a indicator whose identifier is specified in parameter
     * @param strKey The indicator primary key
     * @return an instance of Indicator
     */
    public static Indicator findByKey( String strKey )
    {
        return _dao.loadByKey( strKey, _plugin );
    }

    /**
     * Load the data of all the indicator objects and returns them in form of a collection
     * @return the collection which contains the data of all the indicator objects
     */
    public static Collection<Indicator> getIndicatorsList(  )
    {
        return _dao.selectIndicatorsList( _plugin );
    }
}