Class SpatialParameters
- java.lang.Object
-
- org.eclipse.persistence.expressions.spatial.SpatialParameters
-
public class SpatialParameters extends java.lang.ObjectPUBLIC: A utility class used to set parameters on spatial operators within TopLink's expression framework. This class allows the aptial operator parameters to be passed in directly as a string or to be programatically configured using the attributes defined and the enum types. Each spatial operator offers different parameter arguments and values. This class does not enforce these rules but instead leaves it to the caller to decide what values they want included.When providing the parameter string through setParams or the constructor none of the other values will be used. Instead the string as provided will be used.
Creating an instance of SpatialParameters without configuring it and passing it into the SpatialExpressionFactory call is equivalent to passing in null. The resulting SQL will have NULL writen out for the parameters argument to the spatial operator.
- Since:
- Oracle TopLink 11.1.1.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSpatialParameters.Maskstatic classSpatialParameters.QueryTypestatic classSpatialParameters.Units
-
Constructor Summary
Constructors Constructor Description SpatialParameters()SpatialParameters(java.lang.String params)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.NumbergetDistance()SpatialParameters.Mask[]getMasks()java.lang.NumbergetMaxResolution()java.lang.NumbergetMinResolution()java.lang.StringgetParameterString()PUBLIC: build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial functionjava.lang.StringgetParams()SpatialParameters.QueryTypegetQueryType()SpatialParameters.UnitsgetUnits()SpatialParameterssetDistance(java.lang.Number distance)PUBLIC: Set the DISTANCE parameterSpatialParameterssetMask(SpatialParameters.Mask mask)PUBLIC: Set the MASK parameterSpatialParameterssetMasks(SpatialParameters.Mask[] masks)PUBLIC: Set the MASK parameterSpatialParameterssetMaxResolution(java.lang.Number maxResolution)PUBLIC: Set the MAX_RESOLUTION parameterSpatialParameterssetMinResolution(java.lang.Number minResolution)PUBLIC: Set the MIN_RESOLUTION parameterSpatialParameterssetParams(java.lang.String params)PUBLIC: Set the PARAMS (String) value.SpatialParameterssetQueryType(SpatialParameters.QueryType queryType)PUBLIC: Set the QUERY_TYPE parameterSpatialParameterssetUnits(SpatialParameters.Units units)PUBLIC: Set the UNIT parameter
-
-
-
Method Detail
-
setParams
public SpatialParameters setParams(java.lang.String params)
PUBLIC: Set the PARAMS (String) value. If this value is set then no other param values will be used.- Parameters:
params-- Returns:
- this instance of SpatialParameters
-
getParams
public java.lang.String getParams()
-
setMinResolution
public SpatialParameters setMinResolution(java.lang.Number minResolution)
PUBLIC: Set the MIN_RESOLUTION parameter- Parameters:
minResolution-- Returns:
- this instance of SpatialParameters
-
getMinResolution
public java.lang.Number getMinResolution()
-
setMaxResolution
public SpatialParameters setMaxResolution(java.lang.Number maxResolution)
PUBLIC: Set the MAX_RESOLUTION parameter- Parameters:
maxResolution-- Returns:
- this instance of SpatialParameters
-
getMaxResolution
public java.lang.Number getMaxResolution()
-
setUnits
public SpatialParameters setUnits(SpatialParameters.Units units)
PUBLIC: Set the UNIT parameter- Parameters:
units- a value from the SpatialParameters.Units enum- Returns:
- this instance of SpatialParameters
-
getUnits
public SpatialParameters.Units getUnits()
-
setDistance
public SpatialParameters setDistance(java.lang.Number distance)
PUBLIC: Set the DISTANCE parameter- Parameters:
distance-- Returns:
- this instance of SpatialParameters
-
getDistance
public java.lang.Number getDistance()
-
setQueryType
public SpatialParameters setQueryType(SpatialParameters.QueryType queryType)
PUBLIC: Set the QUERY_TYPE parameter- Parameters:
queryType- a value from the SpatialParameters.QueryType enum- Returns:
- this instance of SpatialParameters
-
getQueryType
public SpatialParameters.QueryType getQueryType()
-
setMasks
public SpatialParameters setMasks(SpatialParameters.Mask[] masks)
PUBLIC: Set the MASK parameter- Parameters:
masks- an array of values from the SpatialParmeters.Mask enum- Returns:
- this instance of SpatialParameters
-
setMask
public SpatialParameters setMask(SpatialParameters.Mask mask)
PUBLIC: Set the MASK parameter- Parameters:
mask- a value from the SpatialParmeters.Mask enum- Returns:
- this instance of SpatialParameters
-
getMasks
public SpatialParameters.Mask[] getMasks()
-
getParameterString
public java.lang.String getParameterString()
PUBLIC: build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function- Returns:
-
-