Package org.openstreetmap.atlas.checks.validation.areas

Class WaterbodyAndIslandSizeCheck

  • All Implemented Interfaces:
    java.io.Serializable, Check
    public class WaterbodyAndIslandSizeCheck
extends BaseCheck
    This check identifies waterbodies and islands that are either too small, or too large in size. Minimum surface area values are measured in meters squared; while maximum values are measured in kilometers squared. We use two units of conversion to avoid very small/large values. For example, 10 meters squared is .00001 kilometers, and 2,000,000 kilometers squared is 2,000,000,000 meters squared. An island can either be tagged as place=island, place=islet, place=archipelago, or a MultiPolygon Relation with the type=multipolygon and natural=water tags.
    See Also:
    Serialized Form

    • Constructor Detail

      • WaterbodyAndIslandSizeCheck

        public WaterbodyAndIslandSizeCheck​(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

      • 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
        Returns:
        The set of instructions to fall back to if configuration results in none.

      • 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

      • 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
        Parameters:
        object - the atlas object supplied by the Atlas-Checks framework for evaluation
        Returns:
        an optional CheckFlag object that