Package org.openstreetmap.atlas.checks.event

Class CheckFlagEvent

  • public final class CheckFlagEvent
extends org.openstreetmap.atlas.event.Event
    Wraps a CheckFlag for submission to the EventService for handling Check results

    • Constructor Detail

      • CheckFlagEvent

        public CheckFlagEvent​(java.lang.String checkName,
                      CheckFlag flag)
        Construct a CheckFlagEvent
        Parameters:
        checkName - name of the check that created this event
        flag - CheckFlag generated within this event

    • Method Detail

      • flagToFeature

        public static com.google.gson.JsonObject flagToFeature​(CheckFlag flag,
                                                       java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
        Converts give CheckFlag to GeoJsonObject with additional key-value parameters
        Parameters:
        flag - CheckFlag to convert to GeoJsonObject
        additionalProperties - additional key-value parameters to be added in "properties" element of the top-level JSON object
        Returns:
        GeoJsonObject created from CheckFlag

      • flagToJson

        public static com.google.gson.JsonObject flagToJson​(CheckFlag flag,
                                                    java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
        Converts given CheckFlag to JsonObject with additional key-value parameters
        Parameters:
        flag - CheckFlag to convert to JsonObject
        additionalProperties - additional key-value parameters to be added in "properties" element of the top-level JSON object
        Returns:
        JsonObject created from CheckFlag

      • asLineDelimitedGeoJsonFeatures

        public java.lang.String asLineDelimitedGeoJsonFeatures()

      • asLineDelimitedGeoJsonFeatures

        public java.lang.String asLineDelimitedGeoJsonFeatures​(java.util.function.Consumer<com.google.gson.JsonObject> jsonMutator)

      • getCheckFlag

        public CheckFlag getCheckFlag()
        Returns:
        CheckFlag generated by the check

      • getCheckName

        public java.lang.String getCheckName()
        Returns:
        Name of the check that generated this event

      • toGeoJsonFeature

        public com.google.gson.JsonObject toGeoJsonFeature()
        Returns:
        GeoJson Feature representation

      • toGeoJsonFeatureCollection

        public com.google.gson.JsonObject toGeoJsonFeatureCollection()
        Returns:
        JsonObject form of the GeoJson FeatureCollection representation

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        String form of the GeoJson FeatureCollection representation