org.openstreetmap.josm.data.validation.tests

Class OpeningHourTest

java.lang.Object

org.openstreetmap.josm.data.validation.Test

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

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

All Implemented Interfaces:

java.lang.Comparable<Test>, OsmPrimitiveVisitor

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
static class	OpeningHourTest.CheckMode In OSM, the syntax originally designed to describe opening hours, is now used to describe a few other things as well.
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, IN_DOWNLOADED_AREA, IN_DOWNLOADED_AREA_STRICT, 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)
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 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, java.lang.String locale) 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.
static java.lang.String	getErrorMessage(java.lang.Object o) Translates and shortens the error/warning message.
(package private) static 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)
java.util.List<java.lang.Object>	getOpeningHoursErrors(java.lang.Object r) Returns the list of errors returned by the opening hours parser.
java.lang.String	getOpeningHoursPrettifiedValues(java.lang.Object r) Returns the prettified value returned by the opening hours parser.
java.util.List<java.lang.Object>	getOpeningHoursWarnings(java.lang.Object r) Returns the list of warnings returned by the opening hours parser.
void	initialize() Initializes any global data used this tester.
java.lang.Object	parse(java.lang.String value, java.lang.String tagKey, OpeningHourTest.CheckMode mode, java.lang.String locale) Parses the opening hour syntax of the value given according to opening_hours.js and returns an object on which methods can be called to extract information.

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, clear, compareTo, deletePrimitivesIfNeeded, endTest, equals, fixError, getErrors, getName, hashCode, isBuilding, isCanceled, isFixable, isPrimitiveUsable, isResidentialArea, ok, setBeforeUpload, setPartialSelection, setShowElements, startTest, testBeforeUpload, 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

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

Parses the opening hour syntax of the value given according to opening_hours.js and returns an object on which methods can be called to extract information.

Parameters:

value - the opening hour value to be checked

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

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

locale - the locale code used for localizing messages

Returns:

The value returned by the underlying method. Usually a jdk.nashorn.api.scripting.ScriptObjectMirror

Throws:

javax.script.ScriptException - if an error occurs during invocation of the underlying method

java.lang.NoSuchMethodException - if underlying method with given name or matching argument types cannot be found

Since:

13147

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)

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.

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,
                                                                                    java.lang.String locale)

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. Can be null

ignoreOtherSeverity - whether to ignore errors with Severity.OTHER.

locale - the locale code used for localizing messages

Returns:

a list of TestError or an empty list

getOpeningHoursPrettifiedValues

public final java.lang.String getOpeningHoursPrettifiedValues(java.lang.Object r)
                                                       throws java.lang.NoSuchMethodException,
                                                              javax.script.ScriptException

Returns the prettified value returned by the opening hours parser.

Parameters:

r - result of parse(java.lang.String, java.lang.String, org.openstreetmap.josm.data.validation.tests.OpeningHourTest.CheckMode, java.lang.String)

Returns:

the prettified value returned by the opening hours parser

Throws:

java.lang.NoSuchMethodException - if method "prettifyValue" or matching argument types cannot be found

javax.script.ScriptException - if an error occurs during invocation of the JavaScript method

Since:

13296

getOpeningHoursErrors

public final java.util.List<java.lang.Object> getOpeningHoursErrors(java.lang.Object r)
                                                             throws java.lang.NoSuchMethodException,
                                                                    javax.script.ScriptException

Returns the list of errors returned by the opening hours parser.

Parameters:

r - result of parse(java.lang.String, java.lang.String, org.openstreetmap.josm.data.validation.tests.OpeningHourTest.CheckMode, java.lang.String)

Returns:

the list of errors returned by the opening hours parser

Throws:

java.lang.NoSuchMethodException - if method "getErrors" or matching argument types cannot be found

javax.script.ScriptException - if an error occurs during invocation of the JavaScript method

Since:

13296

getOpeningHoursWarnings

public final java.util.List<java.lang.Object> getOpeningHoursWarnings(java.lang.Object r)
                                                               throws java.lang.NoSuchMethodException,
                                                                      javax.script.ScriptException

Returns the list of warnings returned by the opening hours parser.

Parameters:

r - result of parse(java.lang.String, java.lang.String, org.openstreetmap.josm.data.validation.tests.OpeningHourTest.CheckMode, java.lang.String)

Returns:

the list of warnings returned by the opening hours parser

Throws:

java.lang.NoSuchMethodException - if method "getWarnings" or matching argument types cannot be found

javax.script.ScriptException - if an error occurs during invocation of the JavaScript method

Since:

13296

getErrorMessage

public static java.lang.String getErrorMessage(java.lang.Object o)

Translates and shortens the error/warning message.

Parameters:

o - error/warning message returned by getOpeningHoursErrors(java.lang.Object) or getOpeningHoursWarnings(java.lang.Object)

Returns:

translated/shortened error/warning message

Since:

13298

getErrorMessage

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

Translates and shortens the error/warning message.

Parameters:

key - OSM key

o - error/warning message returned by getOpeningHoursErrors(java.lang.Object) or getOpeningHoursWarnings(java.lang.Object)

Returns:

translated/shortened error/warning message

check

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

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