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.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.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> 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}
         * 
         * @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() {
        }

        /**
         * 
         */
        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 Tzeggai</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 {
                        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));
        }

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