001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/graphics/optimizers/AbstractOptimizer.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53115 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042 ---------------------------------------------------------------------------*/
043 package org.deegree.graphics.optimizers;
044
045 import java.awt.Graphics2D;
046 import java.util.HashSet;
047 import java.util.Set;
048
049 import org.deegree.graphics.MapView;
050 import org.deegree.graphics.Theme;
051
052 /**
053 * This is the abstract base class for <tt>Optimizer</tt>s that need to alter
054 * the contents of <tt>Theme</tt>s before the parent <tt>MapView</tt> object is
055 * painted. For example, the placements of <tt>LabelDisplayElement</tt>s
056 * in a <tt>Theme</tt> may be optimized to minimize overlapping using the
057 * <tt>LabelOptimizer</tt>.
058 * <p>
059 * @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider</a>
060 * @version $Revision: 9340 $ $Date: 2007-12-27 13:32:12 +0100 (Do, 27 Dez 2007) $
061 */
062
063 public abstract class AbstractOptimizer implements Optimizer {
064
065 // contains all registered Themes
066 protected Set<Theme> themes = new HashSet<Theme> ();
067
068
069 // associated MapView-instance
070 protected MapView mapView;
071
072 /**
073 * Sets the associated <tt>MapView</tt>-instance. Is needed for the scale
074 * and projection information. Called by the <tt>MapView</tt>.
075 * @param mapView
076 *
077 */
078 public void setMapView(MapView mapView) {
079 this.mapView = mapView;
080 }
081
082 /**
083 * Adds a <tt>Theme</tt> that the <tt>Optimizer</tt> should consider.
084 * @param theme
085 */
086 public void addTheme (Theme theme) {
087 themes.add (theme);
088 }
089
090 /**
091 * Invokes the optimization process. The <tt>Optimizer</tt> will now
092 * process and modify the contents of the attached <tt>Theme</tt>s.
093 * @param g
094 */
095 public abstract void optimize (Graphics2D g) throws Exception;
096 }