source: josm/trunk/src/org/openstreetmap/josm/data/validation/tests/DuplicateRelation.java@ 5608

Last change on this file since 5608 was 5608, checked in by stoecker, 11 years ago

don't hardcode created_by for DuplicateRelation validator test, javadoc fixes
File size: 11.1 KB
Line 
1// License: GPL. See LICENSE file for details.
2package org.openstreetmap.josm.data.validation.tests;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.util.ArrayList;
7import java.util.Collection;
8import java.util.HashSet;
9import java.util.LinkedHashSet;
10import java.util.LinkedList;
11import java.util.List;
12import java.util.Map;
13
14import org.openstreetmap.josm.command.ChangeCommand;
15import org.openstreetmap.josm.command.Command;
16import org.openstreetmap.josm.command.DeleteCommand;
17import org.openstreetmap.josm.command.SequenceCommand;
18import org.openstreetmap.josm.data.coor.LatLon;
19import org.openstreetmap.josm.data.osm.Node;
20import org.openstreetmap.josm.data.osm.OsmPrimitive;
21import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
22import org.openstreetmap.josm.data.osm.Relation;
23import org.openstreetmap.josm.data.osm.RelationMember;
24import org.openstreetmap.josm.data.osm.Way;
25import org.openstreetmap.josm.data.validation.Severity;
26import org.openstreetmap.josm.data.validation.Test;
27import org.openstreetmap.josm.data.validation.TestError;
28import org.openstreetmap.josm.gui.progress.ProgressMonitor;
29import org.openstreetmap.josm.tools.MultiMap;
30
31/**
32 * Tests if there are duplicate relations
33 */
34public class DuplicateRelation extends Test {
35
36 /**
37 * Class to store one relation members and information about it
38 */
39 public static class RelMember {
40 /** Role of the relation member */
41 private String role;
42
43 /** Type of the relation member */
44 private OsmPrimitiveType type;
45
46 /** Tags of the relation member */
47 private Map<String, String> tags;
48
49 /** Coordinates of the relation member */
50 private List<LatLon> coor;
51
52 /** ID of the relation member in case it is a {@link Relation} */
53 private long rel_id;
54
55 @Override
56 public int hashCode() {
57 return role.hashCode()+(int)rel_id+tags.hashCode()+type.hashCode()+coor.hashCode();
58 }
59
60 @Override
61 public boolean equals(Object obj) {
62 if (!(obj instanceof RelMember)) return false;
63 RelMember rm = (RelMember) obj;
64 return rm.role.equals(role) && rm.type.equals(type) && rm.rel_id==rel_id && rm.tags.equals(tags) && rm.coor.equals(coor);
65 }
66
67 /** Extract and store relation information based on the relation member
68 * @param src The relation member to store information about
69 */
70 public RelMember(RelationMember src) {
71 role = src.getRole();
72 type = src.getType();
73 rel_id = 0;
74 coor = new ArrayList<LatLon>();
75
76 if (src.isNode()) {
77 Node r = src.getNode();
78 tags = r.getKeys();
79 coor = new ArrayList<LatLon>(1);
80 coor.add(r.getCoor());
81 }
82 if (src.isWay()) {
83 Way r = src.getWay();
84 tags = r.getKeys();
85 List<Node> wNodes = r.getNodes();
86 coor = new ArrayList<LatLon>(wNodes.size());
87 for (int i = 0; i < wNodes.size(); i++) {
88 coor.add(wNodes.get(i).getCoor());
89 }
90 }
91 if (src.isRelation()) {
92 Relation r = src.getRelation();
93 tags = r.getKeys();
94 rel_id = r.getId();
95 coor = new ArrayList<LatLon>();
96 }
97 }
98 }
99
100 /**
101 * Class to store relation members
102 */
103 private class RelationMembers {
104 /** List of member objects of the relation */
105 public List<RelMember> members;
106
107 /** Store relation information
108 * @param members The list of relation members
109 */
110 public RelationMembers(List<RelationMember> members) {
111 this.members = new ArrayList<RelMember>(members.size());
112 for (int i = 0; i < members.size(); i++) {
113 this.members.add(new RelMember(members.get(i)));
114 }
115 }
116
117 @Override
118 public int hashCode() {
119 return members.hashCode();
120 }
121
122 @Override
123 public boolean equals(Object obj) {
124 if (!(obj instanceof RelationMembers)) return false;
125 RelationMembers rm = (RelationMembers) obj;
126 return rm.members.equals(members);
127 }
128 }
129
130 /**
131 * Class to store relation data (keys are usually cleanup and may not be equal to original relation)
132 */
133 private class RelationPair {
134 /** Member objects of the relation */
135 public RelationMembers members;
136 /** Tags of the relation */
137 public Map<String, String> keys;
138
139 /** Store relation information
140 * @param members The list of relation members
141 * @param keys The set of tags of the relation
142 */
143 public RelationPair(List<RelationMember> members, Map<String, String> keys) {
144 this.members = new RelationMembers(members);
145 this.keys = keys;
146 }
147
148 @Override
149 public int hashCode() {
150 return members.hashCode()+keys.hashCode();
151 }
152
153 @Override
154 public boolean equals(Object obj) {
155 if (!(obj instanceof RelationPair)) return false;
156 RelationPair rp = (RelationPair) obj;
157 return rp.members.equals(members) && rp.keys.equals(keys);
158 }
159 }
160
161 /** Code number of completely duplicated relation error */
162 protected static final int DUPLICATE_RELATION = 1901;
163
164 /** Code number of relation with same members error */
165 protected static final int SAME_RELATION = 1902;
166
167 /** MultiMap of all relations */
168 MultiMap<RelationPair, OsmPrimitive> relations;
169
170 /** MultiMap of all relations, regardless of keys */
171 MultiMap<List<RelationMember>, OsmPrimitive> relations_nokeys;
172
173 /** List of keys without useful information */
174 Collection<String> ignoreKeys = new HashSet<String>(OsmPrimitive.getUninterestingKeys());
175
176 /**
177 * Default constructor
178 */
179 public DuplicateRelation() {
180 super(tr("Duplicated relations"),
181 tr("This test checks that there are no relations with same tags and same members with same roles."));
182 }
183
184 @Override
185 public void startTest(ProgressMonitor monitor) {
186 super.startTest(monitor);
187 relations = new MultiMap<RelationPair, OsmPrimitive>(1000);
188 relations_nokeys = new MultiMap<List<RelationMember>, OsmPrimitive>(1000);
189 }
190
191 @Override
192 public void endTest() {
193 super.endTest();
194 for(LinkedHashSet<OsmPrimitive> duplicated : relations.values()) {
195 if (duplicated.size() > 1) {
196 TestError testError = new TestError(this, Severity.ERROR, tr("Duplicated relations"), DUPLICATE_RELATION, duplicated);
197 errors.add( testError );
198 }
199 }
200 relations = null;
201 for(LinkedHashSet<OsmPrimitive> duplicated : relations_nokeys.values()) {
202 if (duplicated.size() > 1) {
203 TestError testError = new TestError(this, Severity.WARNING, tr("Relations with same members"), SAME_RELATION, duplicated);
204 errors.add( testError );
205 }
206 }
207 relations_nokeys = null;
208 }
209
210 @Override
211 public void visit(Relation r) {
212 if (!r.isUsable() || r.hasIncompleteMembers())
213 return;
214 List<RelationMember> rMembers = r.getMembers();
215 Map<String, String> rkeys = r.getKeys();
216 for (String key : ignoreKeys)
217 rkeys.remove(ignoreKeys);
218 RelationPair rKey = new RelationPair(rMembers, rkeys);
219 relations.put(rKey, r);
220 relations_nokeys.put(rMembers, r);
221 }
222
223 /**
224 * Fix the error by removing all but one instance of duplicate relations
225 * @param testError The error to fix, must be of type {@link #DUPLICATE_RELATION}
226 */
227 @Override
228 public Command fixError(TestError testError) {
229 if (testError.getCode() == SAME_RELATION) return null;
230 Collection<? extends OsmPrimitive> sel = testError.getPrimitives();
231 HashSet<Relation> rel_fix = new HashSet<Relation>();
232
233 for (OsmPrimitive osm : sel)
234 if (osm instanceof Relation) {
235 rel_fix.add((Relation)osm);
236 }
237
238 if( rel_fix.size() < 2 )
239 return null;
240
241 long idToKeep = 0;
242 Relation relationToKeep = rel_fix.iterator().next();
243 // Only one relation will be kept - the one with lowest positive ID, if such exist
244 // or one "at random" if no such exists. Rest of the relations will be deleted
245 for (Relation w: rel_fix) {
246 if (!w.isNew()) {
247 if (idToKeep == 0 || w.getId() < idToKeep) {
248 idToKeep = w.getId();
249 relationToKeep = w;
250 }
251 }
252 }
253
254 // Find the relation that is member of one or more relations. (If any)
255 Relation relationWithRelations = null;
256 List<Relation> rel_ref = null;
257 for (Relation w : rel_fix) {
258 List<Relation> rel = OsmPrimitive.getFilteredList(w.getReferrers(), Relation.class);
259 if (!rel.isEmpty()) {
260 if (relationWithRelations != null)
261 throw new AssertionError("Cannot fix duplicate relations: More than one relation is member of another relation.");
262 relationWithRelations = w;
263 rel_ref = rel;
264 }
265 }
266
267 Collection<Command> commands = new LinkedList<Command>();
268
269 // Fix relations.
270 if (relationWithRelations != null && relationToKeep != relationWithRelations) {
271 for (Relation rel : rel_ref) {
272 Relation newRel = new Relation(rel);
273 for (int i = 0; i < newRel.getMembers().size(); ++i) {
274 RelationMember m = newRel.getMember(i);
275 if (relationWithRelations.equals(m.getMember())) {
276 newRel.setMember(i, new RelationMember(m.getRole(), relationToKeep));
277 }
278 }
279 commands.add(new ChangeCommand(rel, newRel));
280 }
281 }
282
283 //Delete all relations in the list
284 rel_fix.remove(relationToKeep);
285 commands.add(new DeleteCommand(rel_fix));
286 return new SequenceCommand(tr("Delete duplicate relations"), commands);
287 }
288
289 @Override
290 public boolean isFixable(TestError testError) {
291 if (!(testError.getTester() instanceof DuplicateRelation)
292 || testError.getCode() == SAME_RELATION) return false;
293
294 // We fix it only if there is no more than one relation that is relation member.
295 Collection<? extends OsmPrimitive> sel = testError.getPrimitives();
296 HashSet<Relation> relations = new HashSet<Relation>();
297
298 for (OsmPrimitive osm : sel)
299 if (osm instanceof Relation) {
300 relations.add((Relation)osm);
301 }
302
303 if (relations.size() < 2)
304 return false;
305
306 int relationsWithRelations = 0;
307 for (Relation w : relations) {
308 List<Relation> rel = OsmPrimitive.getFilteredList(w.getReferrers(), Relation.class);
309 if (!rel.isEmpty()) {
310 ++relationsWithRelations;
311 }
312 }
313 return (relationsWithRelations <= 1);
314 }
315}
Note: See TracBrowser for help on using the repository browser.