001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/portal/PortalUtils.java $
002    /*----------------    FILE HEADER  ------------------------------------------
003    
004     This file is part of deegree.
005     Copyright (C) 2001-2007 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     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;
045    
046    import java.net.URL;
047    import java.util.ArrayList;
048    import java.util.Iterator;
049    import java.util.List;
050    
051    import org.deegree.model.spatialschema.Point;
052    import org.deegree.ogcwebservices.OWSUtils;
053    import org.deegree.ogcwebservices.wms.operation.GetMap;
054    import org.deegree.portal.context.Format;
055    import org.deegree.portal.context.GeneralExtension;
056    import org.deegree.portal.context.Layer;
057    import org.deegree.portal.context.LayerExtension;
058    import org.deegree.portal.context.LayerList;
059    import org.deegree.portal.context.ViewContext;
060    
061    /**
062     * 
063     * 
064     * 
065     * @version $Revision: 7983 $
066     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
067     * @author last edited by: $Author: apoth $
068     * 
069     * @version 1.0. $Revision: 7983 $, $Date: 2007-08-10 16:53:25 +0200 (Fr, 10 Aug 2007) $
070     * 
071     * @since 2.0
072     */
073    public class PortalUtils {
074    
075        /**
076         * returns a comma seperated list of layers marked as sensible for feature info requestes
077         * 
078         * @param vc
079         * @return a comma seperated list of layers marked as sensible for feature info requestes
080         */
081        public static List<String> getFeatureInfoLayers( ViewContext vc ) {
082            List<String> list = new ArrayList<String>();
083            LayerList layerList = vc.getLayerList();
084            Layer[] layers = layerList.getLayers();
085            for ( int i = 0; i < layers.length; i++ ) {
086                if ( layers[i].getExtension() != null && layers[i].getExtension().isSelectedForQuery() ) {
087                    list.add( layers[i].getName() );
088                }
089            }
090            return list;
091        }
092    
093        /**
094         * returns a comma seperated list of visible layers
095         * 
096         * @param vc
097         * @return a comma seperated list of visible layers
098         */
099        public static List getVisibleLayers( ViewContext vc ) {
100            List<String[]> list = new ArrayList<String[]>();
101            LayerList layerList = vc.getLayerList();
102            Layer[] layers = layerList.getLayers();
103            for ( int i = 0; i < layers.length; i++ ) {
104                if ( !layers[i].isHidden() ) {
105                    String[] s = new String[2];
106                    s[0] = layers[i].getName();
107                    s[1] = layers[i].getServer().getOnlineResource().toExternalForm();
108                    list.add( s );
109                }
110            }
111            return list;
112        }
113    
114        /**
115         * returns true if at least one layer of the passed server is visible
116         * 
117         * @param vc
118         * @param serverTitle
119         * @return <code>true</code> if at least one layer of the passed server is visible
120         */
121        public static boolean hasServerVisibleLayers( ViewContext vc, String serverTitle ) {
122            LayerList layerList = vc.getLayerList();
123            Layer[] layers = layerList.getLayers();
124            for ( int i = 0; i < layers.length; i++ ) {
125                if ( layers[i].getServer().getTitle().equals( serverTitle ) && !layers[i].isHidden() ) {
126                    return true;
127                }
128            }
129            return false;
130        }
131    
132        /**
133         * creates the GetMap basic requests required by the JSP page assigned to the MapViewPortlet.
134         * 
135         * @param vc
136         * @return
137         */
138        public static String[] createBaseRequests( ViewContext vc ) {
139    
140            Layer[] layers = vc.getLayerList().getLayers();
141            List<String> list = new ArrayList<String>( layers.length );
142            int i = layers.length - 1;
143            try {
144                while ( i >= 0 ) {
145                    GeneralExtension gExt = vc.getGeneral().getExtension();
146                    Point[] bbox = vc.getGeneral().getBoundingBox();
147                    StringBuffer sb = new StringBuffer( 1000 );
148                    URL url = OWSUtils.getHTTPGetOperationURL( layers[i].getServer().getCapabilities(), GetMap.class );
149                    if ( url != null ) {
150                        String href = url.toExternalForm();
151    
152                        sb.append( OWSUtils.validateHTTPGetBaseURL( href ) );
153                        sb.append( "SRS=" ).append( bbox[0].getCoordinateSystem().getName() );
154                        sb.append( "&REQUEST=GetMap&VERSION=" ).append( layers[i].getServer().getVersion() );
155                        sb.append( "&transparent=" ).append( true );
156                        if ( gExt == null ) {
157                            sb.append( "&BGCOLOR=0xFFFFFF" );
158                        } else {
159                            sb.append( "&BGCOLOR=" ).append( gExt.getBgColor() );
160                        }
161                        sb.append( "&exceptions=application/vnd.ogc.se_inimage" );
162                        Format format = layers[i].getFormatList().getCurrentFormat();
163                        sb.append( "&FORMAT=" ).append( format.getName() );
164                        StringBuffer styles = new StringBuffer( 1000 );
165                        styles.append( "&STYLES=" );
166                        StringBuffer lyrs = new StringBuffer( 1000 );
167                        lyrs.append( "&LAYERS=" );
168                        String title = layers[i].getServer().getTitle();
169                        while ( i >= 0 && title.equals( layers[i].getServer().getTitle() ) ) {
170                            if ( !layers[i].isHidden() ) {
171                                lyrs.append( layers[i].getName() ).append( ',' );
172                                String style = layers[i].getStyleList().getCurrentStyle().getName();
173                                if ( style.equalsIgnoreCase( "DEFAULT" ) ) {
174                                    style = "";
175                                }
176                                styles.append( style ).append( ',' );
177                            }                        
178                            LayerExtension le = layers[i].getExtension();
179                            Iterator<String> iterator = le.getVendorspecificParameterNames();
180                            while ( iterator.hasNext() ) {
181                                sb.append( '&' );
182                                String name = iterator.next();
183                                String value = le.getVendorspecificParameter( name );
184                                sb.append( name ).append( '=' ).append( value );                            
185                            }
186                            i--;
187                        }
188                        String s1 = lyrs.substring( 0, lyrs.length() - 1 );
189                        String s2 = styles.substring( 0, styles.length() - 1 );
190                        sb.append( s1 ).append( s2 );                    
191                        
192                        if ( s1.length() > 7 ) {
193                            // ensure that a request will just be created if
194                            // at least one layer of a group is visible
195                            list.add( sb.toString() );
196                        }
197                    } else {
198                        System.out.println( "no service available for layer: " + layers[i--].getName() );
199                    }
200    
201                }
202            } catch ( Exception shouldneverhappen ) {
203                shouldneverhappen.printStackTrace();
204            }
205    
206            return list.toArray( new String[list.size()] );
207        }
208    
209    }