org.openstreetmap.josm.io

Class NoteReader

java.lang.Object

org.openstreetmap.josm.io.NoteReader

public class NoteReader
extends Object

Class to read Note objects from their XML representation. It can take either API style XML which starts with an "osm" tag or a planet dump style XML which starts with an "osm-notes" tag.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	NoteReader.NoteParseMode Notes can be represented in two XML formats.
private class	NoteReader.Parser SAX handler to read note information from its XML representation.

Field Summary

Fields

Modifier and Type	Field and Description
private InputSource	inputSource
private List<Note>	parsedNotes

Constructor Summary

Constructors

Constructor and Description
NoteReader(InputStream source) Initializes the reader with a given InputStream
NoteReader(String source) Initializes the reader with a string as a source

Method Summary

Modifier and Type	Method and Description
List<Note>	parse() Parses the InputStream given to the constructor and returns the resulting Note objects

Methods inherited from class java.lang.Object

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

Field Detail

inputSource

private final InputSource inputSource

parsedNotes

private List<Note> parsedNotes

Constructor Detail

NoteReader

public NoteReader(InputStream source)
           throws IOException

Initializes the reader with a given InputStream

Parameters:

source - - InputStream containing Notes XML

Throws:

IOException - if any I/O error occurs

NoteReader

public NoteReader(String source)
           throws IOException

Initializes the reader with a string as a source

Parameters:

source - UTF-8 string containing Notes XML to parse

Throws:

IOException - if any I/O error occurs

Method Detail

parse

public List<Note> parse()
                 throws SAXException,
                        IOException

Parses the InputStream given to the constructor and returns the resulting Note objects

Returns:

List of Notes parsed from the input data

Throws:

SAXException - if any SAX parsing error occurs

IOException - if any I/O error occurs