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

Class FixMeReviewCheck

java.lang.Object

org.openstreetmap.atlas.checks.base.BaseCheck<java.lang.Long>

org.openstreetmap.atlas.checks.validation.tag.FixMeReviewCheck

All Implemented Interfaces:

java.io.Serializable, Check

public class FixMeReviewCheck
extends BaseCheck<java.lang.Long>

This check flags features which contain the "fixme" or "FIXME" tag as well as other combinations of important tags.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openstreetmap.atlas.checks.base.BaseCheck

PARAMETER_ACCEPT_PIERS, PARAMETER_CHALLENGE, PARAMETER_DENYLIST_COUNTRIES, PARAMETER_FLAG, PARAMETER_PERMITLIST_COUNTRIES, PARAMETER_PERMITLIST_TAGS, PARAMETER_USE_EXTERNAL_DATA

Constructor Summary

Constructors

Constructor	Description
FixMeReviewCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)	instantiate config values

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<CheckFlag>	flag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)	This is the function that will check to see whether the object needs to be flagged.
protected java.util.List<java.lang.String>	getFallbackInstructions()	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[])
boolean	validCheckForObject(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)	This function will validate if the supplied atlas object is valid for the check.

Methods inherited from class org.openstreetmap.atlas.checks.base.BaseCheck

acceptPier, check, checkObjectFilter, clear, clearFlaggedIdentifiers, configurationKey, configurationKey, configurationValue, configurationValue, createFlag, createFlag, createFlag, createFlag, createFlag, createFlag, createFlag, createFlag, flags, getChallenge, getCheckName, getCheckPolygonFilter, getCountries, getDenylistCountries, getFlaggedIdentifiers, getGlobalPolygonFilter, getLocale, getLocalizedInstruction, getTaskIdentifier, getTaskIdentifier, getUniqueObjectIdentifier, getUniqueOSMIdentifier, isFlagged, logStatus, markAsFlagged, useExternalData, validCheckForCountry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openstreetmap.atlas.checks.base.Check

finder

Constructor Detail

FixMeReviewCheck

public FixMeReviewCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)

instantiate config values

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.

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

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.