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.FileNotFoundException;
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.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 Kr&uuml;ger</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 ;-)
         */
        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> map;

        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}
         */
        public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
                        File sldFile) {

                this.fs = fs;

                id = StyledFS.class.getSimpleName()
                                + new Random(new Date().getTime()).nextInt(10000000);

                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, null);
        }

        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 (fs.getSchema().getCoordinateReferenceSystem() == 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() {
        }

        /**
         * 
         */
        public AttributeMetadataMap<AttributeMetadataImpl> getAttributeMetaDataMap() {
                if (map == null) {

                        map = new AttributeMetadataImplMap();

                        // // Leaving out the first one, it will be the_geom
                        // for (int i = 1; i < fs.getSchema().getAttributeCount(); i++) {
                        // AttributeDescriptor attDesc = fs.getSchema().getDescriptor(i);
                        //
                        // AttributeMetadataImpl attMetaData = new AttributeMetadataImpl(
                        // new NameImpl(attDesc
                        // .getName().getNamespaceURI(), attDesc
                        // .getName().getLocalPart()), map.getLanguages());
                        // map.put(attDesc.getName(), attMetaData);
                        // }

                        // Leaving out the first one, it will be the_geom
                        for (int i = 1; i < fs.getSchema().getAttributeCount(); i++) {
                                AttributeDescriptor attDesc = fs.getSchema().getDescriptor(i);

                                // TODO AttributeMetadataAS would be nicer, which would not work
                                // with Translations ;-)
                                AttributeMetadataImpl attMetaData = new AttributeMetadataImpl(
                                                new NameImpl(attDesc.getName().getNamespaceURI(),
                                                                attDesc.getName().getLocalPart()), map
                                                                .getLanguages());
                                if (String.class.isAssignableFrom(attDesc.getType()
                                                .getBinding())) {
                                        // For Strings we add the "" as NODATA values
                                        attMetaData.addNodataValue("");
                                }
                                map.put(attDesc.getName(), attMetaData);
                        }
                }
                return map;
        }

        /**
         * @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
         *         Kr&uuml;ger</a>
         */
        public File getSldFile() {
                return 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 {
                        return getFeatureSource().getFeatures(filter);
                } 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;
                }

        }

}
1	/*******************************************************************************
2	* Copyright (c) 2009 Martin O. J. Schmitz.
3	*
4	* This file is part of the SCHMITZM library - a collection of utility
5	* classes based on Java 1.6, focusing (not only) on Java Swing
6	* 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	* Stefan A. Tzeggai - additional utility classes
29	******************************************************************************/
30	package skrueger.geotools;
31
32	import java.io.File;
33	import java.io.FileNotFoundException;
34	import java.io.IOException;
35	import java.net.URL;
36	import java.util.Date;
37	import java.util.Random;
38
39	import javax.swing.ImageIcon;
40	import javax.swing.JPanel;
41
42	import org.apache.log4j.Logger;
43	import org.geotools.data.FeatureSource;
44	import org.geotools.feature.FeatureCollection;
45	import org.geotools.feature.NameImpl;
46	import org.geotools.styling.Style;
47	import org.opengis.feature.simple.SimpleFeature;
48	import org.opengis.feature.simple.SimpleFeatureType;
49	import org.opengis.feature.type.AttributeDescriptor;
50	import org.opengis.filter.Filter;
51	import org.opengis.referencing.crs.CoordinateReferenceSystem;
52
53	import schmitzm.geotools.io.GeoImportUtil;
54	import schmitzm.geotools.styling.StylingUtil;
55	import skrueger.AttributeMetadataImpl;
56	import skrueger.AttributeMetadataInterface;
57	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	* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
66	*
67	* TODO Rename to StyledShapefile
68	*/
69	public class StyledFS implements StyledFeatureSourceInterface {
70	private static final Logger LOGGER = Logger.getLogger(StyledFS.class);
71
72	private final FeatureSource<SimpleFeatureType, SimpleFeature> fs;
73
74	/ Caching the CRS of the layer /
75	CoordinateReferenceSystem crs = null;
76
77	/**
78	* A unique ID which identifies the Layer in the Atlas. It's more important
79	* than it should be ;-)
80	*/
81	private String id;
82
83	private Style style;
84
85	private Translation title;
86
87	private Translation desc;
88
89	private File sldFile;
90
91	/ A map of simple attribute names to their meta-data /
92	private AttributeMetadataMap<AttributeMetadataImpl> map;
93
94	private Filter filter = Filter.INCLUDE;
95
96	/**
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	*/
107	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
108	File sldFile) {
109
110	this.fs = fs;
111
112	id = StyledFS.class.getSimpleName()
113	+ new Random(new Date().getTime()).nextInt(10000000);
114
115	this.sldFile = sldFile;
116
117	// datei existiert, dann lesen
118	if (sldFile != null && sldFile.exists()) {
119	try {
120	style = StylingUtil.loadSLD(sldFile)[0];
121	} catch (Exception e) {
122	LOGGER.warn("Reading SLD failed: " + sldFile, e);
123	style = null;
124	}
125	}
126
127	title = new Translation();
128	desc = new Translation();
129
130	if (sldFile != null) {
131	title.fromOneLine(sldFile.getName());
132	desc.fromOneLine(sldFile.getAbsolutePath());
133	}
134
135	}
136
137	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs) {
138	this(fs, null);
139	}
140
141	public void dispose() {
142	}
143
144	/**
145	* Returns human readable {@link String} of the CRS natively used by this
146	* {@link DpLayer}
147	*
148	* If CRS == null, it will call {@link #getGeoObject()}
149	*
150	*/
151	public String getCRSString() {
152	if (getCrs() == null)
153	return "CRS?";
154
155	return getCrs().getName().getCode();
156	}
157
158	public CoordinateReferenceSystem getCrs() {
159	if (crs == null) {
160	crs = fs.getSchema().getCoordinateReferenceSystem();
161	if (fs.getSchema().getCoordinateReferenceSystem() == null) {
162	LOGGER.warn("Could not determine the CRS of " + getTitle()
163	+ ". Using default " + GeoImportUtil.getDefaultCRS());
164	crs = GeoImportUtil.getDefaultCRS();
165	}
166	}
167	return crs;
168	}
169
170	public Translation getDesc() {
171	return desc;
172	}
173
174	public Envelope getEnvelope() {
175	try {
176	return fs.getBounds();
177	} catch (IOException e) {
178	e.printStackTrace();
179	return null;
180	}
181	}
182
183	public FeatureSource<SimpleFeatureType, SimpleFeature> getGeoObject() {
184	return fs;
185	}
186
187	public String getId() {
188	return id;
189	}
190
191	public ImageIcon getImageIcon() {
192	return null;
193	}
194
195	public URL getInfoURL() {
196	return null;
197	}
198
199	public Translation getKeywords() {
200	return null;
201	}
202
203	public Style getStyle() {
204	return style;
205	}
206
207	public Translation getTitle() {
208	return title;
209	}
210
211	public boolean isDisposed() {
212	return false;
213	}
214
215	/**
216	* If true, this layer will not be shown in the legend. Default = false
217	*/
218	/**
219	*
220	* Killed by SK: 6. April 09: Ein Layer soll nicht generell auf
221	* verstecken/nicht verstecken gestellt werden können. Das sind
222	* Eigenschaften der Karte/MapContext, ebenso wie die Reihenfolge der Layer.
223	* Im Atlas verwaltet deshalb nun die Klasse skrueger.atlas.Map welche Layer
224	* nicht in der Legende auftauchen sollen. Meines Wissens hat keiner bisher
225	* die Funktion genutzt.
226	*
227	* // public boolean isHideInLegend() { // return false; // }
228	*/
229
230	public void setDesc(Translation dec) {
231	this.desc = dec;
232	}
233
234	public void setImageIcon(ImageIcon icon) {
235	}
236
237	public void setKeywords(Translation keywords) {
238	}
239
240	public void setStyle(Style style) {
241	this.style = style;
242
243	}
244
245	public void setTitle(Translation title) {
246	this.title = title;
247
248	}
249
250	public void uncache() {
251	}
252
253	/**
254	*
255	*/
256	public AttributeMetadataMap<AttributeMetadataImpl> getAttributeMetaDataMap() {
257	if (map == null) {
258
259	map = new AttributeMetadataImplMap();
260
261	// // Leaving out the first one, it will be the_geom
262	// for (int i = 1; i < fs.getSchema().getAttributeCount(); i++) {
263	// AttributeDescriptor attDesc = fs.getSchema().getDescriptor(i);
264	//
265	// AttributeMetadataImpl attMetaData = new AttributeMetadataImpl(
266	// new NameImpl(attDesc
267	// .getName().getNamespaceURI(), attDesc
268	// .getName().getLocalPart()), map.getLanguages());
269	// map.put(attDesc.getName(), attMetaData);
270	// }
271
272	// Leaving out the first one, it will be the_geom
273	for (int i = 1; i < fs.getSchema().getAttributeCount(); i++) {
274	AttributeDescriptor attDesc = fs.getSchema().getDescriptor(i);
275
276	// TODO AttributeMetadataAS would be nicer, which would not work
277	// with Translations ;-)
278	AttributeMetadataImpl attMetaData = new AttributeMetadataImpl(
279	new NameImpl(attDesc.getName().getNamespaceURI(),
280	attDesc.getName().getLocalPart()), map
281	.getLanguages());
282	if (String.class.isAssignableFrom(attDesc.getType()
283	.getBinding())) {
284	// For Strings we add the "" as NODATA values
285	attMetaData.addNodataValue("");
286	}
287	map.put(attDesc.getName(), attMetaData);
288	}
289	}
290	return map;
291	}
292
293	/**
294	* @return The {@link File} where the SLD was loaded from or
295	* <code>null</code> if there didn't exist a {@link File}.
296	*
297	* @author <a href="mailto:[email protected]">Stefan Alfons
298	* Krüger</a>
299	*/
300	public File getSldFile() {
301	return sldFile;
302	}
303
304	public void setSldFile(File sldFile) {
305	this.sldFile = sldFile;
306	}
307
308	/**
309	* Returns the features of the {@link FeatureSource}.
310	*
311	* @see {@link StyledFeaturesInterface}
312	*/
313	@Override
314	public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollection() {
315	FeatureCollection<SimpleFeatureType, SimpleFeature> features;
316	try {
317	features = getGeoObject().getFeatures();
318	} catch (IOException e) {
319	throw new RuntimeException(
320	"Error getting the features of the FeatureSource");
321	}
322	return features;
323	}
324
325	/**
326	* Same as {@link #getGeoObject()} method, but complies to the
327	* {@link StyledFeaturesInterface}
328	*
329	* @see {@link StyledFeaturesInterface}
330	*/
331	@Override
332	public FeatureSource<SimpleFeatureType, SimpleFeature> getFeatureSource() {
333	return getGeoObject();
334	}
335
336	@Override
337	public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollectionFiltered() {
338	// final FeatureCollection<SimpleFeatureType, SimpleFeature> fc =
339	// getFeatureCollection();
340	// if (filter == Filter.EXCLUDE)
341	// return new EmptyFeatureCollection(fc.getSchema());
342	// if (filter == Filter.INCLUDE)
343	// return fc;
344	// return fc.subCollection(filter);
345
346	try {
347	return getFeatureSource().getFeatures(filter);
348	} catch (IOException e) {
349	throw new RuntimeException(e);
350	}
351	}
352
353	@Override
354	public Filter getFilter() {
355	return filter;
356	}
357
358	@Override
359	public void setFilter(Filter filter) {
360	this.filter = filter;
361	}
362
363	@Override
364	public SimpleFeatureType getSchema() {
365	return getGeoObject().getSchema();
366	}
367
368	/**
369	* Tries to load a style from the file denoted in {@link #getSldFile()}. If
370	* the file doesn't exits, return <code>null</code>;
371	* @return <code>true</code> is style was loaded
372	*/
373	public boolean loadStyle() {
374	if (getSldFile() == null)
375	return false;
376
377	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	}