Package org.openstreetmap.atlas.checks.validation.intersections

Class OceanBleedingCheck

  • All Implemented Interfaces:
    java.io.Serializable, Check
    public class OceanBleedingCheck
extends BaseCheck<java.lang.Long>
    Flags railways (configurable), streets (configurable), buildings that bleed into an ocean. An ocean is defined by a set of ocean tags, and can be an Area or LineItem. Differs from LineCrossingWaterBodyCheck in that that check has a different set of tags/geometries to define waterbodies.
    See Also:
    Serialized Form

    • Constructor Detail

      • OceanBleedingCheck

        public OceanBleedingCheck​(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 ocean features that are tagged appropriately.
        Parameters:
        object - the atlas object supplied by the Atlas-Checks framework for evaluation
        Returns:
        true if this object should be checked

      • flag

        protected java.util.Optional<CheckFlag> flag​(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)
        We flag railways, streets, and buildings that intersect or are within certain ocean features, so each flag is a collection of all invalid interactions for a given ocean feature.
        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 flags the objects that invalidly intersect the ocean feature

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