org.openstreetmap.josm.io

Class OsmReader

java.lang.Object

org.openstreetmap.josm.io.AbstractReader

org.openstreetmap.josm.io.OsmReader

Direct Known Subclasses:

OsmChangeReader

public class OsmReader
extends AbstractReader

Parser for the Osm Api. Read from an input stream and construct a dataset out of it. For each xml element, there is a dedicated method. The XMLStreamReader cursor points to the start of the element, when the method is entered, and it must point to the end of the same element, when it is exited.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OsmReader.OsmParsingCanceledException Exception thrown after user cancelation.
private static class	OsmReader.OsmParsingException

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancel
protected XMLStreamReader	parser
private static List<OsmServerReadPostprocessor>	postprocessors Used by plugins to register themselves as data postprocessors.

Fields inherited from class org.openstreetmap.josm.io.AbstractReader

ds, externalIdMap, relations, uploadChangeset, ways

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OsmReader() constructor (for private and subclasses use only)

Method Summary

Modifier and Type	Method and Description
private User	createUser(String uid, String name)
static void	deregisterPostprocessor(OsmServerReadPostprocessor pp) Deregister a postprocessor previously registered with registerPostprocessor(org.openstreetmap.josm.io.OsmServerReadPostprocessor).
protected DataSet	doParseDataSet(InputStream source, ProgressMonitor progressMonitor)
private long	getLong(String name)
private void	jumpToEnd()
private void	jumpToEnd(boolean printWarning) When cursor is at the start of an element, moves it to the end tag of that element.
protected void	parse()
private void	parseBounds(String generator)
private void	parseChangeset(Long uploadChangesetId)
static DataSet	parseDataSet(InputStream source, ProgressMonitor progressMonitor) Parse the given input source and return the dataset.
protected Node	parseNode()
private void	parseOsm()
protected Relation	parseRelation()
private RelationMemberData	parseRelationMember(Relation r)
protected void	parseRoot()
private void	parseTag(Tagged t)
protected void	parseUnknown()
protected void	parseUnknown(boolean printWarning)
protected Way	parseWay()
private long	parseWayNode(Way w)
private void	readCommon(PrimitiveData current) Read out the common attributes and put them into current OsmPrimitive.
static void	registerPostprocessor(OsmServerReadPostprocessor pp) Register a new postprocessor.
protected void	setParser(XMLStreamReader parser)
protected void	throwException(String msg)
protected void	throwException(String msg, Throwable th)

Methods inherited from class org.openstreetmap.josm.io.AbstractReader

getDataSet, prepareDataSet, processChangesetAfterParsing, processNodesAfterParsing, processRelationsAfterParsing, processWaysAfterParsing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parser

protected XMLStreamReader parser

cancel

protected boolean cancel

postprocessors

private static volatile List<OsmServerReadPostprocessor> postprocessors

Used by plugins to register themselves as data postprocessors.

Constructor Detail

OsmReader

protected OsmReader()

constructor (for private and subclasses use only)

See Also:

parseDataSet(InputStream, ProgressMonitor)

Method Detail

registerPostprocessor

public static void registerPostprocessor(OsmServerReadPostprocessor pp)

Register a new postprocessor.

Parameters:

pp - postprocessor

See Also:

deregisterPostprocessor(org.openstreetmap.josm.io.OsmServerReadPostprocessor)

deregisterPostprocessor

public static void deregisterPostprocessor(OsmServerReadPostprocessor pp)

Deregister a postprocessor previously registered with registerPostprocessor(org.openstreetmap.josm.io.OsmServerReadPostprocessor).

Parameters:

pp - postprocessor

See Also:

registerPostprocessor(org.openstreetmap.josm.io.OsmServerReadPostprocessor)

setParser

protected void setParser(XMLStreamReader parser)

throwException

protected void throwException(String msg,
                              Throwable th)
                       throws XMLStreamException

Throws:

XMLStreamException

throwException

protected void throwException(String msg)
                       throws XMLStreamException

Throws:

XMLStreamException

parse

protected void parse()
              throws XMLStreamException

Throws:

XMLStreamException

parseRoot

protected void parseRoot()
                  throws XMLStreamException

Throws:

XMLStreamException

parseOsm

private void parseOsm()
               throws XMLStreamException

Throws:

XMLStreamException

parseBounds

private void parseBounds(String generator)
                  throws XMLStreamException

Throws:

XMLStreamException

parseNode

protected Node parseNode()
                  throws XMLStreamException

Throws:

XMLStreamException

parseWay

protected Way parseWay()
                throws XMLStreamException

Throws:

XMLStreamException

parseWayNode

private long parseWayNode(Way w)
                   throws XMLStreamException

Throws:

XMLStreamException

parseRelation

protected Relation parseRelation()
                          throws XMLStreamException

Throws:

XMLStreamException

parseRelationMember

private RelationMemberData parseRelationMember(Relation r)
                                        throws XMLStreamException

Throws:

XMLStreamException

parseChangeset

private void parseChangeset(Long uploadChangesetId)
                     throws XMLStreamException

Throws:

XMLStreamException

parseTag

private void parseTag(Tagged t)
               throws XMLStreamException

Throws:

XMLStreamException

parseUnknown

protected void parseUnknown(boolean printWarning)
                     throws XMLStreamException

Throws:

XMLStreamException

parseUnknown

protected void parseUnknown()
                     throws XMLStreamException

Throws:

XMLStreamException

jumpToEnd

private void jumpToEnd(boolean printWarning)
                throws XMLStreamException

When cursor is at the start of an element, moves it to the end tag of that element. Nested content is skipped. This is basically the same code as parseUnknown(), except for the warnings, which are displayed for inner elements and not at top level.

Parameters:

printWarning - if true, a warning message will be printed if an unknown element is met

Throws:

XMLStreamException - if there is an error processing the underlying XML source

jumpToEnd

private void jumpToEnd()
                throws XMLStreamException

Throws:

XMLStreamException

createUser

private User createUser(String uid,
                        String name)
                 throws XMLStreamException

Throws:

XMLStreamException

readCommon

private void readCommon(PrimitiveData current)
                 throws XMLStreamException

Read out the common attributes and put them into current OsmPrimitive.

Parameters:

current - primitive to update

Throws:

XMLStreamException - if there is an error processing the underlying XML source

getLong

private long getLong(String name)
              throws XMLStreamException

Throws:

XMLStreamException

doParseDataSet

protected DataSet doParseDataSet(InputStream source,
                                 ProgressMonitor progressMonitor)
                          throws IllegalDataException

Throws:

IllegalDataException

parseDataSet

public static DataSet parseDataSet(InputStream source,
                                   ProgressMonitor progressMonitor)
                            throws IllegalDataException

Parse the given input source and return the dataset.

Parameters:

source - the source input stream. Must not be null.

progressMonitor - the progress monitor. If null, NullProgressMonitor.INSTANCE is assumed

Returns:

the dataset with the parsed data

Throws:

IllegalDataException - if an error was found while parsing the data from the source

IllegalArgumentException - if source is null