001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/graphics/sld/GraphicStroke.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     ---------------------------------------------------------------------------*/
044    package org.deegree.graphics.sld;
045    
046    import org.deegree.framework.xml.Marshallable;
047    
048    /**
049     * The GraphicStroke element both indicates that a repeated-linear-graphic stroke type will be used.
050     * <p>
051     * </p>
052     * The Graphic sub-element specifies the linear graphic. Proper stroking with a linear graphic
053     * requires two hot-spot points within the space of the graphic to indicate where the rendering line
054     * starts and stops. In the case of raster images with no special mark-up, this line will be assumed
055     * to be middle pixel row of the image, starting from the first pixel column and ending at the last
056     * pixel column.
057     * 
058     * 
059     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
060     * @author last edited by: $Author: apoth $
061     * 
062     * @version. $Revision: 9340 $, $Date: 2007-12-27 13:32:12 +0100 (Do, 27 Dez 2007) $
063     */
064    public class GraphicStroke {
065    
066        /**
067         * 
068         */
069        private Graphic graphic = null;
070    
071        /**
072         * default constructor
073         */
074        GraphicStroke() {
075        }
076    
077        /**
078         * constructor initializing the class with the <GraphicStroke>
079         */
080        GraphicStroke( Graphic graphic ) {
081            setGraphic( graphic );
082        }
083    
084        /**
085         * A Graphic is a graphic symbol with an inherent shape, color(s), and possibly size. A graphic
086         * can be very informally defined as a little picture and can be of either a raster or
087         * vector-graphic source type. The term graphic is used since the term symbol is similar to
088         * symbolizer which is used in a different context in SLD.
089         * 
090         * @return graphic
091         * 
092         */
093        public Graphic getGraphic() {
094            return graphic;
095        }
096    
097        /**
098         * sets <Graphic>
099         * 
100         * @param graphic
101         * 
102         */
103        public void setGraphic( Graphic graphic ) {
104            this.graphic = graphic;
105        }
106    
107        /**
108         * exports the content of the GraphicStroke as XML formated String
109         * 
110         * @return xml representation of the GraphicStroke
111         */
112        public String exportAsXML() {
113    
114            StringBuffer sb = new StringBuffer( 1000 );
115            sb.append( "<GraphicStroke>" );
116            sb.append( ( (Marshallable) graphic ).exportAsXML() );
117            sb.append( "</GraphicStroke>" );
118    
119            return sb.toString();
120        }
121    
122    }