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/ColumnInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ColumnInfo.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ColumnInfo.html new file mode 100644 index 0000000..9ccaba6 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ColumnInfo.html @@ -0,0 +1,640 @@ +<!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>ColumnInfo (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="ColumnInfo (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/ColumnInfo.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/CardinalityConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.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/ColumnInfo.html" target="_top">Frames</a></li> +<li><a href="ColumnInfo.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 ColumnInfo" class="title">Class ColumnInfo</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.ColumnInfo</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ColumnInfo</span> +extends <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></pre> +<div class="block">Describes a column in an input or output table or a parameter + + <p> This describes a column or parameter value that is passed through + the UDR interface, either as a value read from an input table, a + value produced in an output table or a parameter.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<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/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr">ColumnInfo.ColumnUseCode</a></strong></code> +<div class="block">Info on whether a table-valued input or output column is used</div> +</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> +<!-- ======== 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/ColumnInfo.html#ColumnInfo()">ColumnInfo</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/ColumnInfo.html#ColumnInfo(org.trafodion.sql.udr.ColumnInfo)">ColumnInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> c)</code> +<div class="block">Copy constructor</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#ColumnInfo(java.lang.String,%20org.trafodion.sql.udr.TypeInfo)">ColumnInfo</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, + <a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> type)</code> +<div class="block">Constructor, specifying a name and a type</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/ColumnInfo.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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getColName()">getColName</a></strong>()</code> +<div class="block">Get the name of the column.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getCurrentVersion()">getCurrentVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getEstimatedUniqueEntries()">getEstimatedUniqueEntries</a></strong>()</code> +<div class="block">Get the estimated number of unique entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getProvenance()">getProvenance</a></strong>()</code> +<div class="block">Get provenance info for an output column.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getType()">getType</a></strong>()</code> +<div class="block">Get the type of the column.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr">ColumnInfo.ColumnUseCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#getUsage()">getUsage</a></strong>()</code> +<div class="block">Get the usage of an input or output column.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.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="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#serializedLength()">serializedLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setColName(java.lang.String)">setColName</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> colName)</code> +<div class="block">Set the name of the column.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setProvenance(org.trafodion.sql.udr.ProvenanceInfo)">setProvenance</a></strong>(<a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a> provenance)</code> +<div class="block">Set the provenance of an output column.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setType(org.trafodion.sql.udr.TypeInfo)">setType</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> type)</code> +<div class="block">Set the type of the column.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setUniqueEntries(long)">setUniqueEntries</a></strong>(long estimatedUniqueEntries)</code> +<div class="block">Provide an estimate for the number of unique values of a column.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setUsage(org.trafodion.sql.udr.ColumnInfo.ColumnUseCode)">setUsage</a></strong>(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr">ColumnInfo.ColumnUseCode</a> usage)</code> +<div class="block">Set the usage of the column.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#toString(boolean)">toString</a></strong>(boolean longForm)</code> </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#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="ColumnInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ColumnInfo</h4> +<pre>public ColumnInfo()</pre> +<div class="block">Default constructor</div> +</li> +</ul> +<a name="ColumnInfo(java.lang.String, org.trafodion.sql.udr.TypeInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ColumnInfo</h4> +<pre>public ColumnInfo(<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, + <a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> type)</pre> +<div class="block">Constructor, specifying a name and a type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.</dd><dd><code>type</code> - Type of the column to add.</dd></dl> +</li> +</ul> +<a name="ColumnInfo(org.trafodion.sql.udr.ColumnInfo)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ColumnInfo</h4> +<pre>public ColumnInfo(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> c)</pre> +<div class="block">Copy constructor</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getColName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColName</h4> +<pre>public <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> getColName()</pre> +<div class="block">Get the name of the column.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Name of the column in UTF-8.</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> getType()</pre> +<div class="block">Get the type of the column.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Type of the column.</dd></dl> +</li> +</ul> +<a name="getEstimatedUniqueEntries()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEstimatedUniqueEntries</h4> +<pre>public long getEstimatedUniqueEntries()</pre> +<div class="block">Get the estimated number of unique entries. + + <p> This returns an estimate for the number of unique values + for this column in the table. For example, a column containing + the names of US states would have approximately 50 distinct + values, assuming that most or all states are represented. + This estimate can be provided by the UDR writer, through the + setUniqueEntries() method, or in some cases it can also be + provided by the Trafodion compiler.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Estimated number of unique entries.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html#setUniqueEntries(long)"><code>setUniqueEntries(long)</code></a></dd></dl> +</li> +</ul> +<a name="getUsage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsage</h4> +<pre>public <a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr">ColumnInfo.ColumnUseCode</a> getUsage()</pre> +<div class="block">Get the usage of an input or output column. + + <p> This usage may be set in the + UDR::describeDataflowAndPredicates() method, + set automatically by Trafodion for certain situations + with passthru columns, or left at the default of USED.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Usage enum value for the column.</dd></dl> +</li> +</ul> +<a name="getProvenance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProvenance</h4> +<pre>public <a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a> getProvenance()</pre> +<div class="block">Get provenance info for an output column.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Provenance of the column.</dd></dl> +</li> +</ul> +<a name="setColName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColName</h4> +<pre>public void setColName(<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> colName)</pre> +<div class="block">Set the name of the column.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column (in UTF-8). There is a length + limit of 256 bytes for the column name.</dd></dl> +</li> +</ul> +<a name="setType(org.trafodion.sql.udr.TypeInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setType</h4> +<pre>public void setType(<a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> type)</pre> +<div class="block">Set the type of the column. + + <p> This is done by constructing a TypeInfo object and passing it to this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Type of the column.</dd></dl> +</li> +</ul> +<a name="setUniqueEntries(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUniqueEntries</h4> +<pre>public void setUniqueEntries(long estimatedUniqueEntries)</pre> +<div class="block">Provide an estimate for the number of unique values of a column. + + <p> Only use this method from within the following methods: + <ul> + <li> UDR#describeParamsAndColumns() + <li> UDR#describeDataflowAndPredicates() + <li> UDR#describeConstraints() + <li> UDR#describeStatistics() + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>estimatedUniqueEntries</code> - Estimate of the number of unique entries.</dd><dt><span class="strong">See Also:</span></dt><dd><code>ColumnInfo#getUniqueEntries()</code></dd></dl> +</li> +</ul> +<a name="setUsage(org.trafodion.sql.udr.ColumnInfo.ColumnUseCode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUsage</h4> +<pre>public void setUsage(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr">ColumnInfo.ColumnUseCode</a> usage)</pre> +<div class="block">Set the usage of the column. + + <p> See the ColumnInfo::COLUMN_USE enum for different options. + + <p> Only use this method from within the following method: + <ul> + <li> UDR#describeParamsAndColumns() + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usage</code> - Usage enum value of the column.</dd></dl> +</li> +</ul> +<a name="setProvenance(org.trafodion.sql.udr.ProvenanceInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProvenance</h4> +<pre>public void setProvenance(<a href="../../../../org/trafodion/sql/udr/ProvenanceInfo.html" title="class in org.trafodion.sql.udr">ProvenanceInfo</a> provenance)</pre> +<div class="block">Set the provenance of an output column. + + <p> This defines a relationship between an output column and + a column of a table-valued input from which the output value + is copied. Such columns are called pass-thru columns. See + class ProvenanceInfo for more information. + + <p> Only use this method from within the following method: + <ul> + <li> UDR#describeParamsAndColumns() + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>provenance</code> - The provenance information.</dd></dl> +</li> +</ul> +<a name="toString(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString(boolean longForm)</pre> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><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></code> in class <code><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></code></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/ColumnInfo.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/CardinalityConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.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/ColumnInfo.html" target="_top">Frames</a></li> +<li><a href="ColumnInfo.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/ComparisonPredicateInfo.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ComparisonPredicateInfo.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ComparisonPredicateInfo.html new file mode 100644 index 0000000..abea628 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ComparisonPredicateInfo.html @@ -0,0 +1,474 @@ +<!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>ComparisonPredicateInfo (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="ComparisonPredicateInfo (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/ComparisonPredicateInfo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/trafodion/sql/udr/ComparisonPredicateInfo.html" target="_top">Frames</a></li> +<li><a href="ComparisonPredicateInfo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_classes_inherited_from_class_org.trafodion.sql.udr.PredicateInfo">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 ComparisonPredicateInfo" class="title">Class ComparisonPredicateInfo</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/PredicateInfo.html" title="class in org.trafodion.sql.udr">org.trafodion.sql.udr.PredicateInfo</a></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.sql.udr.ComparisonPredicateInfo</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ComparisonPredicateInfo</span> +extends <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></pre> +<div class="block">A comparison predicate to be evaluated on a table + + A predicate that compares a column value to a constant or + another value that evaluates to a constant at runtime, + like an SQL query parameter.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.trafodion.sql.udr.PredicateInfo"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></h3> +<code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.EvaluationCode.html" title="enum in org.trafodion.sql.udr">PredicateInfo.EvaluationCode</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.PredOperator.html" title="enum in org.trafodion.sql.udr">PredicateInfo.PredOperator</a></code></li> +</ul> +<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/ComparisonPredicateInfo.html#ComparisonPredicateInfo()">ComparisonPredicateInfo</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/ComparisonPredicateInfo.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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#getColumnNumber()">getColumnNumber</a></strong>()</code> +<div class="block">Get the column number of the column in this comparison predicate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#getConstValue()">getConstValue</a></strong>()</code> +<div class="block">Return the value, as a string, of the constant in this predicate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#getCurrentVersion()">getCurrentVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#hasAConstantValue()">hasAConstantValue</a></strong>()</code> +<div class="block">Return whether this comparison value involves a constant.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#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="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#serializedLength()">serializedLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#setColumnNumber(int)">setColumnNumber</a></strong>(int columnNumber)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#setValue(java.lang.String)">setValue</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> value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#toString(org.trafodion.sql.udr.TableInfo)">toString</a></strong>(<a href="../../../../org/trafodion/sql/udr/TableInfo.html" title="class in org.trafodion.sql.udr">TableInfo</a> ti)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.trafodion.sql.udr.PredicateInfo"> +<!-- --> +</a> +<h3>Methods inherited from class org.trafodion.sql.udr.<a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</a></h3> +<code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#getEvaluationCode()">getEvaluationCode</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#getOperator()">getOperator</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#isAComparisonPredicate()">isAComparisonPredicate</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#setEvaluationCode(org.trafodion.sql.udr.PredicateInfo.EvaluationCode)">setEvaluationCode</a>, <a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#setOperator(org.trafodion.sql.udr.PredicateInfo.PredOperator)">setOperator</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="ComparisonPredicateInfo()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ComparisonPredicateInfo</h4> +<pre>public ComparisonPredicateInfo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getColumnNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnNumber</h4> +<pre>public int getColumnNumber()</pre> +<div class="block">Get the column number of the column in this comparison predicate.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Column number.</dd></dl> +</li> +</ul> +<a name="hasAConstantValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasAConstantValue</h4> +<pre>public boolean hasAConstantValue()</pre> +<div class="block">Return whether this comparison value involves a constant. + + <p> The method returns whether the comparison predicate is of the form + "column" "op" "constant". If it returns false, the predicate + compares the column with a parameter or some other value not + available to the UDR. Predicates that do not involve a constant + cannot be evaluated in the UDR itself, since the comparison value + is not available to the UDR. They can be evaluated on a table-valued + input, however.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the comparison is with a constant, false otherwise</dd></dl> +</li> +</ul> +<a name="getConstValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstValue</h4> +<pre>public <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> getConstValue()</pre> +<div class="block">Return the value, as a string, of the constant in this predicate. + + <p> This returns the value, using SQL syntax, of the constant involved + in the comparison predicate. It throws an exception if method + hasAConstantValue() would return false.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Value of the constant in this comparison predicate.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/ComparisonPredicateInfo.html#hasAConstantValue()"><code>hasAConstantValue()</code></a></dd></dl> +</li> +</ul> +<a name="setColumnNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColumnNumber</h4> +<pre>public void setColumnNumber(int columnNumber)</pre> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(<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> value)</pre> +</li> +</ul> +<a name="toString(org.trafodion.sql.udr.TableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString(<a href="../../../../org/trafodion/sql/udr/TableInfo.html" title="class in org.trafodion.sql.udr">TableInfo</a> ti) + throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html#toString(org.trafodion.sql.udr.TableInfo)">toString</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</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="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/PredicateInfo.html#serializedLength()">serializedLength</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</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/PredicateInfo.html#serialize(java.nio.ByteBuffer)">serialize</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</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/PredicateInfo.html#deserialize(java.nio.ByteBuffer)">deserialize</a></code> in class <code><a href="../../../../org/trafodion/sql/udr/PredicateInfo.html" title="class in org.trafodion.sql.udr">PredicateInfo</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/ComparisonPredicateInfo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/trafodion/sql/udr/ColumnInfo.ColumnUseCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/trafodion/sql/udr/ComparisonPredicateInfo.html" target="_top">Frames</a></li> +<li><a href="ComparisonPredicateInfo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_classes_inherited_from_class_org.trafodion.sql.udr.PredicateInfo">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/ConstraintInfo.ConstraintTypeCode.html ---------------------------------------------------------------------- diff --git a/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html new file mode 100644 index 0000000..969b2e9 --- /dev/null +++ b/docs/apidocs/2.0.1/tmudr_javadoc/apidocs/org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html @@ -0,0 +1,345 @@ +<!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>ConstraintInfo.ConstraintTypeCode (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="ConstraintInfo.ConstraintTypeCode (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/ConstraintInfo.ConstraintTypeCode.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/ConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/LmCharsetCoder.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/ConstraintInfo.ConstraintTypeCode.html" target="_top">Frames</a></li> +<li><a href="ConstraintInfo.ConstraintTypeCode.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 ConstraintInfo.ConstraintTypeCode" class="title">Enum ConstraintInfo.ConstraintTypeCode</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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a>></li> +<li> +<ul class="inheritance"> +<li>org.trafodion.sql.udr.ConstraintInfo.ConstraintTypeCode</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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.html" title="class in org.trafodion.sql.udr">ConstraintInfo</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">ConstraintInfo.ConstraintTypeCode</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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a>></pre> +<div class="block">Type of a constraint</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/ConstraintInfo.ConstraintTypeCode.html#CARDINALITY">CARDINALITY</a></strong></code> +<div class="block">Cardinality constraint</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html#UNIQUE">UNIQUE</a></strong></code> +<div class="block">Uniqueness constraint</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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.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="CARDINALITY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CARDINALITY</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a> CARDINALITY</pre> +<div class="block">Cardinality constraint</div> +</li> +</ul> +<a name="UNIQUE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNIQUE</h4> +<pre>public static final <a href="../../../../org/trafodion/sql/udr/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</a> UNIQUE</pre> +<div class="block">Uniqueness constraint</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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</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 (ConstraintInfo.ConstraintTypeCode c : ConstraintInfo.ConstraintTypeCode.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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</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/ConstraintInfo.ConstraintTypeCode.html" title="enum in org.trafodion.sql.udr">ConstraintInfo.ConstraintTypeCode</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/ConstraintInfo.ConstraintTypeCode.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/ConstraintInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/trafodion/sql/udr/LmCharsetCoder.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/ConstraintInfo.ConstraintTypeCode.html" target="_top">Frames</a></li> +<li><a href="ConstraintInfo.ConstraintTypeCode.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>
