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

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