001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/ogcwebservices/wms/operation/GetMapResult.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.ogcwebservices.wms.operation;
037    
038    import org.deegree.ogcwebservices.DefaultOGCWebServiceResponse;
039    import org.deegree.ogcwebservices.OGCWebServiceException;
040    import org.deegree.ogcwebservices.OGCWebServiceRequest;
041    
042    /**
043     * This interface describes the access to the response of a GetMap request.
044     * <p>
045     * </p>
046     * The response to a valid GetMap request shall be a map of the georeferenced information layer
047     * requested, in the desired style, and having the specified spatial reference system, bounding box,
048     * size, format and transparency.
049     * <p>
050     * </p>
051     * An invalid GetMap request shall yield an error output in the requested Exceptions format (or a
052     * network protocol error response in extreme cases). In an HTTP environment, the MIME type of the
053     * returned value's Content-type entity header shall match the format of the return value.
054     * <p>
055     * ----------------------------------------------------------------------
056     * </p>
057     *
058     * @author <a href="mailto:k.lupp@web.de">Katharina Lupp</a>
059     * @version 2002-03-01
060     */
061    public class GetMapResult extends DefaultOGCWebServiceResponse {
062        private Object map = null;
063    
064        /**
065         * constructor initializing the class with the <GetMapResult>
066         *
067         * @param request
068         * @param map
069         */
070        public GetMapResult( OGCWebServiceRequest request, Object map ) {
071            super( request );
072            setMap( map );
073        }
074    
075        /**
076         * constructor initializing the class with the <GetMapResult>
077         *
078         * @param request
079         * @param exception
080         */
081        public GetMapResult( OGCWebServiceRequest request, OGCWebServiceException exception ) {
082            super( request, exception );
083            setMap( map );
084        }
085    
086        /**
087         * @return the map that fullfills the GetMap request. If a exception raised generating the map
088         *         and the exception format doesn't equals application/vnd.ogc.se_inimage or
089         *         application/vnd.ogc.se_blank <tt>null</tt> will be returned.
090         */
091        public Object getMap() {
092            return map;
093        }
094    
095        /**
096         * sets the map that fullfills the GetMap request.
097         *
098         * @param map
099         */
100        public void setMap( Object map ) {
101            this.map = map;
102        }
103    
104    }