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

Class InvalidPiersCheck

  • All Implemented Interfaces:
    java.io.Serializable, Check
    public class InvalidPiersCheck
extends BaseCheck<java.lang.Long>
    This check identifies piers (OSM ways with man_made = Pier tag) that have either a linear geometry and no area = Yes tag, or a polygonal geometry and no area=Yes tag. A pier must also have (i) a highway Tag or (ii) a highway overlapping the pier at the same level/layer as the pier or (iii) be connected to a ferry route/amenity = Ferry_Terminal or (iv) be connected to a building at the same level/layer as the pier. A polygonal pier with a building tag or amenity=ferry_terminal is also valid for the check.
    See Also:
    Serialized Form

    • Constructor Detail

      • InvalidPiersCheck

        public InvalidPiersCheck​(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. Valid object for the check is a main edge with man_made=pier tag and does not have an area=yes tag.
        Parameters:
        object - the atlas object supplied by the Atlas-Checks framework for evaluation
        Returns:
        true if this object should be checked

      • acceptPier

        protected boolean acceptPier()
        Overriding this method to not skip piers.
        Overrides:
        acceptPier in class BaseCheck<java.lang.Long>
        Returns:
        true since we need the check to accept piers

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