http://git-wip-us.apache.org/repos/asf/kudu-site/blob/aa106ef2/apidocs/index.html ---------------------------------------------------------------------- diff --git a/apidocs/index.html b/apidocs/index.html index 074474e..e052c2b 100644 --- a/apidocs/index.html +++ b/apidocs/index.html @@ -2,8 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>Kudu 1.0.1 API</title> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Kudu 1.1.0 API</title> <script type="text/javascript"> targetPage = "" + window.location.search; if (targetPage != "" && targetPage != "undefined")
http://git-wip-us.apache.org/repos/asf/kudu-site/blob/aa106ef2/apidocs/org/apache/kudu/ColumnSchema.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/ColumnSchema.html b/apidocs/org/apache/kudu/ColumnSchema.html index 7ab1415..6a644cb 100644 --- a/apidocs/org/apache/kudu/ColumnSchema.html +++ b/apidocs/org/apache/kudu/ColumnSchema.html @@ -2,24 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>ColumnSchema (Kudu 1.0.1 API)</title> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ColumnSchema (Kudu 1.1.0 API)</title> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ColumnSchema (Kudu 1.0.1 API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ColumnSchema (Kudu 1.1.0 API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +49,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu"><span class="strong">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?org/apache/kudu/ColumnSchema.html" target="_top">Frames</a></li> -<li><a href="ColumnSchema.html" target="_top">No Frames</a></li> +<li><a href="ColumnSchema.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> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +77,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -96,8 +110,8 @@ <hr> <br> <pre>@InterfaceAudience.Public [email protected] -public class <span class="strong">ColumnSchema</span> + @InterfaceStability.Evolving +public class <span class="typeNameLabel">ColumnSchema</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">Represents a Kudu Table column. Use <code>ColumnSchema.ColumnSchemaBuilder</code> in order to create columns.</div> @@ -109,83 +123,83 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#equals(java.lang.Object)">equals</a></strong>(<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> o)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#equals-java.lang.Object-">equals</a></span>(<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> o)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>org.apache.kudu.ColumnSchema.CompressionAlgorithm</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#getCompressionAlgorithm()">getCompressionAlgorithm</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#getCompressionAlgorithm--">getCompressionAlgorithm</a></span>()</code> <div class="block">Return the compression algorithm of this column, or null if it is not known.</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><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></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#getDefaultValue()">getDefaultValue</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#getDefaultValue--">getDefaultValue</a></span>()</code> <div class="block">The Java object representation of the default value that's read</div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#getDesiredBlockSize()">getDesiredBlockSize</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#getDesiredBlockSize--">getDesiredBlockSize</a></span>()</code> <div class="block">Gets the desired block size for this column.</div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>org.apache.kudu.ColumnSchema.Encoding</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#getEncoding()">getEncoding</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#getEncoding--">getEncoding</a></span>()</code> <div class="block">Return the encoding of this column, or null if it is not known.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i5" 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/apache/kudu/ColumnSchema.html#getName()">getName</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#getName--">getName</a></span>()</code> <div class="block">Get the column's name</div> </td> </tr> -<tr class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#getType()">getType</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#getType--">getType</a></span>()</code> <div class="block">Get the column's Type</div> </td> </tr> -<tr class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#hashCode()">hashCode</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#hashCode--">hashCode</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#isKey()">isKey</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#isKey--">isKey</a></span>()</code> <div class="block">Answers if the column part of the key</div> </td> </tr> -<tr class="rowColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/ColumnSchema.html#isNullable()">isNullable</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#isNullable--">isNullable</a></span>()</code> <div class="block">Answers if the column can be set to null</div> </td> </tr> -<tr class="altColor"> +<tr id="i10" 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/apache/kudu/ColumnSchema.html#toString()">toString</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/ColumnSchema.html#toString--">toString</a></span>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<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#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#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-ex ternal=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> +<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#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#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-ex ternal=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-int-"; title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -197,11 +211,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getType()"> +<a name="getType--"> <!-- --> </a> <ul class="blockList"> @@ -209,10 +223,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getType</h4> <pre>public <a href="../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> getType()</pre> <div class="block">Get the column's Type</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the type</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the type</dd> +</dl> </li> </ul> -<a name="getName()"> +<a name="getName--"> <!-- --> </a> <ul class="blockList"> @@ -220,10 +237,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getName</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> getName()</pre> <div class="block">Get the column's name</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>A string representation of the name</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A string representation of the name</dd> +</dl> </li> </ul> -<a name="isKey()"> +<a name="isKey--"> <!-- --> </a> <ul class="blockList"> @@ -231,10 +251,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>isKey</h4> <pre>public boolean isKey()</pre> <div class="block">Answers if the column part of the key</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>true if the column is part of the key, else false</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the column is part of the key, else false</dd> +</dl> </li> </ul> -<a name="isNullable()"> +<a name="isNullable--"> <!-- --> </a> <ul class="blockList"> @@ -242,10 +265,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>isNullable</h4> <pre>public boolean isNullable()</pre> <div class="block">Answers if the column can be set to null</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>true if it can be set to null, else false</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if it can be set to null, else false</dd> +</dl> </li> </ul> -<a name="getDefaultValue()"> +<a name="getDefaultValue--"> <!-- --> </a> <ul class="blockList"> @@ -253,10 +279,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getDefaultValue</h4> <pre>public <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> getDefaultValue()</pre> <div class="block">The Java object representation of the default value that's read</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the default read value</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the default read value</dd> +</dl> </li> </ul> -<a name="getDesiredBlockSize()"> +<a name="getDesiredBlockSize--"> <!-- --> </a> <ul class="blockList"> @@ -266,10 +295,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="block">Gets the desired block size for this column. If no block size has been explicitly specified for this column, returns 0 to indicate that the server-side default will be used.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the block size, in bytes, or 0 if none has been configured.</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the block size, in bytes, or 0 if none has been configured.</dd> +</dl> </li> </ul> -<a name="getEncoding()"> +<a name="getEncoding--"> <!-- --> </a> <ul class="blockList"> @@ -279,7 +311,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="block">Return the encoding of this column, or null if it is not known.</div> </li> </ul> -<a name="getCompressionAlgorithm()"> +<a name="getCompressionAlgorithm--"> <!-- --> </a> <ul class="blockList"> @@ -289,7 +321,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="block">Return the compression algorithm of this column, or null if it is not known.</div> </li> </ul> -<a name="equals(java.lang.Object)"> +<a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> @@ -297,12 +329,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>equals</h4> <pre>public boolean equals(<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> o)</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a></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="hashCode()"> +<a name="hashCode--"> <!-- --> </a> <ul class="blockList"> @@ -310,12 +342,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>hashCode</h4> <pre>public int hashCode()</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#hashCode()" title="class or interface in java.lang">hashCode</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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></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="toString()"> +<a name="toString--"> <!-- --> </a> <ul class="blockListLast"> @@ -323,8 +355,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></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> @@ -336,9 +368,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -354,15 +388,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu"><span class="strong">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?org/apache/kudu/ColumnSchema.html" target="_top">Frames</a></li> -<li><a href="ColumnSchema.html" target="_top">No Frames</a></li> +<li><a href="ColumnSchema.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> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -382,16 +416,16 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> http://git-wip-us.apache.org/repos/asf/kudu-site/blob/aa106ef2/apidocs/org/apache/kudu/Schema.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/Schema.html b/apidocs/org/apache/kudu/Schema.html index a58d25d..06e19ba 100644 --- a/apidocs/org/apache/kudu/Schema.html +++ b/apidocs/org/apache/kudu/Schema.html @@ -2,24 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>Schema (Kudu 1.0.1 API)</title> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Schema (Kudu 1.1.0 API)</title> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Schema (Kudu 1.0.1 API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Schema (Kudu 1.1.0 API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +49,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu"><span class="strong">Next Class</span></a></li> +<li><a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?org/apache/kudu/Schema.html" target="_top">Frames</a></li> -<li><a href="Schema.html" target="_top">No Frames</a></li> +<li><a href="Schema.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> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -62,17 +76,17 @@ <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> +<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> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -96,8 +110,8 @@ <hr> <br> <pre>@InterfaceAudience.Public [email protected] -public class <span class="strong">Schema</span> + @InterfaceStability.Evolving +public class <span class="typeNameLabel">Schema</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">Represents table's schema which is essentially a list of columns. This class offers a few utility methods for querying it.</div> @@ -109,22 +123,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> +<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"> +<table class="memberSummary" 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/apache/kudu/Schema.html#Schema(java.util.List)">Schema</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> columns)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#Schema-java.util.List-">Schema</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> columns)</code> <div class="block">Constructs a schema using the specified columns and does some internal accounting</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../org/apache/kudu/Schema.html#Schema(java.util.List,%20java.util.List)">Schema</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> columns, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#Schema-java.util.List-java.util.List-">Schema</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> columns, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> columnIds)</code> <div class="block">Constructs a schema using the specified columns and IDs.</div> </td> @@ -134,114 +148,114 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumn(java.lang.String)">getColumn</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> columnName)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumn-java.lang.String-">getColumn</a></span>(<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> columnName)</code> <div class="block">Get the column associated with the specified name</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumnByIndex(int)">getColumnByIndex</a></strong>(int idx)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumnByIndex-int-">getColumnByIndex</a></span>(int idx)</code> <div class="block">Get the column at the specified index in the original list</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumnCount()">getColumnCount</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumnCount--">getColumnCount</a></span>()</code> <div class="block">Get the count of columns in this schema</div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumnIndex(int)">getColumnIndex</a></strong>(int columnId)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumnIndex-int-">getColumnIndex</a></span>(int columnId)</code> <div class="block">Get the column index of the column with the provided ID.</div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumnIndex(java.lang.String)">getColumnIndex</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> columnName)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumnIndex-java.lang.String-">getColumnIndex</a></span>(<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> columnName)</code> <div class="block">Get the index for the provided column name.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumnOffset(int)">getColumnOffset</a></strong>(int idx)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumnOffset-int-">getColumnOffset</a></span>(int idx)</code> <div class="block">Get the index at which this column can be found in the backing byte array</div> </td> </tr> -<tr class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getColumns()">getColumns</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getColumns--">getColumns</a></span>()</code> <div class="block">Get the list of columns used to create this schema</div> </td> </tr> -<tr class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getPrimaryKeyColumnCount()">getPrimaryKeyColumnCount</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getPrimaryKeyColumnCount--">getPrimaryKeyColumnCount</a></span>()</code> <div class="block">Get the count of columns that are part of the primary key.</div> </td> </tr> -<tr class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getPrimaryKeyColumns()">getPrimaryKeyColumns</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getPrimaryKeyColumns--">getPrimaryKeyColumns</a></span>()</code> <div class="block">Get the primary key columns.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu">Schema</a></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getRowKeyProjection()">getRowKeyProjection</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getRowKeyProjection--">getRowKeyProjection</a></span>()</code> <div class="block">Get a schema that only contains the columns which are part of the key</div> </td> </tr> -<tr class="altColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getRowSize()">getRowSize</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getRowSize--">getRowSize</a></span>()</code> <div class="block">Get the size a row built using this schema would be</div> </td> </tr> -<tr class="rowColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#getVarLengthColumnCount()">getVarLengthColumnCount</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#getVarLengthColumnCount--">getVarLengthColumnCount</a></span>()</code> <div class="block">Get the count of columns with variable length (BINARY/STRING) in this schema.</div> </td> </tr> -<tr class="altColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#hasColumnIds()">hasColumnIds</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#hasColumnIds--">hasColumnIds</a></span>()</code> <div class="block">Tells whether this schema includes IDs for columns.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#hasNullableColumns()">hasNullableColumns</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#hasNullableColumns--">hasNullableColumns</a></span>()</code> <div class="block">Tells if there's at least one nullable column</div> </td> </tr> -<tr class="altColor"> +<tr id="i14" class="altColor"> <td class="colFirst"><code><a href="../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a></code></td> -<td class="colLast"><code><strong><a href="../../../org/apache/kudu/Schema.html#newPartialRow()">newPartialRow</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/kudu/Schema.html#newPartialRow--">newPartialRow</a></span>()</code> <div class="block">Creates a new partial row for the schema.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<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> +<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-int-"; title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -253,11 +267,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> +<li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="Schema(java.util.List)"> +<a name="Schema-java.util.List-"> <!-- --> </a> <ul class="blockList"> @@ -265,41 +279,48 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>Schema</h4> <pre>public Schema(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> columns)</pre> <div class="block">Constructs a schema using the specified columns and does some internal accounting</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columns</code> - the columns in index order</dd> -<dt><span class="strong">Throws:</span></dt> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columns</code> - the columns in index order</dd> +<dt><span class="throwsLabel">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 the key columns aren't specified first - See <code>ColumnPBsToSchema()</code> in <code>src/kudu/common/wire_protocol.cc</code></dd></dl> + See <code>ColumnPBsToSchema()</code> in <code>src/kudu/common/wire_protocol.cc</code></dd> +</dl> </li> </ul> -<a name="Schema(java.util.List, java.util.List)"> +<a name="Schema-java.util.List-java.util.List-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Schema</h4> <pre>public Schema(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> columns, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> columnIds)</pre> + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> columnIds)</pre> <div class="block">Constructs a schema using the specified columns and IDs. - This is not a stable API, prefer using <a href="../../../org/apache/kudu/Schema.html#Schema(java.util.List)"><code>Schema(List)</code></a> to create a new schema.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columns</code> - the columns in index order</dd><dd><code>columnIds</code> - the column ids of the provided columns, or null</dd> -<dt><span class="strong">Throws:</span></dt> + This is not a stable API, prefer using <a href="../../../org/apache/kudu/Schema.html#Schema-java.util.List-"><code>Schema(List)</code></a> to create a new schema.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columns</code> - the columns in index order</dd> +<dd><code>columnIds</code> - the column ids of the provided columns, or null</dd> +<dt><span class="throwsLabel">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 the primary key columns aren't specified first</dd> <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 the column ids length does not match the columns length - See <code>ColumnPBsToSchema()</code> in <code>src/kudu/common/wire_protocol.cc</code></dd></dl> + See <code>ColumnPBsToSchema()</code> in <code>src/kudu/common/wire_protocol.cc</code></dd> +</dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getColumns()"> +<a name="getColumns--"> <!-- --> </a> <ul class="blockList"> @@ -307,10 +328,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getColumns</h4> <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> getColumns()</pre> <div class="block">Get the list of columns used to create this schema</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>list of columns</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>list of columns</dd> +</dl> </li> </ul> -<a name="getVarLengthColumnCount()"> +<a name="getVarLengthColumnCount--"> <!-- --> </a> <ul class="blockList"> @@ -319,10 +343,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <pre>public int getVarLengthColumnCount()</pre> <div class="block">Get the count of columns with variable length (BINARY/STRING) in this schema.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>strings count</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>strings count</dd> +</dl> </li> </ul> -<a name="getRowSize()"> +<a name="getRowSize--"> <!-- --> </a> <ul class="blockList"> @@ -330,10 +357,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getRowSize</h4> <pre>public int getRowSize()</pre> <div class="block">Get the size a row built using this schema would be</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>size in bytes</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>size in bytes</dd> +</dl> </li> </ul> -<a name="getColumnOffset(int)"> +<a name="getColumnOffset-int-"> <!-- --> </a> <ul class="blockList"> @@ -341,11 +371,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getColumnOffset</h4> <pre>public int getColumnOffset(int idx)</pre> <div class="block">Get the index at which this column can be found in the backing byte array</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - column's index</dd> -<dt><span class="strong">Returns:</span></dt><dd>column's offset</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>idx</code> - column's index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column's offset</dd> +</dl> </li> </ul> -<a name="getColumnIndex(java.lang.String)"> +<a name="getColumnIndex-java.lang.String-"> <!-- --> </a> <ul class="blockList"> @@ -353,11 +387,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getColumnIndex</h4> <pre>public int getColumnIndex(<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> columnName)</pre> <div class="block">Get the index for the provided column name.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columnName</code> - column to search for</dd> -<dt><span class="strong">Returns:</span></dt><dd>an index in the schema</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columnName</code> - column to search for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an index in the schema</dd> +</dl> </li> </ul> -<a name="getColumnByIndex(int)"> +<a name="getColumnByIndex-int-"> <!-- --> </a> <ul class="blockList"> @@ -365,11 +403,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getColumnByIndex</h4> <pre>public <a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a> getColumnByIndex(int idx)</pre> <div class="block">Get the column at the specified index in the original list</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - column's index</dd> -<dt><span class="strong">Returns:</span></dt><dd>the column</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>idx</code> - column's index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the column</dd> +</dl> </li> </ul> -<a name="getColumnIndex(int)"> +<a name="getColumnIndex-int-"> <!-- --> </a> <ul class="blockList"> @@ -378,11 +420,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <pre>public int getColumnIndex(int columnId)</pre> <div class="block">Get the column index of the column with the provided ID. This method is not part of the stable API.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columnId</code> - the column id of the column</dd> -<dt><span class="strong">Returns:</span></dt><dd>the column index of the column.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columnId</code> - the column id of the column</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the column index of the column.</dd> +</dl> </li> </ul> -<a name="getColumn(java.lang.String)"> +<a name="getColumn-java.lang.String-"> <!-- --> </a> <ul class="blockList"> @@ -390,11 +436,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getColumn</h4> <pre>public <a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a> getColumn(<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> columnName)</pre> <div class="block">Get the column associated with the specified name</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columnName</code> - column's name</dd> -<dt><span class="strong">Returns:</span></dt><dd>the column</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columnName</code> - column's name</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the column</dd> +</dl> </li> </ul> -<a name="getColumnCount()"> +<a name="getColumnCount--"> <!-- --> </a> <ul class="blockList"> @@ -402,10 +452,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getColumnCount</h4> <pre>public int getColumnCount()</pre> <div class="block">Get the count of columns in this schema</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>count of columns</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>count of columns</dd> +</dl> </li> </ul> -<a name="getPrimaryKeyColumnCount()"> +<a name="getPrimaryKeyColumnCount--"> <!-- --> </a> <ul class="blockList"> @@ -413,10 +466,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getPrimaryKeyColumnCount</h4> <pre>public int getPrimaryKeyColumnCount()</pre> <div class="block">Get the count of columns that are part of the primary key.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>count of primary key columns.</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>count of primary key columns.</dd> +</dl> </li> </ul> -<a name="getPrimaryKeyColumns()"> +<a name="getPrimaryKeyColumns--"> <!-- --> </a> <ul class="blockList"> @@ -424,10 +480,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getPrimaryKeyColumns</h4> <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a>> getPrimaryKeyColumns()</pre> <div class="block">Get the primary key columns.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the primary key columns.</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the primary key columns.</dd> +</dl> </li> </ul> -<a name="getRowKeyProjection()"> +<a name="getRowKeyProjection--"> <!-- --> </a> <ul class="blockList"> @@ -435,10 +494,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>getRowKeyProjection</h4> <pre>public <a href="../../../org/apache/kudu/Schema.html" title="class in org.apache.kudu">Schema</a> getRowKeyProjection()</pre> <div class="block">Get a schema that only contains the columns which are part of the key</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>new schema with only the keys</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>new schema with only the keys</dd> +</dl> </li> </ul> -<a name="hasNullableColumns()"> +<a name="hasNullableColumns--"> <!-- --> </a> <ul class="blockList"> @@ -446,10 +508,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>hasNullableColumns</h4> <pre>public boolean hasNullableColumns()</pre> <div class="block">Tells if there's at least one nullable column</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>true if at least one column is nullable, else false.</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if at least one column is nullable, else false.</dd> +</dl> </li> </ul> -<a name="hasColumnIds()"> +<a name="hasColumnIds--"> <!-- --> </a> <ul class="blockList"> @@ -459,10 +524,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="block">Tells whether this schema includes IDs for columns. A schema created by a client as part of table creation will not include IDs, but schemas for open tables will include IDs. This method is not part of the stable API.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>whether this schema includes column IDs.</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this schema includes column IDs.</dd> +</dl> </li> </ul> -<a name="newPartialRow()"> +<a name="newPartialRow--"> <!-- --> </a> <ul class="blockListLast"> @@ -470,7 +538,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>newPartialRow</h4> <pre>public <a href="../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> newPartialRow()</pre> <div class="block">Creates a new partial row for the schema.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>a new partial row</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new partial row</dd> +</dl> </li> </ul> </li> @@ -481,9 +552,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -499,15 +572,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu"><span class="strong">Next Class</span></a></li> +<li><a href="../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?org/apache/kudu/Schema.html" target="_top">Frames</a></li> -<li><a href="Schema.html" target="_top">No Frames</a></li> +<li><a href="Schema.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> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -526,17 +599,17 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> +<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> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
