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.FileNotFoundException;
import java.io.IOException;
import java.net.URL;
import java.util.Date;
import java.util.Random;

import javax.swing.ImageIcon;
import javax.swing.JPanel;

import org.apache.log4j.Logger;
import org.geotools.data.FeatureSource;
import org.geotools.data.store.EmptyFeatureCollection;
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.styling.StylingUtil;
import skrueger.AttributeMetaData;
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>
 */
public class StyledFS implements StyledFeatureSourceInterface {
        private static final Logger LOGGER = Logger.getLogger(StyledFS.class);

        private final FeatureSource<SimpleFeatureType, SimpleFeature> fs;

        /**
         * 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;

                if (sldFile != null && sldFile.exists()) {
                        try {
                                style = StylingUtil.loadSLD(sldFile)[0];
                        } catch (FileNotFoundException e) {
                                LOGGER
                                                .debug("The SLD file passed was empty. Leaving the Style untouched. (We are in the constructor.. so its null");
                        } catch (Exception e) {
                                LOGGER.warn("Reading SLD failed: " + sldFile, e);
                        }
                }
                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() {
                return fs.getSchema().getCoordinateReferenceSystem();
        }

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

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

                                AttributeMetaData attMetaData = new AttributeMetaData(i, att
                                                .getLocalName());
                                map.put(i, 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 getFeatureCollection() {
                FeatureCollection 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);
        }

        @Override
        public Filter getFilter() {
                return filter;
        }

        @Override
        public void setFilter(Filter filter) {
                this.filter = filter;
        }

        @Override
        public SimpleFeatureType getSchema() {
                return getGeoObject().getSchema();
        }

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