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.Set;
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.StyledMapInterface;

/**
 * This manager holds a set of objects which are <i>selected</i> for a {@link StyledMapInterface}.
 * 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 StyledMapInterface<?> styledMap;


  /** 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 styledMap styled map the selection is controlled of
   */
  public StyledLayerSelectionModel(StyledMapInterface<?> styledMap) {
        this.selectionObjects = new HashSet<E>();
        this.styledMap         = styledMap;
  }

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