skrueger/geotools/StyledFS.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Tzeggai - additional utility classes
 ******************************************************************************/
package skrueger.geotools;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.Date;
import java.util.Random;

import javax.swing.ImageIcon;
import javax.swing.JPanel;

import org.apache.log4j.Logger;
import org.geotools.data.FeatureSource;
import org.geotools.feature.FeatureCollection;
import org.geotools.feature.NameImpl;
import org.geotools.geometry.jts.ReferencedEnvelope;
import org.geotools.styling.Style;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.feature.simple.SimpleFeatureType;
import org.opengis.feature.type.AttributeDescriptor;
import org.opengis.filter.Filter;
import org.opengis.referencing.crs.CoordinateReferenceSystem;

import schmitzm.geotools.io.GeoImportUtil;
import schmitzm.geotools.styling.StylingUtil;
import skrueger.AttributeMetadataImpl;
import skrueger.AttributeMetadataInterface;
import skrueger.i8n.Translation;

import com.vividsolutions.jts.geom.Envelope;

/**
 * This class enables a non Atlas context to use the Atlas LayerPanel
 * {@link JPanel} as a {@link MapContextManagerInterface}
 * 
 * @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
 * 
 *         TODO Rename to StyledShapefile
 */
public class StyledFS implements StyledFeatureSourceInterface {
        private static final Logger LOGGER = Logger.getLogger(StyledFS.class);

        private final FeatureSource<SimpleFeatureType, SimpleFeature> fs;

        /** Caching the CRS of the layer **/
        CoordinateReferenceSystem crs = null;

        /**
         * A unique ID which identifies the Layer in the Atlas. It's more important
         * than it should be ;-)
         */
        final private String id;

        private Style style;

        private Translation title;

        private Translation desc;

        private File sldFile;

        /** A map of simple attribute names to their meta-data **/
        private AttributeMetadataMap<AttributeMetadataImpl> attMap;

        private Filter filter = Filter.INCLUDE;

        /**
         * This class enables a non Atlas context to use the Atlas LayerPanel
         * {@link JPanel} as a {@link MapContextManagerInterface}
         * 
         * @param fs
         *            {@link FeatureSource} that is beeing styled.
         * 
         * @param sldFile
         *            may be <code>null</code>. Otherwise the SLD {@link File} to
         *            import and associate with this {@link StyledFS}
         * 
         * @param id
         *            <code>null</code> is allowed and will autogenerate an id
         */
        public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
                        File sldFile, String id) {

                this.fs = fs;

                if (id == null) {
                        this.id = StyledFS.class.getSimpleName()
                                        + new Random(new Date().getTime()).nextInt(10000000);
                } else {
                        this.id = id;
                }

                this.sldFile = sldFile;

                // datei existiert, dann lesen
                if (sldFile != null && sldFile.exists()) {
                        try {
                                style = StylingUtil.loadSLD(sldFile)[0];
                        } catch (Exception e) {
                                LOGGER.warn("Reading SLD failed: " + sldFile, e);
                                style = null;
                        }
                }

                title = new Translation();
                desc = new Translation();

                if (sldFile != null) {
                        title.fromOneLine(sldFile.getName());
                        desc.fromOneLine(sldFile.getAbsolutePath());
                }

        }

        public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs) {
                this(fs, (File) null, null);
        }

        public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
                        String id) {
                this(fs, null, id);
        }

        public void dispose() {
        }

        /**
         * Returns human readable {@link String} of the CRS natively used by this
         * {@link DpLayer}
         * 
         * If CRS == null, it will call {@link #getGeoObject()}
         * 
         */
        public String getCRSString() {
                if (getCrs() == null)
                        return "CRS?";

                return getCrs().getName().getCode();
        }

        public CoordinateReferenceSystem getCrs() {
                if (crs == null) {
                        crs = fs.getSchema().getCoordinateReferenceSystem();
                        if (crs == null) {

                                crs = fs.getSchema().getGeometryDescriptor()
                                                .getCoordinateReferenceSystem();

                                if (crs == null) {
                                        LOGGER.warn("Could not determine the CRS of " + getTitle()
                                                        + ". Using default "
                                                        + GeoImportUtil.getDefaultCRS());
                                        crs = GeoImportUtil.getDefaultCRS();
                                }
                        }
                }
                return crs;
        }

        public Translation getDesc() {
                return desc;
        }

        public Envelope getEnvelope() {
                try {
                        return fs.getBounds();
                } catch (IOException e) {
                        e.printStackTrace();
                        return null;
                }
        }

        public FeatureSource<SimpleFeatureType, SimpleFeature> getGeoObject() {
                return fs;
        }

        public String getId() {
                return id;
        }

        public ImageIcon getImageIcon() {
                return null;
        }

        public URL getInfoURL() {
                return null;
        }

        public Translation getKeywords() {
                return null;
        }

        public Style getStyle() {
                return style;
        }

        public Translation getTitle() {
                return title;
        }

        public boolean isDisposed() {
                return false;
        }

        /**
         * If true, this layer will not be shown in the legend. Default = false
         */
        /**
         * 
         * Killed by SK: 6. April 09: Ein Layer soll nicht generell auf
         * verstecken/nicht verstecken gestellt werden können. Das sind
         * Eigenschaften der Karte/MapContext, ebenso wie die Reihenfolge der Layer.
         * Im Atlas verwaltet deshalb nun die Klasse skrueger.atlas.Map welche Layer
         * nicht in der Legende auftauchen sollen. Meines Wissens hat keiner bisher
         * die Funktion genutzt.
         * 
         * // public boolean isHideInLegend() { // return false; // }
         */

        public void setDesc(Translation dec) {
                this.desc = dec;
        }

        public void setImageIcon(ImageIcon icon) {
        }

        public void setKeywords(Translation keywords) {
        }

        public void setStyle(Style style) {
                this.style = style;

        }

        public void setTitle(Translation title) {
                this.title = title;

        }

        public void uncache() {
        }

        /**
         * 
         */
        @Override
        public AttributeMetadataMap<AttributeMetadataImpl> getAttributeMetaDataMap() {
                if (attMap == null) {
                        attMap = StyledLayerUtil
                                        .createDefaultAttributeMetadataMap(getSchema());
                }
                return attMap;
        }

        /**
         * @return The {@link File} where the SLD was loaded from or
         *         <code>null</code> if there didn't exist a {@link File}.
         * 
         * @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
         */
        public File getSldFile() {
                return sldFile;
        }

        /**
         * Associates this .sld with the {@link FeatureSource}, but does not
         * automatically load the file. It must not even exist.
         * 
         * @param sldFile
         */
        public void setSldFile(File sldFile) {
                this.sldFile = sldFile;
        }

        /**
         * Returns the features of the {@link FeatureSource}.
         * 
         * @see {@link StyledFeaturesInterface}
         */
        @Override
        public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollection() {
                FeatureCollection<SimpleFeatureType, SimpleFeature> features;
                try {
                        features = getGeoObject().getFeatures();
                } catch (IOException e) {
                        throw new RuntimeException(
                                        "Error getting the features of the  FeatureSource");
                }
                return features;
        }

        /**
         * Same as {@link #getGeoObject()} method, but complies to the
         * {@link StyledFeaturesInterface}
         * 
         * @see {@link StyledFeaturesInterface}
         */
        @Override
        public FeatureSource<SimpleFeatureType, SimpleFeature> getFeatureSource() {
                return getGeoObject();
        }

        @Override
        public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollectionFiltered() {
                // final FeatureCollection<SimpleFeatureType, SimpleFeature> fc =
                // getFeatureCollection();
                // if (filter == Filter.EXCLUDE)
                // return new EmptyFeatureCollection(fc.getSchema());
                // if (filter == Filter.INCLUDE)
                // return fc;
                // return fc.subCollection(filter);

                try {
                        if (filter != Filter.INCLUDE)
                                return getFeatureSource().getFeatures(filter);
                        else
                                return getFeatureSource().getFeatures();
                } catch (IOException e) {
                        throw new RuntimeException(e);
                }
        }

        @Override
        public Filter getFilter() {
                return filter;
        }

        @Override
        public void setFilter(Filter filter) {
                this.filter = filter;
        }

        @Override
        public SimpleFeatureType getSchema() {
                return getGeoObject().getSchema();
        }

        /**
         * Tries to load a style from the file denoted in {@link #getSldFile()}. If
         * the file doesn't exits, return <code>null</code>;
         * 
         * @return <code>true</code> is style was loaded
         */
        public boolean loadStyle() {
                if (getSldFile() == null)
                        return false;

                try {
                        Style[] loadSLD = StylingUtil.loadSLD(getSldFile());
                        setStyle(loadSLD[0]);
                        return true;
                } catch (Exception e) {
                        return false;
                }

        }

        public void setTitle(String title) {
                setTitle(new Translation(title));
        }

        public void setDesc(String desc) {
                setDesc(new Translation(desc));
        }

        public void setCRS(CoordinateReferenceSystem crs2) {
                crs = crs2;
        }

        @Override
        public ReferencedEnvelope getReferencedEnvelope() {
                return new ReferencedEnvelope(getEnvelope(), getCrs());
        }

}
1	alfonx	244	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5	alfonx	256	* classes based on Java 1.6, focusing (not only) on Java Swing
6	alfonx	244	* and the Geotools library.
7			*
8			* The SCHMITZM project is hosted at:
9			* http://wald.intevation.org/projects/schmitzm/
10			*
11			* This program is free software; you can redistribute it and/or
12			* modify it under the terms of the GNU Lesser General Public License
13			* as published by the Free Software Foundation; either version 3
14			* of the License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU Lesser General Public License (license.txt)
22			* along with this program; if not, write to the Free Software
23			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24			* or try this link: http://www.gnu.org/licenses/lgpl.html
25			*
26			* Contributors:
27			* Martin O. J. Schmitz - initial API and implementation
28	alfonx	862	* Stefan A. Tzeggai - additional utility classes
29	alfonx	244	******************************************************************************/
30			package skrueger.geotools;
31
32			import java.io.File;
33			import java.io.IOException;
34			import java.net.URL;
35			import java.util.Date;
36			import java.util.Random;
37
38			import javax.swing.ImageIcon;
39			import javax.swing.JPanel;
40
41			import org.apache.log4j.Logger;
42			import org.geotools.data.FeatureSource;
43			import org.geotools.feature.FeatureCollection;
44	alfonx	770	import org.geotools.feature.NameImpl;
45	alfonx	1203	import org.geotools.geometry.jts.ReferencedEnvelope;
46	alfonx	244	import org.geotools.styling.Style;
47	alfonx	336	import org.opengis.feature.simple.SimpleFeature;
48			import org.opengis.feature.simple.SimpleFeatureType;
49	alfonx	332	import org.opengis.feature.type.AttributeDescriptor;
50	alfonx	426	import org.opengis.filter.Filter;
51	alfonx	244	import org.opengis.referencing.crs.CoordinateReferenceSystem;
52
53	alfonx	454	import schmitzm.geotools.io.GeoImportUtil;
54	alfonx	244	import schmitzm.geotools.styling.StylingUtil;
55	alfonx	769	import skrueger.AttributeMetadataImpl;
56	alfonx	1228	import skrueger.AttributeMetadataInterface;
57	alfonx	244	import skrueger.i8n.Translation;
58
59			import com.vividsolutions.jts.geom.Envelope;
60
61			/**
62			* This class enables a non Atlas context to use the Atlas LayerPanel
63			* {@link JPanel} as a {@link MapContextManagerInterface}
64			*
65	alfonx	888	* @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
66	alfonx	620	*
67	alfonx	863	* TODO Rename to StyledShapefile
68	alfonx	244	*/
69			public class StyledFS implements StyledFeatureSourceInterface {
70			private static final Logger LOGGER = Logger.getLogger(StyledFS.class);
71
72	alfonx	336	private final FeatureSource<SimpleFeatureType, SimpleFeature> fs;
73	alfonx	863
74	alfonx	620	/ Caching the CRS of the layer /
75			CoordinateReferenceSystem crs = null;
76	alfonx	244
77			/**
78			* A unique ID which identifies the Layer in the Atlas. It's more important
79			* than it should be ;-)
80			*/
81	alfonx	1159	final private String id;
82	alfonx	244
83			private Style style;
84
85			private Translation title;
86
87			private Translation desc;
88
89			private File sldFile;
90
91	alfonx	863	/ A map of simple attribute names to their meta-data /
92	alfonx	1228	private AttributeMetadataMap<AttributeMetadataImpl> attMap;
93	alfonx	244
94	alfonx	426	private Filter filter = Filter.INCLUDE;
95
96	alfonx	244	/**
97			* This class enables a non Atlas context to use the Atlas LayerPanel
98			* {@link JPanel} as a {@link MapContextManagerInterface}
99			*
100			* @param fs
101			* {@link FeatureSource} that is beeing styled.
102			*
103			* @param sldFile
104			* may be <code>null</code>. Otherwise the SLD {@link File} to
105			* import and associate with this {@link StyledFS}
106	alfonx	1159	*
107			* @param id
108			* <code>null</code> is allowed and will autogenerate an id
109	alfonx	244	*/
110	alfonx	426	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
111	alfonx	1159	File sldFile, String id) {
112	alfonx	244
113			this.fs = fs;
114	alfonx	620
115	alfonx	1159	if (id == null) {
116			this.id = StyledFS.class.getSimpleName()
117			+ new Random(new Date().getTime()).nextInt(10000000);
118			} else {
119			this.id = id;
120			}
121	alfonx	244
122			this.sldFile = sldFile;
123
124	alfonx	620	// datei existiert, dann lesen
125	alfonx	336	if (sldFile != null && sldFile.exists()) {
126	alfonx	244	try {
127			style = StylingUtil.loadSLD(sldFile)[0];
128			} catch (Exception e) {
129			LOGGER.warn("Reading SLD failed: " + sldFile, e);
130	alfonx	620	style = null;
131	alfonx	244	}
132			}
133	alfonx	620
134	alfonx	244	title = new Translation();
135	alfonx	426	desc = new Translation();
136	alfonx	244
137	alfonx	426	if (sldFile != null) {
138			title.fromOneLine(sldFile.getName());
139			desc.fromOneLine(sldFile.getAbsolutePath());
140			}
141
142	alfonx	244	}
143
144	alfonx	426	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs) {
145	alfonx	1159	this(fs, (File) null, null);
146	alfonx	426	}
147
148	alfonx	1159	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
149			String id) {
150			this(fs, null, id);
151			}
152
153	alfonx	244	public void dispose() {
154			}
155
156			/**
157	alfonx	336	* Returns human readable {@link String} of the CRS natively used by this
158	alfonx	244	* {@link DpLayer}
159			*
160	alfonx	336	* If CRS == null, it will call {@link #getGeoObject()}
161	alfonx	244	*
162			*/
163			public String getCRSString() {
164			if (getCrs() == null)
165			return "CRS?";
166
167			return getCrs().getName().getCode();
168			}
169
170			public CoordinateReferenceSystem getCrs() {
171	alfonx	620	if (crs == null) {
172	alfonx	863	crs = fs.getSchema().getCoordinateReferenceSystem();
173	alfonx	894	if (crs == null) {
174
175			crs = fs.getSchema().getGeometryDescriptor()
176			.getCoordinateReferenceSystem();
177	alfonx	1159
178	alfonx	894	if (crs == null) {
179			LOGGER.warn("Could not determine the CRS of " + getTitle()
180			+ ". Using default "
181			+ GeoImportUtil.getDefaultCRS());
182			crs = GeoImportUtil.getDefaultCRS();
183			}
184	alfonx	620	}
185	alfonx	454	}
186			return crs;
187	alfonx	244	}
188
189			public Translation getDesc() {
190			return desc;
191			}
192
193			public Envelope getEnvelope() {
194			try {
195			return fs.getBounds();
196			} catch (IOException e) {
197			e.printStackTrace();
198			return null;
199			}
200			}
201
202	alfonx	336	public FeatureSource<SimpleFeatureType, SimpleFeature> getGeoObject() {
203	alfonx	244	return fs;
204			}
205
206			public String getId() {
207			return id;
208			}
209
210			public ImageIcon getImageIcon() {
211			return null;
212			}
213
214			public URL getInfoURL() {
215			return null;
216			}
217
218			public Translation getKeywords() {
219			return null;
220			}
221
222			public Style getStyle() {
223			return style;
224			}
225
226			public Translation getTitle() {
227			return title;
228			}
229
230			public boolean isDisposed() {
231			return false;
232			}
233
234			/**
235			* If true, this layer will not be shown in the legend. Default = false
236			*/
237			/**
238			*
239			* Killed by SK: 6. April 09: Ein Layer soll nicht generell auf
240			* verstecken/nicht verstecken gestellt werden können. Das sind
241			* Eigenschaften der Karte/MapContext, ebenso wie die Reihenfolge der Layer.
242			* Im Atlas verwaltet deshalb nun die Klasse skrueger.atlas.Map welche Layer
243			* nicht in der Legende auftauchen sollen. Meines Wissens hat keiner bisher
244			* die Funktion genutzt.
245			*
246			* // public boolean isHideInLegend() { // return false; // }
247			*/
248
249			public void setDesc(Translation dec) {
250			this.desc = dec;
251			}
252
253			public void setImageIcon(ImageIcon icon) {
254			}
255
256			public void setKeywords(Translation keywords) {
257			}
258
259			public void setStyle(Style style) {
260			this.style = style;
261
262			}
263
264			public void setTitle(Translation title) {
265			this.title = title;
266
267			}
268
269			public void uncache() {
270			}
271
272			/**
273			*
274			*/
275	alfonx	1228	@Override
276	alfonx	863	public AttributeMetadataMap<AttributeMetadataImpl> getAttributeMetaDataMap() {
277	alfonx	1228	if (attMap == null) {
278			attMap = StyledLayerUtil
279			.createDefaultAttributeMetadataMap(getSchema());
280	alfonx	244	}
281	alfonx	1228	return attMap;
282	alfonx	244	}
283
284			/**
285			* @return The {@link File} where the SLD was loaded from or
286	alfonx	426	* <code>null</code> if there didn't exist a {@link File}.
287	alfonx	244	*
288	alfonx	894	* @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
289	alfonx	244	*/
290			public File getSldFile() {
291			return sldFile;
292			}
293	alfonx	863
294	alfonx	1191	/**
295			* Associates this .sld with the {@link FeatureSource}, but does not
296			* automatically load the file. It must not even exist.
297			*
298			* @param sldFile
299			*/
300	alfonx	244	public void setSldFile(File sldFile) {
301			this.sldFile = sldFile;
302			}
303
304			/**
305			* Returns the features of the {@link FeatureSource}.
306			*
307			* @see {@link StyledFeaturesInterface}
308			*/
309			@Override
310	alfonx	447	public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollection() {
311			FeatureCollection<SimpleFeatureType, SimpleFeature> features;
312	alfonx	244	try {
313			features = getGeoObject().getFeatures();
314			} catch (IOException e) {
315			throw new RuntimeException(
316			"Error getting the features of the FeatureSource");
317			}
318			return features;
319			}
320
321			/**
322			* Same as {@link #getGeoObject()} method, but complies to the
323			* {@link StyledFeaturesInterface}
324			*
325			* @see {@link StyledFeaturesInterface}
326			*/
327			@Override
328	alfonx	426	public FeatureSource<SimpleFeatureType, SimpleFeature> getFeatureSource() {
329	alfonx	244	return getGeoObject();
330			}
331
332	alfonx	426	@Override
333			public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollectionFiltered() {
334	alfonx	620	// final FeatureCollection<SimpleFeatureType, SimpleFeature> fc =
335			// getFeatureCollection();
336			// if (filter == Filter.EXCLUDE)
337			// return new EmptyFeatureCollection(fc.getSchema());
338			// if (filter == Filter.INCLUDE)
339			// return fc;
340			// return fc.subCollection(filter);
341
342	alfonx	607	try {
343	alfonx	1159	if (filter != Filter.INCLUDE)
344			return getFeatureSource().getFeatures(filter);
345			else
346			return getFeatureSource().getFeatures();
347	alfonx	607	} catch (IOException e) {
348			throw new RuntimeException(e);
349			}
350	alfonx	426	}
351
352			@Override
353			public Filter getFilter() {
354			return filter;
355			}
356
357			@Override
358			public void setFilter(Filter filter) {
359			this.filter = filter;
360			}
361
362			@Override
363			public SimpleFeatureType getSchema() {
364			return getGeoObject().getSchema();
365			}
366
367	alfonx	863	/**
368			* Tries to load a style from the file denoted in {@link #getSldFile()}. If
369			* the file doesn't exits, return <code>null</code>;
370	alfonx	894	*
371	alfonx	863	* @return <code>true</code> is style was loaded
372			*/
373			public boolean loadStyle() {
374			if (getSldFile() == null)
375			return false;
376	alfonx	894
377	alfonx	863	try {
378			Style[] loadSLD = StylingUtil.loadSLD(getSldFile());
379			setStyle(loadSLD[0]);
380			return true;
381			} catch (Exception e) {
382			return false;
383			}
384
385			}
386
387	alfonx	1159	public void setTitle(String title) {
388			setTitle(new Translation(title));
389			}
390
391			public void setDesc(String desc) {
392			setDesc(new Translation(desc));
393			}
394
395	alfonx	1160	public void setCRS(CoordinateReferenceSystem crs2) {
396	alfonx	1191	crs = crs2;
397	alfonx	1160	}
398
399	alfonx	1203	@Override
400			public ReferencedEnvelope getReferencedEnvelope() {
401			return new ReferencedEnvelope(getEnvelope(), getCrs());
402			}
403
404	alfonx	244	}