|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.expressions.spatial.SpatialParameters
public class SpatialParameters
PUBLIC: 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.
Nested Class Summary | |
---|---|
static class |
SpatialParameters.Mask
|
static class |
SpatialParameters.QueryType
|
static class |
SpatialParameters.Units
|
Constructor Summary | |
---|---|
SpatialParameters()
|
|
SpatialParameters(java.lang.String params)
|
Method Summary | |
---|---|
java.lang.Number |
getDistance()
|
SpatialParameters.Mask[] |
getMasks()
|
java.lang.Number |
getMaxResolution()
|
java.lang.Number |
getMinResolution()
|
java.lang.String |
getParameterString()
PUBLIC: build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function |
java.lang.String |
getParams()
|
SpatialParameters.QueryType |
getQueryType()
|
SpatialParameters.Units |
getUnits()
|
SpatialParameters |
setDistance(java.lang.Number distance)
PUBLIC: Set the DISTANCE parameter |
SpatialParameters |
setMask(SpatialParameters.Mask mask)
PUBLIC: Set the MASK parameter |
SpatialParameters |
setMasks(SpatialParameters.Mask[] masks)
PUBLIC: Set the MASK parameter |
SpatialParameters |
setMaxResolution(java.lang.Number maxResolution)
PUBLIC: Set the MAX_RESOLUTION parameter |
SpatialParameters |
setMinResolution(java.lang.Number minResolution)
PUBLIC: Set the MIN_RESOLUTION parameter |
SpatialParameters |
setParams(java.lang.String params)
PUBLIC: Set the PARAMS (String) value. |
SpatialParameters |
setQueryType(SpatialParameters.QueryType queryType)
PUBLIC: Set the QUERY_TYPE parameter |
SpatialParameters |
setUnits(SpatialParameters.Units units)
PUBLIC: Set the UNIT parameter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SpatialParameters()
public SpatialParameters(java.lang.String params)
Method Detail |
---|
public SpatialParameters setParams(java.lang.String params)
params
-
public java.lang.String getParams()
public SpatialParameters setMinResolution(java.lang.Number minResolution)
minResolution
-
public java.lang.Number getMinResolution()
public SpatialParameters setMaxResolution(java.lang.Number maxResolution)
maxResolution
-
public java.lang.Number getMaxResolution()
public SpatialParameters setUnits(SpatialParameters.Units units)
units
- a value from the SpatialParameters.Units enum
public SpatialParameters.Units getUnits()
public SpatialParameters setDistance(java.lang.Number distance)
distance
-
public java.lang.Number getDistance()
public SpatialParameters setQueryType(SpatialParameters.QueryType queryType)
queryType
- a value from the SpatialParameters.QueryType enum
public SpatialParameters.QueryType getQueryType()
public SpatialParameters setMasks(SpatialParameters.Mask[] masks)
masks
- an array of values from the SpatialParmeters.Mask enum
public SpatialParameters setMask(SpatialParameters.Mask mask)
mask
- a value from the SpatialParmeters.Mask enum
public SpatialParameters.Mask[] getMasks()
public java.lang.String getParameterString()
|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |