geotools/selection/TableSelectionSynchronizer.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.Vector;

import javax.swing.JTable;
import javax.swing.ListSelectionModel;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.table.TableModel;

import org.geotools.feature.Feature;

import schmitzm.geotools.gui.FeatureCollectionTableModel;
import schmitzm.swing.table.PipedTableModel;
import schmitzm.swing.table.SelectionTableModel;
import skrueger.geotools.selection.StyledFeatureLayerSelectionModel;
import skrueger.geotools.selection.StyledLayerSelectionEvent;
import skrueger.geotools.selection.StyledLayerSelectionModel;

/**
 * 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 TableSelectionSynchronizer extends
                StyledLayerSelectionModelSynchronizer<StyledFeatureLayerSelectionModel>
                implements ListSelectionListener {
        /**
         * Holds the table to keep synchronized with the layer selection model.
         */
        protected JTable featureTable = null;
        /** Holds the table's data. */
        protected FeatureCollectionTableModel featureTableModel = null;

        /**
         * Creates a new synchronizer
         * 
         * @param layerSelModel
         *            layer selection model to keep synchronized with the feature
         *            table
         * @param table
         *            table to keep synchronized with the layer selection model
         */
        public TableSelectionSynchronizer(
                        StyledFeatureLayerSelectionModel layerSelModel, JTable table) {
                super(layerSelModel);

                TableModel model = table.getModel();
                if (model instanceof PipedTableModel)
                        model = ((PipedTableModel) table.getModel()).getPipedModel();

                if (!(model instanceof FeatureCollectionTableModel))
                        throw new IllegalArgumentException(
                                        "Table must have a model instance of FeatureCollectionTableModel");

                this.featureTableModel = (FeatureCollectionTableModel) model;
                this.featureTable = table;
        }

        /**
         * Called by {@link StyledLayerSelectionModel} when a the selection on other
         * selection components (map, chart, ...) has changed. When calling this
         * method changes the table 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;

                // LOGGER.debug("Table pop changed "+selEvt);
                // LOGGER.debug("Table pop changed to "+newSelection);

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

                ListSelectionModel tableSelModel = featureTable.getSelectionModel();
                tableSelModel.setValueIsAdjusting(true);
                tableSelModel.clearSelection();
                for (String fid : newSelection) {
                        int modelIdx = featureTableModel.findFeature(fid);
                        if (modelIdx >= 0) {
                                int tableIdx = featureTable.convertRowIndexToView(modelIdx);
                                tableSelModel.addSelectionInterval(tableIdx, tableIdx);
                        } else {
                                LOGGER
                                                .warn("Something that is not visible in the Table should be selected");
                        }
                }
                tableSelModel.setValueIsAdjusting(false); // event is fired
                // autmatically!

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

        /**
         * Called when the table selection is changed by the user. When calling this
         * method changes the selection of the {@link StyledLayerSelectionModel}.
         * 
         * @param evt
         *            an event
         */
        @Override
        public void valueChanged(ListSelectionEvent evt) {
                // ignore event if it is part of multiple events
                if (evt != null && evt.getValueIsAdjusting())
                        return;
                // ignore event if it is caused by the DpLayerVectorSelectionModel
                if (selectionChangeCausedByMe)
                        return;

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

                // reset the selection of the DpLayerSelectionModel
                layerSelModel.setValueIsAdjusting(true);
                LOGGER.debug("valueCahnged in TableSyncronizer vom Index "
                                + evt.getFirstIndex() + " to " + evt.getLastIndex());

                if (evt == null || (evt != null && evt.getFirstIndex() == -1)){
                        // If the value is changing because the filter has been changed (e.g.
                        // table structure change) the evt.getFirstIndex() is -1, but evt.getLastIndex is > -1
                        layerSelModel.clearSelection();
                } else{
                        
                        for (int i = evt.getFirstIndex(); i <= evt.getLastIndex(); i++) {
                                int featureIndex = featureTable.convertRowIndexToModel(i);
                                Feature changedFeature = featureTableModel.getFeature(featureIndex);
                                if (featureTable.isRowSelected(i))
                                        layerSelModel.addSelection(changedFeature.getID());
                                else
                                        layerSelModel.removeSelection(changedFeature.getID());
                        }
                }
                layerSelModel.setValueIsAdjusting(false);

                // Danger of event circles in propertyChange(..) banned
                selectionChangeCausedByMe = false;
        }
}
1	alfonx	96	/**
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.Vector;
19
20			import javax.swing.JTable;
21			import javax.swing.ListSelectionModel;
22			import javax.swing.event.ListSelectionEvent;
23			import javax.swing.event.ListSelectionListener;
24	alfonx	100	import javax.swing.table.TableModel;
25	alfonx	96
26			import org.geotools.feature.Feature;
27
28			import schmitzm.geotools.gui.FeatureCollectionTableModel;
29	alfonx	100	import schmitzm.swing.table.PipedTableModel;
30			import schmitzm.swing.table.SelectionTableModel;
31	alfonx	96	import skrueger.geotools.selection.StyledFeatureLayerSelectionModel;
32			import skrueger.geotools.selection.StyledLayerSelectionEvent;
33			import skrueger.geotools.selection.StyledLayerSelectionModel;
34
35			/**
36			* This class keeps the selection of a (feature) {@link JTable} synchronized
37	alfonx	100	* with the {@link StyledLayerSelectionModel} of a layer. This is done by
38			* implementing:
39	alfonx	96	* <ul>
40	alfonx	100	* <li>a {@link PropertyChangeListener} which listens to the
41			* {@link StyledLayerSelectionModel} and accordingly changes the {@link JTable}
42			* selection</li>
43			* <li>a {@link ListSelectionListener} which listens to the {@link JTable} and
44			* accordingly changes the {@link StyledLayerSelectionModel} selection</li>
45	alfonx	96	* </ul>
46	alfonx	100	* After creating, the instance of this synchronizer must be added as listener
47			* to both, the {@link StyledLayerSelectionModel} and the table's
48			* {@link ListSelectionModel}.
49			*
50			* @author <a href="mailto:[email protected]">Martin Schmitz</a>
51			* (University of Bonn/Germany)
52	alfonx	96	*/
53	alfonx	111	public class TableSelectionSynchronizer extends
54			StyledLayerSelectionModelSynchronizer<StyledFeatureLayerSelectionModel>
55			implements ListSelectionListener {
56	alfonx	100	/**
57			* Holds the table to keep synchronized with the layer selection model.
58			*/
59			protected JTable featureTable = null;
60			/** Holds the table's data. */
61			protected FeatureCollectionTableModel featureTableModel = null;
62
63			/**
64	alfonx	96	* Creates a new synchronizer
65			*
66			* @param layerSelModel
67			* layer selection model to keep synchronized with the feature
68			* table
69			* @param table
70			* table to keep synchronized with the layer selection model
71			*/
72	alfonx	111	public TableSelectionSynchronizer(
73			StyledFeatureLayerSelectionModel layerSelModel, JTable table) {
74	alfonx	96	super(layerSelModel);
75
76	alfonx	100	TableModel model = table.getModel();
77			if (model instanceof PipedTableModel)
78			model = ((PipedTableModel) table.getModel()).getPipedModel();
79
80			if (!(model instanceof FeatureCollectionTableModel))
81	alfonx	96	throw new IllegalArgumentException(
82			"Table must have a model instance of FeatureCollectionTableModel");
83
84	alfonx	100	this.featureTableModel = (FeatureCollectionTableModel) model;
85	alfonx	96	this.featureTable = table;
86			}
87
88	alfonx	100	/**
89			* Called by {@link StyledLayerSelectionModel} when a the selection on other
90			* selection components (map, chart, ...) has changed. When calling this
91			* method changes the table selection according to the
92			* {@link StyledLayerSelectionModel} selection.
93			*
94			* @param evt
95			* an event
96			*/
97			@Override
98			public void propertyChange(PropertyChangeEvent evt) {
99			if (!(evt instanceof StyledLayerSelectionEvent))
100			return;
101			StyledLayerSelectionEvent selEvt = (StyledLayerSelectionEvent) evt;
102			// Only react on own layer and ignore events invoked by
103			// this component itself
104			if (selEvt.getEmitter() != layerSelModel \|\| selectionChangeCausedByMe)
105			return;
106			// Apply new selection on table (except this event is one of
107			// some more events)
108	alfonx	111	Vector<String> newSelection = layerSelModel.getSelection();
109	alfonx	100	if (newSelection == null)
110			return;
111	alfonx	96
112	alfonx	111	// LOGGER.debug("Table pop changed "+selEvt);
113			// LOGGER.debug("Table pop changed to "+newSelection);
114
115	alfonx	100	// Avoid event circles in valueChanged(..)
116			selectionChangeCausedByMe = true;
117	alfonx	96
118	alfonx	100	ListSelectionModel tableSelModel = featureTable.getSelectionModel();
119			tableSelModel.setValueIsAdjusting(true);
120			tableSelModel.clearSelection();
121	alfonx	111	for (String fid : newSelection) {
122			int modelIdx = featureTableModel.findFeature(fid);
123	alfonx	100	if (modelIdx >= 0) {
124			int tableIdx = featureTable.convertRowIndexToView(modelIdx);
125			tableSelModel.addSelectionInterval(tableIdx, tableIdx);
126	alfonx	111	} else {
127			LOGGER
128			.warn("Something that is not visible in the Table should be selected");
129	alfonx	100	}
130			}
131			tableSelModel.setValueIsAdjusting(false); // event is fired
132			// autmatically!
133	alfonx	96
134	alfonx	100	// Danger of event circles in valueChanged(..) banned
135			selectionChangeCausedByMe = false;
136			}
137	alfonx	96
138	alfonx	100	/**
139			* Called when the table selection is changed by the user. When calling this
140			* method changes the selection of the {@link StyledLayerSelectionModel}.
141			*
142			* @param evt
143			* an event
144			*/
145			@Override
146			public void valueChanged(ListSelectionEvent evt) {
147			// ignore event if it is part of multiple events
148			if (evt != null && evt.getValueIsAdjusting())
149			return;
150			// ignore event if it is caused by the DpLayerVectorSelectionModel
151			if (selectionChangeCausedByMe)
152			return;
153
154			// Avoid event circles in propertyChange(..)
155			selectionChangeCausedByMe = true;
156
157			// reset the selection of the DpLayerSelectionModel
158			layerSelModel.setValueIsAdjusting(true);
159	alfonx	111	LOGGER.debug("valueCahnged in TableSyncronizer vom Index "
160			+ evt.getFirstIndex() + " to " + evt.getLastIndex());
161
162			if (evt == null \|\| (evt != null && evt.getFirstIndex() == -1)){
163			// If the value is changing because the filter has been changed (e.g.
164			// table structure change) the evt.getFirstIndex() is -1, but evt.getLastIndex is > -1
165			layerSelModel.clearSelection();
166			} else{
167
168			for (int i = evt.getFirstIndex(); i <= evt.getLastIndex(); i++) {
169			int featureIndex = featureTable.convertRowIndexToModel(i);
170			Feature changedFeature = featureTableModel.getFeature(featureIndex);
171			if (featureTable.isRowSelected(i))
172			layerSelModel.addSelection(changedFeature.getID());
173			else
174			layerSelModel.removeSelection(changedFeature.getID());
175			}
176	alfonx	100	}
177			layerSelModel.setValueIsAdjusting(false);
178
179			// Danger of event circles in propertyChange(..) banned
180			selectionChangeCausedByMe = false;
181			}
182	alfonx	96	}
Name	Value
svn:eol-style	native
svn:keywords	Id
svn:mime-type	text/plain