http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html new file mode 100644 index 0000000..17ba8da --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html @@ -0,0 +1,375 @@ +<!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_91) on Wed Aug 31 20:20:39 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UDRPlanInfo.SpecialDegreeOfParallelism (trafodion-sql 2.1.0 API)</title> +<meta name="date" content="2016-08-31"> +<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="UDRPlanInfo.SpecialDegreeOfParallelism (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/UDRPlanInfo.SpecialDegreeOfParallelism.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/UDRPlanInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.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/UDRPlanInfo.SpecialDegreeOfParallelism.html" target="_top">Frames</a></li> +<li><a href="UDRPlanInfo.SpecialDegreeOfParallelism.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: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum UDRPlanInfo.SpecialDegreeOfParallelism" class="title">Enum UDRPlanInfo.SpecialDegreeOfParallelism</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a>></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.sql.udr.UDRPlanInfo.SpecialDegreeOfParallelism</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html" title="class in org.trafodion.sql.udr">UDRPlanInfo</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">UDRPlanInfo.SpecialDegreeOfParallelism</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html#ANY_DEGREE_OF_PARALLELISM">ANY_DEGREE_OF_PARALLELISM</a></strong></code> +<div class="block">Optimizer decides DoP</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html#DEFAULT_DEGREE_OF_PARALLELISM">DEFAULT_DEGREE_OF_PARALLELISM</a></strong></code> +<div class="block">Optimizer decides DoP based on dataflow heuristics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html#MAX_DEGREE_OF_PARALLELISM">MAX_DEGREE_OF_PARALLELISM</a></strong></code> +<div class="block">Execute the UDF with the largest degree of parallelism allowed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html#ONE_INSTANCE_PER_NODE">ONE_INSTANCE_PER_NODE</a></strong></code> +<div class="block">Execute one instance of the on every Trafodion node.</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"> </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/UDRPlanInfo.SpecialDegreeOfParallelism.html#getSpecialDegreeOfParallelism()">getSpecialDegreeOfParallelism</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html#valueOf(java.lang.String)">valueOf</a></strong>(<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> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</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 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#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#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#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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="ANY_DEGREE_OF_PARALLELISM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ANY_DEGREE_OF_PARALLELISM</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a> ANY_DEGREE_OF_PARALLELISM</pre> +<div class="block">Optimizer decides DoP</div> +</li> +</ul> +<a name="DEFAULT_DEGREE_OF_PARALLELISM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_DEGREE_OF_PARALLELISM</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a> DEFAULT_DEGREE_OF_PARALLELISM</pre> +<div class="block">Optimizer decides DoP based on dataflow heuristics.</div> +</li> +</ul> +<a name="MAX_DEGREE_OF_PARALLELISM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_DEGREE_OF_PARALLELISM</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a> MAX_DEGREE_OF_PARALLELISM</pre> +<div class="block">Execute the UDF with the largest degree of parallelism allowed.</div> +</li> +</ul> +<a name="ONE_INSTANCE_PER_NODE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ONE_INSTANCE_PER_NODE</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a> ONE_INSTANCE_PER_NODE</pre> +<div class="block">Execute one instance of the on every Trafodion node. + Used internally for maintenance UDFs.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (UDRPlanInfo.SpecialDegreeOfParallelism c : UDRPlanInfo.SpecialDegreeOfParallelism.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a> valueOf(<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> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="getSpecialDegreeOfParallelism()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSpecialDegreeOfParallelism</h4> +<pre>public int getSpecialDegreeOfParallelism()</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/UDRPlanInfo.SpecialDegreeOfParallelism.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/UDRPlanInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.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/UDRPlanInfo.SpecialDegreeOfParallelism.html" target="_top">Frames</a></li> +<li><a href="UDRPlanInfo.SpecialDegreeOfParallelism.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: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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 © 2016. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.html new file mode 100644 index 0000000..0e882b1 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRPlanInfo.html @@ -0,0 +1,547 @@ +<!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_91) on Wed Aug 31 20:20:39 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UDRPlanInfo (trafodion-sql 2.1.0 API)</title> +<meta name="date" content="2016-08-31"> +<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="UDRPlanInfo (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/UDRPlanInfo.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/UDRInvocationInfo.SQLTransactionType.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum 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/UDRPlanInfo.html" target="_top">Frames</a></li> +<li><a href="UDRPlanInfo.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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 UDRPlanInfo" class="title">Class UDRPlanInfo</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>org.trafodion.sql.udr.UDRPlanInfo</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">UDRPlanInfo</span> +extends <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></pre> +<div class="block">Special degrees of parallelism. + + <p> Values that can be used in the setDesiredDegreeOfParallelism() + method, in addition to positive numbers for the degree of + parallelism (DoP).</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> +<table class="overviewSummary" 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"> </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 </code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr">UDRPlanInfo.SpecialDegreeOfParallelism</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.trafodion.sql.udr.TMUDRSerializableObject"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></h3> +<code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.Endianness.html" title="enum in org.trafodion.sql.udr">TMUDRSerializableObject.Endianness</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.TMUDRObjectType.html" title="enum in org.trafodion.sql.udr">TMUDRSerializableObject.TMUDRObjectType</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"> </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/UDRPlanInfo.html#addPlanData(byte[])">addPlanData</a></strong>(byte[] planData)</code> +<div class="block">Attach a byte array to the plan to be sent to the runtime instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#deserialize(java.nio.ByteBuffer)">deserialize</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> inputBuffer)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#getCostPerRow()">getCostPerRow</a></strong>()</code> +<div class="block">Retreive cost per row</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#getCurrentVersion()">getCurrentVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#getDesiredDegreeOfParallelism()">getDesiredDegreeOfParallelism</a></strong>()</code> +<div class="block">Return the desired degree of parallelism for this plan.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#getPlanData()">getPlanData</a></strong>()</code> +<div class="block">Retrieve plan data attached to the UDR invocation and plan.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.html" title="class in org.trafodion.sql.udr">UDRWriterCompileTimeData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#getUDRWriterCompileTimeData()">getUDRWriterCompileTimeData</a></strong>()</code> +<div class="block">Get data to persist between calls of the optimizer interface</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#serialize(java.nio.ByteBuffer)">serialize</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> outputBuffer)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#serializedLength()">serializedLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#setCostPerRow(long)">setCostPerRow</a></strong>(long microseconds)</code> +<div class="block">Estimate of average time taken to produce an output row, in microseconds</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#setDesiredDegreeOfParallelism(int)">setDesiredDegreeOfParallelism</a></strong>(int dop)</code> +<div class="block">Set the desired degree of parallelism.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#setUDRWriterCompileTimeData(org.trafodion.sql.udr.UDRWriterCompileTimeData)">setUDRWriterCompileTimeData</a></strong>(<a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.html" title="class in org.trafodion.sql.udr">UDRWriterCompileTimeData</a> compileTimeData)</code> +<div class="block">Set data to persist between calls of the optimizer interface</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.trafodion.sql.udr.TMUDRSerializableObject"> +<!-- --> +</a> +<h3>Methods inherited from class org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></h3> +<code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#deserializeBinary(java.nio.ByteBuffer)">deserializeBinary</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#deserializeInt(java.nio.ByteBuffer)">deserializeInt</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#deserializeLong(java.nio.ByteBuffer)">deserializeLong</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#deserializeString(java.nio.ByteBuffer)">deserializeString</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#getNextObjectType(java.nio.ByteBuffer)">getNextObjectType</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#getObjectType()">getObjectType</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#getObjectType(int)">getObjectType</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#getVersion()">getVersion</a>, <a hr ef="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializeBinary(byte[],%20java.nio.ByteBuffer)">serializeBinary</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializeBinary(byte[],%20int,%20java.nio.ByteBuffer)">serializeBinary</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializedLengthOfBinary(int)">serializedLengthOfBinary</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializedLengthOfInt()">serializedLengthOfInt</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializedLengthOfLong()">serializedLengthOfLong</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializedLengthOfString(byte[])">serializedLengthOfString</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializedLengthOfString(int)">serializedLengthOfString</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableO bject.html#serializedLengthOfString(java.lang.String)">serializedLengthOfString</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializeInt(int,%20java.nio.ByteBuffer)">serializeInt</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializeLong(long,%20java.nio.ByteBuffer)">serializeLong</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializeString(java.lang.String,%20java.nio.ByteBuffer)">serializeString</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#sizeOf()">sizeOf</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#validateDeserializedLength(int)">validateDeserializedLength</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#validateObjectType(org.trafodion.sql.udr.TMUDRSerializableObject.TMUDRObjectType)">validateObjectType</a>, <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#validateSeri alizedLength(int)">validateSerializedLength</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 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#clone()" title="class or interface in java.lang">clone</a>, <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#finalize()" title="class or interface in java.lang">finalize</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/java/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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCostPerRow()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCostPerRow</h4> +<pre>public long getCostPerRow()</pre> +<div class="block">Retreive cost per row</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>costPerRow</dd></dl> +</li> +</ul> +<a name="getDesiredDegreeOfParallelism()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDesiredDegreeOfParallelism</h4> +<pre>public int getDesiredDegreeOfParallelism()</pre> +<div class="block">Return the desired degree of parallelism for this plan.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Degree of parallelism to be used for this plan alternative + (positive) or one of the enum values in + UDRPlanInfo#SpecialDegreeOfParallelism (zero or negative).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#setDesiredDegreeOfParallelism(int)"><code>setDesiredDegreeOfParallelism(int)</code></a></dd></dl> +</li> +</ul> +<a name="setDesiredDegreeOfParallelism(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDesiredDegreeOfParallelism</h4> +<pre>public void setDesiredDegreeOfParallelism(int dop) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Set the desired degree of parallelism. + + <p> Here are some special values that can be set, in + addition to positive numbers. These are defined in + class UDRPlanInfo. +<ul> + <li> @c ANY_DEGREE_OF_PARALLELISM: + This will allow the optimizer to choose any degree + of parallelism, including 1 (serial execution) + <li> @c DEFAULT_DEGREE_OF_PARALLELISM: + Currently the same as ANY_DEGREE_OF_PARALLELISM. + The optimizer will use a heuristic based on + the estimated cardinality. + <li> @c MAX_DEGREE_OF_PARALLELISM: + Choose the highest possible degree of parallelism. + <li> @c ONE_INSTANCE_PER_NODE: + Start one parallel instance on every Trafodion node. + This is mostly meant for internal TMUDFs, e.g. a + TMUDF to read the log files on every node. + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dop</code> - desired degree of parallelism (a positive number or + one of the enum values in + UDRPlanInfo#SpecialDegreeOfParallelism).</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/UDRPlanInfo.html#getDesiredDegreeOfParallelism()"><code>getDesiredDegreeOfParallelism()</code></a></dd></dl> +</li> +</ul> +<a name="setCostPerRow(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCostPerRow</h4> +<pre>public void setCostPerRow(long microseconds) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Estimate of average time taken to produce an output row, in microseconds</div> +<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> +<a name="getUDRWriterCompileTimeData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUDRWriterCompileTimeData</h4> +<pre>public <a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.html" title="class in org.trafodion.sql.udr">UDRWriterCompileTimeData</a> getUDRWriterCompileTimeData() + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Get data to persist between calls of the optimizer interface</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>UDR writer-specific data that was previously attached or NULL.</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/UDRPlanInfo.html#setUDRWriterCompileTimeData(org.trafodion.sql.udr.UDRWriterCompileTimeData)"><code>setUDRWriterCompileTimeData(UDRWriterCompileTimeData)</code></a></dd></dl> +</li> +</ul> +<a name="setUDRWriterCompileTimeData(org.trafodion.sql.udr.UDRWriterCompileTimeData)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUDRWriterCompileTimeData</h4> +<pre>public void setUDRWriterCompileTimeData(<a href="../../../../org/trafodion/sql/udr/UDRWriterCompileTimeData.html" title="class in org.trafodion.sql.udr">UDRWriterCompileTimeData</a> compileTimeData) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Set data to persist between calls of the optimizer interface + + <p> This call can be used to attach an object derived from class + UDRWriterCompileTimeData to the UDRPlanInfo object. Once + attached, the data will be carried between the stages of the + optimizer interface and can be used to keep state. Note that + this data will be deleted at the end of the optimizer phase and + will not persist until runtime. + + <p> Use this method to keep data that is specific to a query plan + alternative, represented by the UDRPlanInfo object. Use + UDRInvocationInfo::setUDRWriterCompileTimeData() to keep data + that is common for the entire UDR invocation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>compileTimeData</code> - UDR writer-defined compile-time data to attach.</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/UDRInvocationInfo.html#setUDRWriterCompileTimeData(org.trafodion.sql.udr.UDRWriterCompileTimeData)"><code>UDRInvocationInfo.setUDRWriterCompileTimeData(UDRWriterCompileTimeData)</code></a>, +<a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#getUDRWriterCompileTimeData()"><code>getUDRWriterCompileTimeData()</code></a></dd></dl> +</li> +</ul> +<a name="addPlanData(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPlanData</h4> +<pre>public void addPlanData(byte[] planData) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Attach a byte array to the plan to be sent to the runtime instances. + + <p> Compile time and runtime interfaces of the UDR can be called from + different processes, since UDRs can be executed in parallel and on + different nodes. If the UDR writer would like to carry state from + the compiler interface calls to runtime calls, the best way to achieve + this to attach it using this call and to retrieve the state at runtime + using the UDRPlanInfo#getPlanData() call. + + <p> The best place to use this method is from within + UDRPlanInfo#completeDescription() method, since this method is + called on the optimal plan that will be used at runtime. It can + also be called from other methods, and the plan data will be + discarded if the plan is not chosen.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>planData</code> - A byte array, content defined by the UDR writer, to be + sent to all runtime instances executing the UDR. The buffer + can and should be deleted by the caller after calling this method.</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/UDRPlanInfo.html#getPlanData()"><code>getPlanData()</code></a></dd></dl> +</li> +</ul> +<a name="getPlanData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPlanData</h4> +<pre>public byte[] getPlanData()</pre> +<div class="block">Retrieve plan data attached to the UDR invocation and plan. + + <p> This method can be called at runtime to get state generated at compile time.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Reference to a byte array with plan data generated by the UDR writer + at compile time.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.html#addPlanData(byte[])"><code>addPlanData(byte[])</code></a></dd></dl> +</li> +</ul> +<a name="print()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>print</h4> +<pre>public void 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><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/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="getCurrentVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentVersion</h4> +<pre>public static short getCurrentVersion()</pre> +</li> +</ul> +<a name="serializedLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serializedLength</h4> +<pre>public int serializedLength() + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serializedLength()">serializedLength</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</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></dl> +</li> +</ul> +<a name="serialize(java.nio.ByteBuffer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serialize</h4> +<pre>public int serialize(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> outputBuffer) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#serialize(java.nio.ByteBuffer)">serialize</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</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></dl> +</li> +</ul> +<a name="deserialize(java.nio.ByteBuffer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>deserialize</h4> +<pre>public int deserialize(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> inputBuffer) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html#deserialize(java.nio.ByteBuffer)">deserialize</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</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></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/UDRPlanInfo.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/UDRInvocationInfo.SQLTransactionType.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum 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/UDRPlanInfo.html" target="_top">Frames</a></li> +<li><a href="UDRPlanInfo.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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2016. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/2a3d8b6a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRWriterCompileTimeData.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRWriterCompileTimeData.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRWriterCompileTimeData.html new file mode 100644 index 0000000..7aea5f7 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/UDRWriterCompileTimeData.html @@ -0,0 +1,272 @@ +<!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_91) on Wed Aug 31 20:20:39 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UDRWriterCompileTimeData (trafodion-sql 2.1.0 API)</title> +<meta name="date" content="2016-08-31"> +<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="UDRWriterCompileTimeData (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/UDRWriterCompileTimeData.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/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/UniqueConstraintInfo.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/UDRWriterCompileTimeData.html" target="_top">Frames</a></li> +<li><a href="UDRWriterCompileTimeData.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 UDRWriterCompileTimeData" class="title">Class UDRWriterCompileTimeData</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>org.trafodion.sql.udr.UDRWriterCompileTimeData</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">UDRWriterCompileTimeData</span> +extends <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></pre> +<div class="block">Compile time data owned by the UDR writer + + <p> When attached to a UDRInvocationInfo object, keeps context + between compiler interface calls for this object. This class + can also be attached to a UDRPlanInfo object, to keep state + between plan alternatives for a UDR invocation. The + info is NOT passed to the run time methods, use + UDRPlanInfo#addPlanData() for that.</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"> </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/UDRWriterCompileTimeData.html#UDRWriterCompileTimeData()">UDRWriterCompileTimeData</a></strong>()</code> +<div class="block">Default 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"> </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/UDRWriterCompileTimeData.html#print()">print</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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#clone()" title="class or interface in java.lang">clone</a>, <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#finalize()" title="class or interface in java.lang">finalize</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/java/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="UDRWriterCompileTimeData()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UDRWriterCompileTimeData</h4> +<pre>public UDRWriterCompileTimeData()</pre> +<div class="block">Default constructor. + + <p> UDR writers can derive from this class to store state between + the calls of the compiler interface.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="print()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>print</h4> +<pre>public void print()</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/UDRWriterCompileTimeData.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/UDRPlanInfo.SpecialDegreeOfParallelism.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/UniqueConstraintInfo.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/UDRWriterCompileTimeData.html" target="_top">Frames</a></li> +<li><a href="UDRWriterCompileTimeData.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 © 2016. All rights reserved.</small></p> +</body> +</html>
