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.HashMap;
import java.util.Map;
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.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 HashMap<Integer, AttributeMetaData> map;

        /**
         * 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();
                title.fromOneLine(sldFile.getName());

                desc = new Translation();
                desc.fromOneLine(sldFile.getAbsolutePath());
        }

        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 Map<Integer, AttributeMetaData> getAttributeMetaDataMap() {
                if (map == null) {

                        map = new HashMap<Integer, AttributeMetaData>();

                        // 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 getFeatureSource() {
                return getGeoObject();
        }

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