Package org.openstreetmap.atlas.checks.validation.linear.lines

Class GeneralizedCoastlineCheck

java.lang.Object

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

org.openstreetmap.atlas.checks.validation.linear.lines.GeneralizedCoastlineCheck

All Implemented Interfaces:

java.io.Serializable, Check

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

Flags generalized coastlines-- that is, OSM ways with the tag natural=coastline where x% or more node pairs are y or more meters apart. X and y can be specified in a Configuration. Additionally flags sharp angle locations according to the angle.minimum.threshold Configuration value if it's greater than -1. Coastlines can be represented in Atlas by LineItems and may be members of Relations.

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

Constructor Summary

Constructors

Constructor	Description
GeneralizedCoastlineCheck(org.openstreetmap.atlas.utilities.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<CheckFlag>	flag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)	This method flags appropriate atlas objects
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 method validates or invalidates the supplied atlas object 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, 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

GeneralizedCoastlineCheck

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

Method Detail

validCheckForObject

public boolean validCheckForObject(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)

This method validates or invalidates the supplied atlas object for the check

Parameters:

object - The AtlasObject being checked

Returns:

True if the AtlasObject is a LineItem with the tag natural=coastline, or has a parent relation with that tag; false otherwise

flag

protected java.util.Optional<CheckFlag> flag(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object)

This method flags appropriate atlas objects

Specified by:

flag in class BaseCheck<java.lang.Long>

Parameters:

object - The AtlasObject being analyzed for potential flagging

Returns:

A flag on the parameter AtlasObject if it's a generalized coastline; an empty Optional otherwise

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.