Application: gvSIG desktop » gvSIG raster

package org.gvsig.raster.roimask.lib;

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

/**

 * This locator is the entry point for the Raster library, providing

 * access to all Raster services through the {@link ROIMaskManager}

 * .

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class ROIMaskLocator extends BaseLocator {

    public static final String                      MANAGER_NAME         = "ROIMask.manager";

    public static final String                      MANAGER_DESCRIPTION  = "ROIMask Manager";

    private static final String                     LOCATOR_NAME         = "ROIMask.locator";

    private static final ROIMaskLocator  INSTANCE             = new ROIMaskLocator();

    /**

     * Return the singleton instance.

     * 

     * @return the singleton instance

     */

    public static ROIMaskLocator getInstance() {

        return INSTANCE;

    }

    /**

     * Return the Locator's name.

     * 

     * @return a String with the Locator's name

     */

    public final String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to the ROIMaskManager.

     * 

     * @return a reference to the ROIMaskManager

     * @throws LocatorException

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

     *             instantiated

     * @see Locator#get(String)

     */

    public static ROIMaskManager getManager() throws LocatorException {

        return (ROIMaskManager) getInstance().get(MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the RasterManager interface.

     * 

     * @param clazz

     *            implementing the RasterManager interface

     */

    public static void registerManager(

        Class<? extends ROIMaskManager> clazz) {

        getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

}