Skip Headers

Oracle® XML Developer's Kit Programmer's Guide
10g Release 1 (10.1)

Part Number B10794-01
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Master Index
Master Index
Go to Feedback page

Go to previous page
Go to next page
View PDF


The Preface has the following sections:


This documentation introduces application developers to the XML Developer's Kit (XDK) and how the various language components of the XDK can work together to generate and store XML data in a database or in a document outside the database. Examples and sample applications are introduced where possible.

Other Documentation on XML

For more information about building XML-enabled database applications:

Examples and Sample Code

Many of the XDK examples in this documentation are provided with your software in the following directories:

XML Forum

Post any questions, comments, or bug reports to the XML Forum on the Oracle Technology Network at


Here is a brief summary of what you will find in each chapter:

Chapter 1, " Overview of XML Developer's Kit Components"

Introduces the XDK parts and utilities used with them.

Chapter 2, " Getting Started with XDK Java Components "

How to install the XDK Java components.

Chapter 3, " XML Parser for Java"

Describes the XML parser for Java features.

Chapter 4, " XSLT Processor for Java"

Describes the XSLT processor for Java.

Chapter 5, " XML Schema Processor for Java"

Describes the XML schema processor Java.

Chapter 6, " Using JAXB Class Generator"

Describes JAXB, which replaces the XML class generator for Java.

Chapter 7, " XML SQL Utility (XSU)"

Describes the XML SQL utility for Java.

Chapter 8, " XSQL Pages Publishing Framework"

Describes this Java capability.

Chapter 9, " Pipeline Definition Language for Java"

Describes the implementation of the Pipeline Definition Language for Java.

Chapter 10, " XDK JavaBeans"

Describes the JavaBeans available.

Chapter 11, " Using XDK and SOAP"

A brief introduction to SOAP and the XDK.

Chapter 12, " TransX Utility"

The TransX Utility simplifies the loading of translated seed data and messages into a database.

Chapter 13, " Getting Started with XDK C Components"

How to install the XDK C components.

Chapter 14, " XML Parser for C"

You are requested to use the new unified C API for new XDK applications. The old C functions are supported only for backward compatibility, but will not be enhanced. Describes the C XML parser features.

Chapter 15, " XSLT Processors for C"

Describes the XSLT processor for C features.

Chapter 16, " XML Schema Processor for C"

Describes the XML schema processor for C features.

Chapter 17, " Getting Started with XDK C++ Components "

How to install the XDK C++ components.

Chapter 18, " Unified C++ Interfaces"

The unified C++ API is described. The interfaces are listed.

Chapter 19, " XML Parser for C++"

Describes the XML parser for C++ interfaces.

Chapter 20, " XSLT Processor for C++"

Describes the XSLT processor for C++ interfaces.

Chapter 21, " XML Schema Processor for C++"

Describes the XML schema processor for C++ interfaces.

Chapter 22, " XPath Processor for C++"

Describes the XPath C++ interfaces.

Chapter 23, " XML Class Generator for C++"

Describes the XML class generator for C++ features.

Chapter 24, " XSU for PL/SQL"

XML SQL Utility (XSU) PL/SQL API reflects the Java API in the generation and storage of XML documents from and to a database.


Defines terms of interest to readers of this manual, and related XML manuals. If a term is used in this manual, a cross-reference to the definition is marked in bold.

Related Documentation

Many of the examples in this documentation use the sample schemas of the seed database, which can be installed when you install Oracle. Refer to Oracle Database Sample Schemas for information on how these schemas were created and how you can use them yourself.

Printed documentation is available for sale in the Oracle Store at:

To download free release notes, installation documentation, white papers, or other collateral, please visit the Oracle Technology Network (OTN). You must register online before using OTN; registration is free and can be done at:

If you already have a username and password for OTN, then you can go directly to the documentation section of the OTN Web site at


This section describes the conventions used in the text and in the code examples of this documentation.

Conventions in Text

We use various conventions in text to help you more quickly identify special terms. The following table describes those conventions and provides examples of their use.

Convention Meaning Example
Bold Bold typeface indicates terms that are defined in the text or terms that appear in a glossary, or both. When you specify this clause, you create an index-organized table.
Italics Italic typeface indicates book titles or emphasis. Oracle9i Concepts

Ensure that the recovery catalog and target database do not reside on the same disk.

UPPERCASE monospace (fixed-width font) Uppercase monospace typeface indicates elements supplied by the system. Such elements include parameters, privileges, datatypes, RMAN keywords, SQL keywords, SQL*Plus or utility commands, packages and methods, as well as system-supplied column names, database objects and structures, usernames, and roles. You can specify this clause only for a NUMBER column.

You can back up the database by using the BACKUP command.

Query the TABLE_NAME column in the USER_TABLES data dictionary view.


lowercase monospace (fixed-width font) Lowercase monospace typeface indicates executables, filenames, directory names, and sample user-supplied elements. Such elements include computer and database names, net service names, and connect identifiers, as well as user-supplied database objects and structures, column names, packages and classes, usernames and roles, program units, and parameter values.

Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown.

Enter sqlplus to open SQL*Plus.

The password is specified in the orapwd file.

Back up the data files and control files in the /disk1/oracle/dbs directory.

The department_id, department_name, and location_id columns are in the hr.departments table.

Set the QUERY_REWRITE_ENABLED initialization parameter to true.

Connect as oe user.

The JRepUtil class implements these methods.

lowercase monospace (fixed-width font) italic Lowercase monospace italic font represents placeholders or variables. You can specify the parallel_clause.

Run old_release.SQL where old_release refers to the release you installed prior to upgrading.

Conventions in Syntax and Code Examples

Syntax examples illustrate SQL, PL/SQL, SQL*Plus, or other command-line statements. They are displayed in a monospaced (fixed-width) font and separated from normal text as shown in this example:

SELECT username FROM dba_users WHERE username = 'MIGRATE';

The following table describes typographic conventions used in syntax examples and in code examples, and provides examples of their use.

Convention Meaning Example
[ ] In syntax examples, brackets enclose one or more optional items. Do not enter the brackets. DECIMAL (digits [ , precision ])
{ } In syntax examples, braces enclose two or more items, one of which is required. Do not enter the braces. {ENABLE | DISABLE}
In syntax examples, a vertical bar represents a choice of two or more options within brackets or braces. Enter one of the options. Do not enter the vertical bar. {ENABLE | DISABLE}


... Horizontal ellipsis points indicate either:
  • That we have omitted parts of the code that are not directly related to the example

  • Or, in syntax examples, that you can enter more arguments

CREATE TABLE ... AS subquery;

SELECT col1, col2, ... , coln FROM employees;




Vertical ellipsis points indicate that we have omitted several lines of code not directly related to the example.
9 rows selected.
Other notation You must enter symbols other than brackets, braces, vertical bars, and ellipsis points as shown. acctbal NUMBER(11,2);

acct CONSTANT NUMBER(4) := 3;

Italics Italicized text indicates placeholders or variables for which you must supply particular values. CONNECT SYSTEM/system_password

DB_NAME = database_name

UPPERCASE Uppercase typeface indicates elements supplied by the system. We show these terms in uppercase in order to distinguish them from terms you define. Unless terms appear in brackets, enter them in the order and with the spelling shown. However, because these terms are not case sensitive, you can enter them in lowercase. SELECT last_name, employee_id FROM employees;


DROP TABLE hr.employees;

lowercase Lowercase typeface indicates programmatic elements that you supply. For example, lowercase indicates names of tables, columns, or files.

Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown.

SELECT last_name, employee_id FROM employees;

sqlplus hr/hr


Conventions for Windows Operating Systems

This document describes the features of Oracle Database for Windows that apply to the Windows NT Server, Windows 2000, Windows XP, and Windows Server 2003 operating systems.

The following table describes conventions for Windows operating systems and provides examples of their use.

Convention Meaning Example
Choose Start > How to start a program. To start the Database Configuration Assistant, choose Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Database Configuration Assistant.
File and directory names File and directory names are not case sensitive. The following special characters are not allowed: left angle bracket (<), right angle bracket (>), colon (:), double quotation marks ("), slash (/), pipe (|), and dash (-). The special character backslash (\) is treated as an element separator, even when it appears in quotes. If the file name begins with \\, then Windows assumes it uses the Universal Naming Convention.
c:\winnt"\"system32 is the same as C:\WINNT\SYSTEM32
C:\> Represents the Windows command prompt of the current hard disk drive. The escape character in a command prompt is the caret (^). Your prompt reflects the subdirectory in which you are working. Referred to as the command prompt in this manual.
Special characters The backslash (\) special character is sometimes required as an escape character for the double quotation mark (") special character at the Windows command prompt. Parentheses and the single quotation mark (') do not require an escape character. Refer to your Windows operating system documentation for more information on escape and special characters.
C:\>exp scott/tiger TABLES=emp QUERY=\"WHERE job='SALESMAN' and sal<1600\"
C:\>imp SYSTEM/password FROMUSER=scott TABLES=(emp, dept)
Represents the Oracle home name. The home name can be up to 16 alphanumeric characters. The only special character allowed in the home name is the underscore.
C:\> net start OracleHOME_NAMETNSListener
ORACLE_HOME and ORACLE_BASE In releases prior to Oracle8i release 8.1.3, when you installed Oracle components, all subdirectories were located under a top level ORACLE_HOME directory. For Windows NT, the default location was C:\orant.

This release complies with Optimal Flexible Architecture (OFA) guidelines. All subdirectories are not under a top level ORACLE_HOME directory. There is a top level directory called ORACLE_BASE that by default is C:\oracle. If you install the latest Oracle release on a computer with no other Oracle software installed, then the default setting for the first Oracle home directory is C:\oracle\orann, where nn is the latest release number. The Oracle home directory is located directly under ORACLE_BASE.

All directory path examples in this guide follow OFA conventions.

Refer to Oracle Database Platform Guide for Windows for additional information about OFA compliances and for information about installing Oracle products in non-OFA compliant directories.

Go to the ORACLE_BASE\ORACLE_HOME\rdbms\admin directory.

Special Conventions

This guide uses special text formatting to draw the reader's attention to some information. A paragraph that is indented and begins with a bold text label may have special meaning. The following paragraphs describe the different types of information that are flagged this way.


The Note flag indicates that the reader should pay particular attention to the information to avoid a common problem or increase understanding of a concept.


An item marked Caution indicates something that you must be careful to do or not do in order for an application to work correctly.

See Also:

Text marked See Also points you to another section of this guide, or to other documentation, for additional information about the topic being discussed.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.