PanelService.java

/*
 * Copyright (c) 2002-2020, 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.seo.service;

import fr.paris.lutece.plugins.seo.web.SEOPanel;
import fr.paris.lutece.portal.service.spring.SpringContextService;
import java.io.Serializable;

import java.util.Collections;
import java.util.Comparator;
import java.util.List;

/**
 * Panel Service
 */
public final class PanelService
{
    private static PanelService _singleton;
    private static List<SEOPanel> _listPanels;
    private static Comparator _comparator = new PanelComparator( );

    /**
     * Private constructor
     */
    private PanelService( )
    {
    }

    /**
     * Return the unique instance
     * 
     * @return The instance
     */
    public static synchronized PanelService instance( )
    {
        if ( _singleton == null )
        {
            _singleton = new PanelService( );
            _listPanels = SpringContextService.getBeansOfType( SEOPanel.class );
            Collections.sort( _listPanels, _comparator );
        }

        return _singleton;
    }

    /**
     * Returns the list of all panels
     * 
     * @return The list of all panels
     */
    public List<SEOPanel> getPanels( )
    {
        return _listPanels;
    }

    /**
     * Get the index of a panel
     * 
     * @param strPanelKey
     *            The panel's key
     * @return The index
     */
    public int getIndex( String strPanelKey )
    {
        int nIndex = 1;

        for ( SEOPanel panel : _listPanels )
        {
            if ( panel.getPanelKey( ).equals( strPanelKey ) )
            {
                return nIndex;
            }

            nIndex++;
        }

        return -1;
    }

    /**
     * Comparator
     */
    private static class PanelComparator implements Comparator, Serializable
    {
        /**
         * Comparator
         * 
         * @param o1
         *            object 1
         * @param o2
         *            object 2
         * @return the comparaison
         */
        @Override
        public int compare( Object o1, Object o2 )
        {
            SEOPanel p1 = (SEOPanel) o1;
            SEOPanel p2 = (SEOPanel) o2;

            return p1.getPanelOrder( ) - p2.getPanelOrder( );
        }
    }
}