DashboardComponent.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.portal.service.dashboard;

import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.web.l10n.LocaleService;
import java.util.Locale;

import org.apache.commons.lang3.ObjectUtils;

/**
 * Dashboard Component
 */
public abstract class DashboardComponent implements IDashboardComponent
{
    private String _strName;
    private String _strRight;
    private int _nZone;
    private int _nOrder;
    private Plugin _plugin;
    private Locale _locale;

    /**
     * Returns the Name
     * 
     * @return The Name
     */
    @Override
    public String getName( )
    {
        return _strName;
    }

    /**
     * Sets the Name
     * 
     * @param strName
     *            The Name
     */
    @Override
    public void setName( String strName )
    {
        _strName = strName;
    }

    /**
     * Returns the PluginName
     *
     * @return The PluginName
     */

    /**
     * Returns the Right
     * 
     * @return The Right
     */
    @Override
    public String getRight( )
    {
        return _strRight;
    }

    /**
     * Sets the Right
     * 
     * @param strRight
     *            The Right
     */
    @Override
    public void setRight( String strRight )
    {
        _strRight = strRight;
    }

    /**
     * Returns the Zone
     * 
     * @return The Zone
     */
    @Override
    public int getZone( )
    {
        return _nZone;
    }

    /**
     * Sets the Zone
     * 
     * @param nZone
     *            The Zone
     */
    @Override
    public void setZone( int nZone )
    {
        _nZone = nZone;
    }

    /**
     * Returns the Order
     * 
     * @return The Order
     */
    @Override
    public int getOrder( )
    {
        return _nOrder;
    }

    /**
     * Sets the Order
     * 
     * @param nOrder
     *            The Order
     */
    @Override
    public void setOrder( int nOrder )
    {
        _nOrder = nOrder;
    }

    /**
     * Returns the Plugin
     * 
     * @return The Plugin
     */
    @Override
    public Plugin getPlugin( )
    {
        return _plugin;
    }

    /**
     * Sets the Plugin
     * 
     * @param plugin
     *            The plugin
     */
    @Override
    public void setPlugin( Plugin plugin )
    {
        _plugin = plugin;
    }

    /**
     * Compare component order
     * 
     * @param o
     *            The component to compare to
     * @return less than 0 if the order is lower, 0 if equals and greater than 0 if higher
     */
    @Override
    public int compareTo( IDashboardComponent o )
    {
        return getOrder( ) - o.getOrder( );
    }

    /**
     * Tells if the component is enabled
     * 
     * @return true if enabled
     */
    @Override
    public boolean isEnabled( )
    {
        return PluginService.isPluginEnable( _plugin.getName( ) );
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public boolean equals( Object obj )
    {
        if ( obj instanceof IDashboardComponent )
        {
            IDashboardComponent other = (IDashboardComponent) obj;

            return ObjectUtils.equals( this.getName( ), other.getName( ) );
        }

        return false;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public int hashCode( )
    {
        return ObjectUtils.hashCode( this.getName( ) );
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public String toString( )
    {
        return getClass( ).getName( ) + "[name=" + this.getName( ) + ", zone=" + this.getZone( ) + ", order=" + this.getOrder( ) + "]";
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public void setLocale( Locale locale )
    {
        _locale = locale;
    }

    @Override
    public String getDescription( )
    {
        String strKey;
        Locale locale = ( _locale != null ) ? _locale : LocaleService.getDefault( );

        if ( _plugin == PluginService.getCore( ) )
        {
            strKey = "portal.dashboard.dashboardComponent." + _strName + ".description";
        }
        else
        {
            strKey = _plugin.getName( ) + ".dashboardComponent." + _strName + ".description";
        }
        return I18nService.getLocalizedString( strKey, locale );
    }
}