geotools/selection/FeatureMapLayerSelectionSynchronizer.java

/** 
 Copyright 2008 Stefan Alfons Krüger 
 
 atlas-framework - This file is part of the Atlas Framework

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

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Arrays;
import java.util.Collection;
import java.util.Vector;

import javax.swing.JTable;
import javax.swing.ListSelectionModel;
import javax.swing.event.ListSelectionListener;

import org.geotools.feature.Feature;
import org.geotools.map.MapLayer;
import org.geotools.styling.FeatureTypeStyle;
import org.geotools.styling.Style;
import org.opengis.filter.Filter;
import org.opengis.filter.FilterVisitor;

import schmitzm.geotools.gui.JMapPane;
import schmitzm.geotools.map.event.FeatureSelectedEvent;
import schmitzm.geotools.map.event.JMapPaneEvent;
import schmitzm.geotools.map.event.JMapPaneListener;
import schmitzm.geotools.styling.StylingUtil;
import schmitzm.lang.LangUtil;
import skrueger.geotools.MapPaneToolBar;
import skrueger.geotools.StyledMapInterface;

/**
 * This class keeps the selection of a (feature) {@link JTable} synchronized
 * with the {@link StyledLayerSelectionModel} of a layer. This is done by
 * implementing:
 * <ul>
 * <li>a {@link PropertyChangeListener} which listens to the
 * {@link StyledLayerSelectionModel} and accordingly changes the {@link JTable}
 * selection</li>
 * <li>a {@link ListSelectionListener} which listens to the {@link JTable} and
 * accordingly changes the {@link StyledLayerSelectionModel} selection</li>
 * </ul>
 * After creating, the instance of this synchronizer must be added as listener
 * to both, the {@link StyledLayerSelectionModel} and the table's
 * {@link ListSelectionModel}.
 * 
 * @author <a href="mailto:[email protected]">Martin Schmitz</a>
 *         (University of Bonn/Germany)
 */
public class FeatureMapLayerSelectionSynchronizer extends
                StyledLayerSelectionModelSynchronizer<StyledFeatureLayerSelectionModel>
                implements JMapPaneListener {
        public static final String SELECTION_STYLING = "SELECTION";
        /**
         * Holds the {@link MapLayer} to keep synchronized with the layer selection
         * model.
         */
        protected final MapLayer mapLayer;
        protected final StyledMapInterface<?> styledMapLayer;
        protected final JMapPane mapPane;
        private final MapPaneToolBar toolBar;

        /**
         * Creates a new synchronizer
         * 
         * @param layerSelModel
         *            layer selection model to keep synchronized with the
         *            {@link MapLayer}
         * 
         * @param mapLayer
         *            {@link MapLayer} to keep synchronized with.
         */
        public FeatureMapLayerSelectionSynchronizer(
                        StyledFeatureLayerSelectionModel layerSelModel,
                        StyledMapInterface<?> styledMapLayer, MapLayer mapLayer,
                        JMapPane mapPane, MapPaneToolBar toolBar) {

                super(layerSelModel);
                this.styledMapLayer = styledMapLayer;

                this.mapLayer = mapLayer;
                this.mapPane = mapPane;
                this.toolBar = toolBar;
        }

        /**
         * Called by {@link StyledLayerSelectionModel} when a the selection on other
         * selection components (map, chart, ...) has changed. When calling this
         * 
         * method changes the {@link MapLayer} selection according to the
         * {@link StyledLayerSelectionModel} selection.
         * 
         * @param evt
         *            an event
         */
        @Override
        public void propertyChange(PropertyChangeEvent evt) {
                if (!(evt instanceof StyledLayerSelectionEvent))
                        return;
                StyledLayerSelectionEvent selEvt = (StyledLayerSelectionEvent) evt;
                // Only react on own layer and ignore events invoked by
                // this component itself
                if (selEvt.getEmitter() != layerSelModel || selectionChangeCausedByMe)
                        return;
                // Apply new selection on table (except this event is one of
                // some more events)
                Vector<String> newSelection = layerSelModel.getSelection();
                if (newSelection == null)
                        return;

                // Avoid event circles in valueChanged(..)
                selectionChangeCausedByMe = true;

                changeLayerStyle(newSelection);

                // Danger of event circles in valueChanged(..) banned
                selectionChangeCausedByMe = false;
        }

        private void changeLayerStyle(final Vector<String> newSelection) {
                Style selectionMapStyle = null;
                try {
                        if (newSelection.isEmpty()) {

                                selectionMapStyle = styledMapLayer.getStyle();
                                LOGGER.debug("NO SELECTION .. set to original style directly");

                        } else {
                                LOGGER.debug("SELECTION .. change style");

                                // We take Style from the MapLayer that is displayed at the
                                // moment. We do not use the styledMapLayer.getStyle, because in
                                // the atlas, this always return the default style, but
                                // additionaly styles might be selected.
                                // Taking the style from the mapLayer indicated, that we have to
                                // remove any selection rules first.
                                Style originalStyle = mapLayer.getStyle();

                                // TODO The default style is not good here. We need
                                // .createSelectionStyle(normalStyle, geoObj);
                                selectionMapStyle = StylingUtil
                                                .createSelectionStyle(styledMapLayer.getGeoObject());
//                              selectionMapStyle = StylingUtil
//                              .createDefaultStyle(styledMapLayer.getGeoObject());

                                selectionMapStyle.getFeatureTypeStyles()[0]
                                                .setName(SELECTION_STYLING);

                                // Rule selectedRule = StylingUtil.STYLE_FACTORY.createRule();
                                selectionMapStyle.getFeatureTypeStyles()[0].getRules()[0]
                                                .setFilter(new Filter() {

                                                        @Override
                                                        public Object accept(FilterVisitor visitor,
                                                                        Object extraData) {
                                                                return null;
                                                        }

                                                        @Override
                                                        public boolean evaluate(Object obj) {
                                                                if (obj instanceof Feature) {
                                                                        Feature f = (Feature) obj;
                                                                        // TODO BAD CODE! says Martin.. i am fine
                                                                        // with it.. well.. not great...
                                                                        for (String ffID : newSelection) {
                                                                                if (ffID.equals(f.getID()))
                                                                                        return true;
                                                                        }
                                                                        return false;

                                                                }
                                                                return false;
                                                        }

                                                });

                                FeatureTypeStyle[] originalFeatureTypeStyles = originalStyle
                                                .getFeatureTypeStyles();
                                FeatureTypeStyle[] newFeatureTypes;
                                if (originalFeatureTypeStyles[originalFeatureTypeStyles.length - 1]
                                                .getName() != null
                                                && originalFeatureTypeStyles[originalFeatureTypeStyles.length - 1]
                                                                .getName().equals(SELECTION_STYLING)) {
                                        newFeatureTypes = Arrays.copyOf(originalFeatureTypeStyles,
                                                        originalFeatureTypeStyles.length - 1);
                                } else {
                                        newFeatureTypes = originalFeatureTypeStyles;
                                }
                                
                                // The last FTS is the selection FTS
                                newFeatureTypes = LangUtil.extendArray(newFeatureTypes,
                                                selectionMapStyle.getFeatureTypeStyles());

                                selectionMapStyle.setFeatureTypeStyles(newFeatureTypes);

                        }

                        mapLayer.setStyle(selectionMapStyle);
                        mapPane.refresh();
                } catch (Exception e) {
                        LOGGER.error("Error while trying to create a selection style", e);
                }
        }

        @Override
        public void performMapPaneEvent(JMapPaneEvent e) {

                /**
                 * Only listen to FeatureSelectionEvents if the appropriate tool is
                 * selected.
                 */
                final int selectedTool = toolBar.getSelectedTool();
                if (selectedTool != MapPaneToolBar.TOOL_SELECTION_ADD
                                && selectedTool != MapPaneToolBar.TOOL_SELECTION_REMOVE
                                && selectedTool != MapPaneToolBar.TOOL_SELECTION_CLEAR
                                && selectedTool != MapPaneToolBar.TOOL_SELECTION_SET) {
                        return;
                }

                if (!(e instanceof FeatureSelectedEvent)) {
                        // LOGGER.debug("Ignoring event " + e);
                        return;
                }
                // only listen to events directly coming from JMapPane
                // selection (ignore selections from FilterDialog)
                if (e.getSourceObject() != this.mapPane)
                        return;

                FeatureSelectedEvent fse = (FeatureSelectedEvent) e;

                // ignore event if it is caused by the DpLayerVectorSelectionModel
                if (selectionChangeCausedByMe)
                        return;

                LOGGER.debug("Do event " + fse);

                // Avoid event circles in propertyChange(..)
                selectionChangeCausedByMe = true;

                if (selectedTool == MapPaneToolBar.TOOL_SELECTION_CLEAR) {
                        layerSelModel.clearSelection();
                } else {
                        Collection<Feature> selectionResult = (Collection<Feature>) fse
                                        .getSelectionResult();

                        // reset the selection of the DpLayerSelectionModel
                        // layerSelModel.setValueIsAdjusting(true);

                        if (selectedTool == MapPaneToolBar.TOOL_SELECTION_ADD) {
                                layerSelModel.setValueIsAdjusting(true);
                                for (Feature f : selectionResult) {
                                        layerSelModel.addSelection(f.getID());
                                }
                                layerSelModel.setValueIsAdjusting(false);
                        } else if (selectedTool == MapPaneToolBar.TOOL_SELECTION_SET) {
                                layerSelModel.setValueIsAdjusting(true);
                                layerSelModel.clearSelection();

                                for (Feature f : selectionResult) {
                                        layerSelModel.addSelection(f.getID());
                                }

                                LOGGER.debug("Setting selection to " + selectionResult.size());
                                layerSelModel.setValueIsAdjusting(false);
                        } else if (selectedTool == MapPaneToolBar.TOOL_SELECTION_REMOVE) {
                                layerSelModel.setValueIsAdjusting(true);
                                for (Feature f : selectionResult) {
                                        layerSelModel.removeSelection(f.getID());
                                }
                                layerSelModel.setValueIsAdjusting(false);
                        }
                } // els it's not a Clear Selection command

                // Show selected features in the map, which is not automatically done by
                // the origin: FeatureSelectedEvent
                changeLayerStyle(layerSelModel.getSelection());

                // Danger of event circles in propertyChange(..) banned
                selectionChangeCausedByMe = false;
        }
}
1	/**
2	Copyright 2008 Stefan Alfons Krüger
3
4	atlas-framework - This file is part of the Atlas Framework
5
6	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.
7	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.
8	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
9
10	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.
11	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.
12	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.
13	**/
14	package skrueger.geotools.selection;
15
16	import java.beans.PropertyChangeEvent;
17	import java.beans.PropertyChangeListener;
18	import java.util.Arrays;
19	import java.util.Collection;
20	import java.util.Vector;
21
22	import javax.swing.JTable;
23	import javax.swing.ListSelectionModel;
24	import javax.swing.event.ListSelectionListener;
25
26	import org.geotools.feature.Feature;
27	import org.geotools.map.MapLayer;
28	import org.geotools.styling.FeatureTypeStyle;
29	import org.geotools.styling.Style;
30	import org.opengis.filter.Filter;
31	import org.opengis.filter.FilterVisitor;
32
33	import schmitzm.geotools.gui.JMapPane;
34	import schmitzm.geotools.map.event.FeatureSelectedEvent;
35	import schmitzm.geotools.map.event.JMapPaneEvent;
36	import schmitzm.geotools.map.event.JMapPaneListener;
37	import schmitzm.geotools.styling.StylingUtil;
38	import schmitzm.lang.LangUtil;
39	import skrueger.geotools.MapPaneToolBar;
40	import skrueger.geotools.StyledMapInterface;
41
42	/**
43	* This class keeps the selection of a (feature) {@link JTable} synchronized
44	* with the {@link StyledLayerSelectionModel} of a layer. This is done by
45	* implementing:
46	* <ul>
47	* <li>a {@link PropertyChangeListener} which listens to the
48	* {@link StyledLayerSelectionModel} and accordingly changes the {@link JTable}
49	* selection</li>
50	* <li>a {@link ListSelectionListener} which listens to the {@link JTable} and
51	* accordingly changes the {@link StyledLayerSelectionModel} selection</li>
52	* </ul>
53	* After creating, the instance of this synchronizer must be added as listener
54	* to both, the {@link StyledLayerSelectionModel} and the table's
55	* {@link ListSelectionModel}.
56	*
57	* @author <a href="mailto:[email protected]">Martin Schmitz</a>
58	* (University of Bonn/Germany)
59	*/
60	public class FeatureMapLayerSelectionSynchronizer extends
61	StyledLayerSelectionModelSynchronizer<StyledFeatureLayerSelectionModel>
62	implements JMapPaneListener {
63	public static final String SELECTION_STYLING = "SELECTION";
64	/**
65	* Holds the {@link MapLayer} to keep synchronized with the layer selection
66	* model.
67	*/
68	protected final MapLayer mapLayer;
69	protected final StyledMapInterface<?> styledMapLayer;
70	protected final JMapPane mapPane;
71	private final MapPaneToolBar toolBar;
72
73	/**
74	* Creates a new synchronizer
75	*
76	* @param layerSelModel
77	* layer selection model to keep synchronized with the
78	* {@link MapLayer}
79	*
80	* @param mapLayer
81	* {@link MapLayer} to keep synchronized with.
82	*/
83	public FeatureMapLayerSelectionSynchronizer(
84	StyledFeatureLayerSelectionModel layerSelModel,
85	StyledMapInterface<?> styledMapLayer, MapLayer mapLayer,
86	JMapPane mapPane, MapPaneToolBar toolBar) {
87
88	super(layerSelModel);
89	this.styledMapLayer = styledMapLayer;
90
91	this.mapLayer = mapLayer;
92	this.mapPane = mapPane;
93	this.toolBar = toolBar;
94	}
95
96	/**
97	* Called by {@link StyledLayerSelectionModel} when a the selection on other
98	* selection components (map, chart, ...) has changed. When calling this
99	*
100	* method changes the {@link MapLayer} selection according to the
101	* {@link StyledLayerSelectionModel} selection.
102	*
103	* @param evt
104	* an event
105	*/
106	@Override
107	public void propertyChange(PropertyChangeEvent evt) {
108	if (!(evt instanceof StyledLayerSelectionEvent))
109	return;
110	StyledLayerSelectionEvent selEvt = (StyledLayerSelectionEvent) evt;
111	// Only react on own layer and ignore events invoked by
112	// this component itself
113	if (selEvt.getEmitter() != layerSelModel \|\| selectionChangeCausedByMe)
114	return;
115	// Apply new selection on table (except this event is one of
116	// some more events)
117	Vector<String> newSelection = layerSelModel.getSelection();
118	if (newSelection == null)
119	return;
120
121	// Avoid event circles in valueChanged(..)
122	selectionChangeCausedByMe = true;
123
124	changeLayerStyle(newSelection);
125
126	// Danger of event circles in valueChanged(..) banned
127	selectionChangeCausedByMe = false;
128	}
129
130	private void changeLayerStyle(final Vector<String> newSelection) {
131	Style selectionMapStyle = null;
132	try {
133	if (newSelection.isEmpty()) {
134
135	selectionMapStyle = styledMapLayer.getStyle();
136	LOGGER.debug("NO SELECTION .. set to original style directly");
137
138	} else {
139	LOGGER.debug("SELECTION .. change style");
140
141	// We take Style from the MapLayer that is displayed at the
142	// moment. We do not use the styledMapLayer.getStyle, because in
143	// the atlas, this always return the default style, but
144	// additionaly styles might be selected.
145	// Taking the style from the mapLayer indicated, that we have to
146	// remove any selection rules first.
147	Style originalStyle = mapLayer.getStyle();
148
149	// TODO The default style is not good here. We need
150	// .createSelectionStyle(normalStyle, geoObj);
151	selectionMapStyle = StylingUtil
152	.createSelectionStyle(styledMapLayer.getGeoObject());
153	// selectionMapStyle = StylingUtil
154	// .createDefaultStyle(styledMapLayer.getGeoObject());
155
156	selectionMapStyle.getFeatureTypeStyles()[0]
157	.setName(SELECTION_STYLING);
158
159	// Rule selectedRule = StylingUtil.STYLE_FACTORY.createRule();
160	selectionMapStyle.getFeatureTypeStyles()[0].getRules()[0]
161	.setFilter(new Filter() {
162
163	@Override
164	public Object accept(FilterVisitor visitor,
165	Object extraData) {
166	return null;
167	}
168
169	@Override
170	public boolean evaluate(Object obj) {
171	if (obj instanceof Feature) {
172	Feature f = (Feature) obj;
173	// TODO BAD CODE! says Martin.. i am fine
174	// with it.. well.. not great...
175	for (String ffID : newSelection) {
176	if (ffID.equals(f.getID()))
177	return true;
178	}
179	return false;
180
181	}
182	return false;
183	}
184
185	});
186
187	FeatureTypeStyle[] originalFeatureTypeStyles = originalStyle
188	.getFeatureTypeStyles();
189	FeatureTypeStyle[] newFeatureTypes;
190	if (originalFeatureTypeStyles[originalFeatureTypeStyles.length - 1]
191	.getName() != null
192	&& originalFeatureTypeStyles[originalFeatureTypeStyles.length - 1]
193	.getName().equals(SELECTION_STYLING)) {
194	newFeatureTypes = Arrays.copyOf(originalFeatureTypeStyles,
195	originalFeatureTypeStyles.length - 1);
196	} else {
197	newFeatureTypes = originalFeatureTypeStyles;
198	}
199
200	// The last FTS is the selection FTS
201	newFeatureTypes = LangUtil.extendArray(newFeatureTypes,
202	selectionMapStyle.getFeatureTypeStyles());
203
204	selectionMapStyle.setFeatureTypeStyles(newFeatureTypes);
205
206	}
207
208	mapLayer.setStyle(selectionMapStyle);
209	mapPane.refresh();
210	} catch (Exception e) {
211	LOGGER.error("Error while trying to create a selection style", e);
212	}
213	}
214
215	@Override
216	public void performMapPaneEvent(JMapPaneEvent e) {
217
218	/**
219	* Only listen to FeatureSelectionEvents if the appropriate tool is
220	* selected.
221	*/
222	final int selectedTool = toolBar.getSelectedTool();
223	if (selectedTool != MapPaneToolBar.TOOL_SELECTION_ADD
224	&& selectedTool != MapPaneToolBar.TOOL_SELECTION_REMOVE
225	&& selectedTool != MapPaneToolBar.TOOL_SELECTION_CLEAR
226	&& selectedTool != MapPaneToolBar.TOOL_SELECTION_SET) {
227	return;
228	}
229
230	if (!(e instanceof FeatureSelectedEvent)) {
231	// LOGGER.debug("Ignoring event " + e);
232	return;
233	}
234	// only listen to events directly coming from JMapPane
235	// selection (ignore selections from FilterDialog)
236	if (e.getSourceObject() != this.mapPane)
237	return;
238
239	FeatureSelectedEvent fse = (FeatureSelectedEvent) e;
240
241	// ignore event if it is caused by the DpLayerVectorSelectionModel
242	if (selectionChangeCausedByMe)
243	return;
244
245	LOGGER.debug("Do event " + fse);
246
247	// Avoid event circles in propertyChange(..)
248	selectionChangeCausedByMe = true;
249
250	if (selectedTool == MapPaneToolBar.TOOL_SELECTION_CLEAR) {
251	layerSelModel.clearSelection();
252	} else {
253	Collection<Feature> selectionResult = (Collection<Feature>) fse
254	.getSelectionResult();
255
256	// reset the selection of the DpLayerSelectionModel
257	// layerSelModel.setValueIsAdjusting(true);
258
259	if (selectedTool == MapPaneToolBar.TOOL_SELECTION_ADD) {
260	layerSelModel.setValueIsAdjusting(true);
261	for (Feature f : selectionResult) {
262	layerSelModel.addSelection(f.getID());
263	}
264	layerSelModel.setValueIsAdjusting(false);
265	} else if (selectedTool == MapPaneToolBar.TOOL_SELECTION_SET) {
266	layerSelModel.setValueIsAdjusting(true);
267	layerSelModel.clearSelection();
268
269	for (Feature f : selectionResult) {
270	layerSelModel.addSelection(f.getID());
271	}
272
273	LOGGER.debug("Setting selection to " + selectionResult.size());
274	layerSelModel.setValueIsAdjusting(false);
275	} else if (selectedTool == MapPaneToolBar.TOOL_SELECTION_REMOVE) {
276	layerSelModel.setValueIsAdjusting(true);
277	for (Feature f : selectionResult) {
278	layerSelModel.removeSelection(f.getID());
279	}
280	layerSelModel.setValueIsAdjusting(false);
281	}
282	} // els it's not a Clear Selection command
283
284	// Show selected features in the map, which is not automatically done by
285	// the origin: FeatureSelectedEvent
286	changeLayerStyle(layerSelModel.getSelection());
287
288	// Danger of event circles in propertyChange(..) banned
289	selectionChangeCausedByMe = false;
290	}
291	}
Name	Value
svn:eol-style	native
svn:keywords	Id
svn:mime-type	text/plain