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

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