Package org.openstreetmap.josm.gui.history

Class HistoryLoadTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.gui.history.HistoryLoadTask

All Implemented Interfaces:

java.lang.Runnable, ProgressMonitor.CancelListener

Direct Known Subclasses:

DownloadOsmChangeTask.HistoryLoaderAndListener

public class HistoryLoadTask
extends PleaseWaitRunnable

Loads the object history of a collection of objects from the server. It provides a fluent API for configuration. Sample usage:

   HistoryLoadTask task = new HistoryLoadTask()
      .add(node)
      .add(way)
      .add(relation)
      .add(aHistoryItem);

   MainApplication.worker.execute(task);
 

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	canceled
private boolean	collectMissing
private boolean	getChangesetData
private java.lang.Exception	lastException
private HistoryDataSet	loadedData
private java.util.Set<PrimitiveId>	missingPrimitives
private OsmServerHistoryReader	reader
private java.util.Set<PrimitiveId>	toLoad

Fields inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

progressMonitor

Constructor Summary

Constructors

Constructor	Description
HistoryLoadTask()	Constructs a new HistoryLoadTask.
HistoryLoadTask(java.awt.Component parent)	Constructs a new HistoryLoadTask.

Method Summary

Modifier and Type	Method	Description
HistoryLoadTask	add(History history)	Adds an object to be loaded, the object is specified by an already loaded object history.
HistoryLoadTask	add(HistoryOsmPrimitive primitive)	Adds an object to be loaded, the object is specified by a history item.
HistoryLoadTask	add(OsmPrimitive primitive)	Adds an object to be loaded, the object is specified by an OSM primitive.
HistoryLoadTask	add(PrimitiveId pid)	Adds an object whose history is to be loaded.
HistoryLoadTask	addOsmPrimitives(java.util.Collection<? extends OsmPrimitive> primitives)	Adds a collection of objects to loaded, specified by a collection of OSM primitives.
HistoryLoadTask	addPrimitiveIds(java.util.Collection<? extends PrimitiveId> primitives)	Adds a collection of objects to loaded, specified by a collection of OSM primitives.
protected void	cancel()	User pressed cancel button.
protected void	finish()	Finish up the data work.
java.lang.Exception	getLastException()	Returns the last exception that occurred during loading, if any.
protected static java.lang.String	getLoadingMessage(PrimitiveId pid)
java.util.Set<PrimitiveId>	getMissingPrimitives()	replies the set of ids of all primitives for which a fetch request to the server was submitted but which are not available from the server (the server replied a return code of 404)
boolean	isCanceled()	Determines if this task has ben canceled.
private void	loadHistory(PrimitiveId pid)
protected static HistoryDataSet	loadHistory(OsmServerHistoryReader reader, ProgressMonitor progressMonitor)
protected void	realRun()	Called in the worker thread to do the actual work.
void	setChangesetDataNeeded(boolean b)	Determine if changeset information is needed.
void	setCollectMissing(boolean b)	Determine if missing primitives should be collected.

Methods inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

afterFinish, canRunInBackground, getProgressMonitor, operationCanceled, run

Methods inherited from class java.lang.Object

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

Field Detail

canceled

private boolean canceled

lastException

private java.lang.Exception lastException

toLoad

private final java.util.Set<PrimitiveId> toLoad

loadedData

private HistoryDataSet loadedData

reader

private OsmServerHistoryReader reader

getChangesetData

private boolean getChangesetData

collectMissing

private boolean collectMissing

missingPrimitives

private final java.util.Set<PrimitiveId> missingPrimitives

Constructor Detail

HistoryLoadTask

public HistoryLoadTask()

Constructs a new HistoryLoadTask.

HistoryLoadTask

public HistoryLoadTask(java.awt.Component parent)

Constructs a new HistoryLoadTask.

Parameters:

parent - the component to be used as reference to find the parent for PleaseWaitDialog. Must not be null.

Throws:

java.lang.NullPointerException - if parent is null

Method Detail

add

public HistoryLoadTask add(PrimitiveId pid)

Adds an object whose history is to be loaded.

Parameters:

pid - the primitive id. Must not be null. Id > 0 required.

Returns:

this task

add

public HistoryLoadTask add(HistoryOsmPrimitive primitive)

Adds an object to be loaded, the object is specified by a history item.

Parameters:

primitive - the history item

Returns:

this task

Throws:

java.lang.NullPointerException - if primitive is null

add

public HistoryLoadTask add(History history)

Adds an object to be loaded, the object is specified by an already loaded object history.

Parameters:

history - the history. Must not be null.

Returns:

this task

Throws:

java.lang.NullPointerException - if history is null

add

public HistoryLoadTask add(OsmPrimitive primitive)

Adds an object to be loaded, the object is specified by an OSM primitive.

Parameters:

primitive - the OSM primitive. Must not be null. primitive.getOsmId() > 0 required.

Returns:

this task

Throws:

java.lang.NullPointerException - if the primitive is null

java.lang.IllegalArgumentException - if primitive.getOsmId() <= 0

addPrimitiveIds

public HistoryLoadTask addPrimitiveIds(java.util.Collection<? extends PrimitiveId> primitives)

Adds a collection of objects to loaded, specified by a collection of OSM primitives.

Parameters:

primitives - the OSM primitives. Must not be null. primitive.getId() > 0 required.

Returns:

this task

Throws:

java.lang.NullPointerException - if primitives is null

java.lang.IllegalArgumentException - if one of the ids in the collection <= 0

Since:

16123

addOsmPrimitives

public HistoryLoadTask addOsmPrimitives(java.util.Collection<? extends OsmPrimitive> primitives)

Adds a collection of objects to loaded, specified by a collection of OSM primitives.

Parameters:

primitives - the OSM primitives. Must not be null. primitive.getId() > 0 required.

Returns:

this task

Throws:

java.lang.NullPointerException - if primitives is null

java.lang.IllegalArgumentException - if one of the ids in the collection <= 0

Since:

16123

cancel

protected void cancel()

Description copied from class: PleaseWaitRunnable

User pressed cancel button.

Specified by:

cancel in class PleaseWaitRunnable

finish

protected void finish()

Description copied from class: PleaseWaitRunnable

Finish up the data work. Is guaranteed to be called if realRun is called. Finish is called in the gui thread just after the dialog disappeared.

Specified by:

finish in class PleaseWaitRunnable

realRun

protected void realRun()
                throws org.xml.sax.SAXException,
                       java.io.IOException,
                       OsmTransferException

Description copied from class: PleaseWaitRunnable

Called in the worker thread to do the actual work. When any of the exception is thrown, a message box will be displayed and closeDialog is called. finish() is called in any case.

Specified by:

realRun in class PleaseWaitRunnable

Throws:

org.xml.sax.SAXException - if a SAX error occurs

java.io.IOException - if an I/O error occurs

OsmTransferException - if a communication error with the OSM server occurs

loadHistory

private void loadHistory(PrimitiveId pid)
                  throws OsmTransferException

Throws:

OsmTransferException

loadHistory

protected static HistoryDataSet loadHistory(OsmServerHistoryReader reader,
                                            ProgressMonitor progressMonitor)
                                     throws OsmTransferException

Throws:

OsmTransferException

getLoadingMessage

protected static java.lang.String getLoadingMessage(PrimitiveId pid)

isCanceled

public boolean isCanceled()

Determines if this task has ben canceled.

Returns:

true if this task has ben canceled

getLastException

public java.lang.Exception getLastException()

Returns the last exception that occurred during loading, if any.

Returns:

the last exception that occurred during loading, or null

setChangesetDataNeeded

public void setChangesetDataNeeded(boolean b)

Determine if changeset information is needed. By default it is retrieved.

Parameters:

b - false means don't retrieve changeset data.

Since:

14763

setCollectMissing

public void setCollectMissing(boolean b)

Determine if missing primitives should be collected. By default they are not collected and the first missing object terminates the task.

Parameters:

b - true means collect missing data and continue.

Since:

16205

getMissingPrimitives

public java.util.Set<PrimitiveId> getMissingPrimitives()

replies the set of ids of all primitives for which a fetch request to the server was submitted but which are not available from the server (the server replied a return code of 404)

Returns:

the set of ids of missing primitives

Since:

16205