http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/GPDBWritable.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/GPDBWritable.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/GPDBWritable.html new file mode 100644 index 0000000..dd2d414 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/GPDBWritable.html @@ -0,0 +1,979 @@ +<!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 (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>GPDBWritable</title> +<meta name="date" content="2016-04-20"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="GPDBWritable"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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"> +<!-- --> +</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"> +<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="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/apache/hawq/pxf/service/io/BufferWritable.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/GPDBWritable.html" target="_top">Frames</a></li> +<li><a href="GPDBWritable.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><a href="#field.summary">Field</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><a href="#field.detail">Field</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></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.service.io</div> +<h2 title="Class GPDBWritable" class="title">Class GPDBWritable</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.io.GPDBWritable</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">GPDBWritable</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></pre> +<div class="block">This class represents a GPDB record in the form of + a Java object.</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="memberSummary" 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>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></span></code> +<div class="block">An exception class for column type definition and + set/get value mismatch.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#alignmentOfEightBytes">alignmentOfEightBytes</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#colType">colType</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.lang.Object[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#colValue">colValue</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#errorFlag">errorFlag</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#pktlen">pktlen</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<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><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#GPDBWritable--">GPDBWritable</a></span>()</code> +<div class="block">Empty Constructor</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#GPDBWritable-byte:A-">GPDBWritable</a></span>(byte[] data)</code> +<div class="block">Constructor to build a db record from a serialized form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#GPDBWritable-int:A-">GPDBWritable</a></span>(int[] columnType)</code> +<div class="block">Constructor to build a db record.</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="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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 id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getBoolean-int-">getBoolean</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getBytes-int-">getBytes</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getColType--">getColType</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.Double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getDouble-int-">getDouble</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.Float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getFloat-int-">getFloat</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getInt-int-">getInt</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getLong-int-">getLong</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.Short</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getShort-int-">getShort</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getString-int-">getString</a></span>(int colIdx)</code> +<div class="block">Gets the column value of the record.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#getTypeName-int-">getTypeName</a></span>(int oid)</code> +<div class="block">Helper to get the type name.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#isEmpty--">isEmpty</a></span>()</code> +<div class="block">Returns if the writable object is empty, + based on the pkt len as read from stream.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#readFields-java.io.DataInput-">readFields</a></span>(java.io.DataInput in)</code> +<div class="block">Deserialize the fields of this object from <code>in</code>.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setBoolean-int-java.lang.Boolean-">setBoolean</a></span>(int colIdx, + java.lang.Boolean val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setBytes-int-byte:A-">setBytes</a></span>(int colIdx, + byte[] val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setDouble-int-java.lang.Double-">setDouble</a></span>(int colIdx, + java.lang.Double val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setError-boolean-">setError</a></span>(boolean errorVal)</code> +<div class="block">Sets the error field.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setFloat-int-java.lang.Float-">setFloat</a></span>(int colIdx, + java.lang.Float val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setInt-int-java.lang.Integer-">setInt</a></span>(int colIdx, + java.lang.Integer val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setLong-int-java.lang.Long-">setLong</a></span>(int colIdx, + java.lang.Long val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setShort-int-java.lang.Short-">setShort</a></span>(int colIdx, + java.lang.Short val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#setString-int-java.lang.String-">setString</a></span>(int colIdx, + java.lang.String val)</code> +<div class="block">Sets the column value of the record.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string representation of the object.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html#write-java.io.DataOutput-">write</a></span>(java.io.DataOutput out)</code> +<div class="block">Serialize the fields of this object to <code>out</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="colType"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>colType</h4> +<pre>protected int[] colType</pre> +</li> +</ul> +<a name="colValue"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>colValue</h4> +<pre>protected java.lang.Object[] colValue</pre> +</li> +</ul> +<a name="alignmentOfEightBytes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>alignmentOfEightBytes</h4> +<pre>protected int alignmentOfEightBytes</pre> +</li> +</ul> +<a name="errorFlag"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>errorFlag</h4> +<pre>protected byte errorFlag</pre> +</li> +</ul> +<a name="pktlen"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>pktlen</h4> +<pre>protected int pktlen</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GPDBWritable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GPDBWritable</h4> +<pre>public GPDBWritable()</pre> +<div class="block">Empty Constructor</div> +</li> +</ul> +<a name="GPDBWritable-int:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GPDBWritable</h4> +<pre>public GPDBWritable(int[] columnType)</pre> +<div class="block">Constructor to build a db record. colType defines the schema</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>columnType</code> - the table column types</dd> +</dl> +</li> +</ul> +<a name="GPDBWritable-byte:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GPDBWritable</h4> +<pre>public GPDBWritable(byte[] data) + throws java.io.IOException</pre> +<div class="block">Constructor to build a db record from a serialized form.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>data</code> - a record in the serialized form</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if the data is malformatted.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getColType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColType</h4> +<pre>public int[] getColType()</pre> +</li> +</ul> +<a name="readFields-java.io.DataInput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFields</h4> +<pre>public void readFields(java.io.DataInput in) + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#readFields-java.io.DataInput-">Writable</a></code></span></div> +<div class="block">Deserialize the fields of this object from <code>in</code>. + <p>For efficiency, implementations should attempt to re-use storage in the + existing object where possible.</p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#readFields-java.io.DataInput-">readFields</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - <code>DataInput</code> to deserialize this object from.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if I/O error occurs</dd> +</dl> +</li> +</ul> +<a name="write-java.io.DataOutput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.io.DataOutput out) + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#write-java.io.DataOutput-">Writable</a></code></span></div> +<div class="block">Serialize the fields of this object to <code>out</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#write-java.io.DataOutput-">write</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - <code>DataOutput</code> to serialize this object into.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if I/O error occurs</dd> +</dl> +</li> +</ul> +<a name="setLong-int-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLong</h4> +<pre>public void setLong(int colIdx, + java.lang.Long val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setBoolean-int-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBoolean</h4> +<pre>public void setBoolean(int colIdx, + java.lang.Boolean val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setBytes-int-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBytes</h4> +<pre>public void setBytes(int colIdx, + byte[] val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setString-int-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setString</h4> +<pre>public void setString(int colIdx, + java.lang.String val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setFloat-int-java.lang.Float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFloat</h4> +<pre>public void setFloat(int colIdx, + java.lang.Float val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setDouble-int-java.lang.Double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDouble</h4> +<pre>public void setDouble(int colIdx, + java.lang.Double val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setInt-int-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInt</h4> +<pre>public void setInt(int colIdx, + java.lang.Integer val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setShort-int-java.lang.Short-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShort</h4> +<pre>public void setShort(int colIdx, + java.lang.Short val) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Sets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dd><code>val</code> - the value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getLong-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLong</h4> +<pre>public java.lang.Long getLong(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getBoolean-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public java.lang.Boolean getBoolean(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getBytes-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBytes</h4> +<pre>public byte[] getBytes(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getString-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getFloat-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFloat</h4> +<pre>public java.lang.Float getFloat(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getDouble-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public java.lang.Double getDouble(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getInt-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public java.lang.Integer getInt(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="getShort-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShort</h4> +<pre>public java.lang.Short getShort(int colIdx) + throws <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<div class="block">Gets the column value of the record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>colIdx</code> - the column index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code> - the column type does not match</dd> +</dl> +</li> +</ul> +<a name="setError-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setError</h4> +<pre>public void setError(boolean errorVal)</pre> +<div class="block">Sets the error field.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>errorVal</code> - the error value</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns a string representation of the object.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="getTypeName-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTypeName</h4> +<pre>public static java.lang.String getTypeName(int oid)</pre> +<div class="block">Helper to get the type name. + If a given oid is not in the commonly used list, we + would expect a TEXT for it (for the error message).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>oid</code> - type OID</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>type name</dd> +</dl> +</li> +</ul> +<a name="isEmpty--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<div class="block">Returns if the writable object is empty, + based on the pkt len as read from stream. + -1 means nothing was read (eof).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether the writable object is empty</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> +<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"> +<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="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/apache/hawq/pxf/service/io/BufferWritable.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/GPDBWritable.html" target="_top">Frames</a></li> +<li><a href="GPDBWritable.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><a href="#field.summary">Field</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><a href="#field.detail">Field</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></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Text.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Text.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Text.html new file mode 100644 index 0000000..da84c2d --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Text.html @@ -0,0 +1,767 @@ +<!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 (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>Text</title> +<meta name="date" content="2016-04-20"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Text"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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"> +<!-- --> +</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"> +<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="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/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/Text.html" target="_top">Frames</a></li> +<li><a href="Text.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.service.io</div> +<h2 title="Class Text" class="title">Class Text</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.io.Text</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Text</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></pre> +<div class="block">This class stores text using standard UTF8 encoding. It provides methods to + serialize, deserialize. The type of length is integer and is serialized using + zero-compressed format.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#Text--">Text</a></span>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#Text-byte:A-">Text</a></span>(byte[] utf8)</code> +<div class="block">Construct from a byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#Text-java.lang.String-">Text</a></span>(java.lang.String string)</code> +<div class="block">Construct from a string.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#Text-org.apache.hawq.pxf.service.io.Text-">Text</a></span>(<a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io">Text</a> utf8)</code> +<div class="block">Construct from another text.</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="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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 id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#append-byte:A-int-int-">append</a></span>(byte[] utf8, + int start, + int len)</code> +<div class="block">Appends a range of bytes to the end of the given text.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#clear--">clear</a></span>()</code> +<div class="block">Clears the string to empty.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#decode-byte:A-int-int-">decode</a></span>(byte[] utf8, + int start, + int length)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#decode-byte:A-int-int-boolean-">decode</a></span>(byte[] utf8, + int start, + int length, + boolean replace)</code> +<div class="block">Converts the provided byte array to a String using the UTF-8 encoding.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#decodeVIntSize-byte-">decodeVIntSize</a></span>(byte value)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static java.nio.ByteBuffer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#encode-java.lang.String-">encode</a></span>(java.lang.String string)</code> +<div class="block">Converts the provided String to bytes using the UTF-8 encoding.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static java.nio.ByteBuffer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#encode-java.lang.String-boolean-">encode</a></span>(java.lang.String string, + boolean replace)</code> +<div class="block">Converts the provided String to bytes using the UTF-8 encoding.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> +<div class="block">Returns true iff <code>o</code> is a Text with the same contents.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#getBytes--">getBytes</a></span>()</code> +<div class="block">Returns the raw bytes; however, only data up to <a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#getLength--"><code>getLength()</code></a> is + valid.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#getLength--">getLength</a></span>()</code> +<div class="block">Returns the number of bytes in the byte array</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#isNegativeVInt-byte-">isNegativeVInt</a></span>(byte value)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#readFields-java.io.DataInput-">readFields</a></span>(java.io.DataInput inputStream)</code> +<div class="block">deserialize</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#readVLong-java.io.DataInput-">readVLong</a></span>(java.io.DataInput stream)</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#set-byte:A-">set</a></span>(byte[] utf8)</code> +<div class="block">Sets to a UTF-8 byte array.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#set-byte:A-int-int-">set</a></span>(byte[] utf8, + int start, + int len)</code> +<div class="block">Sets the Text to range of bytes.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#set-java.lang.String-">set</a></span>(java.lang.String string)</code> +<div class="block">Sets to contain the contents of a string.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#set-org.apache.hawq.pxf.service.io.Text-">set</a></span>(<a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io">Text</a> other)</code> +<div class="block">Copies a text.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#toString--">toString</a></span>()</code> +<div class="block">Convert text back to string</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#write-java.io.DataOutput-">write</a></span>(java.io.DataOutput out)</code> +<div class="block">Serialize the fields of this object to <code>out</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="Text--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Text</h4> +<pre>public Text()</pre> +</li> +</ul> +<a name="Text-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Text</h4> +<pre>public Text(java.lang.String string)</pre> +<div class="block">Construct from a string.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>string</code> - input string</dd> +</dl> +</li> +</ul> +<a name="Text-org.apache.hawq.pxf.service.io.Text-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Text</h4> +<pre>public Text(<a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io">Text</a> utf8)</pre> +<div class="block">Construct from another text.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>utf8</code> - text to copy</dd> +</dl> +</li> +</ul> +<a name="Text-byte:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Text</h4> +<pre>public Text(byte[] utf8)</pre> +<div class="block">Construct from a byte array.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>utf8</code> - input byte array</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isNegativeVInt-byte-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNegativeVInt</h4> +<pre>public static boolean isNegativeVInt(byte value)</pre> +</li> +</ul> +<a name="readVLong-java.io.DataInput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readVLong</h4> +<pre>public static long readVLong(java.io.DataInput stream) + throws java.io.IOException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="decodeVIntSize-byte-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeVIntSize</h4> +<pre>public static int decodeVIntSize(byte value)</pre> +</li> +</ul> +<a name="decode-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static java.lang.String decode(byte[] utf8, + int start, + int length) + throws java.nio.charset.CharacterCodingException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.nio.charset.CharacterCodingException</code></dd> +</dl> +</li> +</ul> +<a name="decode-byte:A-int-int-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static java.lang.String decode(byte[] utf8, + int start, + int length, + boolean replace) + throws java.nio.charset.CharacterCodingException</pre> +<div class="block">Converts the provided byte array to a String using the UTF-8 encoding. If + <code>replace</code> is true, then malformed input is replaced with the + substitution character, which is U+FFFD. Otherwise the method throws a + MalformedInputException.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>utf8</code> - UTF-8 encoded byte array</dd> +<dd><code>start</code> - start point</dd> +<dd><code>length</code> - length of array</dd> +<dd><code>replace</code> - whether to replace malformed input with substitution + character</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>decoded string</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.nio.charset.MalformedInputException</code> - if a malformed input is used</dd> +<dd><code>java.nio.charset.CharacterCodingException</code> - if the conversion failed</dd> +</dl> +</li> +</ul> +<a name="encode-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static java.nio.ByteBuffer encode(java.lang.String string) + throws java.nio.charset.CharacterCodingException</pre> +<div class="block">Converts the provided String to bytes using the UTF-8 encoding. If the + input is malformed, invalid chars are replaced by a default value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>string</code> - string to encode</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>ByteBuffer: bytes stores at ByteBuffer.array() and length is + ByteBuffer.limit()</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.nio.charset.CharacterCodingException</code> - if conversion failed</dd> +</dl> +</li> +</ul> +<a name="encode-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static java.nio.ByteBuffer encode(java.lang.String string, + boolean replace) + throws java.nio.charset.CharacterCodingException</pre> +<div class="block">Converts the provided String to bytes using the UTF-8 encoding. If + <code>replace</code> is true, then malformed input is replaced with the + substitution character, which is U+FFFD. Otherwise the method throws a + MalformedInputException.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>string</code> - string to encode</dd> +<dd><code>replace</code> - whether to replace malformed input with substitution + character</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>ByteBuffer: bytes stores at ByteBuffer.array() and length is + ByteBuffer.limit()</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.nio.charset.MalformedInputException</code> - if a malformed input is used</dd> +<dd><code>java.nio.charset.CharacterCodingException</code> - if the conversion failed</dd> +</dl> +</li> +</ul> +<a name="getBytes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBytes</h4> +<pre>public byte[] getBytes()</pre> +<div class="block">Returns the raw bytes; however, only data up to <a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html#getLength--"><code>getLength()</code></a> is + valid.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>raw bytes of byte array</dd> +</dl> +</li> +</ul> +<a name="getLength--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public int getLength()</pre> +<div class="block">Returns the number of bytes in the byte array</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>number of bytes in byte array</dd> +</dl> +</li> +</ul> +<a name="set-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(java.lang.String string)</pre> +<div class="block">Sets to contain the contents of a string.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>string</code> - input string</dd> +</dl> +</li> +</ul> +<a name="set-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(byte[] utf8)</pre> +<div class="block">Sets to a UTF-8 byte array.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>utf8</code> - input UTF-8 byte array</dd> +</dl> +</li> +</ul> +<a name="set-org.apache.hawq.pxf.service.io.Text-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(<a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io">Text</a> other)</pre> +<div class="block">Copies a text.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>other</code> - text object to copy.</dd> +</dl> +</li> +</ul> +<a name="set-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(byte[] utf8, + int start, + int len)</pre> +<div class="block">Sets the Text to range of bytes.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>utf8</code> - the data to copy from</dd> +<dd><code>start</code> - the first position of the new string</dd> +<dd><code>len</code> - the number of bytes of the new string</dd> +</dl> +</li> +</ul> +<a name="append-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public void append(byte[] utf8, + int start, + int len)</pre> +<div class="block">Appends a range of bytes to the end of the given text.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>utf8</code> - the data to copy from</dd> +<dd><code>start</code> - the first position to append from utf8</dd> +<dd><code>len</code> - the number of bytes to append</dd> +</dl> +</li> +</ul> +<a name="clear--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<div class="block">Clears the string to empty.</div> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Convert text back to string</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Object.toString()</code></dd> +</dl> +</li> +</ul> +<a name="write-java.io.DataOutput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.io.DataOutput out) + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#write-java.io.DataOutput-">Writable</a></code></span></div> +<div class="block">Serialize the fields of this object to <code>out</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#write-java.io.DataOutput-">write</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - <code>DataOutput</code> to serialize this object into.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if I/O error occurs</dd> +</dl> +</li> +</ul> +<a name="readFields-java.io.DataInput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFields</h4> +<pre>public void readFields(java.io.DataInput inputStream) + throws java.io.IOException</pre> +<div class="block">deserialize</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#readFields-java.io.DataInput-">readFields</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>inputStream</code> - <code>DataInput</code> to deserialize this object from.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if I/O error occurs</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object o)</pre> +<div class="block">Returns true iff <code>o</code> is a Text with the same contents.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</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> +<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"> +<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="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/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/Text.html" target="_top">Frames</a></li> +<li><a href="Text.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Writable.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Writable.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Writable.html new file mode 100644 index 0000000..35db756 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/Writable.html @@ -0,0 +1,260 @@ +<!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 (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>Writable</title> +<meta name="date" content="2016-04-20"> +<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"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Writable"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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"> +<!-- --> +</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"> +<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="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/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/Writable.html" target="_top">Frames</a></li> +<li><a href="Writable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.service.io</div> +<h2 title="Interface Writable" class="title">Interface Writable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/service/io/BufferWritable.html" title="class in org.apache.hawq.pxf.service.io">BufferWritable</a>, <a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable</a>, <a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io">Text</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Writable</span></pre> +<div class="block">A serializable object which implements a simple, efficient, serialization + protocol, based on <code>DataInput</code> and <code>DataOutput</code>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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 id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#readFields-java.io.DataInput-">readFields</a></span>(java.io.DataInput in)</code> +<div class="block">Deserialize the fields of this object from <code>in</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html#write-java.io.DataOutput-">write</a></span>(java.io.DataOutput out)</code> +<div class="block">Serialize the fields of this object to <code>out</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="write-java.io.DataOutput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>void write(java.io.DataOutput out) + throws java.io.IOException</pre> +<div class="block">Serialize the fields of this object to <code>out</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - <code>DataOutput</code> to serialize this object into.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if I/O error occurs</dd> +</dl> +</li> +</ul> +<a name="readFields-java.io.DataInput-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readFields</h4> +<pre>void readFields(java.io.DataInput in) + throws java.io.IOException</pre> +<div class="block">Deserialize the fields of this object from <code>in</code>. + <p>For efficiency, implementations should attempt to re-use storage in the + existing object where possible.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - <code>DataInput</code> to deserialize this object from.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if I/O error occurs</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> +<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"> +<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="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/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/Writable.html" target="_top">Frames</a></li> +<li><a href="Writable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-frame.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-frame.html new file mode 100644 index 0000000..912c133 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-frame.html @@ -0,0 +1,26 @@ +<!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 (1.8.0_65) on Wed Apr 20 18:03:37 PDT 2016 --> +<title>org.apache.hawq.pxf.service.io</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../../org/apache/hawq/pxf/service/io/package-summary.html" target="classFrame">org.apache.hawq.pxf.service.io</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Writable.html" title="interface in org.apache.hawq.pxf.service.io" target="classFrame"><span class="interfaceName">Writable</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="BufferWritable.html" title="class in org.apache.hawq.pxf.service.io" target="classFrame">BufferWritable</a></li> +<li><a href="GPDBWritable.html" title="class in org.apache.hawq.pxf.service.io" target="classFrame">GPDBWritable</a></li> +<li><a href="Text.html" title="class in org.apache.hawq.pxf.service.io" target="classFrame">Text</a></li> +</ul> +</div> +</body> +</html>
