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.feature.FeatureUtil;
import schmitzm.geotools.feature.FeatureUtil.GeometryForm;
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());
        }

        /**
         * Defaults to the GeometryForm determined with FeatureUtil.getGeometryForm,
         * but can be set to override ANY.
         */
        private GeometryForm geometryForm;

        /**
         * Defaults to the GeometryForm determined with FeatureUtil.getGeometryForm,
         * but can be set to override ANY.
         */

        @Override
        public GeometryForm getGeometryForm() {
                if (geometryForm == null) {
                        geometryForm = FeatureUtil.getGeometryForm(getSchema());
                }
                return geometryForm;
        }

        /**
         * Defaults to the GeometryForm determined with FeatureUtil.getGeometryForm,
         * but can be set to override ANY.
         */
        public void setGeometryForm(GeometryForm geometryForm) {
                this.geometryForm = geometryForm;
        }

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