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