+DelimiterSet (Sqoop 1.4.0-incubating API) +

Added: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/DelimiterSet.html URL: http://svn.apache.org/viewvc/incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/DelimiterSet.html?rev=1211189&view=auto ============================================================================== --- incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/DelimiterSet.html (added) +++ incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/DelimiterSet.html Tue Dec 6 21:53:27 2011 @@ -0,0 +1,400 @@ + + + + + + +DelimiterSet (Sqoop 1.4.0-incubating API) + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +com.cloudera.sqoop.lib +
+Class DelimiterSet

+java.lang.Object
+  org.apache.sqoop.lib.DelimiterSet
+      com.cloudera.sqoop.lib.DelimiterSet
+

All Implemented Interfaces:: java.lang.Cloneable

+Deprecated. use org.apache.sqoop.lib.DelimiterSet instead. +

public class DelimiterSet
extends DelimiterSet
extends DelimiterSet

+ + +

+Encapsulates a set of delimiters used to encode a record. +

+ +

See Also:: DelimiterSet

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static DelimiterSet DEFAULT_DELIMITERS + +
+          Deprecated.
+static DelimiterSet HIVE_DELIMITERS + +
+          Deprecated.
+static DelimiterSet MYSQL_DELIMITERS + +
+          Deprecated.
+static char NULL_CHAR + +
+          Deprecated.
+ + + + + + + + + + + + + + +
+Constructor Summary
DelimiterSet() + +
+          Deprecated. Create a delimiter set with the default delimiters + (comma for fields, newline for records).
DelimiterSet(char field, + char record, + char enclose, + char escape, + boolean isEncloseRequired) + +
+          Deprecated. Create a delimiter set with the specified delimiters.
+ + + + + + + + + + + + +
+Method Summary
+ DelimiterSet copy() + +
+          Deprecated. Identical to clone() but does not throw spurious exceptions.
+ + + + + + + + +
Methods inherited from class org.apache.sqoop.lib.DelimiterSet
clone, equals, formatConstructor, getEnclosedBy, getEscapedBy, getFieldsTerminatedBy, getLinesTerminatedBy, hashCode, isEncloseRequired, setEnclosedBy< /A>, setEncloseRequired, setEscapedBy, setFieldsTerminatedBy, setLinesTerminatedBy, toString
+ + + + + + + + +
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
+ +

+Field Summary
+`static DelimiterSet`	`DEFAULT_DELIMITERS` + + + Deprecated.
+`static DelimiterSet`	`HIVE_DELIMITERS` + + + Deprecated.
+`static DelimiterSet`	`MYSQL_DELIMITERS` + + + Deprecated.
+`static char`	`NULL_CHAR` + + + Deprecated.

+Constructor Summary
`DelimiterSet()` + + + Deprecated. Create a delimiter set with the default delimiters + (comma for fields, newline for records).
`DelimiterSet(char field, + char record, + char enclose, + char escape, + boolean isEncloseRequired)` + + + Deprecated. Create a delimiter set with the specified delimiters.

+Method Summary
+ `DelimiterSet`	`copy()` + + + Deprecated. Identical to clone() but does not throw spurious exceptions.

Methods inherited from class org.apache.sqoop.lib.DelimiterSet
`clone, equals, formatConstructor, getEnclosedBy, getEscapedBy, getFieldsTerminatedBy, getLinesTerminatedBy, hashCode, isEncloseRequired, setEnclosedBy< /A>, setEncloseRequired, setEscapedBy, setFieldsTerminatedBy, setLinesTerminatedBy, toString`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

+ + + + + + + + +
+Field Detail
+ +

+NULL_CHAR

+public static final char NULL_CHAR

Deprecated.

See Also:: Constant Field Values

+ +

+DEFAULT_DELIMITERS

+public static final DelimiterSet DEFAULT_DELIMITERS

Deprecated.

+ +

+HIVE_DELIMITERS

+public static final DelimiterSet HIVE_DELIMITERS

Deprecated.

+ +

+MYSQL_DELIMITERS

+public static final DelimiterSet MYSQL_DELIMITERS

Deprecated.

+ +

+ + + + + + + + +

+Constructor Detail

+ +

+DelimiterSet

+public DelimiterSet()

Deprecated.

Create a delimiter set with the default delimiters + (comma for fields, newline for records). +

+ +

+DelimiterSet

+public DelimiterSet(char field,
+                    char record,
+                    char enclose,
+                    char escape,
+                    boolean isEncloseRequired)

Deprecated.

Create a delimiter set with the specified delimiters. +

Parameters:: field - the fields-terminated-by delimiter; record - the lines-terminated-by delimiter; enclose - the enclosed-by character; escape - the escaped-by character; isEncloseRequired - If true, enclosed-by is applied to all + fields. If false, only applied to fields that embed delimiters.

+ + + + + + + + +

+Method Detail

+ +

+copy

+public DelimiterSet copy()

Deprecated.

Identical to clone() but does not throw spurious exceptions. +

Overrides:: copy in class DelimiterSet

Returns:: a new copy of this same set of delimiters.

+ +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+Copyright © 2011 The Apache Software Foundation + + Propchange: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/DelimiterSet.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldFormatter.html URL: http://svn.apache.org/viewvc/incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldFormatter.html?rev=1211189&view=auto ============================================================================== --- incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldFormatter.html (added) +++ incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldFormatter.html Tue Dec 6 21:53:27 2011 @@ -0,0 +1,300 @@ + + + + + + +FieldFormatter (Sqoop 1.4.0-incubating API) + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +com.cloudera.sqoop.lib +
+Class FieldFormatter

+java.lang.Object
+  com.cloudera.sqoop.lib.FieldFormatter
+

+Deprecated. use org.apache.sqoop.lib.FieldFormatter instead. +

public final class FieldFormatter
extends java.lang.Object
extends java.lang.Object

+ + +

+Static helper class that will help format data with quotes and escape chars. +

+ +

See Also:: FieldFormatter

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static java.lang.String escapeAndEnclose(java.lang.String str, + DelimiterSet delimiters) + +
+          Deprecated. 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.
+static java.lang.String hiveStringDropDelims(java.lang.String str, + DelimiterSet delimiters) + +
+          Deprecated. only pass fields that are strings when --hive-drop-delims option is on.
+static java.lang.String hiveStringReplaceDelims(java.lang.String str, + java.lang.String replacement, + DelimiterSet delimiters) + +
+          Deprecated. replace hive delimiters with a user-defined string passed to the + --hive-delims-replacement option.
+ + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ +

+Method Summary
+`static java.lang.String`	`escapeAndEnclose(java.lang.String str, + DelimiterSet delimiters)` + + + Deprecated. 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.
+`static java.lang.String`	`hiveStringDropDelims(java.lang.String str, + DelimiterSet delimiters)` + + + Deprecated. only pass fields that are strings when --hive-drop-delims option is on.
+`static java.lang.String`	`hiveStringReplaceDelims(java.lang.String str, + java.lang.String replacement, + DelimiterSet delimiters)` + + + Deprecated. replace hive delimiters with a user-defined string passed to the + --hive-delims-replacement option.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

+ + + + + + + + +
+Method Detail
+ +

+hiveStringDropDelims

+public static java.lang.String hiveStringDropDelims(java.lang.String str,
+                                                    DelimiterSet delimiters)

Deprecated.

only pass fields that are strings when --hive-drop-delims option is on. +

Parameters:: str -; delimiters - +
Returns:

+ +

+hiveStringReplaceDelims

+public static java.lang.String hiveStringReplaceDelims(java.lang.String str,
+                                                       java.lang.String replacement,
+                                                       DelimiterSet delimiters)

Deprecated.

replace hive delimiters with a user-defined string passed to the + --hive-delims-replacement option. +

Parameters:: str -; delimiters - +
Returns:

+ +

+escapeAndEnclose

+public static java.lang.String escapeAndEnclose(java.lang.String str,
+                                                DelimiterSet delimiters)

Deprecated.

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'. +

Parameters:: str - - The user's string to escape and enclose; delimiters - - The DelimiterSet to use identifying the escape and + enclose semantics. If the specified escape or enclose characters are + '\000', those operations are not performed. +
Returns:: the escaped, enclosed version of 'str'.

+ +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+Copyright © 2011 The Apache Software Foundation + + Propchange: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldFormatter.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMapProcessor.html URL: http://svn.apache.org/viewvc/incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMapProcessor.html?rev=1211189&view=auto ============================================================================== --- incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMapProcessor.html (added) +++ incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMapProcessor.html Tue Dec 6 21:53:27 2011 @@ -0,0 +1,198 @@ + + + + + + +FieldMapProcessor (Sqoop 1.4.0-incubating API) + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +com.cloudera.sqoop.lib +
+Interface FieldMapProcessor

All Superinterfaces:: FieldMapProcessor

+Deprecated. use org.apache.sqoop.lib.FieldMapProcessor instead. +

public interface FieldMapProcessor
extends FieldMapProcessor
extends FieldMapProcessor

+ + +

+Interface implemented by classes that process FieldMappable objects. +

+ +

See Also:: FieldMapProcessor

+ +

+ + + + + + + + +
+Method Summary
+ + + + + + + + +
Methods inherited from interface org.apache.sqoop.lib.FieldMapProcessor
accept
+ +

Methods inherited from interface org.apache.sqoop.lib.FieldMapProcessor
`accept`

+ +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+Copyright © 2011 The Apache Software Foundation + + Propchange: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMapProcessor.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMappable.html URL: http://svn.apache.org/viewvc/incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMappable.html?rev=1211189&view=auto ============================================================================== --- incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMappable.html (added) +++ incubator/sqoop/site/src/site/resources/docs/1.4.0-incubating/api/com/cloudera/sqoop/lib/FieldMappable.html Tue Dec 6 21:53:27 2011 @@ -0,0 +1,199 @@ + + + + + + +FieldMappable (Sqoop 1.4.0-incubating API) + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +com.cloudera.sqoop.lib +
+Interface FieldMappable

All Superinterfaces:: FieldMappable

+Deprecated. use org.apache.sqoop.lib.FieldMappable instead. +

public interface FieldMappable
extends FieldMappable
extends FieldMappable

+ + +

+Interface describing a class capable of returning a map of the fields + of the object to their values. +

+ +

See Also:: FieldMappable

+ +

+ + + + + + + + +
+Method Summary
+ + + + + + + + +
Methods inherited from interface org.apache.sqoop.lib.FieldMappable
getFieldMap
+ +

Methods inherited from interface org.apache.sqoop.lib.FieldMappable
`getFieldMap`

+ +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +com.cloudera.sqoop.lib + +Class DelimiterSet

+NULL_CHAR

+DEFAULT_DELIMITERS

+HIVE_DELIMITERS

+MYSQL_DELIMITERS

+DelimiterSet

+DelimiterSet

+copy

+ +com.cloudera.sqoop.lib + +Class FieldFormatter

+hiveStringDropDelims

+hiveStringReplaceDelims

+escapeAndEnclose

+ +com.cloudera.sqoop.lib + +Interface FieldMapProcessor

+ +com.cloudera.sqoop.lib + +Interface FieldMappable

+ +com.cloudera.sqoop.lib +
+Class DelimiterSet

+ +com.cloudera.sqoop.lib +
+Class FieldFormatter

+ +com.cloudera.sqoop.lib +
+Interface FieldMapProcessor

+ +com.cloudera.sqoop.lib +
+Interface FieldMappable