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