Skip navigation links

oracle.odi.impexp
Class EncodingOptions

java.lang.Object
oracle.odi.impexp.EncodingOptions

public class EncodingOptions

extends java.lang.Object

This class is used to specify the encoding options when exporting ODI entities.

This represents 3 options:

• XML version
• JAVA Charset
• XML Charset

Default values are provided.

Since:

11.1.1.3.0

Field Summary

static java.lang.String	DEFAULT_JAVA_CHARSET Default value of Java character set used in export.
static java.lang.String	DEFAULT_XML_CHARSET Default value of XML character set used in export.
static java.lang.String	DEFAULT_XML_VERSION Default value of XML version.

Constructor Summary

EncodingOptions()
Construct a new EncodingOptions using the default values that could be overriden using bean-style configuration.

EncodingOptions(java.lang.String pXmlVersion, java.lang.String pJavaCharset, java.lang.String pXmlCharset)
Constructs a new EncodingOptions with the given parameters.

Method Summary

java.lang.String	getJavaCharset() Returns the Java character set defined in this EncodingOptions.
java.lang.String	getXmlCharset() Returns the XML character set defined in this EncodingOptions.
java.lang.String	getXmlVersion() Returns the XML version defined in this EncodingOptions.
void	setJavaCharset(java.lang.String pJavaCharset) Defines the Java character set used to export an ODI object.
void	setXmlCharset(java.lang.String pXmlCharset) Defines the XML character set used to export an ODI object.
void	setXmlVersion(java.lang.String pXmlVersion) Defines the XML version used to export an ODI object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_XML_CHARSET

public static final java.lang.String DEFAULT_XML_CHARSET

Default value of XML character set used in export. The value is "ISO-8859-1".

See Also:

Constant Field Values

DEFAULT_JAVA_CHARSET

public static final java.lang.String DEFAULT_JAVA_CHARSET

Default value of Java character set used in export. The value is "ISO8859_1".

See Also:

Constant Field Values

DEFAULT_XML_VERSION

public static final java.lang.String DEFAULT_XML_VERSION

Default value of XML version. The value is "1.0".

See Also:

Constant Field Values

Constructor Detail

EncodingOptions

public EncodingOptions()

Construct a new EncodingOptions using the default values that could be overriden using bean-style configuration.

EncodingOptions

public EncodingOptions(java.lang.String pXmlVersion,
                       java.lang.String pJavaCharset,
                       java.lang.String pXmlCharset)

Constructs a new EncodingOptions with the given parameters.

Parameters:

pXmlVersion - version of XML

pJavaCharset - a value for Java character set

pXmlCharset - a value for XML character set

Method Detail

getJavaCharset

public java.lang.String getJavaCharset()

Returns the Java character set defined in this EncodingOptions.

The XML file produced when exporting an ODI object will comply to this character set. See http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html for possible values (under the Canonical Name for java.io and java.lang API column).

Returns:

a String representing the java character set value

See Also:

setJavaCharset(String)

setJavaCharset

public void setJavaCharset(java.lang.String pJavaCharset)

Defines the Java character set used to export an ODI object. It can't be null. If not defined, the default value will be used.

The XML file produced when exporting an ODI object will comply to this character set. See http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html for possible values (under the Canonical Name for java.io and java.lang API column).

Parameters:

pJavaCharset - a value for Java character set

Throws:

java.lang.IllegalArgumentException - if the given parameters are null or empty

See Also:

getJavaCharset()

getXmlCharset

public java.lang.String getXmlCharset()

Returns the XML character set defined in this EncodingOptions.

The export XML file produced when exporting an ODI object will comply to this character set. You can see the full list of character encoding names registered by IANA (long). http://www.iana.org/assignments/character-sets.

In practice, a few encodings will be preferred, most likely: ISO-8859-1 (Latin-1), US-ASCII, UTF-16, the other encodings in the ISO-8859 series, iso-2022-jp, euc-kr, and so on.

Returns:

a String representing the XML character set value

See Also:

setXmlCharset(String)

setXmlCharset

public void setXmlCharset(java.lang.String pXmlCharset)

Defines the XML character set used to export an ODI object. It can't be null. If not defined, the default value will be used.

The export XML file produced when exporting an ODI object will comply to this character set. You can see the full list of character encoding names registered by IANA (long). http://www.iana.org/assignments/character-sets.

In practice, a few encodings will be preferred, most likely: ISO-8859-1 (Latin-1), US-ASCII, UTF-16, the other encodings in the ISO-8859 series, iso-2022-jp, euc-kr, and so on.

Parameters:

pXmlCharset - the XML character set

See Also:

getXmlCharset()

getXmlVersion

public java.lang.String getXmlVersion()

Returns the XML version defined in this EncodingOptions.

Returns:

a String representing the XML version value

See Also:

setXmlVersion(String)

setXmlVersion

public void setXmlVersion(java.lang.String pXmlVersion)

Defines the XML version used to export an ODI object. It can't be null. If not defined, the default value will be used.

The export XML file produced when exporting an ODI object will comply to this version.

Parameters:

pXmlVersion - the XML version

See Also:

getXmlVersion()

Skip navigation links