source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/UserListDialog.java@ 10113

Last change on this file since 10113 was 9136, checked in by Don-vip, 9 years ago

sonar fixes + javadoc
  • Property svn:eol-style set to native
File size: 12.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trn;
6
7import java.awt.event.ActionEvent;
8import java.awt.event.KeyEvent;
9import java.awt.event.MouseAdapter;
10import java.awt.event.MouseEvent;
11import java.text.NumberFormat;
12import java.util.ArrayList;
13import java.util.Arrays;
14import java.util.Collection;
15import java.util.Collections;
16import java.util.HashMap;
17import java.util.HashSet;
18import java.util.Iterator;
19import java.util.LinkedList;
20import java.util.List;
21import java.util.Map;
22import java.util.Set;
23
24import javax.swing.AbstractAction;
25import javax.swing.JTable;
26import javax.swing.ListSelectionModel;
27import javax.swing.event.ListSelectionEvent;
28import javax.swing.event.ListSelectionListener;
29import javax.swing.table.DefaultTableModel;
30
31import org.openstreetmap.josm.Main;
32import org.openstreetmap.josm.actions.AbstractInfoAction;
33import org.openstreetmap.josm.data.SelectionChangedListener;
34import org.openstreetmap.josm.data.osm.DataSet;
35import org.openstreetmap.josm.data.osm.OsmPrimitive;
36import org.openstreetmap.josm.data.osm.User;
37import org.openstreetmap.josm.gui.MapView;
38import org.openstreetmap.josm.gui.SideButton;
39import org.openstreetmap.josm.gui.layer.Layer;
40import org.openstreetmap.josm.gui.layer.OsmDataLayer;
41import org.openstreetmap.josm.gui.util.GuiHelper;
42import org.openstreetmap.josm.tools.ImageProvider;
43import org.openstreetmap.josm.tools.OpenBrowser;
44import org.openstreetmap.josm.tools.Shortcut;
45import org.openstreetmap.josm.tools.Utils;
46
47/**
48 * Displays a dialog with all users who have last edited something in the
49 * selection area, along with the number of objects.
50 *
51 */
52public class UserListDialog extends ToggleDialog implements SelectionChangedListener, MapView.LayerChangeListener {
53
54 /**
55 * The display list.
56 */
57 private JTable userTable;
58 private UserTableModel model;
59 private SelectUsersPrimitivesAction selectionUsersPrimitivesAction;
60 private ShowUserInfoAction showUserInfoAction;
61
62 /**
63 * Constructs a new {@code UserListDialog}.
64 */
65 public UserListDialog() {
66 super(tr("Authors"), "userlist", tr("Open a list of people working on the selected objects."),
67 Shortcut.registerShortcut("subwindow:authors", tr("Toggle: {0}", tr("Authors")), KeyEvent.VK_A, Shortcut.ALT_SHIFT), 150);
68 build();
69 }
70
71 @Override
72 public void showNotify() {
73 DataSet.addSelectionListener(this);
74 MapView.addLayerChangeListener(this);
75 }
76
77 @Override
78 public void hideNotify() {
79 MapView.removeLayerChangeListener(this);
80 DataSet.removeSelectionListener(this);
81 }
82
83 protected void build() {
84 model = new UserTableModel();
85 userTable = new JTable(model);
86 userTable.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
87 userTable.addMouseListener(new DoubleClickAdapter());
88
89 // -- select users primitives action
90 //
91 selectionUsersPrimitivesAction = new SelectUsersPrimitivesAction();
92 userTable.getSelectionModel().addListSelectionListener(selectionUsersPrimitivesAction);
93
94 // -- info action
95 //
96 showUserInfoAction = new ShowUserInfoAction();
97 userTable.getSelectionModel().addListSelectionListener(showUserInfoAction);
98
99 createLayout(userTable, true, Arrays.asList(new SideButton[] {
100 new SideButton(selectionUsersPrimitivesAction),
101 new SideButton(showUserInfoAction)
102 }));
103 }
104
105 /**
106 * Called when the selection in the dataset changed.
107 * @param newSelection The new selection array.
108 */
109 @Override
110 public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
111 refresh(newSelection);
112 }
113
114 @Override
115 public void activeLayerChange(Layer oldLayer, Layer newLayer) {
116 if (newLayer instanceof OsmDataLayer) {
117 refresh(((OsmDataLayer) newLayer).data.getAllSelected());
118 } else {
119 refresh(null);
120 }
121 }
122
123 @Override
124 public void layerAdded(Layer newLayer) {
125 // do nothing
126 }
127
128 @Override
129 public void layerRemoved(Layer oldLayer) {
130 // do nothing
131 }
132
133 /**
134 * Refreshes user list from given collection of OSM primitives.
135 * @param fromPrimitives OSM primitives to fetch users from
136 */
137 public void refresh(Collection<? extends OsmPrimitive> fromPrimitives) {
138 model.populate(fromPrimitives);
139 GuiHelper.runInEDT(new Runnable() {
140 @Override
141 public void run() {
142 if (model.getRowCount() != 0) {
143 setTitle(trn("{0} Author", "{0} Authors", model.getRowCount(), model.getRowCount()));
144 } else {
145 setTitle(tr("Authors"));
146 }
147 }
148 });
149 }
150
151 @Override
152 public void showDialog() {
153 super.showDialog();
154 Layer layer = Main.main.getActiveLayer();
155 if (layer instanceof OsmDataLayer) {
156 refresh(((OsmDataLayer) layer).data.getAllSelected());
157 }
158 }
159
160 class SelectUsersPrimitivesAction extends AbstractAction implements ListSelectionListener {
161
162 /**
163 * Constructs a new {@code SelectUsersPrimitivesAction}.
164 */
165 SelectUsersPrimitivesAction() {
166 putValue(NAME, tr("Select"));
167 putValue(SHORT_DESCRIPTION, tr("Select objects submitted by this user"));
168 putValue(SMALL_ICON, ImageProvider.get("dialogs", "select"));
169 updateEnabledState();
170 }
171
172 public void select() {
173 int[] indexes = userTable.getSelectedRows();
174 if (indexes == null || indexes.length == 0)
175 return;
176 model.selectPrimitivesOwnedBy(userTable.getSelectedRows());
177 }
178
179 @Override
180 public void actionPerformed(ActionEvent e) {
181 select();
182 }
183
184 protected void updateEnabledState() {
185 setEnabled(userTable != null && userTable.getSelectedRowCount() > 0);
186 }
187
188 @Override
189 public void valueChanged(ListSelectionEvent e) {
190 updateEnabledState();
191 }
192 }
193
194 /**
195 * Action for launching the info page of a user.
196 */
197 class ShowUserInfoAction extends AbstractInfoAction implements ListSelectionListener {
198
199 ShowUserInfoAction() {
200 super(false);
201 putValue(NAME, tr("Show info"));
202 putValue(SHORT_DESCRIPTION, tr("Launches a browser with information about the user"));
203 putValue(SMALL_ICON, ImageProvider.get("help/internet"));
204 updateEnabledState();
205 }
206
207 @Override
208 public void actionPerformed(ActionEvent e) {
209 int[] rows = userTable.getSelectedRows();
210 if (rows == null || rows.length == 0)
211 return;
212 List<User> users = model.getSelectedUsers(rows);
213 if (users.isEmpty())
214 return;
215 if (users.size() > 10) {
216 Main.warn(tr("Only launching info browsers for the first {0} of {1} selected users", 10, users.size()));
217 }
218 int num = Math.min(10, users.size());
219 Iterator<User> it = users.iterator();
220 while (it.hasNext() && num > 0) {
221 String url = createInfoUrl(it.next());
222 if (url == null) {
223 break;
224 }
225 OpenBrowser.displayUrl(url);
226 num--;
227 }
228 }
229
230 @Override
231 protected String createInfoUrl(Object infoObject) {
232 if (infoObject instanceof User) {
233 User user = (User) infoObject;
234 return Main.getBaseUserUrl() + '/' + Utils.encodeUrl(user.getName()).replaceAll("\\+", "%20");
235 } else {
236 return null;
237 }
238 }
239
240 @Override
241 protected void updateEnabledState() {
242 setEnabled(userTable != null && userTable.getSelectedRowCount() > 0);
243 }
244
245 @Override
246 public void valueChanged(ListSelectionEvent e) {
247 updateEnabledState();
248 }
249 }
250
251 class DoubleClickAdapter extends MouseAdapter {
252 @Override
253 public void mouseClicked(MouseEvent e) {
254 if (e.getButton() == MouseEvent.BUTTON1 && e.getClickCount() == 2) {
255 selectionUsersPrimitivesAction.select();
256 }
257 }
258 }
259
260 /**
261 * Action for selecting the primitives contributed by the currently selected users.
262 *
263 */
264 private static class UserInfo implements Comparable<UserInfo> {
265 public final User user;
266 public final int count;
267 public final double percent;
268
269 UserInfo(User user, int count, double percent) {
270 this.user = user;
271 this.count = count;
272 this.percent = percent;
273 }
274
275 @Override
276 public int compareTo(UserInfo o) {
277 if (count < o.count)
278 return 1;
279 if (count > o.count)
280 return -1;
281 if (user == null || user.getName() == null)
282 return 1;
283 if (o.user == null || o.user.getName() == null)
284 return -1;
285 return user.getName().compareTo(o.user.getName());
286 }
287
288 public String getName() {
289 if (user == null)
290 return tr("<new object>");
291 return user.getName();
292 }
293 }
294
295 /**
296 * The table model for the users
297 *
298 */
299 static class UserTableModel extends DefaultTableModel {
300 private final transient List<UserInfo> data;
301
302 UserTableModel() {
303 setColumnIdentifiers(new String[]{tr("Author"), tr("# Objects"), "%"});
304 data = new ArrayList<>();
305 }
306
307 protected Map<User, Integer> computeStatistics(Collection<? extends OsmPrimitive> primitives) {
308 Map<User, Integer> ret = new HashMap<>();
309 if (primitives == null || primitives.isEmpty())
310 return ret;
311 for (OsmPrimitive primitive: primitives) {
312 if (ret.containsKey(primitive.getUser())) {
313 ret.put(primitive.getUser(), ret.get(primitive.getUser()) + 1);
314 } else {
315 ret.put(primitive.getUser(), 1);
316 }
317 }
318 return ret;
319 }
320
321 public void populate(Collection<? extends OsmPrimitive> primitives) {
322 Map<User, Integer> statistics = computeStatistics(primitives);
323 data.clear();
324 if (primitives != null) {
325 for (Map.Entry<User, Integer> entry: statistics.entrySet()) {
326 data.add(new UserInfo(entry.getKey(), entry.getValue(), (double) entry.getValue() / (double) primitives.size()));
327 }
328 }
329 Collections.sort(data);
330 GuiHelper.runInEDTAndWait(new Runnable() {
331 @Override
332 public void run() {
333 fireTableDataChanged();
334 }
335 });
336 }
337
338 @Override
339 public int getRowCount() {
340 if (data == null)
341 return 0;
342 return data.size();
343 }
344
345 @Override
346 public Object getValueAt(int row, int column) {
347 UserInfo info = data.get(row);
348 switch(column) {
349 case 0: /* author */ return info.getName() == null ? "" : info.getName();
350 case 1: /* count */ return info.count;
351 case 2: /* percent */ return NumberFormat.getPercentInstance().format(info.percent);
352 default: return null;
353 }
354 }
355
356 @Override
357 public boolean isCellEditable(int row, int column) {
358 return false;
359 }
360
361 public void selectPrimitivesOwnedBy(int[] rows) {
362 Set<User> users = new HashSet<>();
363 for (int index: rows) {
364 users.add(data.get(index).user);
365 }
366 Collection<OsmPrimitive> selected = Main.main.getCurrentDataSet().getAllSelected();
367 Collection<OsmPrimitive> byUser = new LinkedList<>();
368 for (OsmPrimitive p : selected) {
369 if (users.contains(p.getUser())) {
370 byUser.add(p);
371 }
372 }
373 Main.main.getCurrentDataSet().setSelected(byUser);
374 }
375
376 public List<User> getSelectedUsers(int[] rows) {
377 List<User> ret = new LinkedList<>();
378 if (rows == null || rows.length == 0)
379 return ret;
380 for (int row: rows) {
381 if (data.get(row).user == null) {
382 continue;
383 }
384 ret.add(data.get(row).user);
385 }
386 return ret;
387 }
388 }
389}
Note: See TracBrowser for help on using the repository browser.