Package org.hibernate.spatial.dialect.oracle.criterion

Enum RelationshipMask

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RelationshipMask>
    public enum RelationshipMask
extends java.lang.Enum<RelationshipMask>
    Enumerates the types of spatial relationship masks supported by Oracle Spatial.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANYINTERACT
      The "anyinteract" relationship
      CONTAINS
      The "contains" relationship
      COVEREDBY
      The "coveredby" relationship
      COVERS
      The "covers" relationship
      EQUAL
      The "equal" relationship
      INSIDE
      The "inside" relationship
      ON
      The "on" relationship
      OVERLAPBYDISJOINT
      The "overlapbydisjoint" relationship
      OVERLAPBYINTERSECT
      The "overlapbyintersect" relationship
      TOUCH
      The "touch" relationship

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String booleanCombination​(RelationshipMask[] masks)
      Combines the passed "RelationshipMasks
      static RelationshipMask valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RelationshipMask[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • OVERLAPBYDISJOINT

        public static final RelationshipMask OVERLAPBYDISJOINT
        The "overlapbydisjoint" relationship

      • OVERLAPBYINTERSECT

        public static final RelationshipMask OVERLAPBYINTERSECT
        The "overlapbyintersect" relationship

      • COVEREDBY

        public static final RelationshipMask COVEREDBY
        The "coveredby" relationship

      • CONTAINS

        public static final RelationshipMask CONTAINS
        The "contains" relationship

      • ANYINTERACT

        public static final RelationshipMask ANYINTERACT
        The "anyinteract" relationship

    • Method Detail

      • values

        public static RelationshipMask[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (RelationshipMask c : RelationshipMask.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static RelationshipMask 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

      • booleanCombination

        public static java.lang.String booleanCombination​(RelationshipMask[] masks)
        Combines the passed "RelationshipMasks
        Parameters:
        masks - The array of masks to combine
        Returns:
        A String representing the combined relationship mask