Package org.openstreetmap.atlas.checks.validation.tag

Class InvalidTagsCheck

java.lang.Object

org.openstreetmap.atlas.checks.base.BaseCheck<java.lang.String>

org.openstreetmap.atlas.checks.validation.tag.InvalidTagsCheck

All Implemented Interfaces:

java.io.Serializable, Check

public class InvalidTagsCheck
extends BaseCheck<java.lang.String>

This flags features based on configurable filters. Each filter passed contains the AtlasEntity classes to check and a TaggableFilter or a RegexTaggableFilter to test objects against. If a feature is of one of the given classes and passes the associated filter then it is flagged. In addition to the taggable filters, there are two configurable boolean values, "filters.resource.append.override" and "filters.resource.append". If the "filters.resource.append.override" key is set to true, only the filters passed through config are used to flag the atlas features. If the "filters.resource.append" is set to true, the filters passed through the config are appended to the default filters that are in the "invalidTags.txt" resource file.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	INLINE_REGEX_FILTER_SIZE

Fields inherited from class org.openstreetmap.atlas.checks.base.BaseCheck

PARAMETER_ACCEPT_PIERS, PARAMETER_CHALLENGE, PARAMETER_DENYLIST_COUNTRIES, PARAMETER_FLAG, PARAMETER_PERMITLIST_COUNTRIES, PARAMETER_PERMITLIST_TAGS, PARAMETER_USE_EXTERNAL_DATA

Constructor Summary

Constructors

Constructor	Description
InvalidTagsCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)	The default constructor that must be supplied.

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<CheckFlag>	flag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)	This is the actual function that will check to see whether the object needs to be flagged.
protected java.util.List<java.lang.String>	getFallbackInstructions()	Method to implement for inheriting checks to return the default set of instruction formats that will be the last resort in BaseCheck.getLocalizedInstruction(int, Object[])
boolean	validCheckForObject(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)	This function will validate if the supplied atlas object is valid for the check.

Methods inherited from class org.openstreetmap.atlas.checks.base.BaseCheck

acceptPier, check, checkObjectFilter, clear, clearFlaggedIdentifiers, configurationKey, configurationKey, configurationValue, configurationValue, createFlag, createFlag, createFlag, createFlag, createFlag, createFlag, createFlag, createFlag, flags, getChallenge, getCheckName, getCheckPolygonFilter, getCountries, getDenylistCountries, getFlaggedIdentifiers, getGlobalPolygonFilter, getLocale, getLocalizedInstruction, getTaskIdentifier, getTaskIdentifier, getUniqueObjectIdentifier, getUniqueOSMIdentifier, isFlagged, logStatus, markAsFlagged, useExternalData, validCheckForCountry

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.atlas.checks.base.Check

finder

Field Detail

INLINE_REGEX_FILTER_SIZE

public static final int INLINE_REGEX_FILTER_SIZE

See Also:

Constant Field Values

Constructor Detail

InvalidTagsCheck

public InvalidTagsCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)

The default constructor that must be supplied. The Atlas Checks framework will generate the checks with this constructor, supplying a configuration that can be used to adjust any parameters that the check uses during operation.

Parameters:

configuration - the JSON configuration for this check

Method Detail

validCheckForObject

public boolean validCheckForObject(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)

This function will validate if the supplied atlas object is valid for the check.

Parameters:

object - the atlas object supplied by the Atlas-Checks framework for evaluation

Returns:

true if this object should be checked

flag

protected java.util.Optional<CheckFlag> flag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)

This is the actual function that will check to see whether the object needs to be flagged.

Specified by:

flag in class BaseCheck<java.lang.String>

Parameters:

object - the atlas object supplied by the Atlas-Checks framework for evaluation

Returns:

an optional CheckFlag object that

getFallbackInstructions

protected java.util.List<java.lang.String> getFallbackInstructions()

Description copied from class: BaseCheck

Method to implement for inheriting checks to return the default set of instruction formats that will be the last resort in BaseCheck.getLocalizedInstruction(int, Object[])

Overrides:

getFallbackInstructions in class BaseCheck<java.lang.String>

Returns:

The set of instructions to fall back to if configuration results in none.