Class HighwayAccessCheck
- java.lang.Object
-
- org.openstreetmap.atlas.checks.base.BaseCheck<java.lang.Long>
-
- org.openstreetmap.atlas.checks.validation.tag.HighwayAccessCheck
-
- All Implemented Interfaces:
java.io.Serializable,Check
public class HighwayAccessCheck extends BaseCheck<java.lang.Long>
HighwayAccessCheck looks for ways that contain the access tag "yes" or "permissive". If the access tag is found, then the highway tag is also checked. Finally, the object is flagged if the highway tag is found in either motorway tags or in the footway tags provided in the beginning.- 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, PARAMETER_USE_EXTERNAL_DATA
-
-
Constructor Summary
Constructors Constructor Description HighwayAccessCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)The default constructor that must be supplied.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CheckFlagcreateFlag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object, java.lang.String instruction)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 inBaseCheck.getLocalizedInstruction(int, Object[])booleanvalidCheckForObject(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, flags, getChallenge, getCheckName, getCheckPolygonFilter, getCountries, getDenylistCountries, getFlaggedIdentifiers, getGlobalPolygonFilter, getLocale, getLocalizedInstruction, getTaskIdentifier, getTaskIdentifier, getUniqueObjectIdentifier, getUniqueOSMIdentifier, isFlagged, logStatus, markAsFlagged, useExternalData, validCheckForCountry
-
-
-
-
Constructor Detail
-
HighwayAccessCheck
public HighwayAccessCheck(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. There are no internal variables- 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:
trueif this object should be checked
-
createFlag
protected CheckFlag createFlag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object, java.lang.String instruction)
- Overrides:
createFlagin classBaseCheck<java.lang.Long>
-
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.
-
getFallbackInstructions
protected java.util.List<java.lang.String> getFallbackInstructions()
Description copied from class:BaseCheckMethod to implement for inheriting checks to return the default set of instruction formats that will be the last resort inBaseCheck.getLocalizedInstruction(int, Object[])- Overrides:
getFallbackInstructionsin classBaseCheck<java.lang.Long>- Returns:
- The set of instructions to fall back to if configuration results in none.
-
-