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.List;
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 skrueger.AttributeMetadataImpl;

import com.vividsolutions.jts.geom.Envelope;

/**
 * This class extends the the {@link FeatureCollectionTableModel} with the
 * functionalities of the {@link AttributeMetadataImpl}.
 * <ul>
 * <li>column names are translated according to
 * {@link AttributeMetadataImpl#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 AttributeMetadataImpl}-Map of the styled layer. */
        protected AttributeMetadataMap<? extends AttributeMetadata> 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;

        /** A cache for the #sortedValuesVisibleOnly() **/
        protected List<? extends AttributeMetadata> amdMapVisibleOnly = 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);
        }

        /**
         * This overwritten method filters the values for NODATA-values defined in
         * the {@link AttributeMetadataImpl}
         */
        @Override
        public Object getValueAt(int row, int col) {
                Object rawValue = super.getValueAt(row, col);
                return amdMap.sortedValuesVisibleOnly().get(col).fiterNodata(rawValue);
        }
        
        /**
         * Sets a new data source for the table.
         * 
         * @param fs
         *            the feature source
         * @param amdm
         *            {@link AttributeMetadataImpl}-Map to define the visible attributes
         *            and translation
         */
        protected void setFeatureSource(
                        FeatureSource<SimpleFeatureType, SimpleFeature> fs,
                        AttributeMetadataMap<? extends AttributeMetadata> amdm, Filter filter) throws Exception {

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

                // this.featureSource = fs;
                this.filter = filter;
                this.amdMap = amdm;
                this.amdMapVisibleOnly = amdMap.sortedValuesVisibleOnly();

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