blob: 8b21e739166cd0ca3e7fd9184fce1b49337ec462 [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.7.0_251) on Sat May 02 18:54:02 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ComparisonPredicateInfo (trafodion-sql 2.4.0 API)</title>
<meta name="date" content="2020-05-02">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ComparisonPredicateInfo (trafodion-sql 2.4.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/ComparisonPredicateInfo.html">Use</a></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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/trafodion/sql/udr/ComparisonPredicateInfo.html" target="_top">Frames</a></li>
<li><a href="ComparisonPredicateInfo.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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_classes_inherited_from_class_org.trafodion.sql.udr.PredicateInfo">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.trafodion.sql.udr</div>
<h2 title="Class ComparisonPredicateInfo" class="title">Class ComparisonPredicateInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/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><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">org.trafodion.sql.udr.TMUDRSerializableObject</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">org.trafodion.sql.udr.PredicateInfo</a></li>
<li>
<ul class="inheritance">
<li>org.trafodion.sql.udr.ComparisonPredicateInfo</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ComparisonPredicateInfo</span>
extends <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></pre>
<div class="block">A comparison predicate to be evaluated on a table
A predicate that compares a column value to a constant or
another value that evaluates to a constant at runtime,
like an SQL query parameter.</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.trafodion.sql.udr.PredicateInfo">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></h3>
<code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.PredOperator.html" title="enum in org.trafodion.sql.udr">PredicateInfo.PredOperator</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#getColumnNumber()">getColumnNumber</a></strong>()</code>
<div class="block">Get the column number of the column in this comparison predicate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#getConstValue()">getConstValue</a></strong>()</code>
<div class="block">Return the value, as a string, of the constant in this predicate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#hasAConstantValue()">hasAConstantValue</a></strong>()</code>
<div class="block">Return whether this comparison value involves a constant.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#serializedLength()">serializedLength</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.trafodion.sql.udr.PredicateInfo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></h3>
<code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#getEvaluationCode()">getEvaluationCode</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#getOperator()">getOperator</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#isAComparisonPredicate()">isAComparisonPredicate</a></code></li>
</ul>
<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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getColumnNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNumber</h4>
<pre>public&nbsp;int&nbsp;getColumnNumber()</pre>
<div class="block">Get the column number of the column in this comparison predicate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Column number.</dd></dl>
</li>
</ul>
<a name="hasAConstantValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasAConstantValue</h4>
<pre>public&nbsp;boolean&nbsp;hasAConstantValue()</pre>
<div class="block">Return whether this comparison value involves a constant.
<p> The method returns whether the comparison predicate is of the form
"column" "op" "constant". If it returns false, the predicate
compares the column with a parameter or some other value not
available to the UDR. Predicates that do not involve a constant
cannot be evaluated in the UDR itself, since the comparison value
is not available to the UDR. They can be evaluated on a table-valued
input, however.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the comparison is with a constant, false otherwise</dd></dl>
</li>
</ul>
<a name="getConstValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstValue</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getConstValue()</pre>
<div class="block">Return the value, as a string, of the constant in this predicate.
<p> This returns the value, using SQL syntax, of the constant involved
in the comparison predicate. It throws an exception if method
hasAConstantValue() would return false.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Value of the constant in this comparison predicate.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#hasAConstantValue()"><code>hasAConstantValue()</code></a></dd></dl>
</li>
</ul>
<a name="serializedLength()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>serializedLength</h4>
<pre>public&nbsp;int&nbsp;serializedLength()
throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/ComparisonPredicateInfo.html">Use</a></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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/trafodion/sql/udr/ComparisonPredicateInfo.html" target="_top">Frames</a></li>
<li><a href="ComparisonPredicateInfo.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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_classes_inherited_from_class_org.trafodion.sql.udr.PredicateInfo">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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; 2020. All rights reserved.</small></p>
</body>
</html>