001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/graphics/sld/LegendGraphic.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.sld;
045
046 import org.deegree.framework.xml.Marshallable;
047
048 /**
049 * The LegendGraphic element gives an optional explicit Graphic symbol to be displayed in a legend
050 * for this rule.
051 *
052 *
053 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
054 * @author last edited by: $Author: apoth $
055 *
056 * @version. $Revision: 6698 $, $Date: 2007-04-26 11:40:11 +0200 (Do, 26 Apr 2007) $
057 */
058 public class LegendGraphic implements Marshallable {
059
060 /**
061 *
062 */
063 private Graphic graphic = null;
064
065 /**
066 * default constructor
067 */
068 LegendGraphic() {
069 }
070
071 /**
072 * constructor initializing the class with the <LegendGraphic>
073 */
074 LegendGraphic( Graphic graphic ) {
075 setGraphic( graphic );
076 }
077
078 /**
079 * A Graphic is a graphic symbol with an inherent shape, color(s), and possibly size. A graphic
080 * can be very informally defined as a little picture and can be of either a raster or
081 * vector-graphic source type. The term graphic is used since the term symbol is similar to
082 * symbolizer which is used in a different context in SLD.
083 *
084 * @return graphic
085 *
086 */
087 public Graphic getGraphic() {
088 return graphic;
089 }
090
091 /**
092 * sets the <Graphic>
093 *
094 * @param graphic
095 *
096 */
097 public void setGraphic( Graphic graphic ) {
098 this.graphic = graphic;
099 }
100
101 /**
102 * exports the content of the Font as XML formated String
103 *
104 * @return xml representation of the Font
105 */
106 public String exportAsXML() {
107
108 StringBuffer sb = new StringBuffer( 1000 );
109 sb.append( "<LegendGraphic>" );
110 sb.append( ( (Marshallable) graphic ).exportAsXML() );
111 sb.append( "</LegendGraphic>" );
112
113 return sb.toString();
114 }
115 }