org.openstreetmap.josm.io

Class OsmServerChangesetReader

java.lang.Object

org.openstreetmap.josm.io.OsmConnection

org.openstreetmap.josm.io.OsmServerReader

org.openstreetmap.josm.io.OsmServerChangesetReader

public class OsmServerChangesetReader
extends OsmServerReader

Reads the history of an OsmPrimitive from the OSM API server.

Nested Class Summary

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

OsmServerReader.DomParser<R>

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

OsmConnection.OAuthAccessTokenFetcher

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	useAnonymousUser

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

contentType, gpxParsedProperly

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

activeConnection, cancel, fetcher, oauthParameters

Constructor Summary

Constructors

Constructor and Description
OsmServerChangesetReader() Constructs a new OsmServerChangesetReader with default settings.
OsmServerChangesetReader(boolean useAnonymousUser) Constructs a new OsmServerChangesetReader

Method Summary

Modifier and Type	Method and Description
ChangesetDataSet	downloadChangeset(int id, ProgressMonitor monitor) Downloads the content of a changeset
protected java.io.InputStream	getChangesetInputStream(long id, boolean includeDiscussion, ProgressMonitor monitor)
DataSet	parseOsm(ProgressMonitor progressMonitor) don't use - not implemented!
java.util.List<Changeset>	queryChangesets(ChangesetQuery query, ProgressMonitor monitor) Queries a list
Changeset	readChangeset(long id, boolean includeDiscussion, ProgressMonitor monitor) Reads the changeset with id id from the server.
java.util.List<Changeset>	readChangesets(java.util.Collection<java.lang.Integer> ids, boolean includeDiscussion, ProgressMonitor monitor) Reads the changesets with id ids from the server.

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

adaptRequest, fetchData, getAttribute, getBaseUrl, getInputStream, getInputStream, getInputStreamRaw, getInputStreamRaw, getInputStreamRaw, getInputStreamRaw, isDoAuthenticate, isGpxParsedProperly, parseNotes, parseOsm, parseOsmChange, parseOsmChange, parseRawGps, parseRawGps, parseRawNotes, parseRawNotes, setDoAuthenticate

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

addAuth, addBasicAuthorizationHeader, addOAuthAuthorizationHeader, cancel, isCanceled, obtainAccessToken, retrieveBasicAuthorizationLogin, setOAuthAccessTokenFetcher

Methods inherited from class java.lang.Object

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

Field Detail

useAnonymousUser

final boolean useAnonymousUser

Constructor Detail

OsmServerChangesetReader

public OsmServerChangesetReader()

Constructs a new OsmServerChangesetReader with default settings.

OsmServerChangesetReader

public OsmServerChangesetReader(boolean useAnonymousUser)

Constructs a new OsmServerChangesetReader

Parameters:

useAnonymousUser - if true, replace all user information with the anonymous user

Since:

14946

Method Detail

parseOsm

public DataSet parseOsm(ProgressMonitor progressMonitor)
                 throws OsmTransferException

don't use - not implemented!

Specified by:

parseOsm in class OsmServerReader

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

getChangesetInputStream

protected final java.io.InputStream getChangesetInputStream(long id,
                                                            boolean includeDiscussion,
                                                            ProgressMonitor monitor)
                                                     throws OsmTransferException

Throws:

OsmTransferException

queryChangesets

public java.util.List<Changeset> queryChangesets(ChangesetQuery query,
                                                 ProgressMonitor monitor)
                                          throws OsmTransferException

Queries a list

Parameters:

query - the query specification. Must not be null.

monitor - a progress monitor. Set to NullProgressMonitor.INSTANCE if null

Returns:

the list of changesets read from the server

Throws:

java.lang.IllegalArgumentException - if query is null

OsmTransferException - if something goes wrong

readChangeset

public Changeset readChangeset(long id,
                               boolean includeDiscussion,
                               ProgressMonitor monitor)
                        throws OsmTransferException

Reads the changeset with id id from the server.

Parameters:

id - the changeset id. id > 0 required.

includeDiscussion - determines if discussion comments must be downloaded or not

monitor - the progress monitor. Set to NullProgressMonitor.INSTANCE if null

Returns:

the changeset read

Throws:

OsmTransferException - if something goes wrong

java.lang.IllegalArgumentException - if id <= 0

Since:

7704

readChangesets

public java.util.List<Changeset> readChangesets(java.util.Collection<java.lang.Integer> ids,
                                                boolean includeDiscussion,
                                                ProgressMonitor monitor)
                                         throws OsmTransferException

Reads the changesets with id ids from the server.

Parameters:

ids - the list of ids. Ignored if null. Only load changesets for ids > 0.

includeDiscussion - determines if discussion comments must be downloaded or not

monitor - the progress monitor. Set to NullProgressMonitor.INSTANCE if null

Returns:

the changeset read

Throws:

OsmTransferException - if something goes wrong

java.lang.IllegalArgumentException - if id <= 0

Since:

7704

downloadChangeset

public ChangesetDataSet downloadChangeset(int id,
                                          ProgressMonitor monitor)
                                   throws OsmTransferException

Downloads the content of a changeset

Parameters:

id - the changeset id. > 0 required.

monitor - the progress monitor. NullProgressMonitor.INSTANCE assumed if null.

Returns:

the changeset content

Throws:

java.lang.IllegalArgumentException - if id <= 0

OsmTransferException - if something went wrong