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. Krüger - 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 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;

        private AttributeMetadataMap 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 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();
        }

}
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. Krüger - 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 Krüger</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	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	private AttributeMetadataMap map;
90
91	private Filter filter = Filter.INCLUDE;
92
93	/**
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	*/
104	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs,
105	File sldFile) {
106
107	this.fs = fs;
108
109	id = StyledFS.class.getSimpleName()
110	+ new Random(new Date().getTime()).nextInt(10000000);
111
112	this.sldFile = sldFile;
113
114	// datei existiert, dann lesen
115	if (sldFile != null && sldFile.exists()) {
116	try {
117	style = StylingUtil.loadSLD(sldFile)[0];
118	} catch (Exception e) {
119	LOGGER.warn("Reading SLD failed: " + sldFile, e);
120	style = null;
121	}
122	}
123
124	title = new Translation();
125	desc = new Translation();
126
127	if (sldFile != null) {
128	title.fromOneLine(sldFile.getName());
129	desc.fromOneLine(sldFile.getAbsolutePath());
130	}
131
132	}
133
134	public StyledFS(FeatureSource<SimpleFeatureType, SimpleFeature> fs) {
135	this(fs, null);
136	}
137
138	public void dispose() {
139	}
140
141	/**
142	* Returns human readable {@link String} of the CRS natively used by this
143	* {@link DpLayer}
144	*
145	* If CRS == null, it will call {@link #getGeoObject()}
146	*
147	*/
148	public String getCRSString() {
149	if (getCrs() == null)
150	return "CRS?";
151
152	return getCrs().getName().getCode();
153	}
154
155	public CoordinateReferenceSystem getCrs() {
156	if (crs == null) {
157	crs = fs.getSchema()
158	.getCoordinateReferenceSystem();
159	if (fs.getSchema().getCoordinateReferenceSystem() == null) {
160	LOGGER.warn("Could not determine the CRS of " + getTitle()
161	+ ". Using default " + GeoImportUtil.getDefaultCRS());
162	crs = GeoImportUtil.getDefaultCRS();
163	}
164	}
165	return crs;
166	}
167
168	public Translation getDesc() {
169	return desc;
170	}
171
172	public Envelope getEnvelope() {
173	try {
174	return fs.getBounds();
175	} catch (IOException e) {
176	e.printStackTrace();
177	return null;
178	}
179	}
180
181	public FeatureSource<SimpleFeatureType, SimpleFeature> getGeoObject() {
182	return fs;
183	}
184
185	public String getId() {
186	return id;
187	}
188
189	public ImageIcon getImageIcon() {
190	return null;
191	}
192
193	public URL getInfoURL() {
194	return null;
195	}
196
197	public Translation getKeywords() {
198	return null;
199	}
200
201	public Style getStyle() {
202	return style;
203	}
204
205	public Translation getTitle() {
206	return title;
207	}
208
209	public boolean isDisposed() {
210	return false;
211	}
212
213	/**
214	* If true, this layer will not be shown in the legend. Default = false
215	*/
216	/**
217	*
218	* Killed by SK: 6. April 09: Ein Layer soll nicht generell auf
219	* verstecken/nicht verstecken gestellt werden können. Das sind
220	* Eigenschaften der Karte/MapContext, ebenso wie die Reihenfolge der Layer.
221	* Im Atlas verwaltet deshalb nun die Klasse skrueger.atlas.Map welche Layer
222	* nicht in der Legende auftauchen sollen. Meines Wissens hat keiner bisher
223	* die Funktion genutzt.
224	*
225	* // public boolean isHideInLegend() { // return false; // }
226	*/
227
228	public void setDesc(Translation dec) {
229	this.desc = dec;
230	}
231
232	public void setImageIcon(ImageIcon icon) {
233	}
234
235	public void setKeywords(Translation keywords) {
236	}
237
238	public void setStyle(Style style) {
239	this.style = style;
240
241	}
242
243	public void setTitle(Translation title) {
244	this.title = title;
245
246	}
247
248	public void uncache() {
249	}
250
251	/**
252	*
253	*/
254	public AttributeMetadataMap getAttributeMetaDataMap() {
255	if (map == null) {
256
257	map = new AttributeMetadataImplMap();
258
259	// // Leaving out the first one, it will be the_geom
260	// for (int i = 1; i < fs.getSchema().getAttributeCount(); i++) {
261	// AttributeDescriptor attDesc = fs.getSchema().getDescriptor(i);
262	//
263	// AttributeMetadataImpl attMetaData = new AttributeMetadataImpl( new NameImpl(attDesc
264	// .getName().getNamespaceURI(), attDesc
265	// .getName().getLocalPart()), map.getLanguages());
266	// map.put(attDesc.getName(), attMetaData);
267	// }
268
269	// Leaving out the first one, it will be the_geom
270	for (int i = 1; i < fs.getSchema().getAttributeCount(); i++) {
271	AttributeDescriptor attDesc = fs.getSchema().getDescriptor(i);
272
273	// TODO AttributeMetadataAS would be nicer, which would not work with Translations ;-)
274	AttributeMetadataImpl attMetaData = new AttributeMetadataImpl( new NameImpl(attDesc
275	.getName().getNamespaceURI(), attDesc
276	.getName().getLocalPart()), map.getLanguages());
277	if (String.class.isAssignableFrom( attDesc.getType().getBinding() )){
278	// For Strings we add the "" as NODATA values
279	attMetaData.addNodataValue("");
280	}
281	map.put(attDesc.getName(), attMetaData);
282	}
283	}
284	return map;
285	}
286
287	/**
288	* @return The {@link File} where the SLD was loaded from or
289	* <code>null</code> if there didn't exist a {@link File}.
290	*
291	* @author <a href="mailto:[email protected]">Stefan Alfons
292	* Krüger</a>
293	*/
294	public File getSldFile() {
295	return sldFile;
296	}
297
298	public void setSldFile(File sldFile) {
299	this.sldFile = sldFile;
300	}
301
302	/**
303	* Returns the features of the {@link FeatureSource}.
304	*
305	* @see {@link StyledFeaturesInterface}
306	*/
307	@Override
308	public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollection() {
309	FeatureCollection<SimpleFeatureType, SimpleFeature> features;
310	try {
311	features = getGeoObject().getFeatures();
312	} catch (IOException e) {
313	throw new RuntimeException(
314	"Error getting the features of the FeatureSource");
315	}
316	return features;
317	}
318
319	/**
320	* Same as {@link #getGeoObject()} method, but complies to the
321	* {@link StyledFeaturesInterface}
322	*
323	* @see {@link StyledFeaturesInterface}
324	*/
325	@Override
326	public FeatureSource<SimpleFeatureType, SimpleFeature> getFeatureSource() {
327	return getGeoObject();
328	}
329
330	@Override
331	public FeatureCollection<SimpleFeatureType, SimpleFeature> getFeatureCollectionFiltered() {
332	// final FeatureCollection<SimpleFeatureType, SimpleFeature> fc =
333	// getFeatureCollection();
334	// if (filter == Filter.EXCLUDE)
335	// return new EmptyFeatureCollection(fc.getSchema());
336	// if (filter == Filter.INCLUDE)
337	// return fc;
338	// return fc.subCollection(filter);
339
340	try {
341	return getFeatureSource().getFeatures(filter);
342	} catch (IOException e) {
343	throw new RuntimeException(e);
344	}
345	}
346
347	@Override
348	public Filter getFilter() {
349	return filter;
350	}
351
352	@Override
353	public void setFilter(Filter filter) {
354	this.filter = filter;
355	}
356
357	@Override
358	public SimpleFeatureType getSchema() {
359	return getGeoObject().getSchema();
360	}
361
362	}