Package org.openstreetmap.atlas.checks.validation.linear.edges

Class RoundaboutValenceCheck

java.lang.Object

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

org.openstreetmap.atlas.checks.validation.linear.edges.RoundaboutValenceCheck

All Implemented Interfaces:

java.io.Serializable, Check

public class RoundaboutValenceCheck
extends BaseCheck<java.lang.Long>

This check ensures that roundabouts with unreasonable valences are flagged. In reference to OSM Wiki, each roundabout should have greater than 1 connection as 1 connection should be tagged as a turning point, and no connections is obviously not a valid way. In addition, no individual Node within a roundabout should have more than one main Edge connecting from outside the roundabout.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
RoundaboutValenceCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)

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

RoundaboutValenceCheck

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

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)

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.Long>

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.Long>

Returns:

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