SDOParameterMap (hibernate-spatial JavaDocs)

java.lang.Object
- org.hibernate.spatial.dialect.oracle.criterion.SDOParameterMap

```
public class SDOParameterMap
extends Object
```
Represents the parameters that can be passed into Oracle’s Spatial operators

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

SDOParameterMap()
Constructs an empty instance

Constructors
Constructor and Description
`SDOParameterMap()` Constructs an empty instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`getDistance()`
`String`	`getMask()`
`Double`	`getMaxResolution()`
`Double`	`getMinResolution()`
`String`	`getQueryType()`
`Integer`	`getSdoBatchSize()`
`Integer`	`getSdoNumRes()`
`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(Double distance)` Adds the distance parameter with the specified value
`void`	`setMask(String mask)` Adds the mask parameter with the specified value
`void`	`setMaxResolution(Double res)` Adds the max_resolution parameter with the specified value
`void`	`setMinResolution(Double res)` Adds the min_resolution parameter with the specified value
`void`	`setQueryType(String queryType)` Adds the querytype parameter with the specified value
`void`	`setQueryTypeToFilter()` Adds the querytype parameter with value "FILTER"
`void`	`setSdoBatchSize(Integer size)` Adds the sdo_batch_size parameter with the specified value
`void`	`setSdoNumRes(Integer res)` Adds the sdo_num_res parameter with the specified value
`void`	`setUnit(String unit)` Adds the unit parameter with the specified value
`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 String DISTANCE
```
    The distance parameter
    
    See Also:
    
    Constant Field Values
  - SDO_BATCH_SIZE
```
public static final String SDO_BATCH_SIZE
```
    The sdo_batch_size parameter
    
    See Also:
    
    Constant Field Values
  - SDO_NUM_RES
```
public static final String SDO_NUM_RES
```
    The sdo_num_res parameter
    
    See Also:
    
    Constant Field Values
  - UNIT
```
public static final String UNIT
```
    The unit parameter
    
    See Also:
    
    Constant Field Values
  - MIN_RESOLUTION
```
public static final String MIN_RESOLUTION
```
    The min_resolution parameter
    
    See Also:
    
    Constant Field Values
  - MAX_RESOLUTION
```
public static final String MAX_RESOLUTION
```
    The max_resolution parameter
    
    See Also:
    
    Constant Field Values
  - MASK
```
public static final String MASK
```
    The mask parameter
    
    See Also:
    
    Constant Field Values
  - QUERYTYPE
```
public static final 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 Double getDistance()
```
  - setDistance
```
public void setDistance(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 Integer getSdoBatchSize()
```
  - setSdoBatchSize
```
public void setSdoBatchSize(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 Integer getSdoNumRes()
```
  - setSdoNumRes
```
public void setSdoNumRes(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 String getUnit()
```
  - setUnit
```
public void setUnit(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 Double getMaxResolution()
```
  - setMaxResolution
```
public void setMaxResolution(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 Double getMinResolution()
```
  - setMinResolution
```
public void setMinResolution(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 String getMask()
```
  - setMask
```
public void setMask(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 String getQueryType()
```
  - setQueryType
```
public void setQueryType(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 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

Class SDOParameterMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISTANCE

SDO_BATCH_SIZE

SDO_NUM_RES

UNIT

MIN_RESOLUTION

MAX_RESOLUTION

MASK

QUERYTYPE

Constructor Detail

SDOParameterMap

Method Detail

isEmpty

getDistance

setDistance

removeDistance

getSdoBatchSize

setSdoBatchSize

removeSdoBatchSize

getSdoNumRes

setSdoNumRes

removeSdoNumRes

getUnit

setUnit

removeUnit

getMaxResolution

setMaxResolution

removeMaxResolution

getMinResolution

setMinResolution

removeMinResolution

getMask

setMask

removeMask

setQueryTypeToFilter

getQueryType

setQueryType

removeQueryType

toQuotedString