geotools/selection/StyledLayerSelectionModel.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.Collection;
import java.util.HashSet;
import java.util.Vector;

import javax.swing.event.EventListenerList;

import org.apache.log4j.Logger;
import org.geotools.feature.Feature;

import schmitzm.swing.event.PropertyChangeEmitter;
import skrueger.geotools.StyledLayerInterface;

/**
 * This manager holds a set of objects which are <i>selected</i> for a {@link StyledLayerInterface}.
 * Several components can connect to this model to keep their selection synchronized.
 * @see #addSelectionListener(java.beans.PropertyChangeListener)
 * @see StyledLayerSelectionModelSynchronizer
 * @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
 */
public abstract class StyledLayerSelectionModel<E> extends PropertyChangeEmitter<StyledLayerSelectionModelSynchronizer<StyledLayerSelectionModel<E>>> {
  /** A static logger for this class  */
  protected final Logger LOGGER = Logger.getLogger(this.getClass());

  /** Indicates that the selection has changed in {@link PropertyChangeEvent}. */
  public final static String SELECTION = "SELECTION";


  /** Holds the connected listeners. */
  protected EventListenerList listenerList = new EventListenerList();

  /** Holds the current selection (e.g. {@link Feature Features}). */
  protected final HashSet<E> selectionObjects;

  /** Holds the styled map whose selection is managed by this class. */
  protected final StyledLayerInterface<?> styledLayer;


  /** Indicates whether a selection change is a part of multiple
   *  changes. If {@code true} {@link #refreshSelection()} has NO effect
   *  until {@link #setValueIsAdjusting(boolean) setValueIsAdjusting(false)}
   *  is called. */
  private boolean valueIsAdjusting = false;

  /**
   * Creates a new selection model.
   * @param styledLayer styled layer the selection is controlled of
   */
  public StyledLayerSelectionModel(StyledLayerInterface<?> styledLayer) {
        this.selectionObjects = new HashSet<E>();
        this.styledLayer         = styledLayer;
  }

  /**
   * Fires an event to every connected listener to update their selection
   * according to the selection of this model.<br>
   * <b>Does nothing if adjusting is <code>true</code></b>.
   */
  public void refreshSelection() {
    if ( getValueIsAdjusting() )
      return;
    firePropertyChangeEvent( createSelectionChangeEvent(null) );
  }

  /**
   * Clears the selection and fires an event to every connected listener
   * to update their selection.
   */
  public void clearSelection() {
    selectionObjects.clear();
    refreshSelection();
  }

  /**
   * Creates a simple {@link PropertyChangeEvent} for property {@link #SELECTION}
   * with no new and old value, just to inform the listeners THAT
   * some selection has changed.
   * Subclasses may overwrite this method to create more sophisticated
   * events.
   * @param respObject object which is responsible for the selection change; this
   *                   object should ignore this event to avoid event circles (can be {@code null}
   *                   in case of general refresh events; in this case all connected
   *                   components will refresh their selection)
   *
   */
  public StyledLayerSelectionEvent createSelectionChangeEvent(Object respObject) {
    if ( respObject == null )
      respObject = this;
    return new StyledLayerSelectionEvent(this,respObject,SELECTION,null,null);
  }


  /**
   * Returns whether the current selection change is a part of multiple
   * changes. If {@code true} {@link #refreshSelection()} has no effect
   * and no {@link StyledLayerSelectionEvent} is fired until
   * {@link #setValueIsAdjusting(boolean) setValueIsAdjusting(false)}
   * is called.
   */
  public boolean getValueIsAdjusting() {
    return this.valueIsAdjusting;
  }

  /**
   * Sets whether the following selection changes are part of multiple
   * changes. If {@code true} {@link #refreshSelection()} has no effect
   * and no {@link StyledLayerSelectionEvent} event is fired.
   * If the value is set from {@code true} to {@code false} an automatic
   * refresh is initiated.
   * @see #refreshSelection()
   */
  public void setValueIsAdjusting(boolean valueIsAdjusting) {
    if ( valueIsAdjusting != this.valueIsAdjusting ) {
      this.valueIsAdjusting = valueIsAdjusting;
      if ( !this.valueIsAdjusting )
        refreshSelection();
    }
  }


  /**
   * Extends the current selection by an individual object.
   * @param selectedObject defines the (new) selected object
   * @return {@code true} if selection has changed by calling this method
   */
  public boolean addSelection(E selectedObject) {
         
    if ( selectionObjects.add(selectedObject) ) {
      refreshSelection();
      return true;
    }
    return false;
  }

  /**
   * Removes an individual object from the current selection.
   * @param unselectedObject defines an object which will be unselected
   * @return {@code true} if selection has changed by calling this method
   */
  public boolean removeSelection(E unselectedObject) {
    if ( selectionObjects.remove(unselectedObject) ) {
      refreshSelection();
      return true;
    }
    return false;
  }

  /**
   * Extends the current selection by individual objects.
   * @param selectedObjects defines some objects which will be selected
   * @return {@code true} if selection has changed by calling this method
   */
  public boolean addSelection(Collection<E> selectedObjects) {
    if ( selectionObjects.addAll(selectedObjects) ) {
      refreshSelection();
      return true;
    }
    return false;
  }

  /**
   * Removes individual objects from the current selection.
   * @param unselectedObjects defines some objects which will be unselected
   * @return {@code true} if selection has changed by calling this method
   */
  public boolean removeSelection(Collection<E> unselectedObjects) {
    if ( selectionObjects.removeAll(unselectedObjects) ) {
      refreshSelection();
      return true;
    }
    return false;
  }

  /**
   * Returns all selected objects as list.
   * @return a copy of the original list, so changes have no effect!
   */
  public Vector<E> getSelection() {
    return new Vector<E>(selectionObjects);
  }

  /**
   * Adds a listener to the listener list. Only alias for {@link #addListener(PropertyChangeListener)}.
   * @param listener a listener
   */
  public void addSelectionListener(StyledLayerSelectionModelSynchronizer<StyledLayerSelectionModel<E>> listener) {
    this.addListener(listener);
  }

  /**
   * Removes a listener from the listener list. Only alias for {@link #removeListener(PropertyChangeListener)}.
   * @param listener a listener
   */
  public void removeSelectionListener(StyledLayerSelectionModelSynchronizer<StyledLayerSelectionModel<E>> listener) {
    this.removeListener(listener);
  }


}
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
15	package skrueger.geotools.selection;
16
17	import java.beans.PropertyChangeEvent;
18	import java.beans.PropertyChangeListener;
19	import java.util.Collection;
20	import java.util.HashSet;
21	import java.util.Vector;
22
23	import javax.swing.event.EventListenerList;
24
25	import org.apache.log4j.Logger;
26	import org.geotools.feature.Feature;
27
28	import schmitzm.swing.event.PropertyChangeEmitter;
29	import skrueger.geotools.StyledLayerInterface;
30
31	/**
32	* This manager holds a set of objects which are <i>selected</i> for a {@link StyledLayerInterface}.
33	* Several components can connect to this model to keep their selection synchronized.
34	* @see #addSelectionListener(java.beans.PropertyChangeListener)
35	* @see StyledLayerSelectionModelSynchronizer
36	* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
37	*/
38	public abstract class StyledLayerSelectionModel<E> extends PropertyChangeEmitter<StyledLayerSelectionModelSynchronizer<StyledLayerSelectionModel<E>>> {
39	/** A static logger for this class */
40	protected final Logger LOGGER = Logger.getLogger(this.getClass());
41
42	/** Indicates that the selection has changed in {@link PropertyChangeEvent}. */
43	public final static String SELECTION = "SELECTION";
44
45
46	/** Holds the connected listeners. */
47	protected EventListenerList listenerList = new EventListenerList();
48
49	/** Holds the current selection (e.g. {@link Feature Features}). */
50	protected final HashSet<E> selectionObjects;
51
52	/** Holds the styled map whose selection is managed by this class. */
53	protected final StyledLayerInterface<?> styledLayer;
54
55
56	/** Indicates whether a selection change is a part of multiple
57	* changes. If {@code true} {@link #refreshSelection()} has NO effect
58	* until {@link #setValueIsAdjusting(boolean) setValueIsAdjusting(false)}
59	* is called. */
60	private boolean valueIsAdjusting = false;
61
62	/**
63	* Creates a new selection model.
64	* @param styledLayer styled layer the selection is controlled of
65	*/
66	public StyledLayerSelectionModel(StyledLayerInterface<?> styledLayer) {
67	this.selectionObjects = new HashSet<E>();
68	this.styledLayer = styledLayer;
69	}
70
71	/**
72	* Fires an event to every connected listener to update their selection
73	* according to the selection of this model.<br>
74	* <b>Does nothing if adjusting is <code>true</code></b>.
75	*/
76	public void refreshSelection() {
77	if ( getValueIsAdjusting() )
78	return;
79	firePropertyChangeEvent( createSelectionChangeEvent(null) );
80	}
81
82	/**
83	* Clears the selection and fires an event to every connected listener
84	* to update their selection.
85	*/
86	public void clearSelection() {
87	selectionObjects.clear();
88	refreshSelection();
89	}
90
91	/**
92	* Creates a simple {@link PropertyChangeEvent} for property {@link #SELECTION}
93	* with no new and old value, just to inform the listeners THAT
94	* some selection has changed.
95	* Subclasses may overwrite this method to create more sophisticated
96	* events.
97	* @param respObject object which is responsible for the selection change; this
98	* object should ignore this event to avoid event circles (can be {@code null}
99	* in case of general refresh events; in this case all connected
100	* components will refresh their selection)
101	*
102	*/
103	public StyledLayerSelectionEvent createSelectionChangeEvent(Object respObject) {
104	if ( respObject == null )
105	respObject = this;
106	return new StyledLayerSelectionEvent(this,respObject,SELECTION,null,null);
107	}
108
109
110	/**
111	* Returns whether the current selection change is a part of multiple
112	* changes. If {@code true} {@link #refreshSelection()} has no effect
113	* and no {@link StyledLayerSelectionEvent} is fired until
114	* {@link #setValueIsAdjusting(boolean) setValueIsAdjusting(false)}
115	* is called.
116	*/
117	public boolean getValueIsAdjusting() {
118	return this.valueIsAdjusting;
119	}
120
121	/**
122	* Sets whether the following selection changes are part of multiple
123	* changes. If {@code true} {@link #refreshSelection()} has no effect
124	* and no {@link StyledLayerSelectionEvent} event is fired.
125	* If the value is set from {@code true} to {@code false} an automatic
126	* refresh is initiated.
127	* @see #refreshSelection()
128	*/
129	public void setValueIsAdjusting(boolean valueIsAdjusting) {
130	if ( valueIsAdjusting != this.valueIsAdjusting ) {
131	this.valueIsAdjusting = valueIsAdjusting;
132	if ( !this.valueIsAdjusting )
133	refreshSelection();
134	}
135	}
136
137
138	/**
139	* Extends the current selection by an individual object.
140	* @param selectedObject defines the (new) selected object
141	* @return {@code true} if selection has changed by calling this method
142	*/
143	public boolean addSelection(E selectedObject) {
144
145	if ( selectionObjects.add(selectedObject) ) {
146	refreshSelection();
147	return true;
148	}
149	return false;
150	}
151
152	/**
153	* Removes an individual object from the current selection.
154	* @param unselectedObject defines an object which will be unselected
155	* @return {@code true} if selection has changed by calling this method
156	*/
157	public boolean removeSelection(E unselectedObject) {
158	if ( selectionObjects.remove(unselectedObject) ) {
159	refreshSelection();
160	return true;
161	}
162	return false;
163	}
164
165	/**
166	* Extends the current selection by individual objects.
167	* @param selectedObjects defines some objects which will be selected
168	* @return {@code true} if selection has changed by calling this method
169	*/
170	public boolean addSelection(Collection<E> selectedObjects) {
171	if ( selectionObjects.addAll(selectedObjects) ) {
172	refreshSelection();
173	return true;
174	}
175	return false;
176	}
177
178	/**
179	* Removes individual objects from the current selection.
180	* @param unselectedObjects defines some objects which will be unselected
181	* @return {@code true} if selection has changed by calling this method
182	*/
183	public boolean removeSelection(Collection<E> unselectedObjects) {
184	if ( selectionObjects.removeAll(unselectedObjects) ) {
185	refreshSelection();
186	return true;
187	}
188	return false;
189	}
190
191	/**
192	* Returns all selected objects as list.
193	* @return a copy of the original list, so changes have no effect!
194	*/
195	public Vector<E> getSelection() {
196	return new Vector<E>(selectionObjects);
197	}
198
199	/**
200	* Adds a listener to the listener list. Only alias for {@link #addListener(PropertyChangeListener)}.
201	* @param listener a listener
202	*/
203	public void addSelectionListener(StyledLayerSelectionModelSynchronizer<StyledLayerSelectionModel<E>> listener) {
204	this.addListener(listener);
205	}
206
207	/**
208	* Removes a listener from the listener list. Only alias for {@link #removeListener(PropertyChangeListener)}.
209	* @param listener a listener
210	*/
211	public void removeSelectionListener(StyledLayerSelectionModelSynchronizer<StyledLayerSelectionModel<E>> listener) {
212	this.removeListener(listener);
213	}
214
215
216	}
Name	Value
svn:eol-style	native
svn:keywords	Id
svn:mime-type	text/plain