org.openstreetmap.josm.data.validation.tests

Class OpeningHourTest

java.lang.Object

org.openstreetmap.josm.data.osm.visitor.AbstractVisitor

org.openstreetmap.josm.data.validation.Test

org.openstreetmap.josm.data.validation.Test.TagTest

org.openstreetmap.josm.data.validation.tests.OpeningHourTest

All Implemented Interfaces:

Visitor

public class OpeningHourTest
extends Test.TagTest

Tests the correct usage of the opening hour syntax of the tags opening_hours, collection_times, service_times according to opening_hours.js.

Since:

6370

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	OpeningHourTest.CheckMode
class	OpeningHourTest.OpeningHoursTestError An error concerning invalid syntax for an "opening_hours"-like tag.

Nested classes/interfaces inherited from class org.openstreetmap.josm.data.validation.Test

Test.TagTest

Field Summary

Fields

Modifier and Type	Field and Description
static javax.script.ScriptEngine	ENGINE Javascript engine

Fields inherited from class org.openstreetmap.josm.data.validation.Test

checkBeforeUpload, checkEnabled, description, enabled, errors, isBeforeUpload, name, partialSelection, progressMonitor, startTime, testBeforeUpload

Constructor Summary

Constructors

Constructor and Description
OpeningHourTest() Constructs a new OpeningHourTest.

Method Summary

Modifier and Type	Method and Description
void	check(OsmPrimitive p) Checks the tags of the given primitive.
protected void	check(OsmPrimitive p, java.lang.String key, OpeningHourTest.CheckMode mode)
java.util.List<OpeningHourTest.OpeningHoursTestError>	checkOpeningHourSyntax(java.lang.String key, java.lang.String value) Checks for a correct usage of the opening hour syntax of the value given, in time range mode, according to opening_hours.js and returns a list containing validation errors or an empty list.
java.util.List<OpeningHourTest.OpeningHoursTestError>	checkOpeningHourSyntax(java.lang.String key, java.lang.String value, OpeningHourTest.CheckMode mode) Checks for a correct usage of the opening hour syntax of the value given according to opening_hours.js and returns a list containing validation errors or an empty list.
java.util.List<OpeningHourTest.OpeningHoursTestError>	checkOpeningHourSyntax(java.lang.String key, java.lang.String value, OpeningHourTest.CheckMode mode, boolean ignoreOtherSeverity) Checks for a correct usage of the opening hour syntax of the value given according to opening_hours.js and returns a list containing validation errors or an empty list.
private java.lang.String	getErrorMessage(java.lang.String key, java.lang.Object o) Translates and shortens the error/warning message.
protected java.util.List<java.lang.Object>	getList(java.lang.Object obj)
void	initialize() Initializes any global data used this tester.
protected java.lang.Object	parse(java.lang.String value, OpeningHourTest.CheckMode mode)

Methods inherited from class org.openstreetmap.josm.data.validation.Test.TagTest

visit, visit, visit

Methods inherited from class org.openstreetmap.josm.data.validation.Test

addGui, deletePrimitivesIfNeeded, endTest, equals, fixError, getErrors, getName, hashCode, isBuilding, isCanceled, isFixable, isPrimitiveUsable, ok, setBeforeUpload, setPartialSelection, startTest, testBeforeUpload, visit

Methods inherited from class org.openstreetmap.josm.data.osm.visitor.AbstractVisitor

visit

Methods inherited from class java.lang.Object

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

Field Detail

ENGINE

public static final javax.script.ScriptEngine ENGINE

Javascript engine

Constructor Detail

OpeningHourTest

public OpeningHourTest()

Constructs a new OpeningHourTest.

Method Detail

initialize

public void initialize()
                throws java.lang.Exception

Description copied from class: Test

Initializes any global data used this tester.

Overrides:

initialize in class Test

Throws:

java.lang.Exception - When cannot initialize the test

parse

protected java.lang.Object parse(java.lang.String value,
                                 OpeningHourTest.CheckMode mode)
                          throws javax.script.ScriptException,
                                 java.lang.NoSuchMethodException

Throws:

javax.script.ScriptException

java.lang.NoSuchMethodException

getList

protected java.util.List<java.lang.Object> getList(java.lang.Object obj)
                                            throws javax.script.ScriptException,
                                                   java.lang.NoSuchMethodException

Throws:

javax.script.ScriptException

java.lang.NoSuchMethodException

checkOpeningHourSyntax

public java.util.List<OpeningHourTest.OpeningHoursTestError> checkOpeningHourSyntax(java.lang.String key,
                                                                                    java.lang.String value,
                                                                                    OpeningHourTest.CheckMode mode)

Checks for a correct usage of the opening hour syntax of the value given according to opening_hours.js and returns a list containing validation errors or an empty list. Null values result in an empty list.

Parameters:

key - the OSM key (should be "opening_hours", "collection_times" or "service_times"). Used in error message

value - the opening hour value to be checked.

mode - whether to validate value as a time range, or points in time, or both.

Returns:

a list of TestError or an empty list

checkOpeningHourSyntax

public java.util.List<OpeningHourTest.OpeningHoursTestError> checkOpeningHourSyntax(java.lang.String key,
                                                                                    java.lang.String value,
                                                                                    OpeningHourTest.CheckMode mode,
                                                                                    boolean ignoreOtherSeverity)

Checks for a correct usage of the opening hour syntax of the value given according to opening_hours.js and returns a list containing validation errors or an empty list. Null values result in an empty list.

Parameters:

key - the OSM key (should be "opening_hours", "collection_times" or "service_times").

value - the opening hour value to be checked.

mode - whether to validate value as a time range, or points in time, or both.

ignoreOtherSeverity - whether to ignore errors with Severity.OTHER.

Returns:

a list of TestError or an empty list

getErrorMessage

private java.lang.String getErrorMessage(java.lang.String key,
                                         java.lang.Object o)

Translates and shortens the error/warning message.

checkOpeningHourSyntax

public java.util.List<OpeningHourTest.OpeningHoursTestError> checkOpeningHourSyntax(java.lang.String key,
                                                                                    java.lang.String value)

Checks for a correct usage of the opening hour syntax of the value given, in time range mode, according to opening_hours.js and returns a list containing validation errors or an empty list. Null values result in an empty list.

Parameters:

key - the OSM key (should be "opening_hours", "collection_times" or "service_times"). Used in error message

value - the opening hour value to be checked.

Returns:

a list of TestError or an empty list

check

protected void check(OsmPrimitive p,
                     java.lang.String key,
                     OpeningHourTest.CheckMode mode)

check

public void check(OsmPrimitive p)

Description copied from class: Test.TagTest

Checks the tags of the given primitive.

Specified by:

check in class Test.TagTest

Parameters:

p - The primitive to test