Package org.openstreetmap.josm.io

Class OsmReader

java.lang.Object

org.openstreetmap.josm.io.AbstractReader

org.openstreetmap.josm.io.OsmReader

Direct Known Subclasses:

OsmChangeReader, OverpassDownloadReader.OverpassOsmReader

public class OsmReader
extends AbstractReader

Parser for the Osm API (XML output). 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	Description
static class	OsmReader.Options	Options are used to change how the xml data is parsed.
private static class	OsmReader.OsmParsingCanceledException	Exception thrown after user cancellation.

Nested classes/interfaces inherited from class org.openstreetmap.josm.io.AbstractReader

AbstractReader.BinaryParserWorker, AbstractReader.CommonReader, AbstractReader.NodeReader, AbstractReader.ParserWorker, AbstractReader.RelationReader, AbstractReader.WayReader

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.Set<java.lang.String>	COMMON_XML_ATTRIBUTES
protected java.util.Collection<OsmReader.Options>	options	The OsmReader.Options to use when parsing the xml data
protected javax.xml.stream.XMLStreamReader	parser

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

cancel, ds, externalIdMap, relations, uploadChangeset, ways

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected DataSet	doParseDataSet(java.io.InputStream source, ProgressMonitor progressMonitor)
private long	getLong(java.lang.String name)
private void	handleIllegalDataException(IllegalDataException e)
protected void	jumpToEnd()
protected 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(java.lang.String generator)
private void	parseChangeset(java.lang.Long uploadChangesetId)
static DataSet	parseDataSet(java.io.InputStream source, ProgressMonitor progressMonitor)	Parse the given input source and return the dataset.
static DataSet	parseDataSet(java.io.InputStream source, ProgressMonitor progressMonitor, OsmReader.Options... options)	Parse the given input source and return the dataset.
private void	parseError()
protected Node	parseNode()
private void	parseNodeTags(NodeData n)
private void	parseOsm()
protected Relation	parseRelation()
private RelationMemberData	parseRelationMember(RelationData r)
private void	parseRelationMembersAndTags(RelationData r, java.util.Collection<RelationMemberData> members)
private void	parseRemark()
protected void	parseRoot()
private void	parseTag(Tagged t)
protected void	parseUnknown()
protected void	parseUnknown(boolean printWarning)
protected Way	parseWay()
private long	parseWayNode(WayData w)
private void	parseWayNodesAndTags(WayData w, java.util.Collection<java.lang.Long> nodeIds)
private void	readCommon(PrimitiveData current)	Read out the common attributes and put them into current OsmPrimitive.
protected void	setParser(javax.xml.stream.XMLStreamReader parser)
protected void	throwException(java.lang.String msg)
protected void	throwException(java.lang.String msg, java.lang.Throwable th)
protected void	throwException(java.lang.Throwable th)

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

buildPrimitive, callPostProcessors, deregisterPostprocessor, doParseDataSet, doParseDataSet, getDataSet, getLong, parseAction, parseBounds, parseChangeset, parseChangeset, parseDownloadPolicy, parseId, parseLocked, parseNode, parseNode, parseRelation, parseRelationMember, parseRelationMember, parseTag, parseTimestamp, parseUploadPolicy, parseUser, parseUser, parseVersion, parseVersion, parseVersion, parseVisible, parseWay, prepareDataSet, processChangesetAfterParsing, processNodesAfterParsing, processRelationsAfterParsing, processWaysAfterParsing, registerPostprocessor

Methods inherited from class java.lang.Object

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

Field Detail

parser

protected javax.xml.stream.XMLStreamReader parser

options

protected final java.util.Collection<OsmReader.Options> options

The OsmReader.Options to use when parsing the xml data

COMMON_XML_ATTRIBUTES

private static final java.util.Set<java.lang.String> COMMON_XML_ATTRIBUTES

Constructor Detail

OsmReader

protected OsmReader()

constructor (for private and subclasses use only)

See Also:

parseDataSet(InputStream, ProgressMonitor)

OsmReader

protected OsmReader(OsmReader.Options... options)

constructor (for private and subclasses use only)

Parameters:

options - The options to use when reading data

Since:

16641

See Also:

parseDataSet(InputStream, ProgressMonitor)

Method Detail

setParser

protected void setParser(javax.xml.stream.XMLStreamReader parser)

throwException

protected void throwException(java.lang.Throwable th)
                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

throwException

protected void throwException(java.lang.String msg,
                              java.lang.Throwable th)
                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

throwException

protected void throwException(java.lang.String msg)
                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parse

protected void parse()
              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseRoot

protected void parseRoot()
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseOsm

private void parseOsm()
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

handleIllegalDataException

private void handleIllegalDataException(IllegalDataException e)
                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseError

private void parseError()
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseRemark

private void parseRemark()
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseBounds

private void parseBounds(java.lang.String generator)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseNode

protected Node parseNode()
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseNodeTags

private void parseNodeTags(NodeData n)
                    throws IllegalDataException

Throws:

IllegalDataException

parseWay

protected Way parseWay()
                throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseWayNodesAndTags

private void parseWayNodesAndTags(WayData w,
                                  java.util.Collection<java.lang.Long> nodeIds)
                           throws IllegalDataException

Throws:

IllegalDataException

parseWayNode

private long parseWayNode(WayData w)
                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseRelation

protected Relation parseRelation()
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseRelationMembersAndTags

private void parseRelationMembersAndTags(RelationData r,
                                         java.util.Collection<RelationMemberData> members)
                                  throws IllegalDataException

Throws:

IllegalDataException

parseRelationMember

private RelationMemberData parseRelationMember(RelationData r)
                                        throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseChangeset

private void parseChangeset(java.lang.Long uploadChangesetId)
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseTag

private void parseTag(Tagged t)
               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseUnknown

protected void parseUnknown(boolean printWarning)
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseUnknown

protected void parseUnknown()
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

jumpToEnd

protected final void jumpToEnd(boolean printWarning)
                        throws javax.xml.stream.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:

javax.xml.stream.XMLStreamException - if there is an error processing the underlying XML source

jumpToEnd

protected final void jumpToEnd()
                        throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

readCommon

private void readCommon(PrimitiveData current)
                 throws IllegalDataException

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

Parameters:

current - primitive to update

Throws:

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

getLong

private long getLong(java.lang.String name)
              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

doParseDataSet

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

Specified by:

doParseDataSet in class AbstractReader

Throws:

IllegalDataException

parseDataSet

public static DataSet parseDataSet(java.io.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

java.lang.IllegalArgumentException - if source is null

parseDataSet

public static DataSet parseDataSet(java.io.InputStream source,
                                   ProgressMonitor progressMonitor,
                                   OsmReader.Options... options)
                            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

options - The options to use when parsing the dataset

Returns:

the dataset with the parsed data

Throws:

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

java.lang.IllegalArgumentException - if source is null

Since:

16641