Application: gvSIG desktop

package org.gvsig.raster.lib.legend.api;

import org.gvsig.tools.locator.AbstractLocator;

import org.gvsig.tools.locator.LocatorException;

/**

 * Raster legend locator to get Raster legend manager singleton instance

 * 

 * @author <a href="mailto:lmarques@disid.com">Lluis Marques</a>

 *

 */

public class RasterLegendLocator extends AbstractLocator {

    public static final String LOCATOR_NAME = "RasterLegendLocator";

    public static final String RASTER_LEGEND_MANAGER_NAME = "RasterLegendManager";

    public static final String RASTER_LEGEND_MANAGER_DESCRIPTION =

        "Raster legend manager of gvSIG raster";

    /**

     * Unique instance.

     */

    private static final RasterLegendLocator instance = new RasterLegendLocator();

    /**

     * Return the singleton instance.

     *

     * @return the singleton instance

     */

    public static RasterLegendLocator getInstance() {

        return instance;

    }

    @Override

    public String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to {@link RasterLegendManager}.

     *

     * @return a reference to RasterLegendManager

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

    public static RasterLegendManager getRasterLegendManager() throws LocatorException {

        return (RasterLegendManager) getInstance().get(RASTER_LEGEND_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the {@link RasterLegendManager}

     * interface.

     *

     * @param clazz

     *            implementing the RasterLegendManager interface

     */

    public static void registerRasterLegendManager(Class clazz) {

        getInstance()

            .register(RASTER_LEGEND_MANAGER_NAME, RASTER_LEGEND_MANAGER_DESCRIPTION, clazz);

    }

}