org.openstreetmap.atlas.checks.base

Interface Check

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbbreviatedNameCheck, AddressPointMatchCheck, AreasWithHighwayTagCheck, BaseCheck, BuildingRoadIntersectionCheck, ConflictingAreaTagCombination, DuplicateNodeCheck, DuplicatePointCheck, DuplicateWaysCheck, EdgeCrossingEdgeCheck, FloatingEdgeCheck, IntersectingBuildingsCheck, InvalidAccessTagCheck, InvalidLanesTagCheck, InvalidMiniRoundaboutCheck, InvalidTurnRestrictionCheck, MalformedRoundaboutCheck, MixedCaseNameCheck, OneMemberRelationCheck, OrphanNodeCheck, OverlappingAOIPolygonCheck, PoolSizeCheck, RoundaboutClosedLoopCheck, RoundaboutValenceCheck, SelfIntersectingPolylineCheck, ShadowDetectionCheck, SharpAngleCheck, SignPostCheck, SinkIslandCheck, SnakeRoadCheck, SpikyBuildingCheck, StreetNameIntegersOnlyCheck, UnusualLayerTagsCheck, WaterbodyAndIslandSizeCheck

public interface Check
extends java.io.Serializable

The check interface has one method that will execute the check against an atlas entity and return an Optional CheckFlag. If the optional is empty then the check didn't find anything to flag.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<CheckFlag>	check(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object) The check for the atlas object
void	clear() Cleanup check to remove any remaining artifacts from execution
default java.util.Optional<org.openstreetmap.atlas.geography.atlas.items.complex.Finder>	finder() The finder returned will be used to collect the ComplexEntitys this check will be applied to.
java.lang.Iterable<CheckFlag>	flags(org.openstreetmap.atlas.geography.atlas.Atlas atlas) Compute and return all the CheckFlags from this check, given AtlasEntitys and Relations.
Challenge	getChallenge() Gets a challenge object for the specific check
java.lang.String	getCheckName() Gets the name of this check
void	logStatus() Helper for debugging.
boolean	validCheckForCountry(java.lang.String country) Checks to see whether the check is valid for the given country.
boolean	validCheckForObject(org.openstreetmap.atlas.geography.atlas.items.AtlasObject object) Checks to see whether the supplied object class type is valid for this particular check

Method Detail

check

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

The check for the atlas object

Parameters:

object - The AtlasObject to check

Returns:

an Optional CheckFlag, Optional.EMPTY if check did not reveal any errors

clear

void clear()

Cleanup check to remove any remaining artifacts from execution

finder

default java.util.Optional<org.openstreetmap.atlas.geography.atlas.items.complex.Finder> finder()

The finder returned will be used to collect the ComplexEntitys this check will be applied to.

Returns:

An Optional Finder

flags

java.lang.Iterable<CheckFlag> flags(org.openstreetmap.atlas.geography.atlas.Atlas atlas)

Compute and return all the CheckFlags from this check, given AtlasEntitys and Relations. ComplexEntitys can be added as well, using the appropriate Finder.

Parameters:

atlas - the Atlas to check

Returns:

all the CheckFlags from this check

getChallenge

Challenge getChallenge()

Gets a challenge object for the specific check

Returns:

a Challenge

getCheckName

java.lang.String getCheckName()

Gets the name of this check

Returns:

a String name

logStatus

void logStatus()

Helper for debugging. Implement in check to log info after check is run.

validCheckForCountry

boolean validCheckForCountry(java.lang.String country)

Checks to see whether the check is valid for the given country.

Parameters:

country - country to check

Returns:

true if the check is applicable to the given country

validCheckForObject

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

Checks to see whether the supplied object class type is valid for this particular check

Parameters:

object - The AtlasObject you are checking

Returns:

true if it is