Class 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
    • 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:
        true if this object should be checked
      • createFlag

        protected CheckFlag createFlag​(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object,
                                       java.lang.String instruction)
        Overrides:
        createFlag in class BaseCheck<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.
        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.