Added: websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/JdbcWritableBridge.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/JdbcWritableBridge.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/JdbcWritableBridge.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,785 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Fri Aug 01 11:11:05 PDT 2014 --> +<title>JdbcWritableBridge (Sqoop 1.4.5 API)</title> +<meta name="date" content="2014-08-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="JdbcWritableBridge (Sqoop 1.4.5 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/JdbcWritableBridge.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/sqoop/lib/FieldMapProcessor.html" title="interface in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html" title="class in org.apache.sqoop.lib"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/sqoop/lib/JdbcWritableBridge.html" target="_top">Frames</a></li> +<li><a href="JdbcWritableBridge.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>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.sqoop.lib</div> +<h2 title="Class JdbcWritableBridge" class="title">Class JdbcWritableBridge</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.sqoop.lib.JdbcWritableBridge</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">JdbcWritableBridge</span> +extends java.lang.Object</pre> +<div class="block">Contains a set of methods which can read db columns from a ResultSet into + Java types, and do serialization of these types to/from DataInput/DataOutput + for use with Hadoop's Writable implementation. This supports null values + for all types.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" 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>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#MAX_BLOB_LENGTH">MAX_BLOB_LENGTH</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#MAX_CLOB_LENGTH">MAX_CLOB_LENGTH</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.math.BigDecimal</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readBigDecimal(int, java.sql.ResultSet)">readBigDecimal</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/cloudera/sqoop/lib/BlobRef.html" title="class in com.cloudera.sqoop.lib">BlobRef</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readBlobRef(int, java.sql.ResultSet)">readBlobRef</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readBoolean(int, java.sql.ResultSet)">readBoolean</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.apache.hadoop.io.BytesWritable</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readBytesWritable(int, java.sql.ResultSet)">readBytesWritable</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/cloudera/sqoop/lib/ClobRef.html" title="class in com.cloudera.sqoop.lib">ClobRef</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readClobRef(int, java.sql.ResultSet)">readClobRef</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.sql.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readDate(int, java.sql.ResultSet)">readDate</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Double</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readDouble(int, java.sql.ResultSet)">readDouble</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Float</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readFloat(int, java.sql.ResultSet)">readFloat</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readInteger(int, java.sql.ResultSet)">readInteger</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readLong(int, java.sql.ResultSet)">readLong</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readString(int, java.sql.ResultSet)">readString</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.sql.Time</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readTime(int, java.sql.ResultSet)">readTime</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.sql.Timestamp</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#readTimestamp(int, java.sql.ResultSet)">readTimestamp</a></strong>(int colNum, + java.sql.ResultSet r)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeBigDecimal(java.math.BigDecimal, int, int, java.sql.PreparedStatement)">writeBigDecimal</a></strong>(java.math.BigDecimal val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeBlobRef(com.cloudera.sqoop.lib.BlobRef, int, int, java.sql.PreparedStatement)">writeBlobRef</a></strong>(<a href="../../../../com/cloudera/sqoop/lib/BlobRef.html" title="class in com.cloudera.sqoop.lib">BlobRef</a> val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeBoolean(java.lang.Boolean, int, int, java.sql.PreparedStatement)">writeBoolean</a></strong>(java.lang.Boolean val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeBytesWritable(org.apache.hadoop.io.BytesWritable, int, int, java.sql.PreparedStatement)">writeBytesWritable</a></strong>(org.apache.hadoop.io.BytesWritable val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeClobRef(com.cloudera.sqoop.lib.ClobRef, int, int, java.sql.PreparedStatement)">writeClobRef</a></strong>(<a href="../../../../com/cloudera/sqoop/lib/ClobRef.html" title="class in com.cloudera.sqoop.lib">ClobRef</a> val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeDate(java.sql.Date, int, int, java.sql.PreparedStatement)">writeDate</a></strong>(java.sql.Date val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeDouble(java.lang.Double, int, int, java.sql.PreparedStatement)">writeDouble</a></strong>(java.lang.Double val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeFloat(java.lang.Float, int, int, java.sql.PreparedStatement)">writeFloat</a></strong>(java.lang.Float val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeInteger(java.lang.Integer, int, int, java.sql.PreparedStatement)">writeInteger</a></strong>(java.lang.Integer val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeLong(java.lang.Long, int, int, java.sql.PreparedStatement)">writeLong</a></strong>(java.lang.Long val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeString(java.lang.String, int, int, java.sql.PreparedStatement)">writeString</a></strong>(java.lang.String val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeTime(java.sql.Time, int, int, java.sql.PreparedStatement)">writeTime</a></strong>(java.sql.Time val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html#writeTimestamp(java.sql.Timestamp, int, int, java.sql.PreparedStatement)">writeTimestamp</a></strong>(java.sql.Timestamp val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="MAX_BLOB_LENGTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_BLOB_LENGTH</h4> +<pre>public static final long MAX_BLOB_LENGTH</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.JdbcWritableBridge.MAX_BLOB_LENGTH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MAX_CLOB_LENGTH"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MAX_CLOB_LENGTH</h4> +<pre>public static final long MAX_CLOB_LENGTH</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.JdbcWritableBridge.MAX_CLOB_LENGTH">Constant Field Values</a></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="readInteger(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readInteger</h4> +<pre>public static java.lang.Integer readInteger(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readLong(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readLong</h4> +<pre>public static java.lang.Long readLong(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readString(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readString</h4> +<pre>public static java.lang.String readString(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readFloat(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFloat</h4> +<pre>public static java.lang.Float readFloat(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readDouble(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readDouble</h4> +<pre>public static java.lang.Double readDouble(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readBoolean(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readBoolean</h4> +<pre>public static java.lang.Boolean readBoolean(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readTime(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readTime</h4> +<pre>public static java.sql.Time readTime(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readTimestamp(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readTimestamp</h4> +<pre>public static java.sql.Timestamp readTimestamp(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readDate(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readDate</h4> +<pre>public static java.sql.Date readDate(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readBytesWritable(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readBytesWritable</h4> +<pre>public static org.apache.hadoop.io.BytesWritable readBytesWritable(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readBigDecimal(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readBigDecimal</h4> +<pre>public static java.math.BigDecimal readBigDecimal(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readBlobRef(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readBlobRef</h4> +<pre>public static <a href="../../../../com/cloudera/sqoop/lib/BlobRef.html" title="class in com.cloudera.sqoop.lib">BlobRef</a> readBlobRef(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="readClobRef(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readClobRef</h4> +<pre>public static <a href="../../../../com/cloudera/sqoop/lib/ClobRef.html" title="class in com.cloudera.sqoop.lib">ClobRef</a> readClobRef(int colNum, + java.sql.ResultSet r) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeInteger(java.lang.Integer, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeInteger</h4> +<pre>public static void writeInteger(java.lang.Integer val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeLong(java.lang.Long, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeLong</h4> +<pre>public static void writeLong(java.lang.Long val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeDouble(java.lang.Double, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeDouble</h4> +<pre>public static void writeDouble(java.lang.Double val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeBoolean(java.lang.Boolean, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBoolean</h4> +<pre>public static void writeBoolean(java.lang.Boolean val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeFloat(java.lang.Float, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFloat</h4> +<pre>public static void writeFloat(java.lang.Float val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeString(java.lang.String, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeString</h4> +<pre>public static void writeString(java.lang.String val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeTimestamp(java.sql.Timestamp, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeTimestamp</h4> +<pre>public static void writeTimestamp(java.sql.Timestamp val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeTime(java.sql.Time, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeTime</h4> +<pre>public static void writeTime(java.sql.Time val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeDate(java.sql.Date, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeDate</h4> +<pre>public static void writeDate(java.sql.Date val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeBytesWritable(org.apache.hadoop.io.BytesWritable, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBytesWritable</h4> +<pre>public static void writeBytesWritable(org.apache.hadoop.io.BytesWritable val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeBigDecimal(java.math.BigDecimal, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBigDecimal</h4> +<pre>public static void writeBigDecimal(java.math.BigDecimal val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeBlobRef(com.cloudera.sqoop.lib.BlobRef, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBlobRef</h4> +<pre>public static void writeBlobRef(<a href="../../../../com/cloudera/sqoop/lib/BlobRef.html" title="class in com.cloudera.sqoop.lib">BlobRef</a> val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="writeClobRef(com.cloudera.sqoop.lib.ClobRef, int, int, java.sql.PreparedStatement)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writeClobRef</h4> +<pre>public static void writeClobRef(<a href="../../../../com/cloudera/sqoop/lib/ClobRef.html" title="class in com.cloudera.sqoop.lib">ClobRef</a> val, + int paramIdx, + int sqlType, + java.sql.PreparedStatement s) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/JdbcWritableBridge.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/sqoop/lib/FieldMapProcessor.html" title="interface in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html" title="class in org.apache.sqoop.lib"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/sqoop/lib/JdbcWritableBridge.html" target="_top">Frames</a></li> +<li><a href="JdbcWritableBridge.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> +</body> +</html>
Added: websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/LargeObjectLoader.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/LargeObjectLoader.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/LargeObjectLoader.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,419 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Fri Aug 01 11:11:05 PDT 2014 --> +<title>LargeObjectLoader (Sqoop 1.4.5 API)</title> +<meta name="date" content="2014-08-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="LargeObjectLoader (Sqoop 1.4.5 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LargeObjectLoader.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/LobRef.html" title="class in org.apache.sqoop.lib"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/sqoop/lib/LargeObjectLoader.html" target="_top">Frames</a></li> +<li><a href="LargeObjectLoader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#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.sqoop.lib</div> +<h2 title="Class LargeObjectLoader" class="title">Class LargeObjectLoader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.sqoop.lib.LargeObjectLoader</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.lang.AutoCloseable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/cloudera/sqoop/lib/LargeObjectLoader.html" title="class in com.cloudera.sqoop.lib">LargeObjectLoader</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LargeObjectLoader</span> +extends java.lang.Object +implements java.io.Closeable</pre> +<div class="block">Contains a set of methods which can read db columns from a ResultSet into + Java types, and do serialization of these types to/from DataInput/DataOutput + for use with Hadoop's Writable implementation. This supports null values + for all types. + + This is a singleton instance class; only one may exist at a time. + However, its lifetime is limited to the current TaskInputOutputContext's + life.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" 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>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#DEFAULT_MAX_LOB_LENGTH">DEFAULT_MAX_LOB_LENGTH</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#MAX_INLINE_LOB_LEN_KEY">MAX_INLINE_LOB_LEN_KEY</a></strong></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#LargeObjectLoader(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path)">LargeObjectLoader</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.Path workPath)</code> +<div class="block">Create a new LargeObjectLoader.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#finalize()">finalize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/cloudera/sqoop/lib/BlobRef.html" title="class in com.cloudera.sqoop.lib">BlobRef</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#readBlobRef(int, java.sql.ResultSet)">readBlobRef</a></strong>(int colNum, + java.sql.ResultSet r)</code> +<div class="block">Actually read a BlobRef instance from the ResultSet and materialize + the data either inline or to a file.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/cloudera/sqoop/lib/ClobRef.html" title="class in com.cloudera.sqoop.lib">ClobRef</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html#readClobRef(int, java.sql.ResultSet)">readClobRef</a></strong>(int colNum, + java.sql.ResultSet r)</code> +<div class="block">Actually read a ClobRef instance from the ResultSet and materialize + the data either inline or to a file.</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, getClass, hashCode, notify, notifyAll, toString, 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="DEFAULT_MAX_LOB_LENGTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_MAX_LOB_LENGTH</h4> +<pre>public static final long DEFAULT_MAX_LOB_LENGTH</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.LargeObjectLoader.DEFAULT_MAX_LOB_LENGTH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MAX_INLINE_LOB_LEN_KEY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MAX_INLINE_LOB_LEN_KEY</h4> +<pre>public static final java.lang.String MAX_INLINE_LOB_LEN_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.LargeObjectLoader.MAX_INLINE_LOB_LEN_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LargeObjectLoader(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LargeObjectLoader</h4> +<pre>public LargeObjectLoader(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.Path workPath) + throws java.io.IOException</pre> +<div class="block">Create a new LargeObjectLoader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the Configuration to use</dd><dd><code>workPath</code> - the HDFS working directory for this task.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></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="finalize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finalize</h4> +<pre>protected void finalize() + throws java.lang.Throwable</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>finalize</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="readBlobRef(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readBlobRef</h4> +<pre>public <a href="../../../../com/cloudera/sqoop/lib/BlobRef.html" title="class in com.cloudera.sqoop.lib">BlobRef</a> readBlobRef(int colNum, + java.sql.ResultSet r) + throws java.io.IOException, + java.lang.InterruptedException, + java.sql.SQLException</pre> +<div class="block">Actually read a BlobRef instance from the ResultSet and materialize + the data either inline or to a file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - the column of the ResultSet's current row to read.</dd><dd><code>r</code> - the ResultSet to read from.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a BlobRef encapsulating the data in this field.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if an error occurs writing to the FileSystem.</dd> +<dd><code>java.sql.SQLException</code> - if an error occurs reading from the database.</dd> +<dd><code>java.lang.InterruptedException</code></dd></dl> +</li> +</ul> +<a name="readClobRef(int, java.sql.ResultSet)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readClobRef</h4> +<pre>public <a href="../../../../com/cloudera/sqoop/lib/ClobRef.html" title="class in com.cloudera.sqoop.lib">ClobRef</a> readClobRef(int colNum, + java.sql.ResultSet r) + throws java.io.IOException, + java.lang.InterruptedException, + java.sql.SQLException</pre> +<div class="block">Actually read a ClobRef instance from the ResultSet and materialize + the data either inline or to a file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - the column of the ResultSet's current row to read.</dd><dd><code>r</code> - the ResultSet to read from.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a ClobRef encapsulating the data in this field.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if an error occurs writing to the FileSystem.</dd> +<dd><code>java.sql.SQLException</code> - if an error occurs reading from the database.</dd> +<dd><code>java.lang.InterruptedException</code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LargeObjectLoader.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/LobRef.html" title="class in org.apache.sqoop.lib"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/sqoop/lib/LargeObjectLoader.html" target="_top">Frames</a></li> +<li><a href="LargeObjectLoader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#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 ======= --> +<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> +</body> +</html> Added: websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/LobRef.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/LobRef.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/LobRef.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,684 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Fri Aug 01 11:11:05 PDT 2014 --> +<title>LobRef (Sqoop 1.4.5 API)</title> +<meta name="date" content="2014-08-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="LobRef (Sqoop 1.4.5 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LobRef.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/LobSerializer.html" title="class in org.apache.sqoop.lib"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/sqoop/lib/LobRef.html" target="_top">Frames</a></li> +<li><a href="LobRef.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#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.sqoop.lib</div> +<h2 title="Class LobRef" class="title">Class LobRef<DATATYPE,CONTAINERTYPE,ACCESSORTYPE></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.sqoop.lib.LobRef<DATATYPE,CONTAINERTYPE,ACCESSORTYPE></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.io.Writable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/cloudera/sqoop/lib/LobRef.html" title="class in com.cloudera.sqoop.lib">LobRef</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">LobRef<DATATYPE,CONTAINERTYPE,ACCESSORTYPE></span> +extends java.lang.Object +implements java.io.Closeable, org.apache.hadoop.io.Writable</pre> +<div class="block">Abstract base class that holds a reference to a Blob or a Clob. + DATATYPE is the type being held (e.g., a byte array). + CONTAINERTYPE is the type used to hold this data (e.g., BytesWritable). + ACCESSORTYPE is the type used to access this data in a streaming fashion + (either an InputStream or a Reader).</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" 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 static java.lang.ThreadLocal<java.util.regex.Matcher></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#EXTERNAL_MATCHER">EXTERNAL_MATCHER</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.apache.commons.logging.Log</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#LOG">LOG</a></strong></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#LobRef()">LobRef</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#LobRef(CONTAINERTYPE)">LobRef</a></strong>(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> container)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#LobRef(java.lang.String, long, long)">LobRef</a></strong>(java.lang.String file, + long offset, + long length)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#clone()">clone</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#deepCopyData(CONTAINERTYPE)">deepCopyData</a></strong>(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</code> +<div class="block">Make a copy of the materialized data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#finalize()">finalize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">DATATYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getData()">getData</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getDataObj()">getDataObj</a></strong>()</code> +<div class="block">Internal API to retrieve the data object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getDataStream(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path)">getDataStream</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.Path basePath)</code> +<div class="block">Get access to the LOB data itself.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getDataStream(org.apache.hadoop.mapreduce.Mapper.Context)">getDataStream</a></strong>(org.apache.hadoop.mapreduce.Mapper.Context mapContext)</code> +<div class="block">Convenience method to access #getDataStream(Configuration, Path) + from within a map task that read this LobRef from a file-based + InputSplit.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getExternalSource(com.cloudera.sqoop.io.LobFile.Reader)">getExternalSource</a></strong>(com.cloudera.sqoop.io.LobFile.Reader reader)</code> +<div class="block">Using the LobFile reader, get an accessor InputStream or Reader to the + underlying data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">DATATYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getInternalData(CONTAINERTYPE)">getInternalData</a></strong>(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#getInternalSource(CONTAINERTYPE)">getInternalSource</a></strong>(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</code> +<div class="block">Wrap the materialized data in an InputStream or Reader.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#isExternal()">isExternal</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#readFields(java.io.DataInput)">readFields</a></strong>(java.io.DataInput in)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#readFieldsInternal(java.io.DataInput)">readFieldsInternal</a></strong>(java.io.DataInput in)</code> +<div class="block">Perform the readFields() operation on a fully-materializable record.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#setDataObj(CONTAINERTYPE)">setDataObj</a></strong>(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</code> +<div class="block">Internal API to set the data object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#write(java.io.DataOutput)">write</a></strong>(java.io.DataOutput out)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/LobRef.html#writeInternal(java.io.DataOutput)">writeInternal</a></strong>(java.io.DataOutput out)</code> +<div class="block">Perform the write() operation on a fully-materializable record.</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>equals, 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="LOG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG</h4> +<pre>public static final org.apache.commons.logging.Log LOG</pre> +</li> +</ul> +<a name="EXTERNAL_MATCHER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EXTERNAL_MATCHER</h4> +<pre>protected static final java.lang.ThreadLocal<java.util.regex.Matcher> EXTERNAL_MATCHER</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LobRef()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LobRef</h4> +<pre>protected LobRef()</pre> +</li> +</ul> +<a name="LobRef(java.lang.Object)"> +<!-- --> +</a><a name="LobRef(CONTAINERTYPE)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LobRef</h4> +<pre>protected LobRef(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> container)</pre> +</li> +</ul> +<a name="LobRef(java.lang.String, long, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LobRef</h4> +<pre>protected LobRef(java.lang.String file, + long offset, + long length)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDataObj()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataObj</h4> +<pre>protected <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> getDataObj()</pre> +<div class="block">Internal API to retrieve the data object.</div> +</li> +</ul> +<a name="setDataObj(java.lang.Object)"> +<!-- --> +</a><a name="setDataObj(CONTAINERTYPE)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataObj</h4> +<pre>protected void setDataObj(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</pre> +<div class="block">Internal API to set the data object.</div> +</li> +</ul> +<a name="clone()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clone</h4> +<pre>public java.lang.Object clone() + throws java.lang.CloneNotSupportedException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>clone</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.CloneNotSupportedException</code></dd></dl> +</li> +</ul> +<a name="finalize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finalize</h4> +<pre>protected void finalize() + throws java.lang.Throwable</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>finalize</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="isExternal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExternal</h4> +<pre>public boolean isExternal()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the LOB data is in an external file; false if + it materialized inline.</dd></dl> +</li> +</ul> +<a name="getDataStream(org.apache.hadoop.mapreduce.Mapper.Context)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataStream</h4> +<pre>public <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a> getDataStream(org.apache.hadoop.mapreduce.Mapper.Context mapContext) + throws java.io.IOException</pre> +<div class="block">Convenience method to access #getDataStream(Configuration, Path) + from within a map task that read this LobRef from a file-based + InputSplit.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mapContext</code> - the Mapper.Context instance that encapsulates + the current map task.</dd> +<dt><span class="strong">Returns:</span></dt><dd>an object that lazily streams the record to the client.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if it cannot find the source + path for this LOB based on the MapContext.</dd> +<dd><code>java.io.IOException</code> - if it could not read the LOB from external storage.</dd></dl> +</li> +</ul> +<a name="getDataStream(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataStream</h4> +<pre>public <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a> getDataStream(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.Path basePath) + throws java.io.IOException</pre> +<div class="block">Get access to the LOB data itself. + This method returns a lazy reader of the LOB data, accessing the + filesystem for external LOB storage as necessary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the Configuration used to access the filesystem</dd><dd><code>basePath</code> - the base directory where the table records are + stored.</dd> +<dt><span class="strong">Returns:</span></dt><dd>an object that lazily streams the record to the client.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if it could not read the LOB from external storage.</dd></dl> +</li> +</ul> +<a name="getExternalSource(com.cloudera.sqoop.io.LobFile.Reader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalSource</h4> +<pre>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a> getExternalSource(com.cloudera.sqoop.io.LobFile.Reader reader) + throws java.io.IOException</pre> +<div class="block">Using the LobFile reader, get an accessor InputStream or Reader to the + underlying data.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="getInternalSource(java.lang.Object)"> +<!-- --> +</a><a name="getInternalSource(CONTAINERTYPE)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalSource</h4> +<pre>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">ACCESSORTYPE</a> getInternalSource(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</pre> +<div class="block">Wrap the materialized data in an InputStream or Reader.</div> +</li> +</ul> +<a name="getInternalData(java.lang.Object)"> +<!-- --> +</a><a name="getInternalData(CONTAINERTYPE)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalData</h4> +<pre>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">DATATYPE</a> getInternalData(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the materialized data itself.</dd></dl> +</li> +</ul> +<a name="deepCopyData(java.lang.Object)"> +<!-- --> +</a><a name="deepCopyData(CONTAINERTYPE)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deepCopyData</h4> +<pre>protected abstract <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> deepCopyData(<a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">CONTAINERTYPE</a> data)</pre> +<div class="block">Make a copy of the materialized data.</div> +</li> +</ul> +<a name="getData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public <a href="../../../../org/apache/sqoop/lib/LobRef.html" title="type parameter in LobRef">DATATYPE</a> getData()</pre> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></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 in) + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>readFields</code> in interface <code>org.apache.hadoop.io.Writable</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="readFieldsInternal(java.io.DataInput)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFieldsInternal</h4> +<pre>protected abstract void readFieldsInternal(java.io.DataInput in) + throws java.io.IOException</pre> +<div class="block">Perform the readFields() operation on a fully-materializable record.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the DataInput to deserialize from.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>write</code> in interface <code>org.apache.hadoop.io.Writable</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="writeInternal(java.io.DataOutput)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writeInternal</h4> +<pre>protected abstract void writeInternal(java.io.DataOutput out) + throws java.io.IOException</pre> +<div class="block">Perform the write() operation on a fully-materializable record.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the DataOutput to deserialize to.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LobRef.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/sqoop/lib/LargeObjectLoader.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/LobSerializer.html" title="class in org.apache.sqoop.lib"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/sqoop/lib/LobRef.html" target="_top">Frames</a></li> +<li><a href="LobRef.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#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 ======= --> +<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> +</body> +</html>
