001    // $HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/portal/context/ViewContext.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.portal.context;
045    
046    import java.io.IOException;
047    
048    import javax.xml.parsers.ParserConfigurationException;
049    
050    import org.deegree.framework.xml.XMLFragment;
051    import org.deegree.framework.xml.XMLParsingException;
052    import org.deegree.model.crs.UnknownCRSException;
053    import org.deegree.security.drm.model.User;
054    import org.xml.sax.SAXException;
055    
056    /**
057     * is the root class of the Web Map Context
058     * 
059     * @version $Revision: 9346 $
060     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
061     */
062    public class ViewContext extends AbstractContext {
063        private LayerList layerList = null;
064    
065        /**
066         * Creates a new WebMapContext object.
067         * 
068         * @param general
069         *            general informations about the map context and its creator
070         * @param layerList
071         *            layers contained in the web map context
072         */
073        public ViewContext( General general, LayerList layerList ) throws ContextException {
074            super( general );
075            setLayerList( layerList );
076        }
077    
078        /**
079         * returns the list of layers contained in this context
080         * 
081         * @return
082         */
083        public LayerList getLayerList() {
084            return layerList;
085        }
086    
087        /**
088         * sets the list of layers to be contained in this context
089         * 
090         * @param layerList
091         * 
092         * @throws ContextException
093         */
094        public void setLayerList( LayerList layerList )
095                                throws ContextException {
096            if ( layerList == null ) {
097                throw new ContextException( "layerList isn't allowed to be null" );
098            }
099            this.layerList = layerList;
100        }
101    
102        /**
103         * The function obtains a copy from the view context
104         * 
105         * @param user
106         * @param sessionID
107         * @return a clone vc
108         * @throws ParserConfigurationException
109         * @throws UnknownCRSException
110         * @throws IOException
111         * @throws XMLParsingException
112         * @throws ContextException
113         * @throws SAXException
114         */
115        public ViewContext clone( User user, String sessionID )
116                                throws ParserConfigurationException, UnknownCRSException, IOException, XMLParsingException,
117                                ContextException, SAXException {
118            XMLFragment xml = XMLFactory.export( this );
119            return WebMapContextFactory.createViewContext( xml, user, sessionID );
120        }
121    }