skrueger/geotools/StyledFeatureCollectionTableModel.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.util.HashMap;
import java.util.Vector;

import org.apache.log4j.Logger;
import org.geotools.data.DefaultQuery;
import org.geotools.data.FeatureSource;
import org.geotools.data.Query;
import org.geotools.feature.FeatureCollection;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.feature.simple.SimpleFeatureType;
import org.opengis.feature.type.AttributeDescriptor;
import org.opengis.filter.Filter;

import schmitzm.geotools.feature.FeatureUtil;
import schmitzm.geotools.gui.FeatureCollectionTableModel;
import skrueger.AttributeMetadata;

import com.vividsolutions.jts.geom.Envelope;

/**
 * This class extends the the {@link FeatureCollectionTableModel} with the
 * functionalities of the {@link AttributeMetadata}.
 * <ul>
 * <li>column names are translated according to
 * {@link AttributeMetadata#getTitle()}</li>
 * <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
 * <li>Any filter defined in the {@link StyledFeaturesInterface} will be
 * applied.</li>
 * </ul>
 * 
 * @author Stefan A. Krüger
 */
public class StyledFeatureCollectionTableModel extends
                FeatureCollectionTableModel {
        final static private Logger LOGGER = Logger
                        .getLogger(StyledFeatureCollectionTableModel.class);
        /** Contains the complete {@link AttributeMetadata}-Map of the styled layer. */
        protected AttributeMetadataMap amdMap = null;
        /** Holds the current filter on the table */
        protected Filter filter = null;
        /** Holds the Bounds for all features. Only set once during the constructor **/
        protected Envelope bounds;
        /**
         * Tooltips für die Spaltennamen. Wird nur beim Aufruf von
         * {@link #reorganize} befuellt.
         */
        protected String[] colTooltips = null;

        /**
         * Creates a new table model for a styled layer.
         * 
         * @param styledFeatures
         *            the styled layer
         * @param filter
         *            filter applied to the table
         */
        public StyledFeatureCollectionTableModel(
                        StyledFeaturesInterface<?> styledFeatures) {
                setStyledFeatures(styledFeatures);
        }

        /**
         * Sets a new data source for the table.
         * 
         * @param fs
         *            the feature source
         * @param amdm
         *            {@link AttributeMetadata}-Map to define the visible attributes
         *            and translation
         */
        protected void setFeatureSource(
                        FeatureSource<SimpleFeatureType, SimpleFeature> fs,
                        AttributeMetadataMap amdm, Filter filter) throws Exception {

                if (filter == null)
                        filter = Filter.INCLUDE;

                // this.featureSource = fs;
                this.filter = filter;
                this.amdMap = amdm;

                FeatureCollection<SimpleFeatureType, SimpleFeature> fc = null;
                if (fs != null) {

                        bounds = fs.getBounds();

                        final SimpleFeatureType schema = fs.getSchema();
                        Query query = new DefaultQuery(schema.getTypeName(), filter);
                        if (amdm != null) {
                                Vector<String> visibleAttrNames = new Vector<String>();

                                // Add the column with the geometry (usually "the_geom") always
                                visibleAttrNames.add(schema.getGeometryDescriptor()
                                                .getLocalName());

                                // Add other visible attributes as ordered by weights
                                for (AttributeMetadata a : amdm.sortedValuesVisibleOnly()) {
                                        visibleAttrNames.add(a.getLocalName());
                                }

//                      Tested with 2.6.x trunk from 2009-11-26 and it now works. So we only request the properties we need!                    
//                              /**
//                               * I got NPEs when properties contained only [the_geom] ?!??!!??
//                               */
//                              if (properties.length > 1) {
                                        query = new DefaultQuery(schema.getTypeName(), filter,
                                                        visibleAttrNames.toArray(new String[] {}));
//                              } else {
//                                      query = new DefaultQuery(schema.getTypeName(), filter);
//                              }
                        }
                        fc = fs.getFeatures(query);
                }
                setFeatureCollection(fc);
        }

        /**
         * Converts the {@code StyledFeatureCollection} to a {@code FeatureSource}
         * and sets this as the new data source for the table.
         * 
         * @param fs
         *            the feature source
         * @param amd
         *            {@link AttributeMetadata}-Map to define the visible attributes
         *            and translation
         */
        public void setStyledFeatures(StyledFeaturesInterface<?> styledFeatures) {
                try {
                        if (styledFeatures == null)
                                setFeatureSource(null, null, null);
                        else {
                                setFeatureSource(styledFeatures.getFeatureSource(),
                                                styledFeatures.getAttributeMetaDataMap(),
                                                styledFeatures.getFilter());
                        }
                } catch (Exception err) {
                        throw new RuntimeException(err);
                }
        }

        /**
         * After calling {@code super.reorganize(.)} this method replaced the column
         * descriptions with the titles of the {@code AttributeMetaData}.
         * 
         * @param fireTableStructureChanged
         *            indicates whether a table event is initiated after reorganize
         */
        @Override
        protected void reorganize(boolean fireTableStructureChanged) {

                featureArray = FeatureUtil.featuresToArray(featureTable);
                if (featureArray == null || featureArray.length == 0) {
                        colNames = new String[0];
                        colTooltips = new String[0]; // Only set and used in
                                                                                        // StyledFeatureCollectionTableModel
                        colClass = new Class[0];
                } else {
                        // Struktur der Tabelle vom AttributeMetaDtaaMap übernehmen
                        SimpleFeatureType schema = featureArray[0].getFeatureType();
                        // Pruefen, welche Attribute angezeigt werden
                        attrTypes.clear();
                        for (AttributeMetadata amd : amdMap.sortedValuesVisibleOnly()) {
                                AttributeDescriptor type = schema.getDescriptor(amd.getName());
                                if (attrFilter == null || attrFilter.accept(type))
                                        attrTypes.add(type);
                        }
                        // Namen und Attribut-Indizes der angezeigten Spalten ermitteln
                        colNames = new String[attrTypes.size()];
                        colTooltips = new String[attrTypes.size()]; // Only set and used in
                                                                                                                // StyledFeatureCollectionTableModel
                        colClass = new Class[attrTypes.size()];
                        attrIdxForCol = new int[attrTypes.size()];
                        for (int i = 0; i < colNames.length; i++) {
                                AttributeDescriptor descriptor = schema.getDescriptor(amdMap.sortedValuesVisibleOnly().get(i).getName());

                                // Not so nice in 26: find the index of an attribute...
                                int idx = schema.getAttributeDescriptors().indexOf(descriptor);
                                attrIdxForCol[i] = idx;

                                String attName = schema.getAttributeDescriptors().get(idx)
                                                .getLocalName();
                                colNames[i] = amdMap.get(attName).getTitle().toString();
                                AttributeMetadata amd = amdMap.get(attName);
                                colTooltips[i] = "<html>"+amd.getDesc().toString()+"<br>"+amd.getName()+"</html>";
                                colClass[i] = schema.getAttributeDescriptors().get(idx).getType()
                                                .getBinding();
                        }
                }

                // store feature indexes in HashMap to optimize findFeature(.)
                featureIdx = new HashMap<String, Integer>();
                for (int i = 0; i < featureArray.length; i++)
                        if (featureArray[i] != null)
                                featureIdx.put(featureArray[i].getID(), i);
//
//              // translate the column names
//              if (amdMap != null) {
//                      for (int i = 0; i < colNames.length; i++) {
//                              colTooltips[i] = amdMap.get(colNames[i]).getDesc().toString()
//                                              + "<br>" + colNames[i];
//                              colNames[i] = amdMap.get(colNames[i]).getTitle().toString();
//
//                      }
//              }
                if (fireTableStructureChanged)
                        fireTableStructureChanged();

        }

        /**
         * @return Cached bounds for the whole dataset (without applying the filter)
         *         or <code>null</code>
         */
        public Envelope getBounds() {
                return bounds;
        }
}
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	alfonx	534	import java.util.HashMap;
33	alfonx	244	import java.util.Vector;
34
35			import org.apache.log4j.Logger;
36			import org.geotools.data.DefaultQuery;
37			import org.geotools.data.FeatureSource;
38			import org.geotools.data.Query;
39			import org.geotools.feature.FeatureCollection;
40	alfonx	335	import org.opengis.feature.simple.SimpleFeature;
41			import org.opengis.feature.simple.SimpleFeatureType;
42	alfonx	332	import org.opengis.feature.type.AttributeDescriptor;
43	alfonx	244	import org.opengis.filter.Filter;
44
45	alfonx	534	import schmitzm.geotools.feature.FeatureUtil;
46	alfonx	244	import schmitzm.geotools.gui.FeatureCollectionTableModel;
47	alfonx	464	import skrueger.AttributeMetadata;
48	alfonx	244
49			import com.vividsolutions.jts.geom.Envelope;
50
51			/**
52			* This class extends the the {@link FeatureCollectionTableModel} with the
53	alfonx	464	* functionalities of the {@link AttributeMetadata}.
54	alfonx	244	* <ul>
55			* <li>column names are translated according to
56	alfonx	464	* {@link AttributeMetadata#getTitle()}</li>
57	alfonx	244	* <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
58	alfonx	534	* <li>Any filter defined in the {@link StyledFeaturesInterface} will be
59			* applied.</li>
60	alfonx	244	* </ul>
61			*
62	alfonx	428	* @author Stefan A. Krüger
63	alfonx	244	*/
64			public class StyledFeatureCollectionTableModel extends
65			FeatureCollectionTableModel {
66			final static private Logger LOGGER = Logger
67			.getLogger(StyledFeatureCollectionTableModel.class);
68	alfonx	464	/** Contains the complete {@link AttributeMetadata}-Map of the styled layer. */
69	alfonx	534	protected AttributeMetadataMap amdMap = null;
70	alfonx	244	/** Holds the current filter on the table */
71			protected Filter filter = null;
72			/ Holds the Bounds for all features. Only set once during the constructor /
73			protected Envelope bounds;
74	alfonx	534	/**
75			* Tooltips für die Spaltennamen. Wird nur beim Aufruf von
76			* {@link #reorganize} befuellt.
77			*/
78			protected String[] colTooltips = null;
79	alfonx	244
80			/**
81			* Creates a new table model for a styled layer.
82			*
83	alfonx	428	* @param styledFeatures
84	alfonx	244	* the styled layer
85			* @param filter
86			* filter applied to the table
87			*/
88	alfonx	534	public StyledFeatureCollectionTableModel(
89			StyledFeaturesInterface<?> styledFeatures) {
90	alfonx	428	setStyledFeatures(styledFeatures);
91	alfonx	244	}
92
93			/**
94			* Sets a new data source for the table.
95			*
96			* @param fs
97			* the feature source
98	alfonx	534	* @param amdm
99	alfonx	464	* {@link AttributeMetadata}-Map to define the visible attributes
100	alfonx	244	* and translation
101			*/
102	alfonx	534	protected void setFeatureSource(
103			FeatureSource<SimpleFeatureType, SimpleFeature> fs,
104			AttributeMetadataMap amdm, Filter filter) throws Exception {
105
106	alfonx	244	if (filter == null)
107			filter = Filter.INCLUDE;
108
109	alfonx	534	// this.featureSource = fs;
110	alfonx	244	this.filter = filter;
111	alfonx	534	this.amdMap = amdm;
112	alfonx	244
113	alfonx	428	FeatureCollection<SimpleFeatureType, SimpleFeature> fc = null;
114	alfonx	244	if (fs != null) {
115
116			bounds = fs.getBounds();
117
118	alfonx	464	final SimpleFeatureType schema = fs.getSchema();
119			Query query = new DefaultQuery(schema.getTypeName(), filter);
120	alfonx	534	if (amdm != null) {
121	alfonx	244	Vector<String> visibleAttrNames = new Vector<String>();
122	alfonx	534
123	alfonx	607	// Add the column with the geometry (usually "the_geom") always
124	alfonx	534	visibleAttrNames.add(schema.getGeometryDescriptor()
125			.getLocalName());
126
127			// Add other visible attributes as ordered by weights
128			for (AttributeMetadata a : amdm.sortedValuesVisibleOnly()) {
129			visibleAttrNames.add(a.getLocalName());
130	alfonx	244	}
131
132	alfonx	607	// Tested with 2.6.x trunk from 2009-11-26 and it now works. So we only request the properties we need!
133			// /**
134			// * I got NPEs when properties contained only [the_geom] ?!??!!??
135			// */
136			// if (properties.length > 1) {
137	alfonx	490	query = new DefaultQuery(schema.getTypeName(), filter,
138	alfonx	607	visibleAttrNames.toArray(new String[] {}));
139			// } else {
140			// query = new DefaultQuery(schema.getTypeName(), filter);
141			// }
142	alfonx	244	}
143			fc = fs.getFeatures(query);
144			}
145			setFeatureCollection(fc);
146			}
147
148			/**
149			* Converts the {@code StyledFeatureCollection} to a {@code FeatureSource}
150			* and sets this as the new data source for the table.
151			*
152			* @param fs
153			* the feature source
154			* @param amd
155	alfonx	464	* {@link AttributeMetadata}-Map to define the visible attributes
156	alfonx	244	* and translation
157			*/
158	alfonx	428	public void setStyledFeatures(StyledFeaturesInterface<?> styledFeatures) {
159	alfonx	244	try {
160	alfonx	428	if (styledFeatures == null)
161	alfonx	244	setFeatureSource(null, null, null);
162			else {
163	alfonx	534	setFeatureSource(styledFeatures.getFeatureSource(),
164			styledFeatures.getAttributeMetaDataMap(),
165			styledFeatures.getFilter());
166	alfonx	244	}
167			} catch (Exception err) {
168			throw new RuntimeException(err);
169			}
170			}
171
172			/**
173			* After calling {@code super.reorganize(.)} this method replaced the column
174			* descriptions with the titles of the {@code AttributeMetaData}.
175			*
176			* @param fireTableStructureChanged
177			* indicates whether a table event is initiated after reorganize
178			*/
179			@Override
180			protected void reorganize(boolean fireTableStructureChanged) {
181	alfonx	534
182			featureArray = FeatureUtil.featuresToArray(featureTable);
183			if (featureArray == null \|\| featureArray.length == 0) {
184			colNames = new String[0];
185			colTooltips = new String[0]; // Only set and used in
186			// StyledFeatureCollectionTableModel
187			colClass = new Class[0];
188			} else {
189			// Struktur der Tabelle vom AttributeMetaDtaaMap übernehmen
190			SimpleFeatureType schema = featureArray[0].getFeatureType();
191			// Pruefen, welche Attribute angezeigt werden
192			attrTypes.clear();
193			for (AttributeMetadata amd : amdMap.sortedValuesVisibleOnly()) {
194			AttributeDescriptor type = schema.getDescriptor(amd.getName());
195			if (attrFilter == null \|\| attrFilter.accept(type))
196			attrTypes.add(type);
197			}
198			// Namen und Attribut-Indizes der angezeigten Spalten ermitteln
199			colNames = new String[attrTypes.size()];
200			colTooltips = new String[attrTypes.size()]; // Only set and used in
201			// StyledFeatureCollectionTableModel
202			colClass = new Class[attrTypes.size()];
203			attrIdxForCol = new int[attrTypes.size()];
204	alfonx	464	for (int i = 0; i < colNames.length; i++) {
205	alfonx	534	AttributeDescriptor descriptor = schema.getDescriptor(amdMap.sortedValuesVisibleOnly().get(i).getName());
206
207			// Not so nice in 26: find the index of an attribute...
208			int idx = schema.getAttributeDescriptors().indexOf(descriptor);
209			attrIdxForCol[i] = idx;
210
211			String attName = schema.getAttributeDescriptors().get(idx)
212			.getLocalName();
213			colNames[i] = amdMap.get(attName).getTitle().toString();
214			AttributeMetadata amd = amdMap.get(attName);
215			colTooltips[i] = "<html>"+amd.getDesc().toString()+"<br>"+amd.getName()+"</html>";
216			colClass[i] = schema.getAttributeDescriptors().get(idx).getType()
217			.getBinding();
218	alfonx	244	}
219			}
220	alfonx	534
221			// store feature indexes in HashMap to optimize findFeature(.)
222			featureIdx = new HashMap<String, Integer>();
223			for (int i = 0; i < featureArray.length; i++)
224			if (featureArray[i] != null)
225			featureIdx.put(featureArray[i].getID(), i);
226			//
227			// // translate the column names
228			// if (amdMap != null) {
229			// for (int i = 0; i < colNames.length; i++) {
230			// colTooltips[i] = amdMap.get(colNames[i]).getDesc().toString()
231			// + "<br>" + colNames[i];
232			// colNames[i] = amdMap.get(colNames[i]).getTitle().toString();
233			//
234			// }
235			// }
236	alfonx	244	if (fireTableStructureChanged)
237			fireTableStructureChanged();
238	alfonx	534
239	alfonx	244	}
240
241			/**
242			* @return Cached bounds for the whole dataset (without applying the filter)
243			* or <code>null</code>
244			*/
245			public Envelope getBounds() {
246			return bounds;
247			}
248			}