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