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

Class StreetNameCheck

  • All Implemented Interfaces:
    java.io.Serializable, Check
    public class StreetNameCheck
extends BaseCheck<java.lang.Long>
    Flags different values "ss" or "ß" for each country specified. Config file contains all the tags required to tag or not to tag specified for each country. The check looks at the object's ISO code and then pulls all the needed tags for that country from configuration.json .
    See Also:
    Serialized Form

    • Constructor Detail

      • StreetNameCheck

        public StreetNameCheck​(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. The function checks that the object is of type Node, Relation or Way (only include MainEdge) and that is has not been flagged already.
        Parameters:
        object - the atlas object supplied by the Atlas-Checks framework for evaluation
        Returns:
        true if this object should be checked

      • createFlag

        protected CheckFlag createFlag​(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object,
                               java.lang.String instruction)
        The function makes sure that the edges are flagged as ways. credit: Brian Jorgenson
        Overrides:
        createFlag in class BaseCheck<java.lang.Long>

      • 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 contains that values in the tag that need to be flagged

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