001 //$HeadURL: http://svn.wald.intevation.org/svn/deegree/base/trunk/src/org/deegree/portal/context/LayerList.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.portal.context;
037
038 import java.util.ArrayList;
039 import java.util.LinkedList;
040 import java.util.List;
041
042 /**
043 *
044 *
045 *
046 * @version $Revision: 29966 $
047 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
048 * @author last edited by: $Author: apoth $
049 *
050 * @version 1.0. $Revision: 29966 $, $Date: 2011-03-09 15:19:04 +0100 (Wed, 09 Mar 2011) $
051 *
052 * @since 2.0
053 */
054 public class LayerList {
055
056 private List<Layer> list = new ArrayList<Layer>( 50 );
057
058 private List<Layer> treeList = new ArrayList<Layer>( 50 );
059
060 /**
061 * Creates a new LayerList object.
062 *
063 * @param layers
064 */
065 public LayerList( Layer[] layers ) {
066 setLayers( layers );
067 }
068
069
070 /**
071 * returns a layer identifies by its name and service address
072 *
073 * @param name
074 * name ofthe layer
075 * @param serverAddress
076 * address of the server which servers the layer
077 *
078 * @return named layer
079 */
080 public Layer getLayer( String name, String serverAddress ) {
081
082 if ( serverAddress != null ) {
083 for ( Layer layer : list ) {
084 String s = layer.getServer().getOnlineResource().toExternalForm();
085 if ( layer.getName().equals( name ) && s.equals( serverAddress ) ) {
086 return layer;
087 }
088 }
089 } else {
090 for ( Layer layer : list ) {
091 if ( layer.getName().equals( name ) ) {
092 return layer;
093 }
094 }
095 }
096 return null;
097 }
098
099 /**
100 * returns all layers of the web map context
101 *
102 * @return array of layers
103 */
104 public Layer[] getLayers() {
105 Layer[] cl = new Layer[list.size()];
106 return list.toArray( cl );
107 }
108
109 /**
110 * sets all layers of the web map context
111 *
112 * @param layers
113 */
114 public void setLayers( Layer[] layers ) {
115 this.list.clear();
116
117 if ( layers != null ) {
118 for ( int i = 0; i < layers.length; i++ ) {
119 list.add( layers[i] );
120 }
121 }
122 }
123
124 /**
125 * @param id
126 *
127 * @return the layers of a node of the tree of the web map context
128 */
129 public Layer[] getLayersByNodeId( int id ) {
130 List<Layer> nodeLayerList = new ArrayList<Layer>( list.size() );
131 int parentNodeId;
132 for ( int k = 0; k < list.size(); k++ ) {
133 parentNodeId = ( list.get( k ) ).getExtension().getParentNodeId();
134 if ( parentNodeId == id ) {
135 nodeLayerList.add( list.get( k ) );
136 }
137 }
138 Layer[] nodeLayers = new Layer[nodeLayerList.size()];
139 return nodeLayerList.toArray( nodeLayers );
140 }
141
142 /**
143 * TODO: review this changed; it has been introduced as of TreeLayerView Portlet
144 *
145 * @param root
146 */
147 public void orderLayerListByLayerTree( Node root ) {
148 treeList.clear();
149 Node[] rootNode = new Node[1];
150 rootNode[0] = root;
151 treeList = getLayerListByNode( rootNode );
152 setLayers( treeList.toArray( new Layer[treeList.size()] ) );
153 }
154
155 /**
156 *
157 * @param nodes
158 * @return list of layers
159 */
160 private List<Layer> getLayerListByNode( Node[] nodes ) {
161 for ( int i = 0; i < nodes.length; i++ ) {
162 getLayerListByNode( nodes[i].getNodes() );
163 Layer[] nl = getLayersByNodeId( nodes[i].getId() );
164 for ( int j = 0; j < nl.length; j++ ) {
165 treeList.add( nl[j] );
166 }
167
168 }
169 return treeList;
170 }
171
172 /**
173 * adds one layer to the the web map context. If a layer with the same name as the passed layer already exits it
174 * will be overwritten
175 *
176 * @param layer
177 */
178 public void addLayer( Layer layer ) {
179 list.add( layer );
180 }
181
182 /**
183 * adds one layer to the top of the web map context. If a layer with the same name as the passed layer already exits
184 * it will be overwritten
185 *
186 * @param layer
187 */
188 public void addLayerToTop( Layer layer ) {
189 list.add( 0, layer );
190 }
191
192
193
194 /**
195 * removes a layer identified by its name from the web map context
196 *
197 * @param name
198 * name of the layer to be removed
199 * @param serverAddress
200 *
201 * @return removed layer
202 */
203 public Layer removeLayer( String name, String serverAddress ) {
204 Layer layer = getLayer( name, serverAddress );
205 list.remove( layer );
206 return layer;
207 }
208
209 /**
210 * moves a layer within the layer list up or down
211 *
212 * @param layer
213 * layer to be moved
214 * @param up
215 * if true the layer will be moved up otherwise it will be moved down
216 */
217 public void move( Layer layer, boolean up ) {
218 int i = 0;
219 Layer target = null;
220 while ( i < list.size() && target == null ) {
221 Layer tmp = list.get( i );
222 if ( tmp.getName().equals( layer.getName() )
223 && tmp.getServer().getOnlineResource().equals( layer.getServer().getOnlineResource() ) ) {
224 target = tmp;
225 }
226 i++;
227 }
228 i--;
229 if ( i > 0 && up ) {
230 Layer o = list.get( i );
231 list.set( i, list.get( i - 1 ) );
232 list.set( i - 1, o );
233 } else if ( i < list.size() - 1 && !up ) {
234 Layer o = list.get( i );
235 list.set( i, list.get( i + 1 ) );
236 list.set( i + 1, o );
237 }
238 }
239
240 /**
241 * moves a layer within the layer list before the beforeLayer
242 *
243 * @param layer
244 * layer to be moved
245 * @param beforeLayer
246 * put the layer before this beforeLayer. If beforeLayer is <code>null</code> move to bottom.
247 *
248 */
249 public void move( Layer layer, Layer beforeLayer ) {
250 if ( beforeLayer != null ) { // move layer before beforeLayer
251 int i = 0;
252 ArrayList<Layer> newList = new ArrayList<Layer>( list.size() );
253
254 while ( i < list.size() ) {
255 Layer tmp = list.get( i );
256 if ( tmp.getName().equals( beforeLayer.getName() )
257 && tmp.getServer().getOnlineResource().equals( beforeLayer.getServer().getOnlineResource() ) ) {
258 newList.add( layer );
259 newList.add( beforeLayer );
260 } else if ( tmp.getName().equals( layer.getName() )
261 && tmp.getServer().getOnlineResource().equals( layer.getServer().getOnlineResource() ) ) {
262 // do nothing
263 } else {
264 newList.add( tmp );
265 }
266 i++;
267 }
268 list = newList;
269 } else { // move to end...
270 // removeLayer( layer.getName(), layer.getServer().getOnlineResource().toString() );
271 // addLayer( layer );
272 // ...but not at the end of the list! some utils need the list ordered
273 // by the parent node IDs.
274 int parentNodeID = layer.getExtension().getParentNodeId();
275 removeLayer( layer.getName(), layer.getServer().getOnlineResource().toString() );
276 boolean inParentNode = false;
277 boolean inserted = false;
278 List<Layer> newList = new LinkedList<Layer>();
279 int i = 0;
280 while ( i < list.size() ) {
281 Layer tmp = list.get( i );
282 if ( tmp.getExtension().getParentNodeId() == parentNodeID ) {
283 inParentNode = true;
284 } else if ( inParentNode ) { // end of parentNode, point to insert layer
285 newList.add( layer );
286 inParentNode = false;
287 inserted = true;
288 }
289 newList.add( tmp );
290 i++;
291 }
292
293 if ( !inserted ) {
294 newList.add( layer );
295 }
296 list = newList;
297 }
298 }
299
300 /**
301 * move all layers with parent <code>nodeID</code> befor the layers with parent <code>beforeNodeID</code>.
302 *
303 * @param nodeID
304 * @param beforeNodeID
305 */
306 public void moveNodes( int nodeID, int beforeNodeID ) {
307 List<Layer> result = new LinkedList<Layer>();
308 List<Layer> tmpNodeLayers = new LinkedList<Layer>();
309 boolean nodeLayersInserted = false;
310
311 // collect all affected nodes
312 for ( Layer layer : list ) {
313 if ( layer.getExtension().getParentNodeId() == nodeID ) {
314 tmpNodeLayers.add( layer );
315 }
316 }
317
318 for ( Layer layer : list ) {
319 if ( layer.getExtension().getParentNodeId() == nodeID ) {
320 // don't insert
321 } else {
322 // insert before beforeNodeID
323 if ( !nodeLayersInserted && layer.getExtension().getParentNodeId() == beforeNodeID ) {
324 result.addAll( tmpNodeLayers );
325 nodeLayersInserted = true;
326 }
327 // add all other nodes
328 result.add( layer );
329 }
330 }
331 // if not inserted put at the end (eg. beforeNodeID not found)
332 if ( !nodeLayersInserted ) {
333 result.addAll( tmpNodeLayers );
334 }
335 list = result;
336 }
337
338 /**
339 * removes all layers from the web map context
340 */
341 public void clear() {
342 list.clear();
343 }
344
345 /**
346 * remove all layer with <code>nodeID</code> as parent node
347 *
348 * @param nodeID
349 */
350 public void removeLayers( int nodeID ) {
351 List<Layer> result = new LinkedList<Layer>();
352 for ( Layer layer : list ) {
353 if ( layer.getExtension().getParentNodeId() != nodeID ) {
354 result.add( layer );
355 }
356 }
357 list = result;
358 }
359
360 }