Package org.eclipse.persistence.expressions.spatial

Class SpatialParameters

java.lang.Object
org.eclipse.persistence.expressions.spatial.SpatialParameters
public class SpatialParameters extends Object
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.

  • Constructor Details

    • SpatialParameters

      public SpatialParameters()

    • SpatialParameters

      public SpatialParameters(String params)

  • Method Details

    • setParams

      public SpatialParameters setParams(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 String getParams()

    • setMinResolution

      public SpatialParameters setMinResolution(Number minResolution)
      PUBLIC: Set the MIN_RESOLUTION parameter
      Parameters:
      minResolution -
      Returns:
      this instance of SpatialParameters

    • getMinResolution

      public Number getMinResolution()

    • setMaxResolution

      public SpatialParameters setMaxResolution(Number maxResolution)
      PUBLIC: Set the MAX_RESOLUTION parameter
      Parameters:
      maxResolution -
      Returns:
      this instance of SpatialParameters

    • getMaxResolution

      public 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(Number distance)
      PUBLIC: Set the DISTANCE parameter
      Parameters:
      distance -
      Returns:
      this instance of SpatialParameters

    • getDistance

      public 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 String getParameterString()
      PUBLIC: build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function
      Returns: