001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/graphics/displayelements/GeometryDisplayElement.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2006 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 ---------------------------------------------------------------------------*/
044 package org.deegree.graphics.displayelements;
045
046 import java.io.Serializable;
047
048 import org.deegree.graphics.sld.Symbolizer;
049 import org.deegree.model.feature.Feature;
050 import org.deegree.model.spatialschema.Geometry;
051
052 /**
053 * Basic interface of all display elements that are related to a geometry (this is the common case).
054 *
055 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
056 * @author last edited by: $Author: bezema $
057 *
058 * @version $Revision: 6259 $, $Date: 2007-03-20 10:15:15 +0100 (Di, 20 Mär 2007) $
059 */
060 abstract class GeometryDisplayElement extends AbstractDisplayElement implements Serializable {
061
062 /** Use serialVersionUID for interoperability. */
063 private final static long serialVersionUID = 465725117946501686L;
064
065 protected Geometry geometry;
066
067 protected Symbolizer symbolizer;
068
069 protected Symbolizer highlightSymbolizer;
070
071 protected Symbolizer selectedSymbolizer;
072
073 protected Object placement;
074
075 /**
076 * Creates a new GeometryDisplayElement object.
077 *
078 * @param feature
079 * @param geometry
080 */
081 GeometryDisplayElement( Feature feature, Geometry geometry ) {
082 super( feature );
083 setGeometry( geometry );
084 }
085
086 /**
087 * Creates a new GeometryDisplayElement object.
088 *
089 * @param feature
090 * @param geometry
091 * @param symbolizer
092 */
093 GeometryDisplayElement( Feature feature, Geometry geometry, Symbolizer symbolizer ) {
094 super( feature );
095 setGeometry( geometry );
096 setSymbolizer( symbolizer );
097 setHighlightSymbolizer( symbolizer );
098 setSelectedSymbolizer( symbolizer );
099 }
100
101 /**
102 * Creates a new GeometryDisplayElement object.
103 *
104 * @param feature
105 * @param geometry
106 * @param symbolizer
107 * @param selectedSymbolizer
108 * @param highlightSymbolizer
109 */
110 GeometryDisplayElement( Feature feature, Geometry geometry, Symbolizer symbolizer,
111 Symbolizer highlightSymbolizer, Symbolizer selectedSymbolizer ) {
112 super( feature );
113 setGeometry( geometry );
114 setSymbolizer( symbolizer );
115 setSelectedSymbolizer( selectedSymbolizer );
116 setHighlightSymbolizer( highlightSymbolizer );
117 }
118
119 /**
120 * Overwrites the default placement of the <tt>DisplayElement</tt>. This method is used by
121 * the <tt>PlacementOptimizer</tt> to minimize the overlapping of labels, for example.
122 * <p>
123 *
124 * @param o
125 * the placement to be used
126 */
127 public void setPlacement( Object o ) {
128 placement = o;
129 }
130
131 /**
132 * sets the geometry that determines the position the DisplayElement will be rendered to
133 */
134 public void setGeometry( Geometry geometry ) {
135 this.geometry = geometry;
136 }
137
138 /**
139 * returns the geometry that determines the position the DisplayElement will be rendered to
140 */
141 public Geometry getGeometry() {
142 return geometry;
143 }
144
145 /**
146 * sets the rules that determines how the geometry will be rendered
147 */
148 public void setSymbolizer( Symbolizer symbolizer ) {
149 this.symbolizer = symbolizer;
150 }
151
152 /**
153 * Returns the symbolizer that determines how the geometry will be rendered.
154 */
155 public Symbolizer getSymbolizer() {
156 return symbolizer;
157 }
158
159 /**
160 * sets the rule that determines how the geometry will be rendered when it's highlighted
161 *
162 * @param rule
163 * symbolizer defining rendering style
164 */
165 public void setHighlightSymbolizer( Symbolizer rule ) {
166 this.highlightSymbolizer = rule;
167 }
168
169 /**
170 * returns the symbolizer that determines how the geometry will be rendered if it's highlighted
171 */
172 public Symbolizer getHighlightSymbolizer() {
173 return highlightSymbolizer;
174 }
175
176 /**
177 * sets the rule that determines how the geometry will be rendered when it's selected
178 *
179 * @param rule
180 * symbolizer defining rendering style
181 */
182 public void setSelectedSymbolizer( Symbolizer rule ) {
183 selectedSymbolizer = rule;
184 }
185
186 /**
187 * returns the symbolizer that determines how the geometry will be rendered if it's selected
188 */
189 public Symbolizer getSelectedSymbolizer() {
190 return selectedSymbolizer;
191 }
192
193 /**
194 * Returns if the <tt>DisplayElement</tt> should be painted at the current scale or not.
195 */
196 public boolean doesScaleConstraintApply( double scale ) {
197 return symbolizer.getMinScaleDenominator() <= scale
198 && symbolizer.getMaxScaleDenominator() > scale;
199 }
200 }
201
202 /***************************************************************************************************
203 * <code>
204 Changes to this class. What the people have been up to:
205
206 $Log$
207 Revision 1.10 2007/02/13 17:01:59 mschneider
208 Fixed footer, improved javadoc.
209
210 Revision 1.9 2006/07/12 14:46:16 poth
211 comment footer added
212
213 * </code>
214 **************************************************************************************************/