    001    //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.4_testing/src/org/deegree/graphics/optimizers/Optimizer.java $
    002    /*----------------------------------------------------------------------------
    003     This file is part of deegree, http://deegree.org/
    004     Copyright (C) 2001-2009 by:
    005       Department of Geography, University of Bonn
    006     and
    007       lat/lon GmbH
    008
    009     This library is free software; you can redistribute it and/or modify it under
    010     the terms of the GNU Lesser General Public License as published by the Free
    011     Software Foundation; either version 2.1 of the License, or (at your option)
    012     any later version.
    013     This library is distributed in the hope that it will be useful, but WITHOUT
    014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
    016     details.
    017     You should have received a copy of the GNU Lesser General Public License
    018     along with this library; if not, write to the Free Software Foundation, Inc.,
    019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
    020
    021     Contact information:
    022
    023     lat/lon GmbH
    024     Aennchenstr. 19, 53177 Bonn
    025     Germany
    026     http://lat-lon.de/
    027
    028     Department of Geography, University of Bonn
    029     Prof. Dr. Klaus Greve
    030     Postfach 1147, 53001 Bonn
    031     Germany
    032     http://www.geographie.uni-bonn.de/deegree/
    033
    034     e-mail: info@deegree.org
    035    ----------------------------------------------------------------------------*/
    036    package org.deegree.graphics.optimizers;
    037
    038    import java.awt.Graphics2D;
    039
    040    import org.deegree.graphics.MapView;
    041    import org.deegree.graphics.Theme;
    042    import org.deegree.graphics.displayelements.LabelDisplayElement;
    043
    044    /**
    045     * This is the interface for (graphical) {@link Optimizer}s that need to alter the contents of {@link Theme}s (e.g.
    046     * positions of display elements} before the parent {@link MapView} object is painted.
    047     * <p>
    048     * For example, the placements of {@link LabelDisplayElement}s in a {@link Theme} may be optimized to minimize
    049     * overlapping using the {@link LabelOptimizer}.
    050     *
    051     * @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider</a>
    052     * @author last edited by: $Author: mschneider $
    053     *
    054     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
    055     */
    056    public interface Optimizer {
    057
    058        /**
    059         * Sets the associated {@link MapView} instance. This is needed to provide scale and projection information. Called
    060         * by the {@link MapView}.
    061         *
    062         * @param mapView
    063         *            {@link MapView} instance to associate with this {@link Optimizer}
    064         */
    065        public void setMapView( MapView mapView );
    066
    067        /**
    068         * Adds a {@link Theme} to be considered by this {@link Optimizer}.
    069         *
    070         * @param theme
    071         *            {@link Theme} to be considered
    072         */
    073        public void addTheme( Theme theme );
    074
    075        /**
    076         * Invokes the optimization process. This {@link Optimizer} will now process and modify the contents of the attached
    077         * {@link Theme}s.
    078         *
    079         * @param g
    080         *            graphis context that will be used to draw the optimized display elements
    081         * @throws Exception
    082         */
    083        public abstract void optimize( Graphics2D g )
    084                                throws Exception;
    085    }