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

Class AbbreviatedNameCheck

java.lang.Object

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

org.openstreetmap.atlas.checks.validation.tag.AbbreviatedNameCheck

All Implemented Interfaces:

java.io.Serializable, Check

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

Flags names that have abbreviations in them. Per OSM wiki, if the name can be spelled without an abbreviation, then it must not be abbreviated. Computers can easily shorten words, but not the other way (St. could be Street or Saint).

See Also:

wiki for more information., Serialized Form

Field Summary

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
AbbreviatedNameCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)	Default constructor

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<CheckFlag>	flag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)	Flags AtlasObjects that has names with abbreviations.
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)	Checks to see whether the supplied object class type is valid for this particular 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

Constructor Detail

AbbreviatedNameCheck

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

Default constructor

Parameters:

configuration - the JSON configuration for this check

Method Detail

validCheckForObject

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

Description copied from interface: Check

Checks to see whether the supplied object class type is valid for this particular check

Parameters:

object - The AtlasObject you are checking

Returns:

true if it is

flag

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

Flags AtlasObjects that has names with abbreviations.

Specified by:

flag in class BaseCheck<java.lang.String>

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.