Package org.openstreetmap.atlas.checks.validation.tag

Class GenericTagCheck

  • All Implemented Interfaces:
    java.io.Serializable, Check
    public class GenericTagCheck
extends BaseCheck<java.lang.String>
    Generic tag check using OSM Wiki Data and Tag Info databases.
    See Also:
    Serialized Form

    • Constructor Detail

      • GenericTagCheck

        public GenericTagCheck​(org.openstreetmap.atlas.utilities.configuration.Configuration configuration,
                       ExternalDataFetcher fileFetcher)
        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
        fileFetcher - A fetcher to get external data with

    • 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

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