skrueger/geotools/StyledFeatureCollectionTableModel.java

/** SCHMITZM - This file is part of the java library of Martin O.J. Schmitz (SCHMITZM)

    This library 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 2.1 of the License, or (at your option) any later version.
    This library 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 Lesser General Public License for more details.
    You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA

    Diese Bibliothek ist freie Software; Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License, wie von der Free Software Foundation veröffentlicht, weiterverteilen und/oder modifizieren; entweder gemäß Version 2.1 der Lizenz oder (nach Ihrer Option) jeder späteren Version.
    Diese Bibliothek wird in der Hoffnung weiterverbreitet, daß sie nützlich sein wird, jedoch OHNE IRGENDEINE GARANTIE, auch ohne die implizierte Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Mehr Details finden Sie in der GNU Lesser General Public License.
    Sie sollten eine Kopie der GNU Lesser General Public License zusammen mit dieser Bibliothek erhalten haben; falls nicht, schreiben Sie an die Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA.
 **/
package skrueger.geotools;

import java.util.Iterator;
import java.util.Map;
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.data.memory.MemoryDataStore;
import org.geotools.feature.AttributeType;
import org.geotools.feature.FeatureCollection;
import org.opengis.filter.Filter;

import schmitzm.geotools.gui.FeatureCollectionTableModel;
import skrueger.AttributeMetaData;
import skrueger.i8n.I8NUtil;
import skrueger.i8n.Translation;

import com.vividsolutions.jts.geom.Envelope;

/**
 * This class extends the the {@link FeatureCollectionTableModel} with the
 * functionalities of the {@link AttributeMetaData} of
 * {@linkplain StyledMapInterface styled objects}.
 * <ul>
 * <li>column names are translated according to
 * {@link AttributeMetaData#getTitle()}</li>
 * <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
 * </ul>
 * 
 * @author <a href="mailto:[email protected]">Martin Schmitz</a>
 *         (University of Bonn/Germany)
 */
public class StyledFeatureCollectionTableModel extends
                FeatureCollectionTableModel {
        final static private Logger LOGGER = Logger
                        .getLogger(StyledFeatureCollectionTableModel.class);
        /** Holds the data source as styled map. */
        protected StyledMapInterface<?> map = null;
        /** Contains only the visible elements of the {@link AttributeMetaData}-Map */
        protected Map<Integer, AttributeMetaData> visibleAMD = null;
        /** Holds the data source for the table as {@code FeatureSource}. */
        protected FeatureSource featureSource = null;
        /** Contains the complete {@link AttributeMetaData}-Map of the styled layer. */
        protected Map<Integer, AttributeMetaData> origAMD = 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;

        /**
         * Creates a new table model for a styled map.
         * 
         * @param map
         *            the styled map
         */
        public StyledFeatureCollectionTableModel(
                        StyledFeatureCollectionInterface map) {
                this(map, Filter.INCLUDE);
        }

        /**
         * Creates a new table model for a styled map.
         * 
         * @param map
         *            the styled map
         * @param filter
         *            filter applied to the table
         */
        public StyledFeatureCollectionTableModel(
                        StyledFeatureCollectionInterface map, Filter filter) {
                super();
                setFeatureCollection(map, filter);
        }

        /**
         * Creates a new table model for a styled map.
         * 
         * @param map
         *            the styled map
         */
        public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map) {
                this(map, Filter.INCLUDE);
        }

        /**
         * Creates a new table model for a styled map.
         * 
         * @param map
         *            the styled map
         * @param filter
         *            filter applied to the table
         */
        public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map,
                        Filter filter) {
                super();
                setFeatureCollection(map, filter);
        }

        /**
         * Sets a new data source for the table.
         * 
         * @param fs
         *            the feature source
         * @param amd
         *            {@link AttributeMetaData}-Map to define the visible attributes
         *            and translation
         */
        protected void setFeatureSource(FeatureSource fs,
                        Map<Integer, AttributeMetaData> amd, Filter filter)
                        throws Exception {
                if (filter == null)
                        filter = Filter.INCLUDE;

                this.featureSource = fs;
                this.filter = filter;
                this.origAMD = amd;
                this.visibleAMD = null;

                FeatureCollection fc = null;
                if (fs != null) {

                        bounds = fs.getBounds();

                        Query query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
                        if (amd != null) {
                                // determine the names of the visible Attributes
                                this.visibleAMD = StyledMapUtil.getVisibleAttributeMetaData(
                                                amd, true);
                                Vector<String> visibleAttrNames = new Vector<String>();
                                // Add the column with the geometry (usually "the_geom")
                                visibleAttrNames.add(fs.getSchema().getDefaultGeometry()
                                                .getLocalName());
                                for (int attrIdx : visibleAMD.keySet()) {

                                        /**
                                         * If the user removed columns from the schema of the DBF
                                         * file, there might exist AttributeMetaData for columns
                                         * that don't exists. We check here to avoid an
                                         * ArrayOutOfIndex.
                                         */
                                        if (attrIdx < fs.getSchema().getAttributeCount()) {
                                                final AttributeType attributeTypeAtIdx = fs.getSchema()
                                                                .getAttributeType(attrIdx);
                                                visibleAttrNames.add(attributeTypeAtIdx.getLocalName());
                                        } else {
                                                LOGGER.warn("AttributeMetaData has been found for columnIdx="+attrIdx+", but fs.getSchema().getAttributeCount() = "+fs.getSchema().getAttributeCount()+". Ignored.");
                                        }
                                }

                                // create a query for the visible attributes
                                String[] properties = visibleAttrNames.toArray(new String[0]);

                                LOGGER.debug("Query contains the following attributes: "
                                                + visibleAttrNames);

                                query = new DefaultQuery(fs.getSchema().getTypeName(), filter,
                                                properties);
                        }
                        fc = fs.getFeatures(query);

                        // FAILS:!!!, even with query = new
                        // DefaultQuery(fs.getSchema().getTypeName(), filter);
                        // java.lang.UnsupportedOperationException: Unknown feature
                        // attribute: PQM_MOD
                        // at
                        // schmitzm.geotools.feature.FeatureOperationTree.evaluate(FeatureOperationTree.java:93)
                        // bounds = fc.getBounds();
                        // SK, 17.4.2009
                        //      
                        // System.out.println("Filter = "+filter);
                        // System.out.println("Size of FC = "+fc.size());
                        // System.out.println("anz att= "+fc.getNumberOfAttributes());
                }
                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 setFeatureCollection(StyledFeatureCollectionInterface map,
                        Filter filter) {
                this.map = map;
                try {
                        if (map == null)
                                setFeatureSource(null, null, null);
                        else {
                                FeatureCollection fc = map.getGeoObject();
                                String fcName = fc.getSchema().getTypeName();
                                FeatureSource fs = new MemoryDataStore(fc)
                                                .getFeatureSource(fcName);
                                setFeatureSource(fs, map.getAttributeMetaDataMap(), filter);
                        }
                } catch (Exception err) {
                        throw new RuntimeException(err);
                }
        }

        /**
         * Sets the {@code StyledFeatureCollection} as 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 setFeatureCollection(StyledFeatureSourceInterface map,
                        Filter filter) {
                this.map = map;
                try {
                        if (map == null)
                                setFeatureSource(null, null, null);
                        else
                                setFeatureSource(map.getGeoObject(), map
                                                .getAttributeMetaDataMap(), filter);
                } catch (Exception err) {
                        throw new RuntimeException(err);
                }
        }

        /**
         * Resets the filter for the table.
         * 
         * @param filter
         *            a filter
         */
        public void setFilter(Filter filter) {
                try {
                        setFeatureSource(this.featureSource, this.origAMD, filter);
                } catch (Exception err) {
                        LOGGER.error("Setting the filter of the table model", err);
                        throw new RuntimeException(err);
                }
        }

        /**
         * @return <code>Filter.INCLUDE</code> or the {@link Filter} applied to the
         *         Features
         */
        public Filter getFilter() {
                return this.filter;
        }

        /**
         * 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) {
                super.reorganize(false);
                // translate the column names
                if (visibleAMD != null) {
                        Iterator<Integer> keys = visibleAMD.keySet().iterator();
                        for (int i = 0; i < colNames.length && keys.hasNext(); i++) {
                                Translation title = visibleAMD.get(keys.next()).getTitle();
                                if (!I8NUtil.isEmpty(title)) {
                                        // System.out.println("set colname " + i + " to " +
                                        // title.toString());
                                        colNames[i] = title.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	/** SCHMITZM - This file is part of the java library of Martin O.J. Schmitz (SCHMITZM)
2
3	This library 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 2.1 of the License, or (at your option) any later version.
4	This library 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 Lesser General Public License for more details.
5	You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
6
7	Diese Bibliothek ist freie Software; Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License, wie von der Free Software Foundation veröffentlicht, weiterverteilen und/oder modifizieren; entweder gemäß Version 2.1 der Lizenz oder (nach Ihrer Option) jeder späteren Version.
8	Diese Bibliothek wird in der Hoffnung weiterverbreitet, daß sie nützlich sein wird, jedoch OHNE IRGENDEINE GARANTIE, auch ohne die implizierte Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Mehr Details finden Sie in der GNU Lesser General Public License.
9	Sie sollten eine Kopie der GNU Lesser General Public License zusammen mit dieser Bibliothek erhalten haben; falls nicht, schreiben Sie an die Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA.
10	**/
11	package skrueger.geotools;
12
13	import java.util.Iterator;
14	import java.util.Map;
15	import java.util.Vector;
16
17	import org.apache.log4j.Logger;
18	import org.geotools.data.DefaultQuery;
19	import org.geotools.data.FeatureSource;
20	import org.geotools.data.Query;
21	import org.geotools.data.memory.MemoryDataStore;
22	import org.geotools.feature.AttributeType;
23	import org.geotools.feature.FeatureCollection;
24	import org.opengis.filter.Filter;
25
26	import schmitzm.geotools.gui.FeatureCollectionTableModel;
27	import skrueger.AttributeMetaData;
28	import skrueger.i8n.I8NUtil;
29	import skrueger.i8n.Translation;
30
31	import com.vividsolutions.jts.geom.Envelope;
32
33	/**
34	* This class extends the the {@link FeatureCollectionTableModel} with the
35	* functionalities of the {@link AttributeMetaData} of
36	* {@linkplain StyledMapInterface styled objects}.
37	* <ul>
38	* <li>column names are translated according to
39	* {@link AttributeMetaData#getTitle()}</li>
40	* <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
41	* </ul>
42	*
43	* @author <a href="mailto:[email protected]">Martin Schmitz</a>
44	* (University of Bonn/Germany)
45	*/
46	public class StyledFeatureCollectionTableModel extends
47	FeatureCollectionTableModel {
48	final static private Logger LOGGER = Logger
49	.getLogger(StyledFeatureCollectionTableModel.class);
50	/** Holds the data source as styled map. */
51	protected StyledMapInterface<?> map = null;
52	/** Contains only the visible elements of the {@link AttributeMetaData}-Map */
53	protected Map<Integer, AttributeMetaData> visibleAMD = null;
54	/** Holds the data source for the table as {@code FeatureSource}. */
55	protected FeatureSource featureSource = null;
56	/** Contains the complete {@link AttributeMetaData}-Map of the styled layer. */
57	protected Map<Integer, AttributeMetaData> origAMD = null;
58	/** Holds the current filter on the table */
59	protected Filter filter = null;
60	/ Holds the Bounds for all features. Only set once during the constructor /
61	protected Envelope bounds;
62
63	/**
64	* Creates a new table model for a styled map.
65	*
66	* @param map
67	* the styled map
68	*/
69	public StyledFeatureCollectionTableModel(
70	StyledFeatureCollectionInterface map) {
71	this(map, Filter.INCLUDE);
72	}
73
74	/**
75	* Creates a new table model for a styled map.
76	*
77	* @param map
78	* the styled map
79	* @param filter
80	* filter applied to the table
81	*/
82	public StyledFeatureCollectionTableModel(
83	StyledFeatureCollectionInterface map, Filter filter) {
84	super();
85	setFeatureCollection(map, filter);
86	}
87
88	/**
89	* Creates a new table model for a styled map.
90	*
91	* @param map
92	* the styled map
93	*/
94	public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map) {
95	this(map, Filter.INCLUDE);
96	}
97
98	/**
99	* Creates a new table model for a styled map.
100	*
101	* @param map
102	* the styled map
103	* @param filter
104	* filter applied to the table
105	*/
106	public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map,
107	Filter filter) {
108	super();
109	setFeatureCollection(map, filter);
110	}
111
112	/**
113	* Sets a new data source for the table.
114	*
115	* @param fs
116	* the feature source
117	* @param amd
118	* {@link AttributeMetaData}-Map to define the visible attributes
119	* and translation
120	*/
121	protected void setFeatureSource(FeatureSource fs,
122	Map<Integer, AttributeMetaData> amd, Filter filter)
123	throws Exception {
124	if (filter == null)
125	filter = Filter.INCLUDE;
126
127	this.featureSource = fs;
128	this.filter = filter;
129	this.origAMD = amd;
130	this.visibleAMD = null;
131
132	FeatureCollection fc = null;
133	if (fs != null) {
134
135	bounds = fs.getBounds();
136
137	Query query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
138	if (amd != null) {
139	// determine the names of the visible Attributes
140	this.visibleAMD = StyledMapUtil.getVisibleAttributeMetaData(
141	amd, true);
142	Vector<String> visibleAttrNames = new Vector<String>();
143	// Add the column with the geometry (usually "the_geom")
144	visibleAttrNames.add(fs.getSchema().getDefaultGeometry()
145	.getLocalName());
146	for (int attrIdx : visibleAMD.keySet()) {
147
148	/**
149	* If the user removed columns from the schema of the DBF
150	* file, there might exist AttributeMetaData for columns
151	* that don't exists. We check here to avoid an
152	* ArrayOutOfIndex.
153	*/
154	if (attrIdx < fs.getSchema().getAttributeCount()) {
155	final AttributeType attributeTypeAtIdx = fs.getSchema()
156	.getAttributeType(attrIdx);
157	visibleAttrNames.add(attributeTypeAtIdx.getLocalName());
158	} else {
159	LOGGER.warn("AttributeMetaData has been found for columnIdx="+attrIdx+", but fs.getSchema().getAttributeCount() = "+fs.getSchema().getAttributeCount()+". Ignored.");
160	}
161	}
162
163	// create a query for the visible attributes
164	String[] properties = visibleAttrNames.toArray(new String[0]);
165
166	LOGGER.debug("Query contains the following attributes: "
167	+ visibleAttrNames);
168
169	query = new DefaultQuery(fs.getSchema().getTypeName(), filter,
170	properties);
171	}
172	fc = fs.getFeatures(query);
173
174	// FAILS:!!!, even with query = new
175	// DefaultQuery(fs.getSchema().getTypeName(), filter);
176	// java.lang.UnsupportedOperationException: Unknown feature
177	// attribute: PQM_MOD
178	// at
179	// schmitzm.geotools.feature.FeatureOperationTree.evaluate(FeatureOperationTree.java:93)
180	// bounds = fc.getBounds();
181	// SK, 17.4.2009
182	//
183	// System.out.println("Filter = "+filter);
184	// System.out.println("Size of FC = "+fc.size());
185	// System.out.println("anz att= "+fc.getNumberOfAttributes());
186	}
187	setFeatureCollection(fc);
188	}
189
190	/**
191	* Converts the {@code StyledFeatureCollection} to a {@code FeatureSource}
192	* and sets this as the new data source for the table.
193	*
194	* @param fs
195	* the feature source
196	* @param amd
197	* {@link AttributeMetaData}-Map to define the visible attributes
198	* and translation
199	*/
200	public void setFeatureCollection(StyledFeatureCollectionInterface map,
201	Filter filter) {
202	this.map = map;
203	try {
204	if (map == null)
205	setFeatureSource(null, null, null);
206	else {
207	FeatureCollection fc = map.getGeoObject();
208	String fcName = fc.getSchema().getTypeName();
209	FeatureSource fs = new MemoryDataStore(fc)
210	.getFeatureSource(fcName);
211	setFeatureSource(fs, map.getAttributeMetaDataMap(), filter);
212	}
213	} catch (Exception err) {
214	throw new RuntimeException(err);
215	}
216	}
217
218	/**
219	* Sets the {@code StyledFeatureCollection} as new data source for the
220	* table.
221	*
222	* @param fs
223	* the feature source
224	* @param amd
225	* {@link AttributeMetaData}-Map to define the visible attributes
226	* and translation
227	*/
228	public void setFeatureCollection(StyledFeatureSourceInterface map,
229	Filter filter) {
230	this.map = map;
231	try {
232	if (map == null)
233	setFeatureSource(null, null, null);
234	else
235	setFeatureSource(map.getGeoObject(), map
236	.getAttributeMetaDataMap(), filter);
237	} catch (Exception err) {
238	throw new RuntimeException(err);
239	}
240	}
241
242	/**
243	* Resets the filter for the table.
244	*
245	* @param filter
246	* a filter
247	*/
248	public void setFilter(Filter filter) {
249	try {
250	setFeatureSource(this.featureSource, this.origAMD, filter);
251	} catch (Exception err) {
252	LOGGER.error("Setting the filter of the table model", err);
253	throw new RuntimeException(err);
254	}
255	}
256
257	/**
258	* @return <code>Filter.INCLUDE</code> or the {@link Filter} applied to the
259	* Features
260	*/
261	public Filter getFilter() {
262	return this.filter;
263	}
264
265	/**
266	* After calling {@code super.reorganize(.)} this method replaced the column
267	* descriptions with the titles of the {@code AttributeMetaData}.
268	*
269	* @param fireTableStructureChanged
270	* indicates whether a table event is initiated after reorganize
271	*/
272	@Override
273	protected void reorganize(boolean fireTableStructureChanged) {
274	super.reorganize(false);
275	// translate the column names
276	if (visibleAMD != null) {
277	Iterator<Integer> keys = visibleAMD.keySet().iterator();
278	for (int i = 0; i < colNames.length && keys.hasNext(); i++) {
279	Translation title = visibleAMD.get(keys.next()).getTitle();
280	if (!I8NUtil.isEmpty(title)) {
281	// System.out.println("set colname " + i + " to " +
282	// title.toString());
283	colNames[i] = title.toString();
284	}
285	}
286	}
287	if (fireTableStructureChanged)
288	fireTableStructureChanged();
289	}
290
291	/**
292	* @return Cached bounds for the whole dataset (without applying the filter)
293	* or <code>null</code>
294	*/
295	public Envelope getBounds() {
296	return bounds;
297	}
298	}