001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/graphics/sld/GraphicStroke.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 GraphicStroke element both indicates that a repeated-linear-graphic stroke type will be used.
042     * <p>
043     * </p>
044     * The Graphic sub-element specifies the linear graphic. Proper stroking with a linear graphic
045     * requires two hot-spot points within the space of the graphic to indicate where the rendering line
046     * starts and stops. In the case of raster images with no special mark-up, this line will be assumed
047     * to be middle pixel row of the image, starting from the first pixel column and ending at the last
048     * pixel column.
049     *
050     *
051     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</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 class GraphicStroke {
057    
058        /**
059         *
060         */
061        private Graphic graphic = null;
062    
063        /**
064         * default constructor
065         */
066        GraphicStroke() {
067            // nothing to do here
068        }
069    
070        /**
071         * constructor initializing the class with the <GraphicStroke>
072         * @param graphic
073         */
074        GraphicStroke( 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 <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 GraphicStroke as XML formated String
103         *
104         * @return xml representation of the GraphicStroke
105         */
106        public String exportAsXML() {
107    
108            StringBuffer sb = new StringBuffer( 1000 );
109            sb.append( "<GraphicStroke>" );
110            sb.append( ( (Marshallable) graphic ).exportAsXML() );
111            sb.append( "</GraphicStroke>" );
112    
113            return sb.toString();
114        }
115    
116    }