blob: 4672fc3d492a3f6385d11f02577170fd25c35d2b [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:04 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ProvenanceInfo (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="ProvenanceInfo (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/ProvenanceInfo.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/PredicateInfo.PredOperator.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/trafodion/sql/udr/TableInfo.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/ProvenanceInfo.html" target="_top">Frames</a></li>
<li><a href="ProvenanceInfo.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>Nested&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.trafodion.sql.udr</div>
<h2 title="Class ProvenanceInfo" class="title">Class ProvenanceInfo</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>org.trafodion.sql.udr.ProvenanceInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ProvenanceInfo</span>
extends <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></pre>
<div class="block">Describes where an output column is coming from.
<p> Points to input table and input column number that is the
source of a column. This must only be used if the result column
always has the exact same value as the current value of the
corresponding input column.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getProvenance()"><code>ColumnInfo.getProvenance()</code></a>,
<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setProvenance(org.trafodion.sql.udr.ProvenanceInfo)"><code>ColumnInfo.setProvenance(ProvenanceInfo)</code></a>,
<a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.html#addPassThruColumns()"><code>UDRInvocationInfo.addPassThruColumns()</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html#ProvenanceInfo()">ProvenanceInfo</a></strong>()</code>
<div class="block">Default constructor, generates unspecified provenance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html#ProvenanceInfo(int,%20int)">ProvenanceInfo</a></strong>(int&nbsp;inputTableNum,
int&nbsp;inputColNum)</code>
<div class="block">Constructor to link an output column to a specific input column</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html#ProvenanceInfo(org.trafodion.sql.udr.ProvenanceInfo)">ProvenanceInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a>&nbsp;p)</code>
<div class="block">Copy constructor.</div>
</td>
</tr>
</table>
</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/ProvenanceInfo.html#getInputColumnNum()">getInputColumnNum</a></strong>()</code>
<div class="block">Get the input column number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html#getInputTableNum()">getInputTableNum</a></strong>()</code>
<div class="block">Get the input table number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html#isFromInputTable()">isFromInputTable</a></strong>()</code>
<div class="block">Test whether the column comes from any table-valued input.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html#isFromInputTable(int)">isFromInputTable</a></strong>(int&nbsp;inputTableNum)</code>
<div class="block">Test whether the column comes from any or from a specific table-valued input.</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/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProvenanceInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProvenanceInfo</h4>
<pre>public&nbsp;ProvenanceInfo()</pre>
<div class="block">Default constructor, generates unspecified provenance.</div>
</li>
</ul>
<a name="ProvenanceInfo(org.trafodion.sql.udr.ProvenanceInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProvenanceInfo</h4>
<pre>public&nbsp;ProvenanceInfo(<a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a>&nbsp;p)</pre>
<div class="block">Copy constructor.</div>
</li>
</ul>
<a name="ProvenanceInfo(int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProvenanceInfo</h4>
<pre>public&nbsp;ProvenanceInfo(int&nbsp;inputTableNum,
int&nbsp;inputColNum)</pre>
<div class="block">Constructor to link an output column to a specific input column
<p> This constructor can be used to produce a "passthru column". An easier
way to do this is the UDRInvocationInfo::addPassThruColumns() method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputTableNum</code> - Input table number (0 for a TMUDF with a single
table-valued input, the most common case).</dd><dd><code>inputColNum</code> - Column number in intput table "inputTableNum"
that is the source of the output column to be
produced.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInputTableNum()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTableNum</h4>
<pre>public&nbsp;int&nbsp;getInputTableNum()</pre>
<div class="block">Get the input table number.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Input table number.</dd></dl>
</li>
</ul>
<a name="getInputColumnNum()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputColumnNum</h4>
<pre>public&nbsp;int&nbsp;getInputColumnNum()</pre>
<div class="block">Get the input column number.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Input column number.</dd></dl>
</li>
</ul>
<a name="isFromInputTable(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFromInputTable</h4>
<pre>public&nbsp;boolean&nbsp;isFromInputTable(int&nbsp;inputTableNum)</pre>
<div class="block">Test whether the column comes from any or from a specific table-valued input.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputTableNum</code> - -1 to test for any table-valued input, or a specific
input table number.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the provenance indicates a column that comes from the
specified input table(s), false otherwise</dd></dl>
</li>
</ul>
<a name="isFromInputTable()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isFromInputTable</h4>
<pre>public&nbsp;boolean&nbsp;isFromInputTable()</pre>
<div class="block">Test whether the column comes from any table-valued input.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the provenance indicates a column that comes from
some input table</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/ProvenanceInfo.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/PredicateInfo.PredOperator.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/trafodion/sql/udr/TableInfo.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/ProvenanceInfo.html" target="_top">Frames</a></li>
<li><a href="ProvenanceInfo.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>Nested&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; 2020. All rights reserved.</small></p>
</body>
</html>