Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / 7bae487f45ea47ce0120322304c66c82f6be5da6 / . / api / 3.0 / org / eclipse / persistence / expressions / spatial / SpatialParameters.html
blob: 5bbfa0055bdcf48f3b62ca1cdb5fe3bac8860c87 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Apr 08 02:07:18 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SpatialParameters (EclipseLink 3.0.1, API Reference)</title>
<meta name="date" content="2021-04-08">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SpatialParameters (EclipseLink 3.0.1, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.1, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialExpressionFactory.html" title="class in org.eclipse.persistence.expressions.spatial"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/expressions/spatial/SpatialParameters.html" target="_top">Frames</a></li>
<li><a href="SpatialParameters.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.expressions.spatial</div>
<h2 title="Class SpatialParameters" class="title">Class SpatialParameters</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.expressions.spatial.SpatialParameters</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SpatialParameters</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">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.
<p>
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.
<p>
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.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Oracle TopLink 11.1.1.0.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.QueryType.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.QueryType</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Units.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Units</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#SpatialParameters--">SpatialParameters</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#SpatialParameters-java.lang.String-">SpatialParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;params)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getDistance--">getDistance</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getMasks--">getMasks</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getMaxResolution--">getMaxResolution</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getMinResolution--">getMinResolution</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getParameterString--">getParameterString</a></span>()</code>
<div class="block">PUBLIC:
build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getParams--">getParams</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.QueryType.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.QueryType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getQueryType--">getQueryType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Units.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Units</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#getUnits--">getUnits</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setDistance-java.lang.Number-">setDistance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;distance)</code>
<div class="block">PUBLIC:
Set the DISTANCE parameter</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setMask-org.eclipse.persistence.expressions.spatial.SpatialParameters.Mask-">setMask</a></span>(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a>&nbsp;mask)</code>
<div class="block">PUBLIC:
Set the MASK parameter</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setMasks-org.eclipse.persistence.expressions.spatial.SpatialParameters.Mask:A-">setMasks</a></span>(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a>[]&nbsp;masks)</code>
<div class="block">PUBLIC:
Set the MASK parameter</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setMaxResolution-java.lang.Number-">setMaxResolution</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;maxResolution)</code>
<div class="block">PUBLIC:
Set the MAX_RESOLUTION parameter</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setMinResolution-java.lang.Number-">setMinResolution</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;minResolution)</code>
<div class="block">PUBLIC:
Set the MIN_RESOLUTION parameter</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setParams-java.lang.String-">setParams</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;params)</code>
<div class="block">PUBLIC:
Set the PARAMS (String) value.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setQueryType-org.eclipse.persistence.expressions.spatial.SpatialParameters.QueryType-">setQueryType</a></span>(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.QueryType.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.QueryType</a>&nbsp;queryType)</code>
<div class="block">PUBLIC:
Set the QUERY_TYPE parameter</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html#setUnits-org.eclipse.persistence.expressions.spatial.SpatialParameters.Units-">setUnits</a></span>(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Units.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Units</a>&nbsp;units)</code>
<div class="block">PUBLIC:
Set the UNIT parameter</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SpatialParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SpatialParameters</h4>
<pre>public&nbsp;SpatialParameters()</pre>
</li>
</ul>
<a name="SpatialParameters-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SpatialParameters</h4>
<pre>public&nbsp;SpatialParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;params)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setParams-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParams</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setParams(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;params)</pre>
<div class="block">PUBLIC:
Set the PARAMS (String) value. If this value is set then no other param
values will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>params</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getParams--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParams</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getParams()</pre>
</li>
</ul>
<a name="setMinResolution-java.lang.Number-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinResolution</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setMinResolution(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;minResolution)</pre>
<div class="block">PUBLIC:
Set the MIN_RESOLUTION parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>minResolution</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getMinResolution--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinResolution</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;getMinResolution()</pre>
</li>
</ul>
<a name="setMaxResolution-java.lang.Number-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxResolution</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setMaxResolution(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;maxResolution)</pre>
<div class="block">PUBLIC:
Set the MAX_RESOLUTION parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxResolution</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getMaxResolution--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxResolution</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;getMaxResolution()</pre>
</li>
</ul>
<a name="setUnits-org.eclipse.persistence.expressions.spatial.SpatialParameters.Units-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnits</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setUnits(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Units.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Units</a>&nbsp;units)</pre>
<div class="block">PUBLIC:
Set the UNIT parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>units</code> - a value from the SpatialParameters.Units enum</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getUnits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnits</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Units.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Units</a>&nbsp;getUnits()</pre>
</li>
</ul>
<a name="setDistance-java.lang.Number-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDistance</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setDistance(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;distance)</pre>
<div class="block">PUBLIC:
Set the DISTANCE parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>distance</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getDistance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistance</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;getDistance()</pre>
</li>
</ul>
<a name="setQueryType-org.eclipse.persistence.expressions.spatial.SpatialParameters.QueryType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryType</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setQueryType(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.QueryType.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.QueryType</a>&nbsp;queryType)</pre>
<div class="block">PUBLIC:
Set the QUERY_TYPE parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryType</code> - a value from the SpatialParameters.QueryType enum</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getQueryType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryType</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.QueryType.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.QueryType</a>&nbsp;getQueryType()</pre>
</li>
</ul>
<a name="setMasks-org.eclipse.persistence.expressions.spatial.SpatialParameters.Mask:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMasks</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setMasks(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a>[]&nbsp;masks)</pre>
<div class="block">PUBLIC:
Set the MASK parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>masks</code> - an array of values from the SpatialParmeters.Mask enum</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="setMask-org.eclipse.persistence.expressions.spatial.SpatialParameters.Mask-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMask</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.html" title="class in org.eclipse.persistence.expressions.spatial">SpatialParameters</a>&nbsp;setMask(<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a>&nbsp;mask)</pre>
<div class="block">PUBLIC:
Set the MASK parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mask</code> - a value from the SpatialParmeters.Mask enum</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this instance of SpatialParameters</dd>
</dl>
</li>
</ul>
<a name="getMasks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMasks</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial">SpatialParameters.Mask</a>[]&nbsp;getMasks()</pre>
</li>
</ul>
<a name="getParameterString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParameterString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getParameterString()</pre>
<div class="block">PUBLIC:
build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.1, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialExpressionFactory.html" title="class in org.eclipse.persistence.expressions.spatial"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/expressions/spatial/SpatialParameters.Mask.html" title="enum in org.eclipse.persistence.expressions.spatial"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/expressions/spatial/SpatialParameters.html" target="_top">Frames</a></li>
<li><a href="SpatialParameters.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>