trafodion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sand...@apache.org
Subject [19/49] incubator-trafodion-site git commit: Updates for python installer documentation in provisioning guide.
Date Fri, 03 Mar 2017 08:44:39 GMT
http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/be8dfc15/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TableInfo.html
----------------------------------------------------------------------
diff --git a/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TableInfo.html b/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TableInfo.html
new file mode 100644
index 0000000..526ad4b
--- /dev/null
+++ b/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TableInfo.html
@@ -0,0 +1,540 @@
+<!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 (version 1.7.0_99) on Fri Mar 03 08:42:48 UTC 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>TableInfo (trafodion-sql 2.1.0 API)</title>
+<meta name="date" content="2017-03-03">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+    if (location.href.indexOf('is-external=true') == -1) {
+        parent.document.title="TableInfo (trafodion-sql 2.1.0 API)";
+    }
+//-->
+</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/TableInfo.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/ProvenanceInfo.html" title="class
in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.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/TableInfo.html" target="_top">Frames</a></li>
+<li><a href="TableInfo.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 TableInfo" class="title">Class TableInfo</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://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/TupleInfo.html" title="class in org.trafodion.sql.udr">org.trafodion.sql.udr.TupleInfo</a></li>
+<li>
+<ul class="inheritance">
+<li>org.trafodion.sql.udr.TableInfo</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">TableInfo</span>
+extends <a href="../../../../org/trafodion/sql/udr/TupleInfo.html" title="class in org.trafodion.sql.udr">TupleInfo</a></pre>
+<div class="block">Describes a table-valued input or a table-valued output</div>
+</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/TableInfo.html#TableInfo()">TableInfo</a></strong>()</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="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>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#addCardinalityConstraint(org.trafodion.sql.udr.CardinalityConstraintInfo)">addCardinalityConstraint</a></strong>(<a
href="../../../../org/trafodion/sql/udr/CardinalityConstraintInfo.html" title="class in org.trafodion.sql.udr">CardinalityConstraintInfo</a>&nbsp;constraint)</code>
+<div class="block">Add a cardinality constraint to the UDF table-valued output.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#addUniquenessConstraint(org.trafodion.sql.udr.UniqueConstraintInfo)">addUniquenessConstraint</a></strong>(<a
href="../../../../org/trafodion/sql/udr/UniqueConstraintInfo.html" title="class in org.trafodion.sql.udr">UniqueConstraintInfo</a>&nbsp;constraint)</code>
+<div class="block">Add a uniqueness constraint to the UDF table-valued output.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html"
title="class in org.trafodion.sql.udr">ConstraintInfo</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getConstraint(int)">getConstraint</a></strong>(int&nbsp;i)</code>
+<div class="block">Get a constraint by index/ordinal number.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getEstimatedNumPartitions()">getEstimatedNumPartitions</a></strong>()</code>
+<div class="block">Get the estimated number of rows of this table.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getEstimatedNumRows()">getEstimatedNumRows</a></strong>()</code>
+<div class="block">Get the estimated number of rows of this table.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getNumConstraints()">getNumConstraints</a></strong>()</code>
+<div class="block">Get the number of constraints defined on this table.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/OrderInfo.html"
title="class in org.trafodion.sql.udr">OrderInfo</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getQueryOrdering()">getQueryOrdering</a></strong>()</code>
+<div class="block">Get the ORDER BY clause for this input table.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html"
title="class in org.trafodion.sql.udr">PartitionInfo</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getQueryPartitioning()">getQueryPartitioning</a></strong>()</code>
+<div class="block">Get the PARTITION BY clause for this input table.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#isStream()">isStream</a></strong>()</code>
+<div class="block">Returns whether the UDF result is treated as a continuous stream.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#print()">print</a></strong>()</code>
+<div class="block">Print the object, for use in debugging.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#setEstimatedNumRows(long)">setEstimatedNumRows</a></strong>(long&nbsp;rows)</code>
+<div class="block">Set the estimated number of rows for a UDF table-valued result.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TableInfo.html#setIsStream(boolean)">setIsStream</a></strong>(boolean&nbsp;stream)</code>
+<div class="block">Set whether a table should be treated as a stream.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://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/TableInfo.html#toString(boolean)">toString</a></strong>(boolean&nbsp;longForm)</code>&nbsp;</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.trafodion.sql.udr.TupleInfo">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/TupleInfo.html"
title="class in org.trafodion.sql.udr">TupleInfo</a></h3>
+<code><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addCharColumn(java.lang.String,%20int,%20boolean)">addCharColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addCharColumn(java.lang.String,%20int,%20boolean,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLCollationCode)">addCharColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addColumn(org.trafodion.sql.udr.ColumnInfo)">addColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addColumnAt(org.trafodion.sql.udr.ColumnInfo,%20int)">addColumnAt</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addColumns(java.util.Vector)">addColumns</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addIntColumn(java.lang.String,%20boolean)">addIntColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addLongColumn(java.lang.String,%20boolean)">addLongColumn</a>,
<a href="../../../../org/trafodion/sql/udr/T
 upleInfo.html#addVarCharColumn(java.lang.String,%20int,%20boolean)">addVarCharColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addVarCharColumn(java.lang.String,%20int,%20boolean,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLCollationCode)">addVarCharColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#deleteColumn(int)">deleteColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#deleteColumn(java.lang.String)">deleteColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getBoolean(int)">getBoolean</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getBoolean(java.lang.String)">getBoolean</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getColNum(java.lang.String)">getColNum</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getColumn(int)">getColumn</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getColumn(java.lang.String
 )">getColumn</a>, <a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDelimitedRow()">getDelimitedRow</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDelimitedRow(char,%20boolean,%20char,%20int,%20int)">getDelimitedRow</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDouble(int)">getDouble</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDouble(java.lang.String)">getDouble</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getInt(int)">getInt</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getInt(java.lang.String)">getInt</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getLong(int)">getLong</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getLong(java.lang.String)">getLong</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getNumColumns()">getNumColumns</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getSQLTypeClass(int)">getSQLTypeClass</a>
 , <a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getString(int)">getString</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getString(java.lang.String)">getString</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getTime(int)">getTime</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getType(int)">getType</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#isAvailable(int)">isAvailable</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setDouble(int,%20double)">setDouble</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setFromDelimitedRow(java.lang.String)">setFromDelimitedRow</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setFromDelimitedRow(java.lang.String,%20char,%20boolean,%20char,%20int,%20int,%20int)">setFromDelimitedRow</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setInt(int,%20int)">setInt</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#se
 tLong(int,%20long)">setLong</a>, <a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setNull(int)">setNull</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setString(int,%20java.lang.String)">setString</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setTime(int,%20java.util.Date)">setTime</a>,
<a href="../../../../org/trafodion/sql/udr/TupleInfo.html#wasNull()">wasNull</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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://docs.oracle.com/javase/7/docs/api/j
 ava/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>,
<a href="http://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="http://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="TableInfo()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>TableInfo</h4>
+<pre>public&nbsp;TableInfo()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="getEstimatedNumRows()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getEstimatedNumRows</h4>
+<pre>public&nbsp;long&nbsp;getEstimatedNumRows()</pre>
+<div class="block">Get the estimated number of rows of this table.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Estimated
number of rows.</dd><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../org/trafodion/sql/udr/TableInfo.html#setEstimatedNumRows(long)"><code>setEstimatedNumRows(long)</code></a>,

+<a href="../../../../org/trafodion/sql/udr/TableInfo.html#getEstimatedNumPartitions()"><code>getEstimatedNumPartitions()</code></a></dd></dl>
+</li>
+</ul>
+<a name="getEstimatedNumPartitions()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getEstimatedNumPartitions</h4>
+<pre>public&nbsp;long&nbsp;getEstimatedNumPartitions()</pre>
+<div class="block">Get the estimated number of rows of this table.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Estimated
number of partitions, if the table
+          has a PARTITION BY clause, -1 otherwise.</dd><dt><span class="strong">See
Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TableInfo.html#getEstimatedNumRows()"><code>getEstimatedNumRows()</code></a></dd></dl>
+</li>
+</ul>
+<a name="getQueryPartitioning()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getQueryPartitioning</h4>
+<pre>public&nbsp;<a href="../../../../org/trafodion/sql/udr/PartitionInfo.html"
title="class in org.trafodion.sql.udr">PartitionInfo</a>&nbsp;getQueryPartitioning()</pre>
+<div class="block">Get the PARTITION BY clause for this input table.
+
+  <p> This returns either the PARTITION BY clause specified in the
+  SQL query, or the updated partitioning information, set by
+  UDRInvocationInfo#setChildPartitioning(), called during
+  UDR#describeParamsAndColumns().</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Partitioning
clause for this input table.</dd></dl>
+</li>
+</ul>
+<a name="getQueryOrdering()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getQueryOrdering</h4>
+<pre>public&nbsp;<a href="../../../../org/trafodion/sql/udr/OrderInfo.html"
title="class in org.trafodion.sql.udr">OrderInfo</a>&nbsp;getQueryOrdering()</pre>
+<div class="block">Get the ORDER BY clause for this input table.
+
+  <p> This returns either the ORDER BY clause specified in the
+  SQL query, or the updated ordering information, set by
+  UDRInvocationInfo#setChildOrdering(), called during
+  UDR#describeParamsAndColumns().</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Ordering
clause for this input table.</dd></dl>
+</li>
+</ul>
+<a name="isStream()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isStream</h4>
+<pre>public&nbsp;boolean&nbsp;isStream()</pre>
+<div class="block">Returns whether the UDF result is treated as a continuous stream.
+
+  <p> Note: This is currently not supported. The method always returns false
+  for now.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true
if the UDF result is a stream, false otherwise.</dd></dl>
+</li>
+</ul>
+<a name="getNumConstraints()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumConstraints</h4>
+<pre>public&nbsp;int&nbsp;getNumConstraints()</pre>
+<div class="block">Get the number of constraints defined on this table.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Number
of constraints defined on this table.</dd></dl>
+</li>
+</ul>
+<a name="getConstraint(int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getConstraint</h4>
+<pre>public&nbsp;<a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html"
title="class in org.trafodion.sql.udr">ConstraintInfo</a>&nbsp;getConstraint(int&nbsp;i)
+                             throws <a href="../../../../org/trafodion/sql/udr/UDRException.html"
title="class in org.trafodion.sql.udr">UDRException</a></pre>
+<div class="block">Get a constraint by index/ordinal number.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code>
- index/ordinal (0-based) of the constraint.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>Constraint
for a given index/ordinal.</dd>
+<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>
+<a name="setEstimatedNumRows(long)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setEstimatedNumRows</h4>
+<pre>public&nbsp;void&nbsp;setEstimatedNumRows(long&nbsp;rows)</pre>
+<div class="block">Set the estimated number of rows for a UDF table-valued result.
+
+  <p> Setting this value can help the Trafodion optimizer generate a better
+  plan for queries containing table-valued UDFs. Note that this is only
+  an estimate, a strict correspondence to the actual number of rows
+  returned at runtime is not required.
+
+  <p> Only use this method from within the following methods:
+  <ul>
+  <li> UDR#describeParamsAndColumns()
+  <li> UDR#describeDataflowAndPredicates()
+  <li> UDR#describeConstraints()
+  <li> UDR#describeStatistics()
+  </ul></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rows</code>
- Estimated number of rows for this table.</dd></dl>
+</li>
+</ul>
+<a name="addCardinalityConstraint(org.trafodion.sql.udr.CardinalityConstraintInfo)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addCardinalityConstraint</h4>
+<pre>public&nbsp;void&nbsp;addCardinalityConstraint(<a href="../../../../org/trafodion/sql/udr/CardinalityConstraintInfo.html"
title="class in org.trafodion.sql.udr">CardinalityConstraintInfo</a>&nbsp;constraint)</pre>
+<div class="block">Add a cardinality constraint to the UDF table-valued output.
+
+  <p> Only use this method from within the following methods:
+ <ul>
+  <li> UDR#describeParamsAndColumns()
+  <li> UDR#describeDataflowAndPredicates()
+  <li> UDR#describeConstraints()
+ </ul></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>constraint</code>
- New constraint to add.</dd></dl>
+</li>
+</ul>
+<a name="addUniquenessConstraint(org.trafodion.sql.udr.UniqueConstraintInfo)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addUniquenessConstraint</h4>
+<pre>public&nbsp;void&nbsp;addUniquenessConstraint(<a href="../../../../org/trafodion/sql/udr/UniqueConstraintInfo.html"
title="class in org.trafodion.sql.udr">UniqueConstraintInfo</a>&nbsp;constraint)
+                             throws <a href="../../../../org/trafodion/sql/udr/UDRException.html"
title="class in org.trafodion.sql.udr">UDRException</a></pre>
+<div class="block">Add a uniqueness constraint to the UDF table-valued output.
+
+  <p> Only use this method from within the following methods:
+ <ul>
+ <li> UDR#describeParamsAndColumns()
+ <li> UDR#describeDataflowAndPredicates()
+ <li> UDR#describeConstraints()
+ </ul></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>constraint</code>
- New uniqueness constraint to add.</dd>
+<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>
+<a name="setIsStream(boolean)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setIsStream</h4>
+<pre>public&nbsp;void&nbsp;setIsStream(boolean&nbsp;stream)
+                 throws <a href="../../../../org/trafodion/sql/udr/UDRException.html"
title="class in org.trafodion.sql.udr">UDRException</a></pre>
+<div class="block">Set whether a table should be treated as a stream.
+
+  <p> This method is not yet supported.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code>
- true if the table is a stream, false otherwise.</dd>
+<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>
+<a name="print()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>print</h4>
+<pre>public&nbsp;void&nbsp;print()
+           throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class
in org.trafodion.sql.udr">UDRException</a></pre>
+<div class="block">Print the object, for use in debugging.</div>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#print()">print</a></code>&nbsp;in
class&nbsp;<code><a href="../../../../org/trafodion/sql/udr/TupleInfo.html" title="class
in org.trafodion.sql.udr">TupleInfo</a></code></dd>
+<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><dt><span
class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/UDR.html#debugLoop()"><code>UDR.debugLoop()</code></a>,

+<a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.DebugFlags.html#PRINT_INVOCATION_INFO_AT_RUN_TIME"><code>UDRInvocationInfo.DebugFlags.PRINT_INVOCATION_INFO_AT_RUN_TIME</code></a></dd></dl>
+</li>
+</ul>
+<a name="toString(boolean)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a>&nbsp;toString(boolean&nbsp;longForm)</pre>
+</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/TableInfo.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/ProvenanceInfo.html" title="class
in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.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/TableInfo.html" target="_top">Frames</a></li>
+<li><a href="TableInfo.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; 2017. All rights reserved.</small></p>
+</body>
+</html>


Mime
View raw message