Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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 3

 * 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.fmap.mapcontext.layers.operations;

import org.gvsig.fmap.dal.exception.ReadException;

import org.gvsig.fmap.geom.type.GeometryType;

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

import org.gvsig.fmap.mapcontext.rendering.legend.events.listeners.LegendListener;

/**

 * <p>Interface that all layers that can be classifiable, must implement.</p>

 * <p>The interface <code>Classifiable</code> allows classify a layer in <i>raster</i> or <i>vector</i>,

 *  and then, generates a legend.</p>

 */

public interface Classifiable {

        /**

         * Adds the specified legend listener to receive legend events from the inner legend.

         *  If the parameter is null, no exception is thrown and no action is performed.

         *

         * @param listener the legend listener

         *

         * @see #removeLegendListener(LegendListener)

         */

        void addLegendListener(LegendListener listener);

        /**

         * Removes the specified legend listener so that it no longer receives legend events from the inner

         *  legend. This method performs no function, nor does it throw an exception, if the listener specified

         *  by the argument was not previously added to the legend. If the parameter is null, no exception is

         *  thrown and no action is performed.

         *

         * @param listener the legend listener

         *

         * @see #addLegendListener(LegendListener)

         */

        void removeLegendListener(LegendListener listener);

        /**

         * Returns the inner legend.

         *

         * @return Legend.

         */

        public ILegend getLegend();

        /**

         * <p>Returns the type of the shape.</p>

         * <p>All geometry types are defined in <code>Geometry.TYPES</code>.

         *  For getting the equivalent shape of a geometry type, you must use a method like

         *  <code>{@linkplain SHPFileWrite#getShapeType()}</code>.</p>

         *

         * @return the type of this shape.

         * @throws ReadException

         *

         * @see Geometry

         * @see Constant

         *

         * @throws ReadDriverException if the driver fails reading the data.

         * 

         * @deprecated to be removed in gvSIG 2.1. Use {@link #getGeometryType()} instead.

         */

        public int getShapeType() throws ReadException;

    /**

     * Returns the layer's geometry type

     * 

     * @return the geometry type

     * 

     * @throws ReadException

     *             if there is an error getting the geometry type

     */

    public GeometryType getGeometryType() throws ReadException;

}