001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/ogcwebservices/wms/configuration/RemoteWMSDataSource.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.ogcwebservices.wms.configuration;
045    
046    import java.awt.Color;
047    import java.net.URL;
048    import java.util.List;
049    import java.util.Map;
050    
051    import org.deegree.datatypes.QualifiedName;
052    import org.deegree.model.spatialschema.Geometry;
053    import org.deegree.ogcwebservices.OGCWebService;
054    import org.deegree.ogcwebservices.wms.RemoteWMService;
055    import org.deegree.ogcwebservices.wms.capabilities.ScaleHint;
056    import org.deegree.ogcwebservices.wms.capabilities.WMSCapabilities;
057    import org.deegree.ogcwebservices.wms.operation.GetMap;
058    
059    
060    /**
061     * Data source description for a REMOTEWMS datasource 
062     * 
063     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth </a>
064     * @version $Revision: 9345 $, $Date: 2007-12-27 17:22:25 +0100 (Do, 27 Dez 2007) $
065     */
066    public class RemoteWMSDataSource extends AbstractDataSource {
067            
068        private GetMap getMap = null;
069        private Color[] transparentColors = null;
070        
071        private List<String> passedParameters;
072        
073        private Map<String, String> addedParameters;
074        
075        /**
076         * Creates a new DataSource object.
077         * @param querable 
078         * @param failOnException 
079         * 
080         * @param name
081         *            name of the featuretype to access
082         * @param type
083         *            type of the data source (REMOTEWCS, LOCALWCS)
084         * @param ows
085         *            <tt>OGCWebService</tt> instance for accessing the data
086         *            source
087         * @param capabilitiesURL 
088         * @param scaleHint
089         *            filter condition
090         * @param validArea 
091         * @param getMap 
092         * @param transparentColors 
093         * @param featureInfoTransform 
094         * @param reqTimeLimit 
095         * @param passedParameters parameter names to be passed in incoming GetMap requests
096         * @param addedParameters parameters and values to be added to outgoing GetMap requests
097         */
098        public RemoteWMSDataSource( boolean querable, boolean failOnException, QualifiedName name, 
099                                   int type, OGCWebService ows, URL capabilitiesURL, ScaleHint scaleHint, 
100                                   Geometry validArea, GetMap getMap, Color[] transparentColors, 
101                                   URL featureInfoTransform, int reqTimeLimit, List<String> passedParameters, Map<String, String> addedParameters ) {
102            super( querable, failOnException, name, type, ows, capabilitiesURL, 
103                   scaleHint, validArea, featureInfoTransform, reqTimeLimit  );
104            this.getMap = getMap;
105            this.transparentColors = transparentColors;
106            this.passedParameters = passedParameters;
107            this.addedParameters = addedParameters;
108        }
109    
110        /**
111         * returns an instance of a <tt>GetMapRequest</tt> encapsulating the
112         * filter conditions against a remote WMS. The request object contains:
113         * WMTVER, LAYERS, STYLES, FORMAT, TRANSPARENT, VENDORSPECIFICPARAMETERS
114         * 
115         * @return filter conditions
116         *  
117         */
118        public GetMap getGetMapRequest() {
119            return getMap;
120        }
121        
122        /**
123         * @return an array of colors that shall be treated as transparent
124         */     
125        public Color[] getTransparentColors() {
126            return transparentColors;
127        }
128        
129        /**
130         * returns an instance of the <tt>OGCWebService</tt> that represents the
131         * datasource. Notice: if more than one layer uses data that are offered by
132         * the same OWS the deegree WMS shall just use one instance for accessing
133         * the OWS
134         *  
135         */
136        @Override
137        public OGCWebService getOGCWebService() {       
138            try {
139                return new RemoteWMService( (WMSCapabilities)ows.getCapabilities() ); 
140            } catch (Exception ignore) {
141                // this is ignored, why?
142            }   
143            return null;
144        }
145        
146        /**
147         * @return a list of parameter names to be passed from incoming requests
148         */
149        public List<String> getPassedParameters() {
150            return passedParameters;
151        }
152        
153        /**
154         * @return a list of parameters to be added to outgoing requests
155         */
156        public Map<String, String> getAddedParameters() {
157            return addedParameters;
158        }
159    
160    }