| gvSIG desktop 1

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Gobernment (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 {DiSiD Technologies}  {Create Manager to register MapContextDrawer implementation}

 */

package org.gvsig.fmap.mapcontext;

import java.awt.Color;

import java.awt.Font;

import org.gvsig.fmap.mapcontext.layers.vectorial.GraphicLayer;

import org.gvsig.fmap.mapcontext.rendering.legend.ILegend;

import org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend;

import org.gvsig.fmap.mapcontext.rendering.legend.driver.ILegendReader;

import org.gvsig.fmap.mapcontext.rendering.legend.driver.ILegendWriter;

import org.gvsig.fmap.mapcontext.rendering.symbols.IMultiLayerSymbol;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.fmap.mapcontext.rendering.symbols.IWarningSymbol;

/**

 * Manager of the MapContext library.

 * 

 * Holds the default implementation of the {@link MapContextDrawer}.

 * 

 * @author <a href="mailto:cordinyana@gvsig.org">C?sar Ordi?ana</a>

 */

public interface MapContextManager {

        int getDefaultCartographicSupportMeasureUnit();

        void setDefaultCartographicSupportMeasureUnit(

                        int defaultCartographicSupportMeasureUnit);

        int getDefaultCartographicSupportReferenceSystem();

        void setDefaultCartographicSupportReferenceSystem(

                        int defaultCartographicSupportReferenceSystem);

        Color getDefaultSymbolColor();

        void setDefaultSymbolColor(Color defaultSymbolColor);

        void resetDefaultSymbolColor();

        Color getDefaultSymbolFillColor();

        void setDefaultSymbolFillColor(Color defaultSymbolFillColor);

        void resetDefaultSymbolFillColor();

        boolean isDefaultSymbolFillColorAleatory();

        void setDefaultSymbolFillColorAleatory(

                        boolean defaultSymbolFillColorAleatory);

        void resetDefaultSymbolFillColorAleatory();

        Font getDefaultSymbolFont();

        void setDefaultSymbolFont(Font defaultSymbolFont);

        void resetDefaultSymbolFont();

        String getSymbolLibraryPath();

        void setSymbolLibraryPath(String symbolLibraryPath);

        void resetSymbolLibraryPath();

        /**

         * Sets the class to use as the default implementation for the

         * {@link MapContextDrawer}.

         * 

         * @param drawerClazz

         *            the {@link MapContextDrawer} class to use

         * @throws MapContextException

         *             if there is any error setting the class

         */

        void setDefaultMapContextDrawer(Class drawerClazz)

                        throws MapContextException;

        void validateMapContextDrawer(Class drawerClazz) throws MapContextException;

        /**

         * Creates a new instance of the default {@link MapContextDrawer}

         * implementation.

         * 

         * @return the new {@link MapContextDrawer} instance

         * @throws MapContextException

         *             if there is an error creating the new object instance

         */

        MapContextDrawer createDefaultMapContextDrawerInstance()

                        throws MapContextException;

        /**

         * Creates a new instance of the provided {@link MapContextDrawer}

         * implementation.

         * 

         * @param drawerClazz

         *            the {@link MapContextDrawer} implementation class

         * @return the new {@link MapContextDrawer} instance

         * @throws MapContextException

         *             if there is an error creating the new object instance

         */

        MapContextDrawer createMapContextDrawerInstance(Class drawerClazz)

                        throws MapContextException;

        GraphicLayer createGraphicsLayer();

        void registerLegend(String legendName, Class legendClass)

                        throws MapContextRuntimeException;

        ILegend createLegend(String legendName) throws MapContextRuntimeException;

        void setDefaultVectorLegend(String legendName);

        IVectorLegend createDefaultVectorLegend(int shapeType)

                        throws MapContextRuntimeException;

        void registerLegendWriter(String legendName, String format,

                        Class writerClass) throws MapContextRuntimeException;

        void registerLegendReader(String format, Class readerClass)

                        throws MapContextRuntimeException;

        ILegendWriter createLegendWriter(String legendName, String format)

                        throws MapContextException;

        ILegendReader createLegendReader(String format)

                        throws MapContextRuntimeException;

        ISymbol createSymbol(String symbolName) throws MapContextRuntimeException;

        ISymbol createSymbol(int shapeType) throws MapContextRuntimeException;

        ISymbol createSymbol(String symbolName, Color color)

                        throws MapContextRuntimeException;

        ISymbol createSymbol(int shapeType, Color color)

                        throws MapContextRuntimeException;

        IMultiLayerSymbol createMultiLayerSymbol(String symbolName)

                        throws MapContextRuntimeException;

        IMultiLayerSymbol createMultiLayerSymbol(int shapeType)

                        throws MapContextRuntimeException;

        void registerSymbol(String symbolName, Class symbolClass)

                        throws MapContextRuntimeException;

        void registerSymbol(String symbolName, int[] shapeTypes, Class symbolClass)

                        throws MapContextException;

        void registerMultiLayerSymbol(String symbolName, Class symbolClass)

                        throws MapContextRuntimeException;

        void registerMultiLayerSymbol(String symbolName, int[] shapeTypes,

                        Class symbolClass) throws MapContextRuntimeException;

        IWarningSymbol getWarningSymbol(String message, String symbolDesc,

                        int symbolDrawExceptionType) throws MapContextRuntimeException;

}