Skip Headers

Oracle® XML Developer's Kit Programmer's Guide 10g Release 2 (10.1.2) Part No. B14033-01 |
| Contents | Index

Previous | Next |

# Preface

This Preface contains these topics:

- Audience

- Documentation Accessibility

- Structure

- Related Documents

- Conventions

## Audience

Oracle XML Developer's Kit Programmer's Guide 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.

To use this document, you need familiarity with XML and a third-generation programming language such as Java, C, or C++.

## 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. Accessibility 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 more information, visit the Oracle Accessibility Program Web site at

`http://www.oracle.com/accessibility/`

Accessibility of Code Examples in Documentation

Screen readers 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, some screen readers 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.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

## Structure

This document contains:

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.

Glossary

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 Documents

For more information, see these Oracle resources:

- Oracle XML DB Developer's Guide

- Oracle XML API Reference

- Oracle XML Java API Reference

- Oracle Streams Advanced Queuing User's Guide and Reference

- `http://www.oracle.com/technology/tech/xml/`

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

- `$ORACLE_HOME/xdk/demo/java/`

- `$ORACLE_HOME/xdk/demo/c/`

- `$ORACLE_HOME/xdk/java/sample/`

- `$ORACLE_HOME/rdbms/demo`

Many of the examples in this book use the sample schemas, which are installed by default when you select the Basic Installation option with an Oracle Database installation. 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

    http://oraclestore.oracle.com/

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

    http://www.oracle.com/technology/membership/

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

    http://www.oracle.com/technology/documentation/

For additional information about XML, see:

- WROX publications, especially XML Design and Implementation by Paul Spencer, which covers XML, XSL, and development.

- Building Oracle XML Applications by Steve Muench, O'Reilly, `http://www.oreilly.com/catalog/orxmlapp/`

- The XML Bible, ```http://www.ibiblio.org/xml/books/biblegold/`

- Oracle Database 10g XML & SQL by the Oracle XML Product Development Team, `http://www.osborne.com/oracle/`

- XML, Java, and the Future of the Web by Jon Bosak, Sun Microsystems, `http://www.ibiblio.org/bosak/xml/why/xmlapps.htm`

- XML for the Absolute Beginner by Mark Johnson, JavaWorld, `http://www.javaworld.com/jw-04-1999/jw-04-xml_p.html`

- XML And Databases by Ronald Bourret, `http://www.rpbourret.com/xml/XMLAndDatabases.htm`

- XML Specifications by the World Wide Web Consortium (W3C), `http://www.w3.org/XML/`

- `XML.com`, a broad collection of XML resources and commentary, `http://www.xml.com/`

- Annotated XML Specification by Tim Bray, `XML.com`, `http://www.xml.com/axml/testaxml.htm`

- The XML FAQ by the W3C XML Special Interest Group (the industry clearing house for XML DTDs that allow companies to exchange XML data), `http://www.ucc.ie/xml/`

- `XML.org`, hosted by OASIS as a resource to developers of purpose-built XML languages, `http://xml.org/`

## Conventions

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

- Conventions in Text

- Conventions in Code Examples

- Conventions for Windows Operating Systems

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. | Oracle Database 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, Recovery Manager 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. Use the `DBMS_STATS`.`GENERATE_STATS` procedure.
`lowercase monospace (fixed-width) font` | Lowercase monospace typeface indicates executable programs, filenames, directory names, and sample user-supplied elements. Such elements include computer and database names, net service names and connect identifiers, 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 start SQL*Plus. The password is specified in the `orapwd` file. Back up the datafiles 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 italic monospace (fixed-width) font` | Lowercase italic monospace 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 Code Examples

Code examples illustrate SQL, PL/SQL, SQL*Plus, or other command-line statements. They are displayed in a monospace (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 code examples and provides examples of their use.

Convention | Meaning | Example
--- | --- | ---
    [ ]
| Anything enclosed in brackets is optional. |
    DECIMAL (digits [ , precision ])
    { }
| Braces are used for grouping items. |
    {ENABLE | DISABLE}
    |
| A vertical bar represents a choice of two options. |
    {ENABLE | DISABLE}
    [COMPRESS | NOCOMPRESS]
    ...
| Ellipsis points mean repetition in syntax descriptions. In addition, ellipsis points can mean an omission in code examples or text. |
    CREATE TABLE ... AS subquery;

    SELECT col1, col2, ... , coln FROM employees;
Other symbols | You must use symbols other than brackets ([ ]), braces ({ }), vertical bars (|), and ellipsis points (...) exactly 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. Because these terms are not case sensitive, you can use them in either UPPERCASE or lowercase. |
    SELECT last_name, employee_id FROM employees;
    SELECT * FROM USER_TABLES;
    DROP TABLE hr.employees;
    lowercase
| Lowercase typeface indicates user-defined programmatic elements, such as 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
    CREATE USER mjones IDENTIFIED BY ty3MU9;

Conventions for Windows Operating Systems

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

Convention | Meaning | Example
--- | --- | ---
Choose Start > menu item | 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 filename 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. |
    C:\oracle\oradata>
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 HR/HR TABLES=emp QUERY=\"WHERE job='REP'\"
    HOME_NAME
| 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. The default for Windows NT 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\product\10.1.0`. 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\product\10.1.0\db_``n`, where `n` is the latest Oracle home 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 Installation 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.