Package org.elasticsearch.common.geo

Enum ShapeRelation

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ShapeRelation>, java.lang.constant.Constable, Writeable
    public enum ShapeRelation
extends java.lang.Enum<ShapeRelation>
implements Writeable
    Enum representing the relationship between a Query / Filter Shape and indexed Shapes that will be used to determine if a Document should be matched or not

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.lang.Enum

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    • Method Summary

      Modifier and Type Method Description
      org.apache.lucene.document.LatLonShape.QueryRelation getLuceneRelation()
      Maps ShapeRelation to Lucene's LatLonShapeRelation
      static ShapeRelation getRelationByName​(java.lang.String name)  
      java.lang.String getRelationName()  
      static ShapeRelation readFromStream​(StreamInput in)  
      static ShapeRelation valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ShapeRelation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      void writeTo​(StreamOutput out)
      Write this into the StreamOutput.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

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

      • valueOf

        public static ShapeRelation valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • readFromStream

        public static ShapeRelation readFromStream​(StreamInput in)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • getRelationByName

        public static ShapeRelation getRelationByName​(java.lang.String name)

      • getLuceneRelation

        public org.apache.lucene.document.LatLonShape.QueryRelation getLuceneRelation()
        Maps ShapeRelation to Lucene's LatLonShapeRelation

      • getRelationName

        public java.lang.String getRelationName()