gvSIG tools: Gazetteer

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

*

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

* MA  02110-1301, USA.

*

*/

/*

* AUTHORS (In addition to CIT):

* 2009 {Iver T.I.}   {Task}

*/

package org.gvsig.gazetteer;

import java.util.Map;

import org.gvsig.gazetteer.drivers.IGazetteerServiceDriver;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public interface GazetteerManager {

        /**

         * It is used to retrieve a driver that supports a concrete

         * protocol

         * @param protocol

         * Gazetteer protocol

         * @return

         * The concrete gazatteer service driver

         */

        public IGazetteerServiceDriver getDriver(String protocol);

        /**

         * @return a list with all the gazetteer drivers

         */

        public IGazetteerServiceDriver[] getDrivers();

        /**

         * This method is used to register a new gazetter driver

         * that manage a concrete protocol

         * @param driver

         * Gazetteer driver to register

         */

        public void register(String name, Class driver);

        /**

         * Returns username for a given protocol

         * @param protocol

         * @return

         */

        public String getUsername(String protocol);

        /**

         * Saves username for a given protocol

         * @param protocol

         * @param username

         */

        public void setUsername(String protocol, String username);

        /**

         * Receives Map with the saved usernames for the different protocols

         * @param usernames

         */

        public void setUsernames(Map usernames);

}