Package org.openstreetmap.josm.data.validation

Class ValidationTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.data.validation.ValidationTask

All Implemented Interfaces:

java.lang.Runnable, ProgressMonitor.CancelListener

public class ValidationTask
extends PleaseWaitRunnable

Asynchronous task for running a collection of tests against a collection of primitives

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	beforeUpload
private boolean	canceled
private java.util.List<TestError>	errors
private java.util.Collection<OsmPrimitive>	formerValidatedPrimitives
private java.util.Collection<OsmPrimitive>	initialPrimitives
private java.util.function.Consumer<java.util.List<TestError>>	onFinish
private java.util.function.BiConsumer<ValidationTask,Test>	testConsumer
private java.util.Collection<Test>	tests

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

progressMonitor

Constructor Summary

Constructors

Modifier	Constructor	Description
	ValidationTask(java.util.Collection<Test> tests, java.util.Collection<OsmPrimitive> validatedPrimitives, java.util.Collection<OsmPrimitive> formerValidatedPrimitives)	Constructs a new ValidationTask
	ValidationTask(java.util.function.Consumer<java.util.List<TestError>> onFinish, ProgressMonitor progressMonitor, java.util.Collection<Test> tests, java.util.Collection<OsmPrimitive> validatedPrimitives, java.util.Collection<OsmPrimitive> formerValidatedPrimitives, boolean beforeUpload)	Constructs a new ValidationTask
protected	ValidationTask(ProgressMonitor progressMonitor, java.util.Collection<Test> tests, java.util.Collection<OsmPrimitive> validatedPrimitives, java.util.Collection<OsmPrimitive> formerValidatedPrimitives)

Method Summary

Modifier and Type	Method	Description
protected void	cancel()	User pressed cancel button.
protected void	finish()	Finish up the data work.
java.util.List<TestError>	getErrors()	Gets the validation errors accumulated until this moment.
private static java.util.Set<OsmPrimitive>	getRelevantParents(java.util.Collection<OsmPrimitive> primitives)	Find objects parent objects of given objects which should be checked for geometry problems or mismatches between child tags and parent tags.
protected void	realRun()	Called in the worker thread to do the actual work.
void	setTestConsumer(java.util.function.BiConsumer<ValidationTask,Test> testConsumer)	A test consumer to avoid filling up memory.

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

onFinish

private final java.util.function.Consumer<java.util.List<TestError>> onFinish

tests

private java.util.Collection<Test> tests

initialPrimitives

private final java.util.Collection<OsmPrimitive> initialPrimitives

formerValidatedPrimitives

private final java.util.Collection<OsmPrimitive> formerValidatedPrimitives

beforeUpload

private final boolean beforeUpload

canceled

private boolean canceled

errors

private final java.util.List<TestError> errors

testConsumer

private java.util.function.BiConsumer<ValidationTask,Test> testConsumer

Constructor Detail

ValidationTask

public ValidationTask(java.util.Collection<Test> tests,
                      java.util.Collection<OsmPrimitive> validatedPrimitives,
                      java.util.Collection<OsmPrimitive> formerValidatedPrimitives)

Constructs a new ValidationTask

Parameters:

tests - the tests to run

validatedPrimitives - the collection of primitives to validate.

formerValidatedPrimitives - the last collection of primitives being validated. May be null.

ValidationTask

public ValidationTask(java.util.function.Consumer<java.util.List<TestError>> onFinish,
                      ProgressMonitor progressMonitor,
                      java.util.Collection<Test> tests,
                      java.util.Collection<OsmPrimitive> validatedPrimitives,
                      java.util.Collection<OsmPrimitive> formerValidatedPrimitives,
                      boolean beforeUpload)

Constructs a new ValidationTask

Parameters:

onFinish - called when the tests are finished

progressMonitor - the progress monitor to update with test progress

tests - the tests to run

validatedPrimitives - the collection of primitives to validate.

formerValidatedPrimitives - the last collection of primitives being validated. May be null.

beforeUpload - true if this is being run prior to upload

Since:

18752

ValidationTask

protected ValidationTask(ProgressMonitor progressMonitor,
                         java.util.Collection<Test> tests,
                         java.util.Collection<OsmPrimitive> validatedPrimitives,
                         java.util.Collection<OsmPrimitive> formerValidatedPrimitives)

Method Detail

getRelevantParents

private static java.util.Set<OsmPrimitive> getRelevantParents(java.util.Collection<OsmPrimitive> primitives)

Find objects parent objects of given objects which should be checked for geometry problems or mismatches between child tags and parent tags.

Parameters:

primitives - the given objects

Returns:

the collection of relevant parent objects

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()

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

getErrors

public java.util.List<TestError> getErrors()

Gets the validation errors accumulated until this moment.

Returns:

The list of errors

setTestConsumer

public void setTestConsumer(java.util.function.BiConsumer<ValidationTask,Test> testConsumer)

A test consumer to avoid filling up memory. A test consumer may remove tests it has consumed.

Parameters:

testConsumer - The consumer which takes a ValidationTask (this) and the test that finished.

Since:

18752