org.openstreetmap.atlas.checks.validation.areas

Class ShadowDetectionCheck

java.lang.Object

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

org.openstreetmap.atlas.checks.validation.areas.ShadowDetectionCheck

All Implemented Interfaces:

java.io.Serializable, Check

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

This flags buildings that are floating in 3D, thus casting a shadow on the base map when rendered in 3D. Buildings are defined as Areas with a building or building:part tag or are part of a building relation, or a relation of type multipolygon with a building tag.

See Also:

Serialized Form

Field Summary

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

PARAMETER_ACCEPT_PIERS, PARAMETER_BLACKLIST_COUNTRIES, PARAMETER_CHALLENGE, PARAMETER_FLAG, PARAMETER_WHITELIST_COUNTRIES, PARAMETER_WHITELIST_TAGS

Constructor Summary

Constructors

Constructor and Description
ShadowDetectionCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration) The default constructor that must be supplied.

Method Summary

Modifier and Type	Method and Description
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.
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, flags, getBlacklistCountries, getChallenge, getCheckName, getCountries, getFlaggedIdentifiers, getLocale, getLocalizedInstruction, getTaskIdentifier, getTaskIdentifier, getUniqueObjectIdentifier, getUniqueOSMIdentifier, isFlagged, logStatus, markAsFlagged, 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

ShadowDetectionCheck

public ShadowDetectionCheck(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.

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