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