1 | package org.openstreetmap.josm.data.osm;
|
---|
2 |
|
---|
3 | import java.util.ArrayList;
|
---|
4 | import java.util.Collection;
|
---|
5 | import java.util.HashSet;
|
---|
6 | import java.util.List;
|
---|
7 | import java.util.Set;
|
---|
8 |
|
---|
9 | import org.openstreetmap.josm.data.osm.visitor.Visitor;
|
---|
10 | import org.openstreetmap.josm.tools.CopyList;
|
---|
11 |
|
---|
12 | /**
|
---|
13 | * An relation, having a set of tags and any number (0...n) of members.
|
---|
14 | *
|
---|
15 | * @author Frederik Ramm <frederik@remote.org>
|
---|
16 | */
|
---|
17 | public final class Relation extends OsmPrimitive {
|
---|
18 |
|
---|
19 | /**
|
---|
20 | * All members of this relation. Note that after changing this,
|
---|
21 | * makeBackReferences and/or removeBackReferences should be called.
|
---|
22 | *
|
---|
23 | */
|
---|
24 | private final List<RelationMember> members = new ArrayList<RelationMember>();
|
---|
25 |
|
---|
26 | /**
|
---|
27 | * @return Members of the relation. Changes made in returned list are not mapped
|
---|
28 | * back to the primitive, use setMembers() to modify the members
|
---|
29 | * @since 1925
|
---|
30 | */
|
---|
31 | public List<RelationMember> getMembers() {
|
---|
32 | return new CopyList<RelationMember>(members.toArray(new RelationMember[members.size()]));
|
---|
33 | }
|
---|
34 |
|
---|
35 | /**
|
---|
36 | *
|
---|
37 | * @param members Can be null, in that case all members are removed
|
---|
38 | * @since 1925
|
---|
39 | */
|
---|
40 | public void setMembers(List<RelationMember> members) {
|
---|
41 | for (RelationMember rm:this.members) {
|
---|
42 | rm.getMember().removeReferrer(this);
|
---|
43 | }
|
---|
44 |
|
---|
45 | this.members.clear();
|
---|
46 | if (members != null) {
|
---|
47 | this.members.addAll(members);
|
---|
48 | }
|
---|
49 | for (RelationMember rm:this.members) {
|
---|
50 | rm.getMember().addReferrer(this);
|
---|
51 | }
|
---|
52 |
|
---|
53 | fireMembersChanged();
|
---|
54 | }
|
---|
55 |
|
---|
56 | /**
|
---|
57 | *
|
---|
58 | * @since 1926
|
---|
59 | */
|
---|
60 | public int getMembersCount() {
|
---|
61 | return members.size();
|
---|
62 | }
|
---|
63 |
|
---|
64 | /**
|
---|
65 | *
|
---|
66 | * @param index
|
---|
67 | * @return
|
---|
68 | * @since 1926
|
---|
69 | */
|
---|
70 | public RelationMember getMember(int index) {
|
---|
71 | return members.get(index);
|
---|
72 | }
|
---|
73 |
|
---|
74 | /**
|
---|
75 | *
|
---|
76 | * @param member
|
---|
77 | * @since 1951
|
---|
78 | */
|
---|
79 | public void addMember(RelationMember member) {
|
---|
80 | members.add(member);
|
---|
81 | member.getMember().addReferrer(this);
|
---|
82 | fireMembersChanged();
|
---|
83 | }
|
---|
84 |
|
---|
85 | /**
|
---|
86 | *
|
---|
87 | * @param index
|
---|
88 | * @param member
|
---|
89 | * @since 1951
|
---|
90 | */
|
---|
91 | public void addMember(int index, RelationMember member) {
|
---|
92 | members.add(index, member);
|
---|
93 | member.getMember().addReferrer(this);
|
---|
94 | fireMembersChanged();
|
---|
95 | }
|
---|
96 |
|
---|
97 | /**
|
---|
98 | * Replace member at position specified by index.
|
---|
99 | * @param index
|
---|
100 | * @param member
|
---|
101 | * @return Member that was at the position
|
---|
102 | * @since 1951
|
---|
103 | */
|
---|
104 | public RelationMember setMember(int index, RelationMember member) {
|
---|
105 | RelationMember result = members.set(index, member);
|
---|
106 | if (result.getMember() != member.getMember()) {
|
---|
107 | member.getMember().addReferrer(this);
|
---|
108 | result.getMember().removeReferrer(this);
|
---|
109 | fireMembersChanged();
|
---|
110 | }
|
---|
111 | return result;
|
---|
112 | }
|
---|
113 |
|
---|
114 | /**
|
---|
115 | * Removes member at specified position.
|
---|
116 | * @param index
|
---|
117 | * @return Member that was at the position
|
---|
118 | * @since 1951
|
---|
119 | */
|
---|
120 | public RelationMember removeMember(int index) {
|
---|
121 | RelationMember result = members.remove(index);
|
---|
122 | for (RelationMember rm:members) {
|
---|
123 | // Do not remove referrer if this primitive is used in relation twice
|
---|
124 | if (rm.getMember() == result.getMember())
|
---|
125 | return result;
|
---|
126 | }
|
---|
127 | result.getMember().removeReferrer(this);
|
---|
128 | fireMembersChanged();
|
---|
129 | return result;
|
---|
130 | }
|
---|
131 |
|
---|
132 | @Override public void visit(Visitor visitor) {
|
---|
133 | visitor.visit(this);
|
---|
134 | }
|
---|
135 |
|
---|
136 | protected Relation(long id, boolean allowNegative) {
|
---|
137 | super(id, allowNegative);
|
---|
138 | }
|
---|
139 |
|
---|
140 | /**
|
---|
141 | * Create a new relation with id 0
|
---|
142 | */
|
---|
143 | public Relation() {
|
---|
144 | super(0, false);
|
---|
145 | }
|
---|
146 |
|
---|
147 | public Relation(Relation clone, boolean clearId) {
|
---|
148 | super(clone.getUniqueId(), true);
|
---|
149 | cloneFrom(clone);
|
---|
150 | if (clearId) {
|
---|
151 | clearOsmId();
|
---|
152 | }
|
---|
153 | }
|
---|
154 |
|
---|
155 | /**
|
---|
156 | * Create an identical clone of the argument (including the id)
|
---|
157 | */
|
---|
158 | public Relation(Relation clone) {
|
---|
159 | this(clone, false);
|
---|
160 | }
|
---|
161 |
|
---|
162 | /**
|
---|
163 | * Creates a new relation for the given id. If the id > 0, the way is marked
|
---|
164 | * as incomplete.
|
---|
165 | *
|
---|
166 | * @param id the id. > 0 required
|
---|
167 | * @throws IllegalArgumentException thrown if id < 0
|
---|
168 | */
|
---|
169 | public Relation(long id) throws IllegalArgumentException {
|
---|
170 | super(id, false);
|
---|
171 | }
|
---|
172 |
|
---|
173 | /**
|
---|
174 | * Creates new complete relation
|
---|
175 | * @param id
|
---|
176 | * @param version
|
---|
177 | */
|
---|
178 | public Relation(long id, int version) {
|
---|
179 | super(id, false);
|
---|
180 | setOsmId(id, version);
|
---|
181 | }
|
---|
182 |
|
---|
183 | @Override public void cloneFrom(OsmPrimitive osm) {
|
---|
184 | super.cloneFrom(osm);
|
---|
185 | // It's not necessary to clone members as RelationMember class is immutable
|
---|
186 | setMembers(((Relation)osm).getMembers());
|
---|
187 | }
|
---|
188 |
|
---|
189 | @Override public void load(PrimitiveData data) {
|
---|
190 | super.load(data);
|
---|
191 |
|
---|
192 | RelationData relationData = (RelationData) data;
|
---|
193 |
|
---|
194 | List<RelationMember> newMembers = new ArrayList<RelationMember>();
|
---|
195 | for (RelationMemberData member : relationData.getMembers()) {
|
---|
196 | OsmPrimitive primitive = getDataSet().getPrimitiveById(member);
|
---|
197 | if (primitive == null)
|
---|
198 | throw new AssertionError("Data consistency problem - relation with missing member detected");
|
---|
199 | newMembers.add(new RelationMember(member.getRole(), primitive));
|
---|
200 | }
|
---|
201 | setMembers(newMembers);
|
---|
202 | }
|
---|
203 |
|
---|
204 | @Override public RelationData save() {
|
---|
205 | RelationData data = new RelationData();
|
---|
206 | saveCommonAttributes(data);
|
---|
207 | for (RelationMember member:getMembers()) {
|
---|
208 | data.getMembers().add(new RelationMemberData(member.getRole(), member.getMember()));
|
---|
209 | }
|
---|
210 | return data;
|
---|
211 | }
|
---|
212 |
|
---|
213 | @Override public String toString() {
|
---|
214 | StringBuilder result = new StringBuilder();
|
---|
215 | result.append("{Relation id=");
|
---|
216 | result.append(getUniqueId());
|
---|
217 | result.append(" version=");
|
---|
218 | result.append(getVersion());
|
---|
219 | result.append(" ");
|
---|
220 | result.append(getFlagsAsString());
|
---|
221 | result.append(" [");
|
---|
222 | for (RelationMember rm:getMembers()) {
|
---|
223 | result.append(OsmPrimitiveType.from(rm.getMember()));
|
---|
224 | result.append(" ");
|
---|
225 | result.append(rm.getMember().getUniqueId());
|
---|
226 | result.append(", ");
|
---|
227 | }
|
---|
228 | result.delete(result.length()-2, result.length());
|
---|
229 | result.append("]");
|
---|
230 | result.append("}");
|
---|
231 | return result.toString();
|
---|
232 | }
|
---|
233 |
|
---|
234 | @Override
|
---|
235 | public boolean hasEqualSemanticAttributes(OsmPrimitive other) {
|
---|
236 | if (other == null || ! (other instanceof Relation) )
|
---|
237 | return false;
|
---|
238 | if (! super.hasEqualSemanticAttributes(other))
|
---|
239 | return false;
|
---|
240 | Relation r = (Relation)other;
|
---|
241 | return members.equals(r.members);
|
---|
242 | }
|
---|
243 |
|
---|
244 | public int compareTo(OsmPrimitive o) {
|
---|
245 | return o instanceof Relation ? Long.valueOf(getUniqueId()).compareTo(o.getUniqueId()) : -1;
|
---|
246 | }
|
---|
247 |
|
---|
248 | public RelationMember firstMember() {
|
---|
249 | if (isIncomplete()) return null;
|
---|
250 | return (members.size() == 0) ? null : members.get(0);
|
---|
251 | }
|
---|
252 | public RelationMember lastMember() {
|
---|
253 | if (isIncomplete()) return null;
|
---|
254 | return (members.size() == 0) ? null : members.get(members.size() -1);
|
---|
255 | }
|
---|
256 |
|
---|
257 | /**
|
---|
258 | * removes all members with member.member == primitive
|
---|
259 | *
|
---|
260 | * @param primitive the primitive to check for
|
---|
261 | */
|
---|
262 | public void removeMembersFor(OsmPrimitive primitive) {
|
---|
263 | if (primitive == null)
|
---|
264 | return;
|
---|
265 |
|
---|
266 | ArrayList<RelationMember> todelete = new ArrayList<RelationMember>();
|
---|
267 | for (RelationMember member: members) {
|
---|
268 | if (member.getMember() == primitive) {
|
---|
269 | todelete.add(member);
|
---|
270 | }
|
---|
271 | }
|
---|
272 | primitive.removeReferrer(this);
|
---|
273 | members.removeAll(todelete);
|
---|
274 | fireMembersChanged();
|
---|
275 | }
|
---|
276 |
|
---|
277 | @Override
|
---|
278 | public void setDeleted(boolean deleted) {
|
---|
279 | for (RelationMember rm:members) {
|
---|
280 | if (deleted) {
|
---|
281 | rm.getMember().removeReferrer(this);
|
---|
282 | } else {
|
---|
283 | rm.getMember().addReferrer(this);
|
---|
284 | }
|
---|
285 | }
|
---|
286 | super.setDeleted(deleted);
|
---|
287 | }
|
---|
288 |
|
---|
289 | /**
|
---|
290 | * removes all members with member.member == primitive
|
---|
291 | *
|
---|
292 | * @param primitives the primitives to check for
|
---|
293 | */
|
---|
294 | public void removeMembersFor(Collection<OsmPrimitive> primitives) {
|
---|
295 | if (primitives == null || primitives.isEmpty())
|
---|
296 | return;
|
---|
297 |
|
---|
298 | ArrayList<RelationMember> todelete = new ArrayList<RelationMember>();
|
---|
299 | for (RelationMember member: members) {
|
---|
300 | if (primitives.contains(member.getMember())) {
|
---|
301 | todelete.add(member);
|
---|
302 | }
|
---|
303 | }
|
---|
304 | members.removeAll(todelete);
|
---|
305 | for (OsmPrimitive primitive:primitives) {
|
---|
306 | primitive.removeReferrer(this);
|
---|
307 | }
|
---|
308 | fireMembersChanged();
|
---|
309 | }
|
---|
310 |
|
---|
311 | @Override
|
---|
312 | public String getDisplayName(NameFormatter formatter) {
|
---|
313 | return formatter.format(this);
|
---|
314 | }
|
---|
315 |
|
---|
316 | /**
|
---|
317 | * Replies the set of {@see OsmPrimitive}s referred to by at least one
|
---|
318 | * member of this relation
|
---|
319 | *
|
---|
320 | * @return the set of {@see OsmPrimitive}s referred to by at least one
|
---|
321 | * member of this relation
|
---|
322 | */
|
---|
323 | public Set<OsmPrimitive> getMemberPrimitives() {
|
---|
324 | HashSet<OsmPrimitive> ret = new HashSet<OsmPrimitive>();
|
---|
325 | for (RelationMember m: members) {
|
---|
326 | if (m.getMember() != null) {
|
---|
327 | ret.add(m.getMember());
|
---|
328 | }
|
---|
329 | }
|
---|
330 | return ret;
|
---|
331 | }
|
---|
332 |
|
---|
333 | public OsmPrimitiveType getType() {
|
---|
334 | return OsmPrimitiveType.RELATION;
|
---|
335 | }
|
---|
336 |
|
---|
337 | @Override
|
---|
338 | public BBox getBBox() {
|
---|
339 | return new BBox(0, 0, 0, 0);
|
---|
340 | }
|
---|
341 |
|
---|
342 | @Override
|
---|
343 | public void updatePosition() {
|
---|
344 | // Do nothing for now
|
---|
345 | }
|
---|
346 |
|
---|
347 | private void fireMembersChanged() {
|
---|
348 | if (getDataSet() != null) {
|
---|
349 | getDataSet().fireRelationMembersChanged(this);
|
---|
350 | }
|
---|
351 | }
|
---|
352 | }
|
---|