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

Class RoadNameSpellingConsistencyCheck

  • All Implemented Interfaces:
    java.io.Serializable, Check
    public class RoadNameSpellingConsistencyCheck
extends BaseCheck<java.lang.Long>
    Flags road segments that have a NameTag with a different spelling from that of other segments of the same road. This check is primarily meant to catch small errors in spelling, such as a missing letter, letter accent mixups, or capitalization errors.
    See Also:
    Serialized Form

    • Constructor Detail

      • RoadNameSpellingConsistencyCheck

        public RoadNameSpellingConsistencyCheck​(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)

    • 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. squid:S3655 is suppressed because edges without names are filtered out by the walker.
        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 an OSM way for spelling inconsistencies.

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