AttributeService.java

/*
 * Copyright (c) 2002-2022, City of 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.pluginwizard.service;

import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.util.ReferenceList;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

/**
 * Attribute Service
 */
public class AttributeService
{
    private static final String I18N_RESOURCE_KEY_PREFIX = "pluginwizard.pluginwizard_attributes_types.";
    private static final String I18N_RESOURCE_KEY_DESCRIPTION_SUFFIX = ".description";
    private List<AttributeType> _listAttributeTypes;

    /**
     * Sets the list of attribute types
     * 
     * @param list
     *            The list
     */
    public void setAttributeTypesList( List<AttributeType> list )
    {
        if ( list != null )
        {
            _listAttributeTypes = (List<AttributeType>) ( ( (ArrayList<AttributeType>) list ).clone( ) );
        }
        else
        {
            _listAttributeTypes = null;
        }
    }

    /**
     * Returns a Reference list with all attribute types available
     * 
     * @return The list
     */
    public ReferenceList getAttributeTypes( Locale locale )
    {
        ReferenceList list = new ReferenceList( );

        for ( AttributeType type : _listAttributeTypes )
        {
            String strDescription = I18nService
                    .getLocalizedString( I18N_RESOURCE_KEY_PREFIX + type.getIdAttributeType( ) + I18N_RESOURCE_KEY_DESCRIPTION_SUFFIX, locale );
            if ( strDescription == null )
            {
                strDescription = type.getDescription( );
            }

            list.addItem( type.getIdAttributeType( ), strDescription );
        }

        return list;
    }

    /**
     * Get the type object from its ID
     * 
     * @param nAttributeTypeId
     *            The ID
     * @return The object
     */
    public AttributeType getType( int nAttributeTypeId )
    {
        for ( AttributeType type : _listAttributeTypes )
        {
            if ( type.getIdAttributeType( ) == nAttributeTypeId )
            {
                return type;
            }
        }

        return null;
    }
}