Added: websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/DelimiterSet.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/DelimiterSet.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/DelimiterSet.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,726 @@ +<!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:04 PDT 2014 --> +<title>DelimiterSet (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="DelimiterSet (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/DelimiterSet.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/ClobRef.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/FieldFormatter.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/DelimiterSet.html" target="_top">Frames</a></li> +<li><a href="DelimiterSet.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 DelimiterSet" class="title">Class DelimiterSet</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.sqoop.lib.DelimiterSet</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Cloneable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DelimiterSet</span> +extends java.lang.Object +implements java.lang.Cloneable</pre> +<div class="block">Encapsulates a set of delimiters used to encode a record.</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 java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#INPUT_ENCLOSE_REQUIRED_KEY">INPUT_ENCLOSE_REQUIRED_KEY</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/DelimiterSet.html#INPUT_ENCLOSED_BY_KEY">INPUT_ENCLOSED_BY_KEY</a></strong></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/DelimiterSet.html#INPUT_ESCAPED_BY_KEY">INPUT_ESCAPED_BY_KEY</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/DelimiterSet.html#INPUT_FIELD_DELIM_KEY">INPUT_FIELD_DELIM_KEY</a></strong></code> +<div class="block">Create the input variations for export instead of overloading them.</div> +</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/DelimiterSet.html#INPUT_RECORD_DELIM_KEY">INPUT_RECORD_DELIM_KEY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#NULL_CHAR">NULL_CHAR</a></strong></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/DelimiterSet.html#OUTPUT_ENCLOSE_REQUIRED_KEY">OUTPUT_ENCLOSE_REQUIRED_KEY</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/DelimiterSet.html#OUTPUT_ENCLOSED_BY_KEY">OUTPUT_ENCLOSED_BY_KEY</a></strong></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/DelimiterSet.html#OUTPUT_ESCAPED_BY_KEY">OUTPUT_ESCAPED_BY_KEY</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/DelimiterSet.html#OUTPUT_FIELD_DELIM_KEY">OUTPUT_FIELD_DELIM_KEY</a></strong></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/DelimiterSet.html#OUTPUT_RECORD_DELIM_KEY">OUTPUT_RECORD_DELIM_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/DelimiterSet.html#DelimiterSet()">DelimiterSet</a></strong>()</code> +<div class="block">Create a delimiter set with the default delimiters + (comma for fields, newline for records).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#DelimiterSet(char, char, char, char, boolean)">DelimiterSet</a></strong>(char field, + char record, + char enclose, + char escape, + boolean isEncloseRequired)</code> +<div class="block">Create a delimiter set with the specified delimiters.</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>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#clone()">clone</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html" title="class in org.apache.sqoop.lib">DelimiterSet</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#copy()">copy</a></strong>()</code> +<div class="block">Identical to clone() but does not throw spurious exceptions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code> </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/DelimiterSet.html#formatConstructor()">formatConstructor</a></strong>()</code> +<div class="block">Format this set of delimiters as a call to the constructor for + this object, that would generate identical delimiters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#getEnclosedBy()">getEnclosedBy</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#getEscapedBy()">getEscapedBy</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#getFieldsTerminatedBy()">getFieldsTerminatedBy</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#getLinesTerminatedBy()">getLinesTerminatedBy</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#isEncloseRequired()">isEncloseRequired</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/DelimiterSet.html#setEnclosedBy(char)">setEnclosedBy</a></strong>(char e)</code> +<div class="block">Sets the enclosed-by character.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#setEncloseRequired(boolean)">setEncloseRequired</a></strong>(boolean required)</code> +<div class="block">Set whether the enclosed-by character must be applied to all fields, + or only fields with embedded delimiters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#setEscapedBy(char)">setEscapedBy</a></strong>(char e)</code> +<div class="block">Sets the escaped-by character.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#setFieldsTerminatedBy(char)">setFieldsTerminatedBy</a></strong>(char f)</code> +<div class="block">Sets the fields-terminated-by character.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/DelimiterSet.html#setLinesTerminatedBy(char)">setLinesTerminatedBy</a></strong>(char r)</code> +<div class="block">Sets the end-of-record lines-terminated-by character.</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/DelimiterSet.html#toString()">toString</a></strong>()</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>finalize, getClass, 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="NULL_CHAR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NULL_CHAR</h4> +<pre>public static final char NULL_CHAR</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.NULL_CHAR">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="OUTPUT_FIELD_DELIM_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OUTPUT_FIELD_DELIM_KEY</h4> +<pre>public static final java.lang.String OUTPUT_FIELD_DELIM_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.OUTPUT_FIELD_DELIM_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="OUTPUT_RECORD_DELIM_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OUTPUT_RECORD_DELIM_KEY</h4> +<pre>public static final java.lang.String OUTPUT_RECORD_DELIM_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.OUTPUT_RECORD_DELIM_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="OUTPUT_ENCLOSED_BY_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OUTPUT_ENCLOSED_BY_KEY</h4> +<pre>public static final java.lang.String OUTPUT_ENCLOSED_BY_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.OUTPUT_ENCLOSED_BY_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="OUTPUT_ESCAPED_BY_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OUTPUT_ESCAPED_BY_KEY</h4> +<pre>public static final java.lang.String OUTPUT_ESCAPED_BY_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.OUTPUT_ESCAPED_BY_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="OUTPUT_ENCLOSE_REQUIRED_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OUTPUT_ENCLOSE_REQUIRED_KEY</h4> +<pre>public static final java.lang.String OUTPUT_ENCLOSE_REQUIRED_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.OUTPUT_ENCLOSE_REQUIRED_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INPUT_FIELD_DELIM_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INPUT_FIELD_DELIM_KEY</h4> +<pre>public static final java.lang.String INPUT_FIELD_DELIM_KEY</pre> +<div class="block">Create the input variations for export instead of overloading them.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.INPUT_FIELD_DELIM_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INPUT_RECORD_DELIM_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INPUT_RECORD_DELIM_KEY</h4> +<pre>public static final java.lang.String INPUT_RECORD_DELIM_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.INPUT_RECORD_DELIM_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INPUT_ENCLOSED_BY_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INPUT_ENCLOSED_BY_KEY</h4> +<pre>public static final java.lang.String INPUT_ENCLOSED_BY_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.INPUT_ENCLOSED_BY_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INPUT_ESCAPED_BY_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INPUT_ESCAPED_BY_KEY</h4> +<pre>public static final java.lang.String INPUT_ESCAPED_BY_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.INPUT_ESCAPED_BY_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INPUT_ENCLOSE_REQUIRED_KEY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INPUT_ENCLOSE_REQUIRED_KEY</h4> +<pre>public static final java.lang.String INPUT_ENCLOSE_REQUIRED_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.sqoop.lib.DelimiterSet.INPUT_ENCLOSE_REQUIRED_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="DelimiterSet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DelimiterSet</h4> +<pre>public DelimiterSet()</pre> +<div class="block">Create a delimiter set with the default delimiters + (comma for fields, newline for records).</div> +</li> +</ul> +<a name="DelimiterSet(char, char, char, char, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DelimiterSet</h4> +<pre>public DelimiterSet(char field, + char record, + char enclose, + char escape, + boolean isEncloseRequired)</pre> +<div class="block">Create a delimiter set with the specified delimiters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the fields-terminated-by delimiter</dd><dd><code>record</code> - the lines-terminated-by delimiter</dd><dd><code>enclose</code> - the enclosed-by character</dd><dd><code>escape</code> - the escaped-by character</dd><dd><code>isEncloseRequired</code> - If true, enclosed-by is applied to all + fields. If false, only applied to fields that embed delimiters.</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="copy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copy</h4> +<pre>public <a href="../../../../org/apache/sqoop/lib/DelimiterSet.html" title="class in org.apache.sqoop.lib">DelimiterSet</a> copy()</pre> +<div class="block">Identical to clone() but does not throw spurious exceptions.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new copy of this same set of delimiters.</dd></dl> +</li> +</ul> +<a name="setFieldsTerminatedBy(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFieldsTerminatedBy</h4> +<pre>public void setFieldsTerminatedBy(char f)</pre> +<div class="block">Sets the fields-terminated-by character.</div> +</li> +</ul> +<a name="getFieldsTerminatedBy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFieldsTerminatedBy</h4> +<pre>public char getFieldsTerminatedBy()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the fields-terminated-by character.</dd></dl> +</li> +</ul> +<a name="setLinesTerminatedBy(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLinesTerminatedBy</h4> +<pre>public void setLinesTerminatedBy(char r)</pre> +<div class="block">Sets the end-of-record lines-terminated-by character.</div> +</li> +</ul> +<a name="getLinesTerminatedBy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLinesTerminatedBy</h4> +<pre>public char getLinesTerminatedBy()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the end-of-record (lines-terminated-by) character.</dd></dl> +</li> +</ul> +<a name="setEnclosedBy(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnclosedBy</h4> +<pre>public void setEnclosedBy(char e)</pre> +<div class="block">Sets the enclosed-by character.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the enclosed-by character, or '\000' for no enclosing character.</dd></dl> +</li> +</ul> +<a name="getEnclosedBy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnclosedBy</h4> +<pre>public char getEnclosedBy()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the enclosed-by character, or '\000' for none.</dd></dl> +</li> +</ul> +<a name="setEscapedBy(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEscapedBy</h4> +<pre>public void setEscapedBy(char e)</pre> +<div class="block">Sets the escaped-by character.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the escaped-by character, or '\000' for no escape character.</dd></dl> +</li> +</ul> +<a name="getEscapedBy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEscapedBy</h4> +<pre>public char getEscapedBy()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the escaped-by character, or '\000' for none.</dd></dl> +</li> +</ul> +<a name="setEncloseRequired(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEncloseRequired</h4> +<pre>public void setEncloseRequired(boolean required)</pre> +<div class="block">Set whether the enclosed-by character must be applied to all fields, + or only fields with embedded delimiters.</div> +</li> +</ul> +<a name="isEncloseRequired()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEncloseRequired</h4> +<pre>public boolean isEncloseRequired()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the enclosed-by character must be applied to all fields, + or false if it's only used for fields with embedded delimiters.</dd></dl> +</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="formatConstructor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>formatConstructor</h4> +<pre>public java.lang.String formatConstructor()</pre> +<div class="block">Format this set of delimiters as a call to the constructor for + this object, that would generate identical delimiters.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a String that can be embedded in generated code that + provides this set of delimiters.</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></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 other)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="clone()"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +</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/DelimiterSet.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/ClobRef.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/FieldFormatter.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/DelimiterSet.html" target="_top">Frames</a></li> +<li><a href="DelimiterSet.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/FieldFormatter.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/FieldFormatter.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/FieldFormatter.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,294 @@ +<!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:04 PDT 2014 --> +<title>FieldFormatter (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="FieldFormatter (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/FieldFormatter.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/DelimiterSet.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/FieldMappable.html" title="interface 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/FieldFormatter.html" target="_top">Frames</a></li> +<li><a href="FieldFormatter.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.sqoop.lib</div> +<h2 title="Class FieldFormatter" class="title">Class FieldFormatter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.sqoop.lib.FieldFormatter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">FieldFormatter</span> +extends java.lang.Object</pre> +<div class="block">Static helper class that will help format data with quotes and escape chars.</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="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.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/FieldFormatter.html#escapeAndEnclose(java.lang.String, com.cloudera.sqoop.lib.DelimiterSet)">escapeAndEnclose</a></strong>(java.lang.String str, + <a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a> delimiters)</code> +<div class="block">Takes an input string representing the value of a field, encloses it in + enclosing chars, and escapes any occurrences of such characters in the + middle.</div> +</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/FieldFormatter.html#hiveStringDropDelims(java.lang.String, com.cloudera.sqoop.lib.DelimiterSet)">hiveStringDropDelims</a></strong>(java.lang.String str, + <a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a> delimiters)</code> +<div class="block">This drops all default Hive delimiters from the string and passes it on.</div> +</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/FieldFormatter.html#hiveStringReplaceDelims(java.lang.String, java.lang.String, com.cloudera.sqoop.lib.DelimiterSet)">hiveStringReplaceDelims</a></strong>(java.lang.String str, + java.lang.String replacement, + <a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a> delimiters)</code> +<div class="block">replace hive delimiters with a user-defined string passed to the + --hive-delims-replacement option.</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, toString, wait, wait, wait</code></li> +</ul> +</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="hiveStringDropDelims(java.lang.String, com.cloudera.sqoop.lib.DelimiterSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hiveStringDropDelims</h4> +<pre>public static java.lang.String hiveStringDropDelims(java.lang.String str, + <a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a> delimiters)</pre> +<div class="block">This drops all default Hive delimiters from the string and passes it on. + + These delimiters are \n, \r and \01. This method is invoked when the + command line option <code>--hive-drop-delims</code> is provided.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - </dd><dd><code>delimiters</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd></dd></dl> +</li> +</ul> +<a name="hiveStringReplaceDelims(java.lang.String, java.lang.String, com.cloudera.sqoop.lib.DelimiterSet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hiveStringReplaceDelims</h4> +<pre>public static java.lang.String hiveStringReplaceDelims(java.lang.String str, + java.lang.String replacement, + <a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a> delimiters)</pre> +<div class="block">replace hive delimiters with a user-defined string passed to the + --hive-delims-replacement option.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - </dd><dd><code>delimiters</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd></dd></dl> +</li> +</ul> +<a name="escapeAndEnclose(java.lang.String, com.cloudera.sqoop.lib.DelimiterSet)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>escapeAndEnclose</h4> +<pre>public static java.lang.String escapeAndEnclose(java.lang.String str, + <a href="../../../../com/cloudera/sqoop/lib/DelimiterSet.html" title="class in com.cloudera.sqoop.lib">DelimiterSet</a> delimiters)</pre> +<div class="block">Takes an input string representing the value of a field, encloses it in + enclosing chars, and escapes any occurrences of such characters in the + middle. The escape character itself is also escaped if it appears in the + text of the field. If there is no enclosing character, then any + delimiters present in the field body are escaped instead. + + The field is enclosed only if: + enclose != '\000', and: + encloseRequired is true, or + one of the fields-terminated-by or lines-terminated-by characters is + present in the string. + + Escaping is not performed if the escape char is '\000'.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - - The user's string to escape and enclose</dd><dd><code>delimiters</code> - - The DelimiterSet to use identifying the escape and + enclose semantics. If the specified escape or enclose characters are + '\000', those operations are not performed.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the escaped, enclosed version of 'str'.</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/FieldFormatter.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/DelimiterSet.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/FieldMappable.html" title="interface 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/FieldFormatter.html" target="_top">Frames</a></li> +<li><a href="FieldFormatter.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 ======= --> +<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/FieldMapProcessor.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/FieldMapProcessor.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/FieldMapProcessor.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,224 @@ +<!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:04 PDT 2014 --> +<title>FieldMapProcessor (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="FieldMapProcessor (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/FieldMapProcessor.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/FieldMappable.html" title="interface in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.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/FieldMapProcessor.html" target="_top">Frames</a></li> +<li><a href="FieldMapProcessor.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.sqoop.lib</div> +<h2 title="Interface FieldMapProcessor" class="title">Interface FieldMapProcessor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/cloudera/sqoop/lib/FieldMapProcessor.html" title="interface in com.cloudera.sqoop.lib">FieldMapProcessor</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">FieldMapProcessor</span></pre> +<div class="block">Interface implemented by classes that process FieldMappable objects.</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="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/FieldMapProcessor.html#accept(com.cloudera.sqoop.lib.FieldMappable)">accept</a></strong>(<a href="../../../../com/cloudera/sqoop/lib/FieldMappable.html" title="interface in com.cloudera.sqoop.lib">FieldMappable</a> record)</code> +<div class="block">Allow arbitrary processing of a FieldMappable object.</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="accept(com.cloudera.sqoop.lib.FieldMappable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>accept</h4> +<pre>void accept(<a href="../../../../com/cloudera/sqoop/lib/FieldMappable.html" title="interface in com.cloudera.sqoop.lib">FieldMappable</a> record) + throws java.io.IOException, + <a href="../../../../com/cloudera/sqoop/lib/ProcessingException.html" title="class in com.cloudera.sqoop.lib">ProcessingException</a></pre> +<div class="block">Allow arbitrary processing of a FieldMappable object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>record</code> - an object which can emit a map of its field names to values.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if the processor encounters an IO error when + operating on this object.</dd> +<dd><code><a href="../../../../org/apache/sqoop/lib/ProcessingException.html" title="class in org.apache.sqoop.lib">ProcessingException</a></code> - if the FieldMapProcessor encounters + a general processing error when operating on this object.</dd> +<dd><code><a href="../../../../com/cloudera/sqoop/lib/ProcessingException.html" title="class in com.cloudera.sqoop.lib">ProcessingException</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FieldMapProcessor.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/FieldMappable.html" title="interface in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/JdbcWritableBridge.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/FieldMapProcessor.html" target="_top">Frames</a></li> +<li><a href="FieldMapProcessor.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 ======= --> +<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/FieldMappable.html ============================================================================== --- websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/FieldMappable.html (added) +++ websites/staging/sqoop/trunk/content/docs/1.4.5/api/org/apache/sqoop/lib/FieldMappable.html Wed Aug 13 01:44:09 2014 @@ -0,0 +1,222 @@ +<!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:04 PDT 2014 --> +<title>FieldMappable (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="FieldMappable (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/FieldMappable.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/FieldFormatter.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/FieldMapProcessor.html" title="interface 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/FieldMappable.html" target="_top">Frames</a></li> +<li><a href="FieldMappable.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.sqoop.lib</div> +<h2 title="Interface FieldMappable" class="title">Interface FieldMappable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/cloudera/sqoop/lib/FieldMappable.html" title="interface in com.cloudera.sqoop.lib">FieldMappable</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/sqoop/lib/SqoopRecord.html" title="class in org.apache.sqoop.lib">SqoopRecord</a>, <a href="../../../../com/cloudera/sqoop/lib/SqoopRecord.html" title="class in com.cloudera.sqoop.lib">SqoopRecord</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">FieldMappable</span></pre> +<div class="block">Interface describing a class capable of returning a map of the fields + of the object to their values.</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="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.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/sqoop/lib/FieldMappable.html#getFieldMap()">getFieldMap</a></strong>()</code> +<div class="block">Returns a map containing all fields of this record.</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="getFieldMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFieldMap</h4> +<pre>java.util.Map<java.lang.String,java.lang.Object> getFieldMap()</pre> +<div class="block">Returns a map containing all fields of this record.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a map from column names to the object-based values for + this record. The map may not be null, though it may be 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><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/FieldMappable.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/FieldFormatter.html" title="class in org.apache.sqoop.lib"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/sqoop/lib/FieldMapProcessor.html" title="interface 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/FieldMappable.html" target="_top">Frames</a></li> +<li><a href="FieldMappable.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 ======= --> +<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> +</body> +</html>
