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/ParameterListInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ParameterListInfo.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ParameterListInfo.html new file mode 100644 index 0000000..8f1892a --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ParameterListInfo.html @@ -0,0 +1,359 @@ +<!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:38 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ParameterListInfo (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="ParameterListInfo (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/ParameterListInfo.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/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PartitionInfo.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/ParameterListInfo.html" target="_top">Frames</a></li> +<li><a href="ParameterListInfo.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_classes_inherited_from_class_org.trafodion.sql.udr.TMUDRSerializableObject">Nested</a> | </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 ParameterListInfo" class="title">Class ParameterListInfo</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.ParameterListInfo</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">ParameterListInfo</span> +extends <a href="../../../../org/trafodion/sql/udr/TupleInfo.html" title="class in org.trafodion.sql.udr">TupleInfo</a></pre> +<div class="block">Describes the parameters of a UDR. + + <p> This method currently has no methods relevant to the UDR + writer, but the base class, TupleInfo, has a variety of methods.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TupleInfo.html" title="class in org.trafodion.sql.udr"><code>TupleInfo</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<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> +<!-- ======== 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/ParameterListInfo.html#ParameterListInfo()">ParameterListInfo</a></strong>()</code> </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/ParameterListInfo.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="rowColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ParameterListInfo.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/ParameterListInfo.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/ParameterListInfo.html#serializedLength()">serializedLength</a></strong>()</code> </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 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#decode(org.trafodion.sql.udr.TypeInfo,%20byte[])">decode</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#encode(org.trafodion.sql.udr.TypeInfo,%20java.lang.String)">encode</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/traf odion/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/T upleInfo.html#getRecordLength()">getRecordLength</a>, <a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getRow()">getRow</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#print()">print</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#setLong(int,%20long)">setLong</a>, <a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setNull(int)">setNull</a>, <a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setRow(byte[])">setRow</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_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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ParameterListInfo()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ParameterListInfo</h4> +<pre>public ParameterListInfo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<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/TupleInfo.html#serializedLength()">serializedLength</a></code> in class <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></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/TupleInfo.html#serialize(java.nio.ByteBuffer)">serialize</a></code> in class <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></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/TupleInfo.html#deserialize(java.nio.ByteBuffer)">deserialize</a></code> in class <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></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/ParameterListInfo.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/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PartitionInfo.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/ParameterListInfo.html" target="_top">Frames</a></li> +<li><a href="ParameterListInfo.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_classes_inherited_from_class_org.trafodion.sql.udr.TMUDRSerializableObject">Nested</a> | </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>
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/PartitionInfo.PartitionTypeCode.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html new file mode 100644 index 0000000..ec70f4d --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html @@ -0,0 +1,398 @@ +<!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:38 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PartitionInfo.PartitionTypeCode (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="PartitionInfo.PartitionTypeCode (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/PartitionInfo.PartitionTypeCode.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/PartitionInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.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/PartitionInfo.PartitionTypeCode.html" target="_top">Frames</a></li> +<li><a href="PartitionInfo.PartitionTypeCode.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 PartitionInfo.PartitionTypeCode" class="title">Enum PartitionInfo.PartitionTypeCode</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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a>></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.sql.udr.PartitionInfo.PartitionTypeCode</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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html" title="class in org.trafodion.sql.udr">PartitionInfo</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">PartitionInfo.PartitionTypeCode</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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a>></pre> +<div class="block">Type of partitioning</div> +</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/PartitionInfo.PartitionTypeCode.html#ANY">ANY</a></strong></code> +<div class="block">No limitations on parallel execution, typical for + mappers, any row can be evaluated by any parallel + instance of the UDF</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html#PARTITION">PARTITION</a></strong></code> +<div class="block">Allow parallelism with partitioning key, if specified, + serial execution otherwise</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html#REPLICATE">REPLICATE</a></strong></code> +<div class="block">Replicate the data to each parallel instance</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html#SERIAL">SERIAL</a></strong></code> +<div class="block">No partitioning is allowed, execute serially in a + single instance</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html#UNKNOWN">UNKNOWN</a></strong></code> +<div class="block">Partitioning type not yet determined</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>static <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html#fromOrdinal(int)">fromOrdinal</a></strong>(int n)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.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="UNKNOWN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UNKNOWN</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> UNKNOWN</pre> +<div class="block">Partitioning type not yet determined</div> +</li> +</ul> +<a name="ANY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ANY</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> ANY</pre> +<div class="block">No limitations on parallel execution, typical for + mappers, any row can be evaluated by any parallel + instance of the UDF</div> +</li> +</ul> +<a name="SERIAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SERIAL</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> SERIAL</pre> +<div class="block">No partitioning is allowed, execute serially in a + single instance</div> +</li> +</ul> +<a name="PARTITION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PARTITION</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> PARTITION</pre> +<div class="block">Allow parallelism with partitioning key, if specified, + serial execution otherwise</div> +</li> +</ul> +<a name="REPLICATE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>REPLICATE</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> REPLICATE</pre> +<div class="block">Replicate the data to each parallel instance</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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</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 (PartitionInfo.PartitionTypeCode c : PartitionInfo.PartitionTypeCode.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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</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="fromOrdinal(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fromOrdinal</h4> +<pre>public static <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> fromOrdinal(int n)</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/PartitionInfo.PartitionTypeCode.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/PartitionInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.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/PartitionInfo.PartitionTypeCode.html" target="_top">Frames</a></li> +<li><a href="PartitionInfo.PartitionTypeCode.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/PartitionInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PartitionInfo.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PartitionInfo.html new file mode 100644 index 0000000..bf26c2e --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PartitionInfo.html @@ -0,0 +1,407 @@ +<!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:38 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PartitionInfo (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="PartitionInfo (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/PartitionInfo.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/ParameterListInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.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/PartitionInfo.html" target="_top">Frames</a></li> +<li><a href="PartitionInfo.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><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 PartitionInfo" class="title">Class PartitionInfo</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.PartitionInfo</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">PartitionInfo</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">Partitioning key of an input table or result table + + <p> Describes the partitioning key of a table-valued input or + result. When executing a UDR in parallel, if a table is + partitioned on some columns, e.g. (a,b), this means that a rows + with particular values for (a,b), e.g. (10, 20) will all go to + the same parallel instance and will be seen as a contiguous + group. This is similar to the key of a reducer in MapReduce, + except that in this case we process a group of rows with the + same key, not a single key and a list of values.</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/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></strong></code> +<div class="block">Type of partitioning</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/PartitionInfo.html#PartitionInfo()">PartitionInfo</a></strong>()</code> +<div class="block">Default constructor</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#PartitionInfo(org.trafodion.sql.udr.PartitionInfo)">PartitionInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.html" title="class in org.trafodion.sql.udr">PartitionInfo</a> p)</code> </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/PartitionInfo.html#addEntry(int)">addEntry</a></strong>(int colNum)</code> +<div class="block">Add a new column to the list of partitioning columns</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getColumnNum(int)">getColumnNum</a></strong>(int i)</code> +<div class="block">Get the number/ordinal of the ith partitioning column.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getNumEntries()">getNumEntries</a></strong>()</code> +<div class="block">Get the number of columns that form the partitioning key</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Vector.html?is-external=true"; title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getPartCols()">getPartCols</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#getType()">getType</a></strong>()</code> +<div class="block">Get the partitioning type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PartitionInfo.html#setType(org.trafodion.sql.udr.PartitionInfo.PartitionTypeCode)">setType</a></strong>(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> type)</code> +<div class="block">Set the partitioning type.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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="PartitionInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PartitionInfo</h4> +<pre>public PartitionInfo()</pre> +<div class="block">Default constructor + + <p> Use this constructor to generate an object to be passed + to UDRInvocationInfo::setChildPartitioning()</div> +</li> +</ul> +<a name="PartitionInfo(org.trafodion.sql.udr.PartitionInfo)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PartitionInfo</h4> +<pre>public PartitionInfo(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.html" title="class in org.trafodion.sql.udr">PartitionInfo</a> p)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> getType()</pre> +<div class="block">Get the partitioning type</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Partition type enum</dd></dl> +</li> +</ul> +<a name="getNumEntries()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumEntries</h4> +<pre>public int getNumEntries()</pre> +<div class="block">Get the number of columns that form the partitioning key + + <p> Returns the number of columns in the list of partitioning keys + or zero if there are no such columns.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Number of partitioning key columns (could be zero)</dd></dl> +</li> +</ul> +<a name="getColumnNum(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnNum</h4> +<pre>public int getColumnNum(int i) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Get the number/ordinal of the ith partitioning column.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Number/ordinal (0-based) of the ith partitioning column in + the list of partitioning columns.</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="setType(org.trafodion.sql.udr.PartitionInfo.PartitionTypeCode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setType</h4> +<pre>public void setType(<a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.html" title="enum in org.trafodion.sql.udr">PartitionInfo.PartitionTypeCode</a> type)</pre> +<div class="block">Set the partitioning type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Partition type enum.</dd></dl> +</li> +</ul> +<a name="addEntry(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEntry</h4> +<pre>public void addEntry(int colNum) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<div class="block">Add a new column to the list of partitioning columns + + <p> Add a new column to the list of column numbers that form the + partitioning key. Use this only if the type of the partitioning + is set to PARTITION.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Number of the column (ordinal, 0-based) of the + associated table.</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="getPartCols()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPartCols</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Vector.html?is-external=true"; title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>> getPartCols()</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/PartitionInfo.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/ParameterListInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PartitionInfo.PartitionTypeCode.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/PartitionInfo.html" target="_top">Frames</a></li> +<li><a href="PartitionInfo.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><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> 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/PredicateInfo.EvaluationCode.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html new file mode 100644 index 0000000..115dd78 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html @@ -0,0 +1,392 @@ +<!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:38 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PredicateInfo.EvaluationCode (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="PredicateInfo.EvaluationCode (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/PredicateInfo.EvaluationCode.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.PredOperator.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/PredicateInfo.EvaluationCode.html" target="_top">Frames</a></li> +<li><a href="PredicateInfo.EvaluationCode.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 PredicateInfo.EvaluationCode" class="title">Enum PredicateInfo.EvaluationCode</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/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a>></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.sql.udr.PredicateInfo.EvaluationCode</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/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">PredicateInfo.EvaluationCode</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/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a>></pre> +<div class="block">Info on whether a table-valued input or output column is used + + <p> Note that these are not necessarily exclusive, a predicate might + be evaluated in multiple places, although that should not be + common and is not yet allowed.</div> +</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/PredicateInfo.EvaluationCode.html#EVALUATE_IN_CHILD">EVALUATE_IN_CHILD</a></strong></code> +<div class="block">Predicate should be evaluated in a table-valued input before the data reaches the UDF.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html#EVALUATE_IN_UDF">EVALUATE_IN_UDF</a></strong></code> +<div class="block">Predicate is evaluated inside the code provided by the UDF writer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html#EVALUATE_ON_RESULT">EVALUATE_ON_RESULT</a></strong></code> +<div class="block">Predicate is evaluated on the UDF result, in Trafodion code.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html#UNKNOWN_EVAL">UNKNOWN_EVAL</a></strong></code> +<div class="block">Not yet determined where predicate is evaluated.</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>static <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html#getEnum(int)">getEnum</a></strong>(int x)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html#getEvaluationCode()">getEvaluationCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.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="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.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="UNKNOWN_EVAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UNKNOWN_EVAL</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a> UNKNOWN_EVAL</pre> +<div class="block">Not yet determined where predicate is evaluated.</div> +</li> +</ul> +<a name="EVALUATE_ON_RESULT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVALUATE_ON_RESULT</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a> EVALUATE_ON_RESULT</pre> +<div class="block">Predicate is evaluated on the UDF result, in Trafodion code. This is the default.</div> +</li> +</ul> +<a name="EVALUATE_IN_UDF"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVALUATE_IN_UDF</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a> EVALUATE_IN_UDF</pre> +<div class="block">Predicate is evaluated inside the code provided by the UDF writer.</div> +</li> +</ul> +<a name="EVALUATE_IN_CHILD"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EVALUATE_IN_CHILD</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a> EVALUATE_IN_CHILD</pre> +<div class="block">Predicate should be evaluated in a table-valued input before the data reaches the UDF.</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/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</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 (PredicateInfo.EvaluationCode c : PredicateInfo.EvaluationCode.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/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</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="getEvaluationCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvaluationCode</h4> +<pre>public int getEvaluationCode()</pre> +</li> +</ul> +<a name="getEnum(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getEnum</h4> +<pre>public static <a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a> getEnum(int x)</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/PredicateInfo.EvaluationCode.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/PredicateInfo.PredOperator.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/PredicateInfo.EvaluationCode.html" target="_top">Frames</a></li> +<li><a href="PredicateInfo.EvaluationCode.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>
