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

Class SDOParameterMap

  • public class SDOParameterMap
extends java.lang.Object
    Represents the parameters that can be passed into Oracle's Spatial operators

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DISTANCE
      The distance parameter
      static java.lang.String MASK
      The mask parameter
      static java.lang.String MAX_RESOLUTION
      The max_resolution parameter
      static java.lang.String MIN_RESOLUTION
      The min_resolution parameter
      static java.lang.String QUERYTYPE
      The querytype parameter
      static java.lang.String SDO_BATCH_SIZE
      The sdo_batch_size parameter
      static java.lang.String SDO_NUM_RES
      The sdo_num_res parameter
      static java.lang.String UNIT
      The unit parameter

    • Constructor Summary

      Constructors 
      Constructor Description
      SDOParameterMap()
      Constructs an empty instance

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Double getDistance()  
      java.lang.String getMask()  
      java.lang.Double getMaxResolution()  
      java.lang.Double getMinResolution()  
      java.lang.String getQueryType()  
      java.lang.Integer getSdoBatchSize()  
      java.lang.Integer getSdoNumRes()  
      java.lang.String getUnit()  
      boolean isEmpty()
      Checks whether this instance is empty
      void removeDistance()
      Removes the distance parameter
      void removeMask()
      Removes the mask parameter
      void removeMaxResolution()
      Removes the max_resolution parameter
      void removeMinResolution()
      Removes the min_resolution parameter
      void removeQueryType()
      Removes the querytype parameter
      void removeSdoBatchSize()
      Removes the sdo_batch_size parameter
      void removeSdoNumRes()
      Removes the sdo_num_res parameter
      void removeUnit()
      Removes the unit parameter
      void setDistance​(java.lang.Double distance)
      Adds the distance parameter with the specified value
      void setMask​(java.lang.String mask)
      Adds the mask parameter with the specified value
      void setMaxResolution​(java.lang.Double res)
      Adds the max_resolution parameter with the specified value
      void setMinResolution​(java.lang.Double res)
      Adds the min_resolution parameter with the specified value
      void setQueryType​(java.lang.String queryType)
      Adds the querytype parameter with the specified value
      void setQueryTypeToFilter()
      Adds the querytype parameter with value "FILTER"
      void setSdoBatchSize​(java.lang.Integer size)
      Adds the sdo_batch_size parameter with the specified value
      void setSdoNumRes​(java.lang.Integer res)
      Adds the sdo_num_res parameter with the specified value
      void setUnit​(java.lang.String unit)
      Adds the unit parameter with the specified value
      java.lang.String toQuotedString()
      Returns all parameters contained in this instance as a quoted String containing the <parameter name>=<parameter value> pairs separated by spaces.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DISTANCE

        public static final java.lang.String DISTANCE
        The distance parameter
        See Also:
        Constant Field Values

      • SDO_BATCH_SIZE

        public static final java.lang.String SDO_BATCH_SIZE
        The sdo_batch_size parameter
        See Also:
        Constant Field Values

      • SDO_NUM_RES

        public static final java.lang.String SDO_NUM_RES
        The sdo_num_res parameter
        See Also:
        Constant Field Values

      • MIN_RESOLUTION

        public static final java.lang.String MIN_RESOLUTION
        The min_resolution parameter
        See Also:
        Constant Field Values

      • MAX_RESOLUTION

        public static final java.lang.String MAX_RESOLUTION
        The max_resolution parameter
        See Also:
        Constant Field Values

      • QUERYTYPE

        public static final java.lang.String QUERYTYPE
        The querytype parameter
        See Also:
        Constant Field Values

    • Constructor Detail

      • SDOParameterMap

        public SDOParameterMap()
        Constructs an empty instance

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Checks whether this instance is empty
        Returns:
        true if empty, false otherwise

      • getDistance

        public java.lang.Double getDistance()

      • setDistance

        public void setDistance​(java.lang.Double distance)
        Adds the distance parameter with the specified value
        Parameters:
        distance - The value for the distance parameter

      • removeDistance

        public void removeDistance()
        Removes the distance parameter

      • getSdoBatchSize

        public java.lang.Integer getSdoBatchSize()

      • setSdoBatchSize

        public void setSdoBatchSize​(java.lang.Integer size)
        Adds the sdo_batch_size parameter with the specified value
        Parameters:
        size - The value for the sdo_batch_size parameter

      • removeSdoBatchSize

        public void removeSdoBatchSize()
        Removes the sdo_batch_size parameter

      • getSdoNumRes

        public java.lang.Integer getSdoNumRes()

      • setSdoNumRes

        public void setSdoNumRes​(java.lang.Integer res)
        Adds the sdo_num_res parameter with the specified value
        Parameters:
        res - The value for the sdo_num_res parameter

      • removeSdoNumRes

        public void removeSdoNumRes()
        Removes the sdo_num_res parameter

      • getUnit

        public java.lang.String getUnit()

      • setUnit

        public void setUnit​(java.lang.String unit)
        Adds the unit parameter with the specified value
        Parameters:
        unit - The value for the unit parameter

      • removeUnit

        public void removeUnit()
        Removes the unit parameter

      • getMaxResolution

        public java.lang.Double getMaxResolution()

      • setMaxResolution

        public void setMaxResolution​(java.lang.Double res)
        Adds the max_resolution parameter with the specified value
        Parameters:
        res - The value for the max_resolution parameter

      • removeMaxResolution

        public void removeMaxResolution()
        Removes the max_resolution parameter

      • getMinResolution

        public java.lang.Double getMinResolution()

      • setMinResolution

        public void setMinResolution​(java.lang.Double res)
        Adds the min_resolution parameter with the specified value
        Parameters:
        res - The value for the min_resolution parameter

      • removeMinResolution

        public void removeMinResolution()
        Removes the min_resolution parameter

      • getMask

        public java.lang.String getMask()

      • setMask

        public void setMask​(java.lang.String mask)
        Adds the mask parameter with the specified value
        Parameters:
        mask - The value for the mask parameter

      • removeMask

        public void removeMask()
        Removes the mask parameter

      • setQueryTypeToFilter

        public void setQueryTypeToFilter()
        Adds the querytype parameter with value "FILTER"

      • getQueryType

        public java.lang.String getQueryType()

      • setQueryType

        public void setQueryType​(java.lang.String queryType)
        Adds the querytype parameter with the specified value
        Parameters:
        queryType - The value for the quertype parameter

      • removeQueryType

        public void removeQueryType()
        Removes the querytype parameter

      • toQuotedString

        public java.lang.String toQuotedString()
        Returns all parameters contained in this instance as a quoted String containing the <parameter name>=<parameter value> pairs separated by spaces.

        The return format is as expected by the various SDO_GEOMETRY spatial functions.

        Returns:
        String