1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.io;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.io.InputStream;
|
---|
7 | import java.util.ArrayList;
|
---|
8 | import java.util.Collection;
|
---|
9 | import java.util.HashMap;
|
---|
10 | import java.util.List;
|
---|
11 | import java.util.Map;
|
---|
12 | import java.util.Map.Entry;
|
---|
13 |
|
---|
14 | import org.openstreetmap.josm.data.osm.Changeset;
|
---|
15 | import org.openstreetmap.josm.data.osm.DataSet;
|
---|
16 | import org.openstreetmap.josm.data.osm.Node;
|
---|
17 | import org.openstreetmap.josm.data.osm.OsmPrimitive;
|
---|
18 | import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
|
---|
19 | import org.openstreetmap.josm.data.osm.PrimitiveId;
|
---|
20 | import org.openstreetmap.josm.data.osm.Relation;
|
---|
21 | import org.openstreetmap.josm.data.osm.RelationMember;
|
---|
22 | import org.openstreetmap.josm.data.osm.RelationMemberData;
|
---|
23 | import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
|
---|
24 | import org.openstreetmap.josm.data.osm.Way;
|
---|
25 | import org.openstreetmap.josm.gui.progress.ProgressMonitor;
|
---|
26 | import org.openstreetmap.josm.tools.Logging;
|
---|
27 |
|
---|
28 | /**
|
---|
29 | * Abstract Reader, allowing other implementations than OsmReader (PbfReader in PBF plugin for example)
|
---|
30 | * @author Vincent
|
---|
31 | *
|
---|
32 | */
|
---|
33 | public abstract class AbstractReader {
|
---|
34 |
|
---|
35 | /**
|
---|
36 | * The dataset to add parsed objects to.
|
---|
37 | */
|
---|
38 | protected DataSet ds = new DataSet();
|
---|
39 |
|
---|
40 | protected Changeset uploadChangeset;
|
---|
41 |
|
---|
42 | /** the map from external ids to read OsmPrimitives. External ids are
|
---|
43 | * longs too, but in contrast to internal ids negative values are used
|
---|
44 | * to identify primitives unknown to the OSM server
|
---|
45 | */
|
---|
46 | protected final Map<PrimitiveId, OsmPrimitive> externalIdMap = new HashMap<>();
|
---|
47 |
|
---|
48 | /**
|
---|
49 | * Data structure for the remaining way objects
|
---|
50 | */
|
---|
51 | protected final Map<Long, Collection<Long>> ways = new HashMap<>();
|
---|
52 |
|
---|
53 | /**
|
---|
54 | * Data structure for relation objects
|
---|
55 | */
|
---|
56 | protected final Map<Long, Collection<RelationMemberData>> relations = new HashMap<>();
|
---|
57 |
|
---|
58 | /**
|
---|
59 | * Replies the parsed data set
|
---|
60 | *
|
---|
61 | * @return the parsed data set
|
---|
62 | */
|
---|
63 | public DataSet getDataSet() {
|
---|
64 | return ds;
|
---|
65 | }
|
---|
66 |
|
---|
67 | /**
|
---|
68 | * Processes the parsed nodes after parsing. Just adds them to
|
---|
69 | * the dataset
|
---|
70 | *
|
---|
71 | */
|
---|
72 | protected void processNodesAfterParsing() {
|
---|
73 | for (OsmPrimitive primitive: externalIdMap.values()) {
|
---|
74 | if (primitive instanceof Node) {
|
---|
75 | this.ds.addPrimitive(primitive);
|
---|
76 | }
|
---|
77 | }
|
---|
78 | }
|
---|
79 |
|
---|
80 | /**
|
---|
81 | * Processes the ways after parsing. Rebuilds the list of nodes of each way and
|
---|
82 | * adds the way to the dataset
|
---|
83 | *
|
---|
84 | * @throws IllegalDataException if a data integrity problem is detected
|
---|
85 | */
|
---|
86 | protected void processWaysAfterParsing() throws IllegalDataException {
|
---|
87 | for (Entry<Long, Collection<Long>> entry : ways.entrySet()) {
|
---|
88 | Long externalWayId = entry.getKey();
|
---|
89 | Way w = (Way) externalIdMap.get(new SimplePrimitiveId(externalWayId, OsmPrimitiveType.WAY));
|
---|
90 | List<Node> wayNodes = new ArrayList<>();
|
---|
91 | for (long id : entry.getValue()) {
|
---|
92 | Node n = (Node) externalIdMap.get(new SimplePrimitiveId(id, OsmPrimitiveType.NODE));
|
---|
93 | if (n == null) {
|
---|
94 | if (id <= 0)
|
---|
95 | throw new IllegalDataException(
|
---|
96 | tr("Way with external ID ''{0}'' includes missing node with external ID ''{1}''.",
|
---|
97 | externalWayId,
|
---|
98 | id));
|
---|
99 | // create an incomplete node if necessary
|
---|
100 | n = (Node) ds.getPrimitiveById(id, OsmPrimitiveType.NODE);
|
---|
101 | if (n == null) {
|
---|
102 | n = new Node(id);
|
---|
103 | ds.addPrimitive(n);
|
---|
104 | }
|
---|
105 | }
|
---|
106 | if (n.isDeleted()) {
|
---|
107 | Logging.info(tr("Deleted node {0} is part of way {1}", id, w.getId()));
|
---|
108 | } else {
|
---|
109 | wayNodes.add(n);
|
---|
110 | }
|
---|
111 | }
|
---|
112 | w.setNodes(wayNodes);
|
---|
113 | if (w.hasIncompleteNodes()) {
|
---|
114 | Logging.info(tr("Way {0} with {1} nodes has incomplete nodes because at least one node was missing in the loaded data.",
|
---|
115 | externalWayId, w.getNodesCount()));
|
---|
116 | }
|
---|
117 | ds.addPrimitive(w);
|
---|
118 | }
|
---|
119 | }
|
---|
120 |
|
---|
121 | /**
|
---|
122 | * Completes the parsed relations with its members.
|
---|
123 | *
|
---|
124 | * @throws IllegalDataException if a data integrity problem is detected, i.e. if a
|
---|
125 | * relation member refers to a local primitive which wasn't available in the data
|
---|
126 | */
|
---|
127 | protected void processRelationsAfterParsing() throws IllegalDataException {
|
---|
128 |
|
---|
129 | // First add all relations to make sure that when relation reference other relation, the referenced will be already in dataset
|
---|
130 | for (Long externalRelationId : relations.keySet()) {
|
---|
131 | Relation relation = (Relation) externalIdMap.get(
|
---|
132 | new SimplePrimitiveId(externalRelationId, OsmPrimitiveType.RELATION)
|
---|
133 | );
|
---|
134 | ds.addPrimitive(relation);
|
---|
135 | }
|
---|
136 |
|
---|
137 | for (Entry<Long, Collection<RelationMemberData>> entry : relations.entrySet()) {
|
---|
138 | Long externalRelationId = entry.getKey();
|
---|
139 | Relation relation = (Relation) externalIdMap.get(
|
---|
140 | new SimplePrimitiveId(externalRelationId, OsmPrimitiveType.RELATION)
|
---|
141 | );
|
---|
142 | List<RelationMember> relationMembers = new ArrayList<>();
|
---|
143 | for (RelationMemberData rm : entry.getValue()) {
|
---|
144 | // lookup the member from the map of already created primitives
|
---|
145 | OsmPrimitive primitive = externalIdMap.get(new SimplePrimitiveId(rm.getMemberId(), rm.getMemberType()));
|
---|
146 |
|
---|
147 | if (primitive == null) {
|
---|
148 | if (rm.getMemberId() <= 0)
|
---|
149 | // relation member refers to a primitive with a negative id which was not
|
---|
150 | // found in the data. This is always a data integrity problem and we abort
|
---|
151 | // with an exception
|
---|
152 | //
|
---|
153 | throw new IllegalDataException(
|
---|
154 | tr("Relation with external id ''{0}'' refers to a missing primitive with external id ''{1}''.",
|
---|
155 | externalRelationId,
|
---|
156 | rm.getMemberId()));
|
---|
157 |
|
---|
158 | // member refers to OSM primitive which was not present in the parsed data
|
---|
159 | // -> create a new incomplete primitive and add it to the dataset
|
---|
160 | //
|
---|
161 | primitive = ds.getPrimitiveById(rm.getMemberId(), rm.getMemberType());
|
---|
162 | if (primitive == null) {
|
---|
163 | switch (rm.getMemberType()) {
|
---|
164 | case NODE:
|
---|
165 | primitive = new Node(rm.getMemberId()); break;
|
---|
166 | case WAY:
|
---|
167 | primitive = new Way(rm.getMemberId()); break;
|
---|
168 | case RELATION:
|
---|
169 | primitive = new Relation(rm.getMemberId()); break;
|
---|
170 | default: throw new AssertionError(); // can't happen
|
---|
171 | }
|
---|
172 |
|
---|
173 | ds.addPrimitive(primitive);
|
---|
174 | externalIdMap.put(new SimplePrimitiveId(rm.getMemberId(), rm.getMemberType()), primitive);
|
---|
175 | }
|
---|
176 | }
|
---|
177 | if (primitive.isDeleted()) {
|
---|
178 | Logging.info(tr("Deleted member {0} is used by relation {1}", primitive.getId(), relation.getId()));
|
---|
179 | } else {
|
---|
180 | relationMembers.add(new RelationMember(rm.getRole(), primitive));
|
---|
181 | }
|
---|
182 | }
|
---|
183 | relation.setMembers(relationMembers);
|
---|
184 | }
|
---|
185 | }
|
---|
186 |
|
---|
187 | protected void processChangesetAfterParsing() {
|
---|
188 | if (uploadChangeset != null) {
|
---|
189 | for (Map.Entry<String, String> e : uploadChangeset.getKeys().entrySet()) {
|
---|
190 | ds.addChangeSetTag(e.getKey(), e.getValue());
|
---|
191 | }
|
---|
192 | }
|
---|
193 | }
|
---|
194 |
|
---|
195 | protected final void prepareDataSet() throws IllegalDataException {
|
---|
196 | ds.beginUpdate();
|
---|
197 | try {
|
---|
198 | processNodesAfterParsing();
|
---|
199 | processWaysAfterParsing();
|
---|
200 | processRelationsAfterParsing();
|
---|
201 | processChangesetAfterParsing();
|
---|
202 | } finally {
|
---|
203 | ds.endUpdate();
|
---|
204 | }
|
---|
205 | }
|
---|
206 |
|
---|
207 | protected abstract DataSet doParseDataSet(InputStream source, ProgressMonitor progressMonitor) throws IllegalDataException;
|
---|
208 | }
|
---|