Application: gvSIG desktop » gvSIG projections

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2012 gvSIG Association.

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.proj.swing;

import java.util.Set;

import org.gvsig.proj.CoordinateReferenceSystemManager;

import org.gvsig.proj.catalog.CRSCatalogManager;

import org.gvsig.proj.catalog.CRSDefinition;

import org.gvsig.proj.catalog.TransformationDefinition;

import org.gvsig.tools.dynobject.DynObject;

/**

 * This class is responsible of the management of the library's swing user

 * interface. It is the swing library's main entry point, and provides all the

 * services to manage library swing components.

 * 

 * @see JProjServicePanel

 * @author gvSIG team

 * @version $Id$

 */

public interface CoordinateReferenceSystemSwingManager {

    /**

     * Returns the component to select a CoordinateReferenceSystem.

     * 

     * @return a {@link CoordinateReferenceSystemSelectorComponent} to select a

     *         CoordinateReferenceSystem

     */

    CoordinateReferenceSystemSelectorComponent createCoordinateReferenceSystemSelectionComponent();

    /**

     * Returns the component to select a CoordinateTransformation.

     * 

     * @return a {@link CoordinateTransformationSelectorComponent} to select a

     *         CoordinateTransformation 

     */

    CoordinateTransformationSelectorComponent createCoordinateTransformSelectionComponent();

    /**

     * Gets the list of recently used CoordinateReferenceSystems.

     * 

     * @return A <code>RecentHistory</code> object, which can be used to add new

     * elements to the history or to iterate on history elements.

     */

    RecentHistory<CRSDefinition> getCoordinateReferenceSystemHistory();

    /**

     * Gets the list of recently used CoordinateTransformations.

     * 

     * @return A <code>RecentHistory</code> object, which can be used to add new

     * elements to the history or to iterate on history elements.

     */

    RecentHistory<TransformationDefinition> getTransformationHistory();

    /**

     * Gets the list of recently used strings in the CRS search UI.

     * 

     * @return A <code>RecentHistory</code> object, which can be used to add new

     * elements to the history or to iterate on history elements.

     */

    RecentHistory<String> getCoordinateReferenceSystemTextFilterHistory();

    /**

     * Gets the list of recently used strings in the CoordinateTransformation search UI.

     * 

     * @return A <code>RecentHistory</code> object, which can be used to add new

     * elements to the history or to iterate on history elements.

     */

    RecentHistory<String> getTransformationTextFilterHistory();

    /**

     * Gets the list of favorite CoordinateReferenceSystems.

     * 

     * @return A <code>List</code> object, which can be used to add new favorites

     * or to iterate on existing favorites.

     */

    Set<CRSDefinition> getCoordinateReferenceSystemFavorites();

    /**

     * Gets the list of favorite CoordinateTransformations.

     * 

     * @return A <code>List</code> object, which can be used to add new favorites

     * or to iterate on existing favorites.

     */

    Set<TransformationDefinition> getTransformationFavorites();

    /**

     * Returns the {@link CoordinateReferenceSystemManager}.

     * 

     * @return {@link CoordinateReferenceSystemManager}

     * @see {@link CoordinateReferenceSystemManager}

     */

    CoordinateReferenceSystemManager getCRSManager();

    CRSCatalogManager getCatalogManager();

    /**

     * <p>Gets the preferences of the manager, as a DynObject. Don't store an instance of

     * this object, use this method to retrieve it when needed, since it is only updated

     * when retrieved.</p>

     * 

     * <p>The object contains the following fields:

     * <ul>

     * <li><code>crsHistory</code> of type List (containing {@code CRSDefinition}s)</li>

     * <li><code>crsHistorySize</code> of type Integer, which defines the maximum number of elements to store on

     * the CRS history</li>

     * <li><code>transformationHistory</code> of type List (containing {@code TransformationDefinition}s)</li>

     * <li><code>transformationHistorySize</code> of type Integer, which defines the maximum number of elements to store on

     * the transformation history</li>

     * <li><code>crsTextFilterHistory</code> of type List (containing {@code String}s)</li>

     * <li><code>crsTextFilterHistorySize</code> of type Integer, which defines the maximum number of elements to store on

     * the CRS text filter history</li>

     * <li><code>transformationTextFilterHistory</code> of type List (containing {@code String}s)</li>

     * <li><code>transformationTextFilterHistorySize</code> of type Integer, which defines the maximum number of elements to store on

     * the transformation text filter history</li>

     * <li><code>crsFavorites</code> of type List (containing {@code CRSDefinition}s)</li>

     * <li><code>transformationFavorites</code> of type List (containing {@code TransformationDefinition}s)</li>

     * </ul>

     * </p>

     * 

     * @return

     */

    public DynObject getPreferences();

    /**

     * Sets the preferences of the plugin, as a DynObject. The favorite and history lists

     * will be updated according to the provided DynObject values.

     * 

     * Check {@link #getPreferences()}

     * documentation to see the expected structure of the DynObject.

     */

    public void setPreferences(DynObject preferences);

}