Package org.elasticsearch.index.query

Enum Class GeoValidationMethod

java.lang.Object
java.lang.Enum<GeoValidationMethod>
org.elasticsearch.index.query.GeoValidationMethod
All Implemented Interfaces:
Serializable, Comparable<GeoValidationMethod>, Constable, Writeable
public enum GeoValidationMethod extends Enum<GeoValidationMethod> implements Writeable
This enum is used to determine how to deal with invalid geo coordinates in geo related queries: On STRICT validation invalid coordinates cause an exception to be thrown. On IGNORE_MALFORMED invalid coordinates are being accepted. On COERCE invalid coordinates are being corrected to the most likely valid coordinate.

  • Enum Constant Details

  • Field Details

    • DEFAULT

      public static final GeoValidationMethod DEFAULT

    • DEFAULT_LENIENT_PARSING

      public static final boolean DEFAULT_LENIENT_PARSING

  • Method Details

    • values

      public static GeoValidationMethod[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GeoValidationMethod valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • readFromStream

      public static GeoValidationMethod readFromStream(StreamInput in) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • fromString

      public static GeoValidationMethod fromString(String op)

    • isIgnoreMalformed

      public static boolean isIgnoreMalformed(GeoValidationMethod method)
      Returns whether or not to skip bounding box validation.

    • isCoerce

      public static boolean isCoerce(GeoValidationMethod method)
      Returns whether or not to try and fix broken/wrapping bounding boxes.

    • infer

      public static GeoValidationMethod infer(boolean coerce, boolean ignoreMalformed)
      Returns validation method corresponding to given coerce and ignoreMalformed values.