Contents

Title and Copyright Information

Preface

Audience

Documentation Accessibility

Related Documents

Conventions

What's New in the XDK?

Features Introduced in Oracle XML Developer's Kit 11g Release 1 (11.1)

Features Introduced in Oracle XDK 11g Release 2 (11.2)

Features Changed in Oracle XDK 11g Release 2 (11.2)

1 Introduction to Oracle XML Developer's Kit

Overview of Oracle XML Developer's Kit (XDK)

XDK Components

XML Parsers

XSLT Processors

XML Schema Processors

XML Class Generators

XML Pipeline Processor

XDK JavaBeans

Oracle XML SQL Utility (XSU)

Handling or Representing an XML Document

Using XSU with an XML Class Generator

TransX Utility

XSQL Pages Publishing Framework

Soap Services

XSLT Virtual Machine (XVM)

XML Document Generation with the XDK Components

XML Document Generation with Java

XML Document Generation with C

XML Document Generation with C++

Development Tools and Frameworks for the XDK

Oracle JDeveloper

User Interface XML (UIX)

Oracle Reports

Oracle XML Gateway

Oracle Data Provider for .NET

Installing the XDK

Part I XDK for Java

2 Unified Java API for XML

Overview of Unified Java API

Component Unification

Moving to the Unified Java API Model

Java DOM APIs for XMLType Classes

Extension APIs

Document Creation Java APIs

3 Getting Started with Java XDK Components

Installing Java XDK Components

Java XDK Component Dependencies

Setting Up the Java XDK Environment

Setting Java XDK Environment Variables for UNIX

Testing the Java XDK Environment on UNIX

Setting Java XDK Environment Variables for Windows

Testing the Java XDK Environment on Windows

Verifying the Java XDK Components Version

4 XML Parsing for Java

Introduction to the XML Parsing for Java

Prerequisites

Standards and Specifications

Large Node Handling

XML Parsing in Java

DOM in XML Parsing

DOM Creation

Scalable DOM

Pluggable DOM Support

Lazy Materialization

Configurable DOM Settings

SAX in the XML Parser

JAXP in the XML Parser

Namespace Support in the XML Parser

Validation in the XML Parser

Compression in the XML Parser

Using XML Parsing for Java: Overview

Using the XML Parser for Java: Basic Process

Running the XML Parser Demo Programs

Using the XML Parser Command-Line Utility

Parsing XML with DOM

Using the DOM API

DOM Parser Architecture

Performing Basic DOM Parsing

Useful Methods and Interfaces

Creating Scalable DOM

Using Pluggable DOM

Using Lazy Materialization

Using Configurable DOM Settings

Performance Advantages to Configurable DOM Settings

Scalable DOM Applications

Performing DOM Operations with Namespaces

Performing DOM Operations with Events

Performing DOM Operations with Ranges

Performing DOM Operations with TreeWalker

Parsing XML with SAX

Using the SAX API

Performing Basic SAX Parsing

Performing Basic SAX Parsing with Namespaces

Performing SAX Parsing with XMLTokenizer

Parsing XML with JAXP

Using the JAXP API

Using the SAX API Through JAXP

Using the DOM API Through JAXP

Transforming XML Through JAXP

Parsing with JAXP

Performing Basic Transformations with JAXP

Compressing XML

Compressing and Decompressing XML from DOM

Compressing a DOM Object

Decompressing a DOM Object

Compressing and Decompressing XML from SAX

Compressing a SAX Object

Decompressing a SAX Object

Tips and Techniques for Parsing XML

Extracting Node Values from a DOM Tree

Merging Documents with appendChild()

Parsing DTDs

Loading External DTDs

Caching DTDs with setDoctype

Handling Character Sets with the XML Parser

Detecting the Encoding of an XML File on the Operating System

Detecting the Encoding of XML Stored in an NCLOB Column

Writing an XML File in a Nondefault Encoding

Working with XML in Strings

Parsing XML Documents with Accented Characters

Handling Special Characters in Tag Names

5 Using Binary XML for Java

Introduction to Binary XML for Java

Binary XML Storage Format

Binary XML Processors

Models for Using Binary XML

Glossary for Binary XML

Standalone Model

Client-Server Model

Web Services Model with Repository

Web Services Model Without Repository

The Parts of Binary XML for Java

Binary XML Encoding

Binary XML Decoding

Binary XML Vocabulary Management

Schema Management

Schema Registration

Schema Identification

Schema Annotations

User-Level Annotations

System-Level Annotations

Token Management

Using Java Binary XML Package

Binary XML Encoder

Schema-less Option

Inline-token Option

Binary XML Decoder

Schema Registration

Resolving xsi:schemaLocation

Binary XML DB

Persistent Storage of Metadata

6 Using the XSLT Processor for Java

Introduction to the XSLT Processor

Prerequisites

Standards and Specifications

XML Transformation with XSLT 1.0 and 2.0

Using the XSLT Processor for Java: Overview

Using the XSLT Processor: Basic Process

Running the XSLT Processor Demo Programs

Using the XSLT Processor Command-Line Utility

Using the XSLT Processor Command-Line Utility: Example

Transforming XML

Performing Basic XSL Transformation

Obtaining DOM Results from an XSL Transformation

Programming with Oracle XSLT Extensions

Overview of Oracle XSLT Extensions

Specifying Namespaces for XSLT Extension Functions

Using Static and Non-Static Java Methods in XSLT

Using Constructor Extension Functions

Using Return Value Extension Functions

Tips and Techniques for Transforming XML

Merging XML Documents with XSLT

Creating an HTML Input Form Based on the Columns in a Table

7 Using the Schema Processor for Java

Introduction to XML Validation

Prerequisites

Standards and Specifications

XML Validation with DTDs

DTD Samples in the XDK

XML Validation with XML Schemas

XML Schema Samples in the XDK

Differences Between XML Schemas and DTDs

Using the XML Schema Processor: Overview

Using the XML Schema Processor: Basic Process

Running the XML Schema Processor Demo Programs

Using the XML Schema Processor Command-Line Utility

Using oraxml to Validate Against a Schema

Using oraxml to Validate Against a DTD

Validating XML with XML Schemas

Validating Against Internally Referenced XML Schemas

Validating Against Externally Referenced XML Schemas

Validating a Subsection of an XML Document

Validating XML from a SAX Stream

Validating XML from a DOM

Validating XML from Designed Types and Elements

Validating XML with the XSDValidator Bean

Tips and Techniques for Programming with XML Schemas

Overriding the Schema Location with an Entity Resolver

Converting DTDs to XML Schemas

8 Using the JAXB Class Generator

Introduction to the JAXB Class Generator

Prerequisites

Standards and Specifications

JAXB Class Generator Features

Marshalling and Unmarshalling with JAXB

Validation with JAXB

JAXB Customization

Using the JAXB Class Generator: Overview

Using the JAXB Processor: Basic Process

Running the XML Schema Processor Demo Programs

Using the JAXB Class Generator Command-Line Utility

Using the JAXB Class Generator Command-Line Utility: Example

JAXB Features Not Supported in the XDK

Processing XML with the JAXB Class Generator

Binding Complex Types

Defining the Schema

Generating and Compiling the Java Classes

Processing the XML Data

Customizing a Class Name in a Top-Level Element

Defining the Schema

Generating and Compiling the Java Classes

Processing the XML Data

9 Using the XML Pipeline Processor for Java

Introduction to the XML Pipeline Processor

Prerequisites

Standards and Specifications

Multistage XML Processing

Customized Pipeline Processes

Using the XML Pipeline Processor: Overview

Using the XML Pipeline Processor: Basic Process

Running the XML Pipeline Processor Demo Programs

Using the XML Pipeline Processor Command-Line Utility

Processing XML in a Pipeline

Creating a Pipeline Document

Example of a Pipeline Document

Writing a Pipeline Processor Application

Writing a Pipeline Error Handler

10 Using XDK JavaBeans

Introduction to XDK JavaBeans

Prerequisites

Standards and Specifications

XDK JavaBeans Features

DOMBuilder

XSLTransformer

DBAccess

XMLDBAccess

XMLDiff

XMLCompress

XSDValidator

Using the XDK JavaBeans: Overview

Using the XDK JavaBeans: Basic Process

Using the DOMBuilder JavaBean: Basic Process

Using the XSLTransformer JavaBean: Basic Process

Using the XMLDBAccess JavaBean: Basic Process

Using the XMLDiff JavaBean: Basic Process

Running the JavaBean Demo Programs

Running sample1

Running sample2

Running sample3

Running sample4

Running sample5

Running sample6

Running sample7

Running sample8

Running sample9

Running sample10

Processing XML with the XDK JavaBeans

Processing XML Asynchronously with the DOMBuilder and XSLTransformer Beans

Parsing the Input XSLT Stylesheet

Processing the XML Documents Asynchronously

Comparing XML Documents with the XMLDiff Bean

Comparing the XML Files and Generating a Stylesheet

11 Using the XML SQL Utility (XSU)

Introduction to the XML SQL Utility (XSU)

Prerequisites

XSU Features

XSU Restrictions

Using the XML SQL Utility: Overview

Using XSU: Basic Process

Generating XML with the XSU Java API: Basic Process

Performing DML with the XSU Java API: Basic Process

Generating XML with the XSU PL/SQL API: Basic Process

Performing DML with the PL/SQL API: Basic Process

Installing XSU

Installing XSU in the Database

Installing XSU in an Application Server

Installing XSU in a Web Server

Running the XSU Demo Programs

Using the XSU Command-Line Utility

Generating XML with the XSU Command-Line Utility

Generating XMLType Data with the XSU Command-Line Utility

Performing DML with the XSU Command-Line Utility

Programming with the XSU Java API

Generating a String with OracleXMLQuery

Running the testXMLSQL Program

Generating a DOM Tree with OracleXMLQuery

Paginating Results with OracleXMLQuery

Limiting the Number of Rows in the Result Set

Keeping the Object Open for the Duration of the User's Session

Paginating Results with OracleXMLQuery: Example

Generating Scrollable Result Sets

Generating XML from Cursor Objects

Inserting Rows with OracleXMLSave

Inserting XML into All Columns with OracleXMLSave

Inserting XML into a Subset of Columns with OracleXMLSave

Updating Rows with OracleXMLSave

Updating with Key Columns with OracleXMLSave

Updating a Column List with OracleXMLSave

Deleting Rows with OracleXMLSave

Deleting by Row with OracleXMLSave

Deleting by Key with OracleXMLSave

Handling XSU Java Exceptions

Obtaining the Parent Exception

Raising a No Rows Exception

Programming with the XSU PL/SQL API

Generating XML from Simple Queries with DBMS_XMLQuery

Specifying Element Names with DBMS_XMLQuery

Paginating Results with DBMS_XMLQuery

Setting Stylesheets in XSU

Binding Values in XSU

Inserting XML with DBMS_XMLSave

Inserting Values into All Columns with DBMS_XMLSave

Inserting into a Subset of Columns with DBMS_XMLSave

Updating with DBMS_XMLSave

Updating with Key Columns with DBMS_XMLSave

Specifying a List of Columns with DBMS_XMLSave: Example

Deleting with DBMS_XMLSave

Deleting by Row with DBMS_XMLSave: Example

Deleting by Key with DBMS_XMLSave: Example

Handling Exceptions in the XSU PL/SQL API

Reusing the Context Handle with DBMS_XMLSave

Tips and Techniques for Programming with XSU

How XSU Maps Between SQL and XML

Default SQL to XML Mapping

Default XML to SQL Mapping

Customizing Generated XML

How XSU Processes SQL Statements

How XSU Queries the Database

How XSU Inserts Rows

How XSU Updates Rows

How XSU Deletes Rows

How XSU Commits After DML

12 Using the TransX Utility

Introduction to the TransX Utility

Prerequisites

TransX UtilityFeatures

Simplified Multilingual Data Loading

Simplified Data Format Support and Interface

Additional TransX Utility Features

Using the TransX Utility: Overview

Using the TransX Utility: Basic Process

Running the TransX Utility Demo Programs

Using the TransX Command-Line Utility

TransX utility Command-Line Options

TransX Utility Command-Line Parameters

Loading Data with the TransX Utility

Storing Messages in the Database

Creating a Dataset in a Predefined Format

Format of the Input XML Document

Specifying Translations in a Dataset

Loading the Data

Querying the Data

13 Data Loading Format (DLF) Specification

Introduction to DLF

Naming Conventions for DLF

Elements and Attributes

Values

File Extensions

General Structure of DLF

Tree Structure of DLF

DLF Specifications

XML Declaration in DLF

Entity References in DLF

Elements in DLF

Top Level Table Element

Translation Elements

Lookup Key Elements

Metadata Elements

Data Elements

Attributes in DLF

DLF Attributes

XML Namespace Attributes

DLF Examples

Minimal DLF Document

Typical DLF Document

Localized DLF Document

DLF References

14 Using the XSQL Pages Publishing Framework

Introduction to the XSQL Pages Publishing Framework

Prerequisites

Using the XSQL Pages Publishing Framework: Overview

Using the XSQL Pages Framework: Basic Process

Setting Up the XSQL Pages Framework

Creating and Testing XSQL Pages with Oracle JDeveloper

Setting the CLASSPATH for XSQL Pages

Configuring the XSQL Servlet Container

Setting Up the Connection Definitions

Running the XSQL Pages Demo Programs

Setting Up the XSQL Demos

Running the XSQL Demos

Using the XSQL Pages Command-Line Utility

Generating and Transforming XML with XSQL Servlet

Composing XSQL Pages

Using Bind Parameters

Using Lexical Substitution Parameters

Providing Default Values for Bind and Substitution Parameters

How the XSQL Page Processor Handles Different Types of Parameters

Producing Datagrams from SQL Queries

Transforming XML Datagrams into an Alternative XML Format

Transforming XML Datagrams into HTML for Display

Using XSQL in Java Programs

XSQL Pages Tips and Techniques

XSQL Pages Limitations

Hints for Using the XSQL Servlet

Specifying a DTD While Transforming XSQL Output to a WML Document

Testing Conditions in XSQL Pages

Passing a Query Result to the WHERE Clause of Another Query

Handling Multi-Valued HTML Form Parameters

Invoking PL/SQL Wrapper Procedures to Generate XML Datagrams

Accessing Contents of Posted XML

Changing Database Connections Dynamically

Retrieving the Name of the Current XSQL Page

Resolving Common XSQL Connection Errors

Receiving "Unable to Connect" Errors

Receiving "No Posted Document to Process" When Using HTTP POST

Security Considerations for XSQL Pages

Installing Your XSQL Configuration File in a Safe Directory

Disabling Default Client Stylesheet Overrides

Protecting Against the Misuse of Substitution Parameters

15 Using the XSQL Pages Publishing Framework: Advanced Topics

Customizing the XSQL Configuration File Name

Controlling How Stylesheets Are Processed

Overriding Client Stylesheets

Controlling the Content Type of the Returned Document

Assigning the Stylesheet Dynamically

Processing XSLT Stylesheets in the Client

Providing Multiple Stylesheets

Working with Array-Valued Parameters

Supplying Values for Array-Valued Parameters

Setting Array-Valued Page or Session Parameters from Strings

Binding Array-Valued Parameters in SQL and PL/SQL Statements

Setting Error Parameters on Built-in Actions

Using Conditional Logic with Error Parameters

Formatting XSQL Action Handler Errors

Including XMLType Query Results in XSQL Pages

Handling Posted XML Content

Understanding XML Posting Options

Producing PDF Output with the FOP Serializer

Performing XSQL Customizations

Writing Custom XSQL Action Handlers

Implementing the XSQLActionHandler Interface

Using Multivalued Parameters in Custom XSQL Actions

Implementing Custom XSQL Serializers

Techniques for Using a Custom Serializer

Assigning a Short Name to a Custom Serializer

Using a Custom XSQL Connection Manager for JDBC Datasources

Writing Custom XSQL Connection Managers

Accessing Authentication Information in a Custom Connection Manager

Implementing a Custom XSQLErrorHandler

Providing a Custom XSQL Logger Implementation

Part II XDK for C

16 Getting Started with C XDK Components

Installing C XDK Components

Configuring the UNIX Environment for C XDK Components

C XDK Component Dependencies on UNIX

Setting C XDK Environment Variables on UNIX

Testing the C XDK Runtime Environment on UNIX

Setting Up and Testing the C XDK Compile-Time Environment on UNIX

Testing the C XDK Compile-Time Environment on UNIX

Verifying the C XDK Component Version on UNIX

Configuring the Windows Environment for C XDK Components

C XDK Component Dependencies on Windows

Setting C XDK Environment Variables on Windows

Testing the C XDK Runtime Environment on Windows

Setting Up and Testing the C XDK Compile-Time Environment on Windows

Testing the C XDK Compile-Time Environment on Windows

Using the C XDK Components with Visual C/C++ on Windows

Setting a Path for a Project in Visual C/C++ on Windows

Setting the Library Path in Visual C/C++ on Windows

Overview of the Unified C API

Globalization Support for the C XDK Components

17 Using the XSLT and XVM Processors for C

XVM Processor

XVM Usage Example

Using the XVM Processor Command-Line Utility

Accessing XVM Processor for C

XSLT Processor

XSLT Processor Usage Example

XPath Processor Usage Example

Using the C XSLT Processor Command-Line Utility

Accessing Oracle XSLT processor for C

Using the Demo Files Included with the Software

Building the C Demo Programs for XSLT

18 Using the XML Parser for C

Introduction to the XML Parser for C

Prerequisites

Standards and Specifications

Using the XML Parser for C

Overview of the Parser API for C

XML Parser for C Datatypes

XML Parser for C Defaults

XML Parser for C Calling Sequence

Using the XML Parser for C: Basic Process

Running the XML Parser for C Demo Programs

Using the C XML Parser Command-Line Utility

Using the XML Parser Command-Line Utility: Example

Using the DOM API for C

Controlling the Data Encoding of XML Documents for the C API

Using NULL-Terminated and Length-Encoded C API Functions

Handling Errors with the C API

Using orastream Functions

Using the SAX API for C

Using the XML Pull Parser for C

Using Basic XML Pull Parsing Capabilities

XML Event Context

About the XML Event Context

Parsing Multiple XML Documents

ID Callback

Error Handling for the XML Pull Parser

Parser Errors

Programming Errors

Sample Pull Parser Application

An XML Pull Parser Sample Application

Sample Document

Events Generated by XML Pull Parser Sample Application

Using OCI and the XDK C API

Using XMLType Functions and Descriptions

Initializing an XML Context for XML DB

Creating XMLType Instances on the Client

Operating on XML Data in the Database Server

Using OCI and the XDK C API: Examples

19 Using Binary XML for C

Introduction to Binary XML for C

Prerequisites

Binary XML Storage Format

20 Using the XML Schema Processor for C

Oracle XML Schema Processor for C

Oracle XML Schema for C Features

Standards Conformance

XML Schema Processor for C: Supplied Software

Using the C XML Schema Processor Command-Line Utility

XML Schema Processor for C Usage Diagram

How to Run XML Schema for C Sample Programs

What is the Streaming Validator?

Using Transparent Mode

Error Handling in Transparent Mode

Streaming Validator Example

Using Opaque Mode

Error Handling in Opaque Mode

Example of Opaque Mode Application

Enhancement of the Existing XmlSchemaLoad() Function

Validation Options

21 Determining XML Differences Using C

Overview of XMLDiff in C

Flow of Process for XMLDiff

Using XmlDiff

User Options for Optimization

User Option for Hashing

How XmlDiff Looks at Input Documents

Using the XmlDiff Command Line Utility

Sample Input Document

Sample Xdiff Instance Document

Output Model and XML Processing Instructions

Xdiff Operations

Format of Xdiff Instance Document

Xdiff Schema

Using XMLDiff in an Application

Customized Output

Using XmlPatch

Using the XmlPatch Command Line Utility

Using XmlPatch in an Application

Using XmlHash

Calling XmlDiff and XmlPatch

22 Using SOAP with the C XDK

Introduction to SOAP for C

SOAP Messaging Overview

SOAP Message Format

Using SOAP Clients

Using SOAP Servers

SOAP C Functions

SOAP Example 1: Sending an XML Document

SOAP Example 2: A Response Asking for Clarification

SOAP Example 3: Using POST

Part III Oracle XDK for C++

23 Getting Started with C++ XDK Components

Installing the C++ XDK Components

Configuring the UNIX Environment for C++ XDK Components

C++ XDK Component Dependencies on UNIX

Setting C++ XDK Environment Variables on UNIX

Testing the C++ XDK Runtime Environment on UNIX

Setting Up and Testing the C++ XDK Compile-Time Environment on UNIX

Testing the C++ XDK Compile-Time Environment on UNIX

Verifying the C++ XDK Component Version on UNIX

Configuring the Windows Environment for C++ XDK Components

C++ XDK Component Dependencies on Windows

Setting C++ XDK Environment Variables on Windows

Testing the C++ XDK Runtime Environment on Windows

Setting Up and Testing the C++ XDK Compile-Time Environment on Windows

Testing the C++ XDK Compile-Time Environment on Windows

Using the C++ XDK Components with Visual C/C++

24 Overview of the Unified C++ Interfaces

What is the Unified C++ API?

Accessing the C++ Interface

OracleXML Namespace

OracleXML Interfaces

Ctx Namespace

OracleXML Datatypes

Ctx Interfaces

IO Namespace

IO Datatypes

IO Interfaces

Tools Package

Tools Interfaces

Error Message Files

25 Using the XML Parser for C++

Introduction to Parser for C++

DOM Namespace

DOM Datatypes

DOM Interfaces

DOM Traversal and Range Datatypes

DOM Traversal and Range Interfaces

Parser Namespace

GParser Interface

DOMParser Interface

SAXParser Interface

SAX Event Handlers

Thread Safety

XML Parser for C++ Usage

XML Parser for C++ Default Behavior

C++ Sample Files

26 Using the XSLT Processor for C++

Accessing XSLT for C++

Xsl Namespace

Xsl Interfaces

XSLT for C++ DOM Interface Usage

Invoking XSLT for C++

Command Line Usage

Writing C++ Code to Use Supplied APIs

Using the Sample Files Included with the Software

27 Using the XML Schema Processor for C++

Oracle XML Schema Processor for C++

Oracle XML Schema for C++ Features

Online Documentation

Standards Conformance

XML Schema Processor API

Invoking XML Schema Processor for C++

Running the Provided XML Schema for C++ Sample Programs

28 Using the XPath Processor for C++

XPath Interfaces

Sample Programs

29 Using the XML Class Generator for C++

Accessing XML C++ Class Generator

Using XML C++ Class Generator

External DTD Parsing

Error Message Files

Using the XML C++ Class Generator Command-Line Utility

Input to the XML C++ Class Generator

Using the XML C++ Class Generator Examples

XML C++ Class Generator Example 1: XML — Input File to Class Generator, CG.xml

XML C++ Class Generator Example 2: DTD — Input File to Class Generator, CG.dtd

XML C++ Class Generator Example 3: CG Sample Program

Part IV Oracle XDK Reference

30 XSQL Pages Reference

XSQL Configuration File Parameters

<xsql:action>

<xsql:delete-request>

<xsql:dml>

<xsql:if-param>

<xsql:include-owa>

<xsql:include-param>

<xsql:include-posted-xml>

<xsql:include-request-params>

<xsql:include-xml>

<xsql:include-xsql>

<xsql:insert-param>

<xsql:insert-request>

<xsql:query>

<xsql:ref-cursor-function>

<xsql:set-cookie>

<xsql:set-page-param>

<xsql:set-session-param>

<xsql:set-stylesheet-param>

<xsql:update-request>

31 XDK Standards

XML Standards Supported by the XDK

Summary of XML Standards Supported by the XDK

XML Standards for the XDK for Java

DOM Standard for the XDK for Java

XSLT Standard for the XDK for Java

JAXB Standard for the XDK for Java

Pipeline Definition Language Standard for the XDK for Java

Character Sets Supported by the XDK

Character Sets Supported by the XDK for Java

Character Sets Supported by the XDK for C

A Oracle XDK for Java XML Error Messages

XML Error Messages

XML Parser Error Messages

XML-20003: missing token string at line string, column string

XML-20004: missing keyword string at line string, column string

XML-20005: missing keyword string or string at line string, column string

XML-20006: unexpected text at line string, column string; expected EOF

XML-20007: missing content model in element declaration at line string, column string

XML-20008: missing element name in content model at line string, column string

XML-20009: target name string of processing instruction at line string, column string is reserved

XML-20010: missing notation name in unparsed entity declaration at line string, column string

XML-20011: missing attribute type in attribute-list declaration at line string, column string

XML-20012: missing white space at line string, column string

XML-20013: invalid character string in entity value at line string, column string

XML-20014: -- not allowed in comment at line string, column string

XML-20015: ]]> not allowed in text at line string, column string

XML-20016: white space not allowed before occurrence indicator at line string, column string

XML-20017: occurrence indicator string not allowed in mixed-content at line string, column string

XML-20018: content list not allowed inside mixed-content at line string, column string

XML-20019: duplicate element string in mixed-content declaration at line string, column string

XML-20020: root element string does not match the DOCTYPE name string at line string, column string

XML-20021: duplicate element declaration string at line string, column string

XML-20022: element string has multiple ID attributes at line string, column string

XML-20023: ID attribute string in element string must be #IMPLIED or #REQUIRED at line string, column string

XML-20024: missing required attribute string in element string at line string, column string

XML-20025: duplicate ID value: string

XML-20026: undefined ID value string in IDREF

XML-20027: attribute string in element string has invalid enumeration value string at line string, column string

XML-20028: attribute string in element string has invalid value string, must be string at line string, column {5}

XML-20029: attribute default must be REQUIRED, IMPLIED, or FIXED at line string, column string

XML-20030: invalid text in content of element string at line string, column string

XML-20031: invalid element string in content of element string at line string, column string

XML-20032: incomplete content in element string at line string, column string

XML-20033: invalid replacement-text for entity string at line string, column string

XML-20034: end-element tag string does not match start-element tag string at line string, column string

XML-20035: duplicate attribute string in element string at line string, column string

XML-20036: invalid character string in attribute value at line string, column string

XML-20037: invalid reference to external entity string in attribute string at line string, column string

XML-20038: invalid reference to unparsed entity string in element string at line string, column string

XML-20039: invalid attribute type string in attribute-list declaration at line string, column string

XML-20040: invalid character string in element content at line string, column string

XML-20041: entity reference string refers to itself at line string, column string

XML-20042: invalid Nmtoken: string

XML-20043: invalid character string in public identifier at line string, column string

XML-20044: undeclared namespace prefix string used at line string, column string

XML-20045: attribute string in element string must be an unparsed entity at line string, column string

XML-20046: undeclared notation string used in unparsed entity string at line string, column string

XML-20047: missing element declaration string

XML-20048: duplicate entity declaration string at line string, column string

XML-20049: invalid use of NDATA in parameter entity declaration at line string, column string

XML-20050: duplicate attribute declaration string at line string, column string

XML-20051: duplicate notation declaration string at line string, column string

XML-20052: undeclared attribute string used at line string, column string

XML-20053: undeclared element string used at line string, column string

XML-20054: undeclared entity string used at line string, column string

XML-20055: invalid document returned by NodeFactory's createDocument

XML-20056: invalid SAX feature string

XML-20057: invalid value string passed for SAX feature string

XML-20058: invalid SAX property string

XML-20059: invalid value passed for SAX property string

XML-20060: Error occurred while opening URL string

XML-20061: invalid byte stream string in UTF8 encoded data

XML-20062: 5-byte UTF8 encoding not supported

XML-20063: 6-byte UTF8 encoding not supported

XML-20064: invalid XML character string

XML-20065: encoding string doesn't match encoding string in XML declaration

XML-20066: encoding string not supported

XML-20067: invalid InputSource returned by EntityResolver's resolveEntity

XML-20100: Expected string.

XML-20101: Expected string or string.

XML-20102: Expected string, string, or string.

XML-20103: Illegal token in content model.

XML-20104: Could not find element with ID string.

XML-20105: ENTITY type Attribute value string does not match any unparsed Entity.

XML-20106: Could not find Notation string.

XML-20107: Could not find declaration for element string.

XML-20108: Start of root element expected.

XML-20109: PI with the name 'xml' can occur only in the beginning of the document.

XML-20110: #PCDATA expected in mixed-content declaration.

XML-20111: Element string repeated in mixed-content declaration.

XML-20112: Error opening external DTD string.

XML-20113: Unable to open input source (string).

XML-20114: Bad conditional section start syntax, expected '['.

XML-20115: Expected ']]>' to end conditional section.

XML-20116: Entity string already defined, using the first definition.

XML-20117: NDATA not allowed in parameter entity declaration.

XML-20118: NDATA value required.

XML-20119: Entity Value should start with quote.

XML-20120: Entity value not well-formed.

XML-20121: End tag does not match start tag string.

XML-20122: '=' missing in attribute.

XML-20123: '>' Missing from end tag.

XML-20124: An attribute cannot appear more than once in the same start tag.

XML-20125: Attribute value should start with quote.

XML-20126: '<' cannot appear in attribute value.

XML-20127: Reference to an external entity not allowed in attribute value.

XML-20128: Reference to unparsed entity not allowed in element content.

XML-20129: Namespace prefix string used but not declared.

XML-20130: Root element name must match the DOCTYPE name.

XML-20131: Element string already declared.

XML-20132: Element cannot have more than one ID attribute.

XML-20133: Attr type missing.

XML-20134: ID attribute must be declared #IMPLIED or #REQUIRED.

XML-20135: Attribute string already defined, using the first definition.

XML-20136: Notation string already declared.

XML-20137: Attribute string used but not declared.

XML-20138: REQUIRED attribute string is not specified.

XML-20139: ID value string is not unique.

XML-20140: IDREF value string does not match any ID attribute value.

XML-20141: Attribute value string should be one of the declared enumerated values.

XML-20142: Unknown attribute type.

XML-20143: Unrecognized text at end of attribute value.

XML-20144: FIXED type Attribute value not equal to the default value string.

XML-20145: Unexpected text in content of Element string.

XML-20146: Unexpected text in content of Element string, expected elements string.

XML-20147: Invalid element string in content of string, expected closing tag.

XML-20148: Invalid element string in content of string, expected elements string.

XML-20149: Element string used but not declared.

XML-20150: Element string not complete, expected elements string.

XML-20151: Entity string used but not declared.

XML-20170: Invalid UTF8 encoding.

XML-20171: Invalid XML character(string).

XML-20172: 5-byte UTF8 encoding not supported.

XML-20173: 6-byte UTF8 encoding not supported.

XML-20180: User Supplied NodeFactory returned a Null Pointer.

XML-20190: Whitespace required.

XML-20191: '>' required to end DTD.

XML-20192: Unexpected text in DTD.

XML-20193: Unexpected EOF.

XML-20194: Unable to write to output stream.

XML-20195: Encoding not supported in PrintWriter.

XML-20200: Expected string instead of string.

XML-20201: Expected string instead of string.

XML-20202: Expected string to be string.

XML-20205: Expected string.

XML-20206: Expected string or string.

XML-20210: Unexpected string.

XML-20211: string is not allowed in string.

XML-20220: Invalid InputSource.

XML-20221: Invalid char in text.

XML-20230: Illegal change of encoding: from string to string.

XML-20231: Encoding string is not currently supported.

XML-20240: Unable to open InputSource.

XML-20241: Unable to open entity string.

XML-20242: Error opening external DTD string.

XML-20250: Missing entity string.

XML-20251: Cyclic Entity Reference in entity string.

XML-20280: Bad character (string).

XML-20281: NMToken must contain atleast one NMChar.

XML-20282: string not allowed in a PubIdLiteral.

XML-20284: Illegal white space before optional character in content model.

XML-20285: Illegal mixed content model.

XML-20286: Content list not allowed inside mixed content model.

XML-20287: Content particles not allowed inside mixed content model.

XML-20288: Invalid default declaration in attribute declaration.

XML-20500: SAX feature string not recognized.

XML-20501: SAX feature string not supported.

XML-20502: SAX property string not recognized.

XML-20503: SAX property string not supported.

DOM Error Messages

XML-21000: invalid size string specified

XML-21001: invalid index string specified; must be between 0 and string

XML-21002: cannot add an ancestor as a child node

XML-21003: node of type string cannot be added to node of type string

XML-21004: document node can have only one string node as child

XML-21005: node of type string cannot be added to attribute list

XML-21006: cannot add a node belonging to a different document

XML-21007: invalid character string in name

XML-21008: cannot set value for node of type string

XML-21009: cannot modify descendants of entity or entity reference nodes

XML-21010: cannot modify DTD's content

XML-21011: cannot remove attribute; not found in the current element

XML-21012: cannot remove or replace node; it is not a child of the current node

XML-21013: parameter string not recognized

XML-21014: value string of parameter string is not supported

XML-21015: cannot add attribute belonging to another element

XML-21016: invalid namespace string for prefix string

XML-21017: invalid qualified name: string

XML-21018: conflicting namespace declarations string and string for prefix string

XML-21019: string object is detached

XML-21020: bad boundary specified; cannot partially select a node of type string

XML-21021: node of type string does not support range operation string

XML-21022: invalid event type: string

XML-21023: prefix not allowed on nodes of type string

XML-21024: import not allowed on nodes of type string

XML-21025: rename not allowed on nodes of type string

XML-21026: Unrepresentable character in node: string

XML-21027: Namespace normalization error in node: string

XML-21997: function not supported on THICK DOM

XML-21998: system error occurred: string

XSL Transformation Error Messages

XML-22000: Error while parsing XSL file (string).

XML-22001: XSL Stylesheet does not belong to XSLT namespace.

XML-22002: Error while processing include XSL file (string).

XML-22003: Unable to write to output stream (string).

XML-22004: Error while parsing input XML document (string).

XML-22005: Error while reading input XML stream (string).

XML-22006: Error while reading input XML URL (string).

XML-22007: Error while reading input XML reader (string).

XML-22008: Namespace prefix string used but not declared.

XML-22009: Attribute string not found in string.

XML-22010: Element string not found in string.

XML-22011: Cannot construct XML PI with content: string.

XML-22012: Cannot construct XML comment with content: string.

XML-22013: Error in expression: string.

XML-22014: Expecting node-set before relative location path.

XML-22015: Function string not found.

XML-22016: Extension function namespace should start with string.

XML-22017: Literal expected in string function. Found string.

XML-22018: Parse Error in string function.

XML-22019: Expected string instead of string.

XML-22020: Error in extension function arguments.

XML-22021: Error parsing external document: string.

XML-22022: Error while testing predicates. Not a nodeset type.

XML-22023: Literal Mismatch.

XML-22024: Unknown multiply operator.

XML-22025: Expression error: Empty string.

XML-22026: Unknown expression at EOF: string.

XML-22027: Closing } not found in Attribute Value template.

XML-22028: Expression value type string not recognized by string.

XML-22029: Cannot transform child string in string.

XML-22030: Attribute value string not expected for string.

XML-22031: Variable not defined: string.

XML-22032: Found a single } outside expression in Attribute value template.

XML-22033: Token not recognized:!.

XML-22034: Namespace definition not found for prefix string.

XML-22035: Axis string not found

XML-22036: Cannot convert string to string.

XML-22037: Unsupported feature: string.

XML-22038: Expected Node-set in Path Expression.

XML-22039: Extension function error: Error invoking constructor for string

XML-22040: Extension function error: Overloaded constructors for string

XML-22041: Extension function error: Constructor not found for string

XML-22042: Extension function error: Overloaded method string

XML-22043: Extension function error: Method not found string

XML-22044: Extension function error: Error invoking string:string

XML-22045: Extension function error: Class not found string

XML-22046: Apply import cannot be called when current template is null.

XML-22047: Invalid instantiation of string in string context.

XML-22048: The string element children must precede all other element children of an string element.

XML-22049: Template string invoked but not defined.

XML-22050: Duplicate variable string definition.

XML-22051: only a literal or a reference to a variable or parameter is allowed in id() function when used as a pattern

XML-22052: no sort key named as: string was defined

XML-22053: cannot detect encoding in unparsed-text(), please specify

XML-22054: no such xsl:function with namespace: string and local name: string was defined

XML-22055: range expression can only accept xs:integer data type, but not string

XML-22056: exactly one of four group attributes must be present in xsl:for-each-group

XML-22057: string can only have string as children

XML-22058: wrong child of xsl:function

XML-22059: wrong child order of xsl:function

XML-22060: TERMINATE PROCESSING

XML-22061: teminate attribute in <xsl:message> can only be yes or no

XML-22062: string must have at least one string child

XML-22063: no definition for character-map with qname string

XML-22064: cannot define character-map with the same name string and the same import precedence

XML-22065: at least one string must be defined under string

XML-22066: if select attribute is present, string instructions sequence-constructor must be empty

XML-22067: if use attribute is present, string instructions sequence-constructor must be empty

XML-22068: only primary sort key is allowed to have the stable attribute.

XML-22069: only string or string is allowed.

XML-22101: DOMSource node as this type not supported.

XML-22103: DOMResult can not be this kind of node.

XML-22106: Invalid StreamSource - InputStream, Reader, and SystemId are null.

XML-22107: Invalid SAXSource - InputSource is null.

XML-22108: Invalid Source - URL format is incorrect.

XML-22109: Internal error while reporting SAX events.

XML-22110: Invalid StreamResult set in TransformerHandler.

XML-22111: Invalid Result set in TransformerHandler.

XML-22112: Namespace URI missing }.

XML-22113: Namespace URI should start with {.

XML-22117: URL format has problems (null or bad format or missing 'href' or missing '=').

XML-22121: Could not get associated stylesheet.

XML-22122: Invalid StreamResult - OutputStream, Writer, and SystemId are null.

XML-22900: An internal error condition occurred.

XPath Error Messages

XML-23002: internal xpath error

XML-23003: XPath 2.0 feature schema-element/schema-attribute not supported

XML-23006: value does not match required type

XML-23007: FOAR0001: division by zero

XML-23008: FOAR0002: numeric operation overflow/unflow

XML-23009: FOCA0001: Error in casting to decimal

XML-23010: FOCA0002: invalid lexical value

XML-23011: FOCA0003: input value too large for integer

XML-23012: FOCA0004: Error in casting to integer

XML-23013: FOCA0005: NaN supplied as float/double value

XML-23014: FOCH0001: invalid codepoint

XML-23015: FOCH0002: unsupported collation

XML-23016: FOCH0003: unsupported normalization form

XML-23017: FOCH0004: collation does not support collation units

XML-23018: FODC0001: no context document

XML-23019: FODC0002: Error retrieving resource

XML-23020: FODC0003: Error parsing contents of resource

XML-23021: FODC0004: invalid argument to fn:collection()

XML-23022: FODT0001: overflow in date/time arithmetic

XML-23023: FODT0002: overflow in duration arithmetic

XML-23024: FONC0001: undefined context item

XML-23025: FONS0002: default namespace is defined

XML-23026: FONS0003: no prefix defined for namespace

XML-23027: FONS0004: no namespace found for prefix

XML-23028: FONS0005: base URI not defined in the static context

XML-23029: FORG0001: invalid value for cast/constructor

XML-23030: FORG0002: invalid argument to fn:resolve-uri()

XML-23031: FORG0003: zero-or-one called with sequence containing more than one item

XML-23032: FORG0004: fn:one-or-more called with sequence containing no items

XML-23033: FORG0005: exactly-one called with sequence containing zero or more than one item

XML-23034: FORG0006: invalid argument type

XML-23035: FORG0007: invalid argument to aggregate function

XML-23036: FORG0008: both arguments to fn:dateTime have a specified timezone

XML-23037: FORG0009: base uri argument to fn:resolve-uri is not an absolute URI

XML-23038: FORX0001: invalid regular expression flags

XML-23039: FORX0002: invalid regular expression

XML-23040: FORX0003: regular expression matches zero-length string

XML-23041: FORX0004: invalid replacement string

XML-23042: FOTY0001: type error

XML-23043: FOTY0011: context item is not a node

XML-23044: FOTY0012: items not comparable

XML-23045: FOTY0013: type does not have equality defined

XML-23046: FOTY0014: type exception

XML-23047: FORT0001: invalid number of parameters

XML-23048: FOTY0002: type definition not found

XML-23049: FOTY0021: invalid node type

XML-23050: FOER0000: unidentified error

XML-23051: FODC0005: invalid argument to fn:doc

XML-23052: FODT0003: invalid timezone value

XML Schema Validation Error Messages

XML-24000: internal error

XML-24001: attribute string not expected at line string, column string

XML-24002: can not find element declaration string.

XML-24003: context-determined element declaration string absent.

XML-24004: declaration for element string absent.

XML-24005: element string not assessed

XML-24006: element string laxly assessed

XML-24007: missing attribute declaration stringin element string

XML-24008: type absent for attribute string

XML-24009: invalid attribute value string

XML-24010: attribute value string and fixed value string not match

XML-24011: type of element string is abstract.

XML-24012: no children allowed for element string with empty content type

XML-24013: element child string not allowed for simple content

XML-24014: characters string not allowed for element-only content

XML-24015: multiple ID attributes in element string at line string, column string

XML-24016: invalid string value string at line string, column string

XML-24017: invalid boolean value string at line string, column string

XML-24018: invalid decimal value string at line string, column string

XML-24019: invalid float value string at line string, column string

XML-24020: invalid double value string at line string, column string

XML-24021: invalid duration string at line string, column string

XML-24022: invalid date value string at line string, column string

XML-24023: invalid dateTime value string at line string, column string

XML-24024: invalid time value string at line string, column string

XML-24025: invalid gYearMonth value string at line string, column string

XML-24026: invalid gYear value string at line string, column string

XML-24027: invalid gMonthDay value string at line string, column string

XML-24028: invalid gDay value string at line string, column string

XML-24029: invalid gMonth value string at line string, column string

XML-24030: invalid hexBinary value string at line string, column string

XML-24031: invalid base64Binary value string at line string, column string

XML-24032: invalid anyURI value string at line string, column string

XML-24033: invalid QName value string at line string, column string

XML-24034: invalid NOTATION value string at line string, column string

XML-24035: invalid normalizedString value string at line string, column string

XML-24036: invalid token value string at line string, column string

XML-24037: invalid language value string at line string, column string

XML-24038: invalid NMTOKEN value string at line string, column string

XML-24039: invalid NMTOKENS value string at line string, column string

XML-24040: invalid Name value string at line string, column string

XML-24041: invalid NCName value string at line string, column string

XML-24042: invalid ID value string at line string, column string

XML-24043: invalid IDREF value string at line string, column string

XML-24044: invalid ENTITY value string at line string, column string

XML-24045: invalid ENTITIES value string at line string, column string

XML-24046: invalid integer value string at line string, column string

XML-24047: invalid nonPositiveInteger value string at line string, column string

XML-24048: invalid negativeInteger value string

XML-24049: invalid long value string at line string, column string

XML-24050: invalid int value string at line string, column string

XML-24051: invalid short value string at line string, column string

XML-24052: invalid byte value string at line string, column string

XML-24053: invalid nonNegativeInteger value string at line string, column string

XML-24054: invalid unsignedLong value string at line string, column string

XML-24055: invalid unsignedInt value string at line string, column string

XML-24056: invalid unsignedShort value string at line string, column string

XML-24057: invalid unsignedByte value string at line string, column string

XML-24058: value string must be valid with respect to one member type

XML-24059: element string not expected at line string, column string

XML-24060: element string abstract

XML-24061: element string not nillable

XML-24062: no character or element children allowed for nil content string

XML-24063: nil element does not satisfy fixed value constraint

XML-24064: xsi:type not a QName at line string, column string

XML-24065: xsi:type string not resolved to a type definition

XML-24066: local type string not validly derived from the type of element string

XML-24067: value string not in enumeration

XML-24068: invalid facet string for type string

XML-24069: too many fraction digits in value string at line string, column string

XML-24070: missing ID definition for ID reference string at line string, column string

XML-24071: duplicate ID string at line string, column string

XML-24072: duplicate key sequence string

XML-24073: target node set not equals to qualified node set for key string

XML-24074: element member string in key sequence is nillable

XML-24075: missing key sequence for key reference string

XML-24076: incorrect length of value string

XML-24077: value string greater than or equal to maxExclusive

XML-24078: value string greater than the maxInclusive

XML-24079: value length of string greater than maxLength

XML-24080: value string smaller or equals to minExclusive

XML-24081: value string smaller than minInclusive

XML-24082: value string shorter than minLength

XML-24083: wildcard particle in the content of element string not done

XML-24084: element particle string not done

XML-24085: model group string in the content of element string not done

XML-24086: invlid literal string with respect to pattern facet string

XML-24087: undefined type string

XML-24088: undeclared attribute string

XML-24089: undeclared element string

XML-24090: undefined attribute group string

XML-24091: undefined model group string

XML-24092: undeclared notation string

XML-24093: too many digits in value string at line string, column string

Schema Representation Constraint Error Messages

XML-24100: element string must belong to XML Schema namespace

XML-24101: can not build schema from location string

XML-24102: can not resolve schema by target namespace string

XML-24103: invalid annotation representation at line string, column string

XML-24104: multiple annotations at line string, column string

XML-24105: annotation must be the first element at line string, column string

XML-24106: attribute wildcard before attribute declaration at line string, column string

XML-24107: multiple attribute wildcard

XML-24108: default string and fixed string both present

XML-24109: default value string conflicts with attribute use stringXML-24109: default value string conflicts with attribute use string

XML-24110: missing name or ref attribute

XML-24111: both name and ref presented in attribute declaration

XML-24112: ref conflicits with form, type, or simpleType child

XML-24113: type attribute conflicts with simpleType child

XML-24114: intersecton of attribute wildcard is not expressible

XML-24115: circular attribute group reference string

XML-24116: circular group reference string

XML-24117: base type string for complexContent is not complex type

XML-24118: simple content required in base type string

XML-24119: properties specified with element reference string

XML-24120: simpleType and complexType can not both present in element declaration string

XML-24121: imported namespace string must different from namespace string

XML-24122: target namespace string required

XML-24123: namespace stringis different from expedted targetNamespace string

XML-24124: targetNamespace string not expected in schema

XML-24125: can not include schema fromstring

XML-24126: included targetNamespace string must the same as string

XML-24127: no-namespace schema can not include schema with target namespace string

XML-24128: itemType attribute conflicits with simpleType child

XML-24129: prefix of qname string can not be resolved

XML-24130: redefined schema has different namespace. line string column string

XML-24131: no-namespace schema can only redefine schema without targetNamespace

XML-24132: type derivation string must be restriction

XML-24132: type string must redefine itself at line string, column string

XML-24133: group string can have only one self reference in redefinition

XML-24134: self reference of group string must not have minOccurs or maxOccurs other than 1 in redefinition

XML-24135: redefined group stringis not a restriction of its orginal group

XML-24236: attribute group string can have only one self reference in redefinition

XML-24136: redefined attribute group string must be a restriction of its orginal group

XML-24137: restriction must not have both base and simpleType child

XML-24138: simple type restriction must have either base attribute or simpleType child

XML-24139: neitehr itemType or simpleType child present for list

XML-24140: itemType and simpleType child can not both be present in list type.

XML-24141: circular union type is disallowed

XML-24142: facet string can not be specified more than once

XML-24143: memberTypes and simpleType child can not both be absent in union

XML-24144: facets can only used for restriction

Schema Component Constraint Error Messages

XML-24201: duplicate attribute string declaration

XML-24202: more than one attributes with ID type not allowed

XML-24203: invalid value constraint string

XML-24204: value constraint string not allowed for ID type

XML-24205: fixed value string does not match string in attribute declaration

XML-24206: value constraint must be fixed to match that in attribute declaration

XML-24207: invalid xpath expression string

XML-24208: invalid field xpath string

XML-24209: maxOccurs in element string of All group must be 0 or 1

XML-24210: All group has to form a content type.

XML-24211: All group has to form a content type.

XML-24212: type string does not allow facet string

XML-24213: wildcard intersection is not exprssible

XML-24214: base type not allow string derivation

XML-24215: complex type string is not a derivation of type string

XML-24216: must specify a particle in extened content type

XML-24217: content type string conflicts with base type's content type string

XML-24218: inconsistent local element declarations string

XML-24219: element string is not valid substitutable for element string

XML-24220: itemType string can not be list

XML-24221: cricular union string not allowed

XML-24222: ambiguous particles string

XML-24223: invalid particle extension

XML-24224: invalid particle restriction

XML-24225: simple type string does not allowed restriction

XML-24226: invalid derivation from base type string

XML-24227: atomic type can not restrict list string

XML-24228: base type can not be ur-type in restriction

XML-24229: base type of list must be list or ur-type

XML-24230: base type of union must be union or ur-type

XML-24231: element default stringrequires mixed content to be emptiable

XML-24232: element default string requires mixed content or simple content

XML-24233: element default string must be valid to its content type

XML-24234: wrong field cardinality for keyref string

XML-24235: complex type can only extend simple type string

XML-24236: cricular type definition string

XML-24237: base type string must be complex type

XML-24238: attribute string not allowed in base type

XML-24239: required attribute string not in restriction

XML-24240: no correspoonding attribue wildcard in bas type string

XML-24241: base type string must have simple content or emptiable

XML-24242: base type string must have empty content or emptiable

XML-24243: enumeration facet required for NOTATION

XML-24244: invalid value string in enumeration

XML-24245: default value stringis element type invalid

XML-24246: invalid substitutionGroup string, type invalid

XML-24247: ID type does not allow value constraint string

XML-24248: fractionDigits stringgreater than totalDigits string

XML-24249: length facet can not be specified with minLength or maxLength

XML-24250: length string not the same as length in base type's

XML-24251: maxExclusive greater than its original

XML-24252: minInclusive greater than or equal to maxExclusive

XML-24253: maxLength is greater than that in base type

XML-24254: circular group stringdisallowed

XML-24256: minExclusive must be less than or equal to maxExclusive

XML-24257: minExclusive stringmust be less than maxInclusive

XML-24258: invalid minExclusive string

XML-24259: invalid minExclusive string

XML-24260: invalid minExclusive string

XML-24261: invalid minExclusive string

XML-24262: minInclusive string must not be greater than maxInclusive

XML-24263: Can not specify both minInclusive and minExclusive

XML-24264: invalid minInclusive string

XML-24265: invalid minInclusive string

XML-24267: invalid minInclusive string

XML-24268: invalid minInclusive string

XML-24269: invalid minLength string

XML-24270: invalid minLength string

XML-24271: can not declare xmlns attribute

XML-24272: no xsi for targetNamespace

XML-24272: minOccurs is greater than maxOccurs

XML-24281: maxOccurs must greater than or equal to 1

XML-24282: incorrect Notation properties

XML-24283: particle's range is not valid restriction

XML-24284: sequence group is not valid derivation of choice group

XML-24285: element string is not valid restriction of element string

XML-24286: element string is not valid restriction of wildcard

XML-24287: group is not valid restriction of wildcard

XML-24288: group any is not valid restriction

XML-24289: invalid restriction of all or sequence group

XML-24290: wildcard is not valid restriction

XML-24291: sequence is not a valid restriction of all

XML-24292: duplicate component definitions string

XML-24293: Incorrect simple type definition properties

XML-24294: wildcard is not a subset of its super

XML-24295: totalDigits stringis greater than string in base type

XML-24296: whiteSpace string can not restrict base type's string

XML-24297: circular substitution group string

XSQL Server Pages Error Messages

XML-25001: Cannot locate requested XSQL file. Check the name.

XML-25002: Cannot acquire database connection from pool: string

XML-25003: Failed to find config file string in CLASSPATH.

XML-25004: Could not acquire a database connection named: string

XML-25005: XSQL page is not well-formed.

XML-25006: XSLT stylesheet is not well-formed: string

XML-25007: Cannot acquire a database connection to process page.

XML-25008: Cannot find XSLT Stylesheet: string

XML-25009: Missing arguments on command line

XML-25010: Error creating: string\nUsing standard output.

XML-25011: Error processing XSLT stylesheet: string

XML-25012: Cannot Read XSQL Page

XML-25013: XSQL Page URI is null; check exact case of file name.

XML-25014: Resulting page is an empty document or had multiple document elements.

XML-25015: Error inserting XML Document

XML-25016: Error parsing posted XML Document

XML-25017: Unexpected Error Occurred

XML-25018: Unexpected Error Occurred processing stylesheet string

XML-25019: Unexpected Error Occurred reading stylesheet string

XML-25020: Config file string is not well-formed.

XML-25021: Serializer string is not defined in XSQL configuration file

XML-25022: Cannot load serializer class string

XML-25023: Class string is not an XSQL Serializer

XML-25024: Attempted to get response Writer after getting OutputStream

XML-25025: Attempted to get response OutputStream after getting Writer

XML-25026: Stylesheet URL references an untrusted server.

XML-25027: Failed to load string class for built-in xsql:string action.

XML-25028: Error reading string. Check case of the name.

XML-25029: Cannot load error handler class string

XML-25030: Class string is not an XSQL ErrorHandler

XML-25100: You must supply a string attribute.

XML-25101: Fatal error in Stylesheet Pool

XML-25102: Error instantiating class string

XML-25103: Unable to load class string

XML-25104: Class string is not an XSQLActionHandler

XML-25105: XML returned from PLSQL agent was not well-formed

XML-25106: Invalid URL string

XML-25107: Error loading URL string

XML-25108: XML Document string is not well-formed

XML-25109: XML Document returned from database is not well-formed

XML-25110: XML Document in parameter string is not well-formed

XML-25111: Problem including string

XML-25112: Error reading parameter value

XML-25113: Error loading XSL transform string

XML-25114: Parameter string has a null value

XML-25115: No posted document to process

XML-25116: No query statement supplied

XML-25117: No PL/SQL function name supplied

XML-25118: Stylesheet URL references an untrusted server.

XML-25119: You must supply either the string or string attribute.

XML-25120: You selected fewer than the expected string values.

XML-25121: Cannot use 'xpath' to set multiple parameters.

XML-25122: Query must be supplied to set multiple parameters

XML-25123: Error reading string. Check case of the name.

XML-25124: Error printing additional error information.

XML-25125: Only one of (string) attributes is allowed.

XML-25126: One of (string) attributes must be supplied.

XML Pipeline Error Messages

XML-30000: Error ignored in string: string

XML-30001: Error occurred in execution of Process

XML-30002: Only XML type(s) string allowed.

XML-30003: Error creating/writing to output string

XML-30004: Error creating base url string

XML-30005: Error reading input string

XML-30006: Error in processing pipedoc Error element

XML-30007: Error converting output to xml type required by dependent process

XML-30008: A valid parameter target is required

XML-30009: Error piping output to input

XML-30010: Process definition element string needs to be defined

XML-30011: ContentHandler not available

XML-30012: Pipeline components are not compatible

XML-30013: Process with output label string not found

XML-30014: Pipeline is not complete, missing output/outparam label called string

XML-30016: Unable to instantiate class

XML-30017: Target is up-to-date, pipeline not executed

Java API for XML Binding (JAXB) Error Messages

XML-32202: a problem was encountered because multiple <schemaBindings> were defined.

XML-32203: a problem was encountered because multiple <class> name annotations were defined on node string.

XML-32204: a problem was encountered because the name in <class> declaration contained a package name prefix string which was not allowed.

XML-32205: a problem was encountered because the property customization was not specified correctly on node string.

XML-32206: a problem was encountered because the javaType customization was not specified correctly on node string.

XML-32207: a problem was encountered in declaring the baseType customization on the node string.

XML-32208: a problem was encountered because multiple baseType customizations were declared on the node string.

XML-32209: a problem was encountered because multiple javaType customizations were declared on the node string.

XML-32210: a problem was encountered because invalid value was specified on customization of string.

XML-32211: a problem was encountered because incorrect <schemaBindings> customization was specified.

XML-32212: the <class> customization did not support specifiying the implementation class using implClass declaration. The implClass declaration specified on node string was ignored.

XML-32213: the <globalBindings> customization did not support specifiying user specific class that implements java.util.List. The collectionType declaration was ignored.

B Oracle XDK for Java TXU Error Messages

TXU Error Messages

General TXU Error Messages

TXU-0001: Fatal Error

TXU-0002: Error

TXU-0003: Warning

DLF Error Messages

TXU-0100: parameter string in query string not found

TXU-0101: incompatible attributes col and constant coexist at string in query string

TXU-0102: node string not found

TXU-0103: element string lacks content

TXU-0104: element string with SQL string lacks col or constant attribute

TXU-0105: SQL exception string while processing SQL string

TXU-0106: no data for column string selected by SQL string

TXU-0107: datatype string not supported

TXU-0108: missing maxsize attribute for column string

TXU-0109: a text length of string for string exceeds the allowed maximum of string

TXU-0110: undeclared column string in row string

TXU-0111: lacking column data for string in row string

TXU-0112: undeclared query parameter string for column string

TXU-0113: incompatible attribute string with a query on column string

TXU-0114: DLF parse error (string) on line string, character string in string

TXU-0115: The specified date string string has an invalid format

TransX Informational Messages

TXU-0200: duplicate row at string

TransX Error Messages

TXU-0300: document string not found

TXU-0301: file string could not be read

TXU-0302: archive string not found

TXU-0303: schema string not found in string

TXU-0304: archive path for string not found

TXU-0305: no database connection on string call for string

TXU-0306: null tablename given; access denied

TXU-0307: lookup-keys could not be determined string

TXU-0308: binary file string not found

TXU-0309: a file size of string exceeds the allowed maximum of 2,000 bytes

Assertion Messages

TXU-0400: missing SQL statement element on string

TXU-0401: missing node string

TXU-0402: invalid flag string

TXU-0403: internal error string

TXU-0404: unexpected Exception string

Usage Description Messages

TXU-0500: XML data transfer utility

TXU-0501: Parameters are as follows:

TXU-0502: JDBC connect string

TXU-0503: You can omit the connect string information through the '@' symbol.

TXU-0504: Then jdbc:oracle:thin:@ will be supplied.

TXU-0505: database username

TXU-0506: database password

TXU-0507: data file name or URL

TXU-0508: Options:

TXU-0509: update existing rows

TXU-0510: raise exception if a row is already existing

TXU-0511: print data in the predefined format

TXU-0512: save data in the predefined format

TXU-0513: print the XML to load

TXU-0514: print the tree for update

TXU-0515: omit validation

TXU-0516: validate the data format and exit without loading

TXU-0517: preserve whitespace

TXU-0518: Examples:

C Oracle XDK for Java XSU Error Messages

XSU Error Messages

Keywords and Syntax for Error Messages

XSUK-0001: DOCUMENT

XSUK-0002: ROWSET

XSUK-0003: ROW

XSUK-0004: ERROR

XSUK-0005: num

XSUK-0006: item

Generic Error Messages

XSUE-0000: Internal Error -- Exception Caught string

XSUE-0001: Internal Error -- string

XSUE-0002: string is not a scalar column. The row id attribute can only get values from scalar columns.

XSUE-0003: string is not a valid column name.

XSUE-0004: This object has been closed. If you would like the object not to be closed implicitly between calls, see the string method.

XSUE-0005: The row-set enclosing tag and the row enclosing tag are both omitted; consequently, the result can consist of at most one row which contains exactly one column which is not marked to be an XML attribute.

XSUE-0006: The row enclosing tag or the row-set enclosing tag is ommitted; consequently to get a well formed XML document, the result can only consist of a single row with multiple columns or multiple rows with exactly one column which is not marked to be an XML attribute.

XSUE-0007: Parsing of the sqlname failed -- invalid arguments.

XSUE-0008: Character string is not allowed in an XML tag name.

XSUE-0009: this method is not supported by string class. Please use string instead.

XSUE-0010: The number of bind names does not equal the number of bind values.

XSUE-0011: The number of bind values does not match the number of binds in the SQL statement.

XSUE-0012: Bind name identifier string does not exist in the sql query.

XSUE-0013: The bind identifier has to be of non-zero length.

XSUE-0014: Root node supplied is null.

XSUE-0015: Invalid LOB locator specified.

XSUE-0016: File string does not exit.

XSUE-0017: Can not create oracle.sql.STRUCT object of a type other than oracle.sql.STRUCT (i.e. ADT).

XSUE-0018: Null is not a valid DocumentHandler.

XSUE-0019: Null and empty string are not valid namespace aliases.

XSUE-0020: to use this method you will have to override it in your subclass.

XSUE-0021: You are using an old version of the gss library; thus, sql-xml name escaping is not supported.

XSUE-0022: cannot create XMLType object from opaque base type: string

Query Error Messages

XSUE-0100: Invalid context handle specified.

XSUE-0101: In the FIRST row of the resultset there is a nested cursor whose parent cursor is empty; when this condition occurs we are unable to generate a dtd.

XSUE-0102: string is not a valid IANA encoding.

XSUE-0103: The resultset is a "TYPE_FORWARD_ONLY" (non-scrollable); consequently, xsu can not reposition the read point. Furthermore, since the result set has been passed to the xsu by the caller, the xsu can not recreate the resultset.

XSUE-0104: input character is invalid for well-formed XML: string

DML Error Messages

XSUE-0200: The XML element tag string does not match the name of any of the columns/attributes of the target database object.

XSUE-0201: NULL is an invalid column name.

XSUE-0202: Column string, specified to be a key column, does not not exits in table string.

XSUE-0203: Column string, specified as column to be updated, does not exist in the table string.

XSUE-0204: Invalid REF element - string - attribute string missing.

XSUE-0206: Must specify key values before calling update routine. Use the string function.

XSUE-0207: UpdateXML: No columns to update. The XML document must contain some non-key columns to update.

XSUE-0208: The key column array must be non empty.

XSUE-0209: The key column array must be non empty.

XSUE-0210: No rows to modify -- the row enclosing tag missing. Specify the correct row enclosing tag.

XSUE-0211: string encountered during processing ROW element string in the XML document.

XSUE-0212: string XML rows were successfully processed.

XSUE-0213: All prior XML row changes were rolled back.

Pieces of Error Messages

XSUE-0300: Note

XSUE-0301: Exception string caught: string

XSUE-0302: column

XSUE-0303: name

XSUE-0303: invalid

XSUE-0304: xml document

XSUE-0305: template

Glossary

Index

Oracle® XML Developer's Kit

Programmer's Guide

11g Release 2 (11.2)

E23582-01

July 2011

Oracle XML Developer's Kit Programmer's Guide, 11g Release 2 (11.2)

E23582-01

Copyright © 2001, 2011, Oracle and/or its affiliates. All rights reserved.

Primary Authors: Drew Adams, Lance Ashdown, Janis Greenberg, Jack Melnick, Sue Pelski

Contributing Authors:  Steve Muench, Mark Scardina, Jinyu Wang

Contributors: Nipun Agarwal, Sivasankaran Chandrasekar, Dan Chiba, Steve Ding, Mark Drake, Bill Han, Bhushan Khaladkar, Roza Leyderman, Valarie Moore, Ravi Murthy, Anguel Novoselsky, Helen Slattery, Balu Sthanikam, Lu Sun, Asha Tarachandani, Tim Yu, Simon Wong, Kongyi Zhou

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Preface

This Preface contains these topics:

Audience

Documentation Accessibility

Related Documents

Conventions

Audience

Oracle XML Developer's Kit Programmer's Guide is intended for application developers interested in learning how the various language components of the Oracle XML Developer's Kit (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

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

For more information, see these Oracle resources:

Oracle XML DB Developer's Guide

Oracle Database XML C API Reference

Oracle Database XML C++ API Reference

Oracle Database XML Java API Reference

Oracle Database Advanced Queuing User's Guide

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.

For additional information about XML, see:

Oracle Database 10g XML & SQL: Design, Build, & Manage XML Applications in Java, C, C++, & PL/SQL by Mark Scardina, Ben Chang, and Jinyu Wang, Oracle Press, http://www.osborne.com/oracle/

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/

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

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

Conventions

The following text conventions are used in this document:

Convention | Meaning
boldface | Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.
italic | Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.
monospace | Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

What's New in the XDK?

The following sections describe features introduced or changed in this manual:

Features Introduced in Oracle XML Developer's Kit 11g Release 1 (11.1)

Features Introduced in Oracle XDK 11g Release 2 (11.2)

Features Changed in Oracle XDK 11g Release 2 (11.2)

Features Introduced in Oracle XML Developer's Kit 11g Release 1 (11.1)

DOM Stream access to XML nodes is done by PL/SQL and Java APIs. Nodes in an XML document can now exceed 64 KBytes by a large amount.

See Also:

"Large Node Handling"

The new XDK compact binary XML processors provide an encoder, a decoder, and a token manager to convert the schema or non-schema-based stream to and from XML 1.0 text and SAX events. The format is the same used in Oracle XML DB Developer's Guide.

See Also:

Chapter 5, "Using Binary XML for Java"

Binary XML adds a third storage model for persistent XML in the database: binary XML. Java and C APIs, and PL/SQL packages are affected. Binary XML support in the C API is used for both XML Developer's Kit and XML DB.

See Also:

Chapter 19, "Using Binary XML for C"

Support is now provided for a scalable, pluggable DOM in Java:

Scalable DOM support for Java includes lazy loading of DOM nodes, DOM updates of binary XML, multiple applications sharing the same DOM source, binary XML as output, and shadow copy in DOM.

Pluggable DOM splits the DOM implementation into two separate layers: DOM API layer and data layer. The data is either internal or plug-in, and are accessed through an implementation of the InfosetReader interface.

Configurable support for Java DOM is provided.

See Also:

"Scalable DOM"

The Unified Java API for XML allows mid-tier Java programs to leverage all the benefits of XMLType used with a session pool model of connection management. This allows XMLType object to be disconnected from the database session used to create it.

See Also:

Chapter 2, " Unified Java API for XML"

JAXP 1.3 support for XPath with extensions improves Java XSLT performance. Support is for static and dynamic context and users can register runtime context.

HTTP server for SOA is enabled. The database is capable of exposing PL/SQL packages, procedures, and functions as Web Services. The database is capable of executing dynamic XQuery and SQL queries.

See Also:

Chapter 22, "Using SOAP with the C XDK"

Chapters on SOAP for Java and C++ were removed.

XmlDiff for C detects the differences between two XML documents and represents the difference in XML. XmlPatch outputs the differences and applies the changes on the target XML document.

See Also:

Chapter 21, "Determining XML Differences Using C"

The JSR 170 standard is supported.

See Also:

"Standards and Specifications"

The C Pull Parser reduces memory overhead compared to the SAX model.

See Also:

"Using the XML Pull Parser for C"

Streaming Validator support for C improves XML processing.

See Also:

"What is the Streaming Validator?"

Document Updates For DLF/TransX is enhanced.

See Also:

Chapter 12, "Using the TransX Utility"

Chapter 13, "Data Loading Format (DLF) Specification"

Features Introduced in Oracle XDK 11g Release 2 (11.2)

The orastream functions in the XDK for C enable you to access large nodes.

See Also:

"Using orastream Functions"

Features Changed in Oracle XDK 11g Release 2 (11.2)

Oracle recommends discontinuing the use of the following features in new applications. These features are supported in the current release, but they may be deprecated in a future release. In particular:

Do not create an XMLIndex on the XML DB repository.

Do not use the XSQL feature with XML DB applications.

Do not use encoding types as specified in Chapter 5, "Using Binary XML for Java", in these sections:

Binary XML Vocabulary Management

Using Java Binary XML Package

For improved performance, consider using the PL/SQL packages DBMS_XMLGen and DBMS_XMLStore, which are written in C and built into the database, rather than the DBMS_XMLQuery and DBMS_XMLSave packages as specified in Chapter 11, Using XSU: Basic Process.

See Also:

Oracle XML DB Developer's Guide for more information about deprecated Oracle XML DB constructs

1 Introduction to Oracle XML Developer's Kit

This chapter contains the following topics:

Overview of Oracle XML Developer's Kit (XDK)

XDK Components

XML Document Generation with the XDK Components

Development Tools and Frameworks for the XDK

Installing the XDK

Overview of Oracle XML Developer's Kit (XDK)

Oracle Oracle XML Developer's Kit (XDK) is a versatile set of components that enables you to build and deploy C, C++, and Java software programs that process XML. You can assemble these components into an XML application that serves your business needs.

Note:

Customers using Oracle XDK with PL/SQL and migrating from Oracle Database Release 8.1 or 9.2 are strongly encouraged to use AL32UTF8 as the database character set. Otherwise, issues can arise during PL/SQL processing of XML data that contains escaped entities.

Oracle XDK provides the foundation for the Oracle XML solution. The XDK supports Oracle XML DB, which is a set of technologies used for storage and processing of XML in the database. You can use the XDK in conjunction with Oracle XML DB to build applications that run in Oracle Database. You can also use the XDK independently of XML DB.

XML Date Formatting

Dates and timestamps in generated XML are now in the formats specified by XML Schema. See Oracle Oracle XML DB Developer's Guide, Chapter "Generating XML Data from the Database", section "XMLELEMENT and XMLATTRIBUTES SQL Functions", subsection "Formatting of XML Dates and Timestamps".

The Oracle XDK is fully supported by Oracle and comes with a commercial redistribution license. The standard installation of Oracle Database includes the XDK.

Table 1-1 describes the XDK components, specifies which programming languages are supported, and directs you to sections that describe how to use the components.

Table 1-1 Overview of XDK Components

Component
Description
Lang.
Refer To

XML Parser

Creates and parses XML with industry standard DOM and SAX interfaces.

Java, C, C++

Chapter 4, "XML Parsing for Java"

Chapter 18, "Using the XML Parser for C"

Chapter 25, "Using the XML Parser for C++"

XML Compressor

Enables binary compression and decompression of XML documents. The compressor is built into the XML parser for Java.

Java

"Compressing XML"

Java API for XML Processing (JAXP)

Enables you to use SAX, DOM, XML Schema processor, XSLT processors, or alternative processors, from your Java program.

Java

"Parsing XML with JAXP"

XSLT Processor

Transforms XML into other text-based formats such as HTML.

Java, C, C++

Chapter 6, "Using the XSLT Processor for Java"

Chapter 17, "Using the XSLT and XVM Processors for C"

Chapter 26, "Using the XSLT Processor for C++"

XML Schema Processor

Validates schemas, allowing use of simple and complex XML datatypes.

Java, C, C++

Chapter 7, "Using the Schema Processor for Java"

Chapter 20, "Using the XML Schema Processor for C"

Chapter 27, "Using the XML Schema Processor for C++"

XML Class Generator

Generates Java or C++ classes from DTDs or XML schemas so that you can send XML data from Web forms or applications. The Java implementation supports Java Architecture for XML Binding (JAXB).

Java, C++

Chapter 8, "Using the JAXB Class Generator" and Chapter 29, "Using the XML Class Generator for C++"

XML Pipeline Processor

Applies XML processes specified in a declarative XML Pipeline document.

Java

Chapter 9, "Using the XML Pipeline Processor for Java"

XML JavaBeans

Provides a set of bean encapsulations of XDK components for ease of use of Integrated Development Environment (IDE), Java Server Pages (JSP), and applets.

Java

Chapter 10, "Using XDK JavaBeans"

XML SQL Utility (XSU)

Generates XML documents, DTDs, and Schemas from SQL queries. Maps any SQL query result to XML and vice versa. The XSU Java classes are mirrored by PL/SQL packages.

Java, PL/SQL

Chapter 11, "Using the XML SQL Utility (XSU)"

TransX Utility

Loads translated seed data and messages into the database using XML.

Java

Chapter 12, "Using the TransX Utility"

XSQL servlet

Combines XML, SQL, and XSLT in the server to deliver dynamic Web content.

Java

Chapter 14, "Using the XSQL Pages Publishing Framework"

Oracle SOAP Server

Provides a lightweight SOAP messaging protocol for sending and receiving requests and responses across the Internet.

C

Chapter 22, "Using SOAP with the C XDK"

XSLT Virtual Machine (XVM)

Provides a high-performance XSLT transformation engine that supports compiled stylesheets.

C, C++

"XVM Processor"

See Also:

Chapter 31, "XDK Standards" to learn about XDK support for XML-related standards

"XDK Components" for fuller descriptions of the components listed in Table 1-1

XDK Components

You can use the XDK components to perform various types of XML processing. For example, you can develop programs that do the following:

Parse XML

Validate XML against a DTD or XML schema

Transform an XML document into another XML document by applying an XSLT stylesheet

Generate Java and C++ classes from input XML schemas and DTDs

Figure 1-1 illustrates a hypothetical XML processor that performs the preceding tasks.

Figure 1-1 Sample XML Processor

Description of Figure 1-1 follows
Description of "Figure 1-1 Sample XML Processor"

The XDK contains components that you can use in your programs. This section describes the following XDK components, some of which are illustrated in Figure 1-1:

XML Parsers

XSLT Processors

XML Schema Processors

XML Class Generators

XSQL Pages Publishing Framework

XML Pipeline Processor

XDK JavaBeans

Oracle XML SQL Utility (XSU)

TransX Utility

Soap Services

XSLT Virtual Machine (XVM)

XML Parsers

An XML parser is a processor that reads an XML document and determines the structure and properties of the data. It breaks the data into parts and provides them to other components.

An XML processor can programmatically access the parsed XML data with the following APIs:

Use a SAX interface to serially access the data element by element. You can register event handlers with a SAX parser and invoke callback methods when certain events are encountered.Use DOM APIs to represent the XML document as an in-memory tree and manipulate or navigate it.

The XDK includes XML parsers for Java, C, and C++. Each parser includes support for both DOM and SAX APIs.

The XML parser for Java supports version 1.2 of JAXP, which is a standard API that enables use of DOM, SAX, XML Schema, and XSLT independently of a processor implementation. Thus, you can change the implementation of XML processors without impacting your programs.

The XML compressor is integrated into the XML parser for Java. It provides element-level XML compression and decompression with DOM and SAX interfaces. The compressor will compress XML documents without losing the structural and hierarchical information of the DOM tree. After parsing an XML document, you can serialize it with DOM or SAX to a binary stream and then reconstruct it later.

You can use the compressor to reduce the size of XML message payloads, thereby increasing throughput. When used within applications as the internal XML document access, it significantly reduces memory usage while maintaining fast access.

Figure 1-2 illustrates the functionality of the XDK parsers for Java, C, and C++.

Figure 1-2 The XML Parsers for Java, C, and C++

Description of Figure 1-2 follows
Description of "Figure 1-2 The XML Parsers for Java, C, and C++"

See Also:

Chapter 4, "XML Parsing for Java"

Chapter 18, "Using the XML Parser for C"

Chapter 25, "Using the XML Parser for C++"

XSLT Processors

eXtensible Stylesheet Language Transformation (XSLT) is a stylesheet language that enables processors to transform one XML document into another XML document. An XSLT document is a stylesheet that contains template rules that govern the transformation.

The Oracle XSLT processor fully supports the W3C XSL Transformations 1.0 recommendation. The processor also implements also implements the current working drafts of the XSLT and XPath 2.0 standards. It enables standards-based transformation of XML information inside and outside the database on any operating system.

The Oracle XML parsers include an integrated XSLT processor for transforming XML data by means of XSLT stylesheets. By using the XSLT processor, you can transform XML documents from XML to XML, to XHTML, or almost any other text format.

See Also:

"Using the XSLT Processor for Java: Overview".

Specifications and other information are found on the W3C site at http://www.w3.org/Style/XSL

XML Schema Processors

The XML Schema language was created by the W3C to describe the content and structure of XML documents in XML, thus improving on DTDs. An XML schema contains rules that define validity for an XML application. Unlike a DTD, an XML schema is itself written in XML. One of the principal advantages of an XML schema over a DTD is that a schema can specify rules for the content of elements and attributes. An XML schema specifies a set of built-in datatypes, for example, string, float, and date. Users can derive their own datatypes from the built-in datatypes. For example, the schema can restrict dates to those after the year 2000 or specify a list of legal values.

The Oracle XDK includes an XML Schema processor for Java, C, and C++.

See Also:

Chapter 7, "Using the Schema Processor for Java"

Chapter 20, "Using the XML Schema Processor for C"

Chapter 27, "Using the XML Schema Processor for C++"

XML Class Generators

An XML class generator is a software program that accepts a parsed XML schema or DTD as input and generates Java or C++ source class files as output. The XDK includes both the JAXB class generator and the C++ class generator.JAXB is a Java API and set of tools that map to and from XML data and Java objects. Because JAXB presents an XML document to a Java program in a Java format, you can write programs that process XML data without having to use a SAX parser or write callback methods. Each object derives from an instance of the schema component in the input document. JAXB does not directly support DTDs, but you can convert a DTD to an XML schema that is usable by JAXB. The XML class generator for C++ supports both DTDs and XML Schemas.

As an example of how to use JAXB, you can write a Java program that uses generated Java classes to build XML documents gradually. Suppose that you write an XML schema for use by a human resources department and a Java program that responds to users who change their personal data. The program can use JAXB to construct an XML confirmation document in a piecemeal fashion, which an XSLT processor can transform into XHTML and deliver to a browser.

Figure 1-3 Oracle JAXB Class Generator

Description of Figure 1-3 follows
Description of "Figure 1-3 Oracle JAXB Class Generator"

See Also:

Chapter 8, "Using the JAXB Class Generator"

Chapter 29, "Using the XML Class Generator for C++"

XML Pipeline Processor

The XML Pipeline Definition Language is an XML vocabulary for describing the processing relationships between XML resources. A document that is an instance of the pipeline language, that is, that defines the relationship between processes, is a pipeline document. For example, the document can specify that the program should first validate an input XML document and then, if it is valid, transform it.

Oracle XML Pipeline processor conforms to the XML Pipeline Definition Language 1.0 standard. The processor can take an input XML pipeline document and execute the pipeline processes according to the derived dependencies. The pipeline processor helps Java developers by replacing custom Java code with a simple declarative XML syntax for building XML processing applications.

See Also:

Chapter 9, "Using the XML Pipeline Processor for Java"

XDK JavaBeans

JavaBeans is a Java API for developing reusable software components that can be manipulated visually in a builder tool. A JavaBean is a Java object that conforms to this API. The Oracle XDK JavaBeans are a collection of visual and non-visual beans that are useful in a variety of XML-enabled Java programs or applets. Table 1-2 summarizes the XDK JavaBeans.

Table 1-2 Summary of XDK JavaBeans

JavaBean
Description

DOMBuilder

Builds a DOM Tree from an XML document. This bean is nonvisual.

XSLTransformer

Accepts an XML file, applies the transformation specified by an input XSLT stylesheet and creates the resulting output file. This bean is nonvisual.

DBAccess

Maintains CLOB tables that contain multiple XML and text documents.

XMLDBAccess

Extends the DBAccess bean to support the XMLType column, in which XML documents are stored in an Oracle Database table.

XMLDiff

Compares two XML DOM trees.

XMLCompress

Encapsulates the XML compression functionality.

XSDValidator

Encapsulates the oracle.xml.parser.schema.XSDValidator class and adds capabilities for validating a DOM tree.

See Also:

Chapter 10, "Using XDK JavaBeans"

Oracle XML SQL Utility (XSU)

XSU is a set of Java class libraries that you can use to perform the following tasks:

Automatically and dynamically render the results of arbitrary SQL queries into canonical XML. XSU supports queries over richly-structured, user-defined object types and object views, including XMLType. When XSU transforms relational data into XML, the resulting XML document has the following structure:

Columns are mapped to top-level elements.

Scalar values are mapped to elements with text-only content.

Object types are mapped to elements with attributes appearing as sub-elements.

Collections are mapped to lists of elements.

Load data from an XML document into an existing database schema or view.

Note:

XSU also has a PL/SQL implementation. The DBMS_XMLQuery and DBMS_XMLSave PL/SQL packages reflect the functions in the OracleXMLQuery and OracleXMLSave Java classes.

Figure 1-4 illustrates how XSU processes SQL queries and returns the results as an XML document.

Figure 1-4 XSU Processes SQL Queries and Returns the Result as XML

Description of Figure 1-4 follows
Description of "Figure 1-4 XSU Processes SQL Queries and Returns the Result as XML"

Handling or Representing an XML Document

XSU can generate an XML document in any of the following ways:

A string representation of the XML document. Use this representation if you are returning the XML document to a requester. An in-memory DOM tree. Use this representation if you are operating on the XML programmatically, for example, transforming it with the XSLT processor by using DOM methods to search or modify the XML. A series of SAX events. You can use this functionality when retrieving XML, especially large documents or result sets.

Using XSU with an XML Class Generator

You can use XSU to generate an XML schema based on the relational schema of the underlying table or view that you are querying. You can use the generated XML schema as input to the JAXB class generator the C++ class generator. You can then write code that uses the generated classes to create the infrastructure behind a Web-based form. Based on this infrastructure, the form can capture user data and create an XML document compatible with the database schema. A program can write the XML directly to the corresponding table or object view without further processing.

See Also:

Chapter 11, "Using the XML SQL Utility (XSU)"

TransX Utility

The Oracle TransX utility is a data transfer utility that enables you to populate a database with multilingual XML data. It uses a simple data format that is intuitive for both developers and translators and uses a validation capability that is less error-prone than previous techniques.How is the TransX utility different from XSU? TransX utility is an application of XSU that loads translated seed data and messages into a database schema. If you have data to be populated into a database in multiple languages, then the utility provides the functionality that you would otherwise need to develop with XSU.

See Also:

Chapter 12, "Using the TransX Utility"

XSQL Pages Publishing Framework

The XSQL pages publishing framework (XSQL servlet) is a server component that processes an XSQL file, which is an XML file with a specific structure and grammar, and produces dynamic XML documents from one or more SQL queries of data objects. Figure 1-5 shows you can invoke the XSQL servlet.

Figure 1-5 XSQL Pages Publishing Framework

This graphic is described in the surrounding text.
Description of "Figure 1-5 XSQL Pages Publishing Framework"

The XSQL servlet uses the Oracle XML parser to process the XSQL file, passing XSLT processing statements to its internal processor while passing parameters and SQL statements between the tags to XSU. Results from those queries are received as XML-formatted text or a JDBC ResultSet object. If necessary, you can further transform the query results by using the built-in XSLT processor.

One example of an XSQL servlet is a page that contains a query of flight schedules for an airline with a bind variable for the airport name. The user can pass an airport name as a parameter in a web form. The servlet binds the parameter value in its database query and transforms the output XML into HTML for display in a browser.

See Also:

Chapter 14, "Using the XSQL Pages Publishing Framework"

Soap Services

Simple Object Access Protocol (SOAP) is a platform-independent messaging protocol that enables programs to access services, objects, and servers. Oracle SOAP Services is published and executed through the Web and provides the standard XML message format for all programs. With SOAP Services, you can use the XDK to develop messaging, RPC, and Web service programs with XML standards.

See Also:

Chapter 22, "Using SOAP with the C XDK"

XSLT Virtual Machine (XVM)

The XVM for C/C++ is the software implementation of a CPU designed to run compiled XSLT code. To run this code, you need to compile XSLT stylesheets into byte code that the XVM engine understands. Figure 1-6 illustrates how the XVM processes XML and XSL.

Figure 1-6 XSLT Virtual Machine

This graphic is described in the surrounding text.
Description of "Figure 1-6 XSLT Virtual Machine"

The XDK includes an XSLT compiler that is compliant with the XSLT 1.0 standard. The compilation can occur at runtime or be stored for runtime retrieval. Applications perform transformations more quickly with higher throughput because the stylesheet does not need to be parsed and the templates are applied based on an index lookup instead of an XML operation.

See Also:

"XVM Processor"

XML Document Generation with the XDK Components

The XDK enables you to map the structure of an XML document to a relational schema. You can use the XDK to establish a two-way path to an Oracle database in which your program creates XML documents from tables and inserts XML-tagged data into tables. Each XDK programming language supports the development of programs that generate XML documents from relational data.

This section contains the following topics:

XML Document Generation with Java

XML Document Generation with C

XML Document Generation with C++

XML Document Generation with Java

As shown in Figure 1-7, you can execute a SQL query against the database in three different ways. Table 1-3 describes the alternatives.

Table 1-3 Generating XML in Java

Technology
Label in Figure 1-7
Description

XSQL Servlet

A

Includes XSU and the XML parser

XSU

B

Includes XML parser

JDBC

C

Sends output data to the XML parser

Figure 1-7 Sample XML Processor Built with Java XDK Components

Description of Figure 1-7 follows
Description of "Figure 1-7 Sample XML Processor Built with Java XDK Components"

Regardless of how your software program generates the XML from the database, Figure 1-7 illustrates possible further processing that your program can perform on the XML document. Table 1-4 describes some of the components that you can use to perform this additional processing.

Table 1-4 Additional Document Processing with the Java XDK

Technology
Label in Figure 1-7
Description

JAXB

D

Generates Java class files that correspond to an input XML Schema

JavaBeans

E

Can compare an XML document with another XML document

XSLT

F

Transforms the XML document into XHTML with an XSLT stylesheet

XML Document Generation with C

Figure 1-8 illustrates the Oracle XDK C language components that you can use to generate XML documents from relational data. The XDK C components are listed in Table 1-1.

Figure 1-8 Generating XML Documents with XDK C Components

Description of Figure 1-8 follows
Description of "Figure 1-8 Generating XML Documents with XDK C Components"

As illustrated in Figure 1-8, you can use the XDK to develop a C program that processes an XML document as follows:

Send SQL queries to the database by the Oracle Call Interface (OCI) or the Pro*C/C++ Precompiler. The program must leverage the XML DB XML view functionality.

Process the resulting XML data with the XML parser or from the CLOB as an XML document.

Transform the document with the XSLT processor, send it to an XML-enabled browser, or send it for further processing to a software program.

XML Document Generation with C++

Figure 1-9 shows the Oracle XDK C++ components that you can use to generate XML documents. The XDK C++ components are listed in Table 1-1.

Figure 1-9 Generating XML Documents Using XDK C++ Components

Description of Figure 1-9 follows
Description of "Figure 1-9 Generating XML Documents Using XDK C++ Components"

As illustrated in Figure 1-9, you can use the XDK to develop a C++ program that processes an XML document as follows:

Send SQL queries to the database by the Oracle C++ Call Interface (OCCI) or the Pro*C/C++ Precompiler.

Process the resulting XML data with the XML parser or from the CLOB as an XML document.

Transform the document with the XSLT processor, send it to an XML-enabled browser, or send it for further processing to a software program.

Development Tools and Frameworks for the XDK

Figure 1-10 illustrates some of the tools and frameworks that you can use to develop software programs that use XDK components. For example, you can use Oracle JDeveloper to write a Java client that can query the database, generate XML, and perform additional processing. An employee can then use this program to send a query to an Oracle database. The program can transfer XML documents to XML-based business solutions for data exchange with other users, content and data management, and so forth.

Figure 1-10 XDK Tools and Frameworks

Description of Figure 1-10 follows
Description of "Figure 1-10 XDK Tools and Frameworks"

This section describes some of the tools and frameworks that you can use in e-business development:

Oracle JDeveloper

User Interface XML (UIX)

Oracle Reports

Oracle XML Gateway

Oracle Data Provider for .NET

Oracle JDeveloper

Oracle JDeveloper is a J2EE development environment with end-to-end support for developing, debugging, and deploying e-business applications. JDeveloper provides a comprehensive set of integrated tools that support the complete development life cycle, from source code control, modeling, and coding through debugging, testing, profiling, and deployment. JDeveloper simplifies development by providing deployment tools to create J2EE components such as the following:

Applets

JavaBeans

Java Server Pages (JSP)

Servlets

Enterprise JavaBeans (EJB)

JDeveloper also provides a public API to extend and customize the development environment and integrate it with external products.

The Oracle XDK is integrated into JDeveloper, offering many ways to manage XML. For example, you can use the XSQL Servlet to perform the following tasks:

Query and manipulate database information

Generate XML documents

Transform XML with XSLT stylesheets

Deliver XML on the Web

JDeveloper has an integrated XML schema-driven code editor for working on XML Schema-based documents such as XML schemas and XSLT stylesheets. By specifying the schema for a certain language, the editor can assist you in creating a document in that markup language. You can use the Code Insight feature to provide a list of valid alternatives for XML elements or attributes in the document.

Oracle JDeveloper simplifies the task of working with Java application code and XML data and documents at the same time. It features drag-and-drop XML development modules such as the following:

Color-coded syntax highlighting for XML

Built-in syntax checking for XML and XSL

Editing support for XML schema documents

XSQL Pages and Servlet support

Oracle's XML parser for Java

XSLT processor

XDK for JavaBeans components

XSQL Page Wizard

XSQL Action Handlers

Schema-driven XML editor

See Also:

http://www.oracle.com/technetwork/developer-tools/jdev/overview/index.html for more information about JDeveloper

User Interface XML (UIX)

UIX (User Interface XML) is a framework for developing XML-enabled Web applications. The main focus of UIX is the user presentation layer of a program, with additional functionality for managing events and application flow. You can use UIX to create programs with page-based navigation, such as an online human resources program, rather than full-featured programs requiring advanced interaction, such as an integrated development environment (IDE).

See Also:

http://www.oracle.com/technetwork/developer-tools/jdev/viewlet-097827.html for sample JDeveloper Demonstration code

JDeveloper online help for the complete UIX Developer's Guide

Oracle Reports

Oracle Reports Developer and Reports Server is a development tool that enables you to build and publish dynamically generated Web reports. A wizard expedites the use of each major task. Report templates and live data previews allow you to customize the report structure. You can publish reports throughout the enterprise through a standard Web browser in formats such as the following:

XML

HTML with or without CSS

PDF

Text

RTF

PostScript

PCL

See Also:

http://www.oracle.com/technetwork/middleware/reports/overview/index.html for information about Oracle Reports

Oracle XML Gateway

Oracle XML Gateway is a set of services that enables integration with the Oracle E-Business Suite to create and consume XML messages triggered by business events. It integrates with Oracle Streams Advanced Queuing to enqueue and dequeue a message, which it can then transmit to or from the business partner through any message transport agent.

See Also:

Oracle Database Advanced Queuing User's Guide

Oracle XML DB Developer's Guide

Oracle Data Provider for .NET

Oracle Data Provider for .NET (ODP.NET) is an implementation of a data provider for the Oracle Database. ODP.NET uses Oracle native APIs to offer fast and reliable access to Oracle data and features from any .NET application and also uses and inherits classes and interfaces available in the Microsoft .NET Framework Class Library.

You can use ODP.NET and the XDK to extract data from relational and object-relational tables and views as XML documents. The use of XML documents for insert, update, and delete operations to the database server is also allowed. ODP.NET supports XML natively in the database through XML DB.

ODP.NET supports XML with features that:

Store XML data natively in the database server as the Oracle native type XMLType.

Access relational and object-relational data as XML data from an Oracle Database instance into Microsoft .NET environment and process the XML with the Microsoft .NET framework.

Save changes to the database server with XML data.

For the .NET application developer, features include the following:

Enhancements to the OracleCommand, OracleConnection, and OracleDataReader classes

XML-specific classes:

OracleXmlType

OracleXmlStream

OracleXmlQueryProperties

OracleXmlSaveProperties

See Also:

Oracle Data Provider for .NET Developer's Guide

Installing the XDK

This section assumes that you installed Oracle Database from either CD-ROM or from an archive downloaded from Oracle Technology Network (OTN). The Oracle Database CD installs the Oracle XDK by default. Note that you must install the demo programs from the Oracle Database Examples media to obtain the XDK demos. This manual presumes that you have access to the XDK demos programs.

After installing Oracle Database and the demos from the Oracle database Examples media, your Oracle Database home should be set up as follows:

- Oracle_home_directory
   | - bin: includes XDK executables
   | - lib: includes XDK libraries
   | - jlib: includes Globalization Support libraries for the XDK
   | - nls: includes binary files used as part of globalization support
   | - xdk: XDK scripts, message files, documentation, and demos
        readme.html
        | - admin: SQL scripts and XSL Servlet Configuration
                    file (XSQLConfig.xml)
        | - demo: sample programs (installed from Oracle Database Examples media)
             | - c
             | - cpp
             | - java
             | - jsp
        | - doc: release notes and readme
             content.html
             index.html
             license.html
             title.html
              | - cpp
              | - images
              | - java
        | - include: header files
        | - mesg: error message files

The directory that contains the XDK is called the XDK home. Set the $XDK_HOME environment variable (UNIX) or the %XDK_HOME% variable (Windows) to the XDK directory in your Oracle home. For example, you can set use csh on UNIX to set the XDK home as follows:

setenv XDK_HOME $ORACLE_HOME/xdk

See Also:

Chapter 3, "Getting Started with Java XDK Components"

Chapter 16, "Getting Started with C XDK Components"

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

Part I

XDK for Java

This part contains chapters describing how to use Oracle XDK in Java development.

This part contains the following chapters:

Chapter 3, "Getting Started with Java XDK Components"

Chapter 2, " Unified Java API for XML"

Chapter 4, "XML Parsing for Java"

Chapter 5, "Using Binary XML for Java"

Chapter 6, "Using the XSLT Processor for Java"

Chapter 7, "Using the Schema Processor for Java"

Chapter 8, "Using the JAXB Class Generator"

Chapter 9, "Using the XML Pipeline Processor for Java"

Chapter 10, "Using XDK JavaBeans"

Chapter 11, "Using the XML SQL Utility (XSU)"

Chapter 12, "Using the TransX Utility"

Chapter 13, "Data Loading Format (DLF) Specification"

Chapter 14, "Using the XSQL Pages Publishing Framework"

Chapter 15, "Using the XSQL Pages Publishing Framework: Advanced Topics"

2 Unified Java API for XML

This chapter introduces you to the Unified Java API for XMLType and provides information about the APIs that are unified for Oracle XML DB and Oracle XML Developer's Kit.

This chapter contains these topics:

Overview of Unified Java API 

Component Unification

Moving to the Unified Java API Model

Overview of Unified Java API

Unified Java API is a programming interface that combines the functionality required by both Oracle XDK and Oracle XML DB. Oracle XML DB implements Java DOM API using the Java package oracle.xdb.dom and Oracle XML Developer's Kit implements it using the oracle.xml.parser.v2 package. With Unified Java APIs, you can use a unified set of core DOM APIs required by both Oracle XDK and Oracle XML DB, as well as make use of the new Java classes that provide extra functionality that is built on top of the DOM API.

You can use Unified Java APIs irrespective of how your XML data is stored, that is, whether it resides within or outside the database. This is because Unified Java APIs use a session pool model of connection management. If you do not specify the connection type as thick (that uses OCI APIs and is C-based) or thin (that uses JDBC APIs and is pure Java-based), then Java Document Object Model (DOM) APIs are used for connecting to a local document object that is not stored in the database.

See Also:

Oracle Database XML Java API Reference for information about the oracle.xml.parser.v2 package.

Component Unification

Certain components that were either supported by only the thick connection or the thin connection have been unified in the Unified Java API model. The components that were earlier supported by thin connection but have been unified include:

DOM Parser

JAXP Transformer

XSU

XSLT

Moving to the Unified Java API Model

Unified Java API provides new Java classes that replace the old oracle.xdb.dom Java classes. All classes in the oracle.xdb.dom package have been deprecated. If you are using any of the old classes, you need to migrate to the new Unified Java API and use the oracle.xml.parser.v2 classes instead.

Java DOM APIs for XMLType Classes

Table 2-1 lists the oracle.xdb.dom package classes that have been deprecated in the Oracle Database 11g release 1.

Table 2-1 Deprecated XDB Package Classes And Their Unified Java API Equivalent

oracle.xdb.dom.* classes
oracle.xml.parser.v2 (Unified Java API) classes

XDBAttribute

XMLAttr

XDBBinaryDocument

This has been deprecated and has no replacement in the Java DOM API XMLType classes

XDBCData

XMLCDATA

XDBCharData

CharData

XDBComment

XMLComment

XDBDocFragment

XMLDocumentFragment

XDBDocument

XMLDocument

XDBDocumentType

DTD

XDBDOMException

XMLDomException

XDBDomImplementation

XMLDomImplementation

XDBDOMNotFoundErrException

This has been deprecated and has no replacement in the Java DOM API XMLType classes

XDBElement

XMLElement

XDBEntity

XMLEntity

XDBEntityReference

XMLEntityReference

XDBNamedNodeMap

XMLAttrList

XDBNode

XMLNode

XDBNotation

XMLNotation

XDBNotImplementedException

This has been deprecated and has no replacement in the Java DOM API XMLType classes

XDBProcInst

XMLPI

XDBText

XMLText

When you use the Java DOM API to retrieve XML data, you either get an XMLDocument instance if the connection is thin, or an XDBDocument instance with method getDOM() and an XMLDocument instance with method getDocument(). Both XMLDocument and XDBDocument are instances of the W3C DOM interface. The getDOM() method and XDBDocument class have been deprecated in the Unified Java APIs. Table 2-2 lists the new methods and classes that are supported with the current release.

Table 2-2 Deprecated XMLType Methods

oracle.xdb.XMLType old API
oracle.xdb.XMLType new API

getDOM()

getDocument()

public XMLType createXML(...)

public XMLType createXML(..., int kind) where kind is either XMLDocument.THICK or XMLDocument.THIN

Extension APIs

In addition to the W3C Recommendation, the Unified Java API implementation provides some extension APIs that extend the W3C DOM APIs in various ways. You can use the Oracle-specific extension APIs for either performing the basic functions like connecting to a database or for performance enhancement.

XMLDocument is a class that represents the DOM for the instantiated XML document. You can retrieve the XMLType value from the XML document using the XMLType constructor that takes a Document argument:

XMLType createXML(Connection conn, Document domdoc)

Use the freeNode() extension API available in the oracle.xml.parser.v2 package (XMLNode class) for manual dereferencing of nodes. When you use freeNode(), you explicitly dereference a document fragment from the DOM tree.

Document Creation Java APIs

The unified Java APIs that create an XMLDocument must create either a thin document or a thick document. A thick document requires a Connection object in order to establish communication with the database. So the creation APIs are extended to accept a Connection object.

Note:

You must specify the Connection type. Old document creation APIs are still supported for backward compatibility.

For XMLType.createXML APIs, Connection determines the type of object and for other APIs, a thin (pure Java) object is created if not explicitly specified.

Table 2-3 lists the XMLDocument output, based on the KIND and Connection property:

Table 2-3 XMLDocument Output Based on XMLDocument.KIND and XMLDocument.CONNECTION

XMLDocument.KIND
XMLDocument.CONNECTION
XMLDocument

XMLDocument.THICK

Thick or KPRB connection

Thick DOM

XMLDocument.THICK

Thin or no connection

Exception

XMLDocument.THIN

Any connection type

Thin DOM

Not specified

Any connection type

Non-XMLType APIs. Thin DOM

XMLType.createXML APIs - Based on connection type. That is, Thick DOM for OCI or KPRB connection, and Thin DOM for a Thin connection.

The following objects and methods are provided for document creation in the unified Java API model:

DOMParser object and parse() method: Use the DOMParser object and parse() method to parse XML documents. You must specify the type of object, that is, thick or thin. For thick objects, you must also provide the Connection property using the DOMParser.setAttribute() API. For example:

DOMParser parser = new oracle.xml.parser.v2.DOMParser();
parser.setAttribute(XMLDocument.KIND, XMLDocument.THICK);
parser.setAttribute(XMLDocument.CONNECTION, conn);

DocumentBuilder object: Use the DocumentBuilder object to parse XML document using the Java-specific API, JAXP. You need to create a DOM parser factory with the DocumentBuilderFactory class. The DocumentBuilderFactory class then passes the connection into the DOMParser, which is used to create the document from these APIs.

DocumentBuilder builds DOM from input SAX events. This takes the Connection from a property set on the DocumentBuilderFactory. For example:

DocumentBuilderFactory.setAttribute(XMLDocument.CONNECTION, conn);
DocumentBuilderFactory.setAttribute(XMLDocument.KIND,XMLDocument.THICK);

DocumentBuilderFactory passes the connection into the DOMParser that is used to create the document from the following APIs:

DocumentBuilder.newDocument()
DocumentBuilder parse(InputStream)
DocumentBuilder parse(InputStream, int)
DocumentBuilder.parse(InputSource)

XSU: These methods return an XMLDocument to the user. You can specify whether they want a thick or thin object:

OracleXMLUtil util = new OracleXMLUtil(...);
util.setAttribute(XMLDocument.KIND, XMLDocument.THICK);
util.setAttribute(XMLDocument.CONNECTION, conn);
Document doc = util.getXMLDOMFromStruct(struct, enc);

OracleXMLQuery query = new OracleXMLQuery(...);
query.setAttribute(XMLDocument.KIND, XMLDocument.THICK);
query.setAttribute(XMLDocument.CONNECTION, conn);
Document doc = query.getXMLDOM (root, meta);

OracleXMLDocGenDOM dgd = new OracleXMLDocGenDOM(...);
dgd.setAttribute(XMLDocument.KIND, XMLDocument.THICK);
dgd.setAttribute(XMLDocument.CONNECTION, conn);
Document doc = dgd.getXMLDocumentDOM(struct, enc);

XMLType: Using the getDocument() method, you can specify whether you want a thick or thin object. All existing XMLType methods are still available. In this example, the connection is inferred from the OPAQUE:

XMLType xt = XMLType.createXML(orset.getOPAQUE(1), XMLDocument.THICK);
Document doc = xt.getDocument();

One known case that will not allow for the user to specify the type is the case of an XMLType that is created using the ResultSet.getObject() API. If a user has a table with an XMLType column, and the user selects of this column, the user can call getObject() on the ResultSet. This will return an XMLType object. The type is determined by the Connection used in the JDBC call to fetch the column.

3 Getting Started with Java XDK Components

This chapter contains these topics:

Installing Java XDK Components

Java XDK Component Dependencies

Setting Java XDK Environment Variables for UNIX

Setting Java XDK Environment Variables for Windows

Verifying the Java XDK Components Version

Installing Java XDK Components

The Java XDK components are included with Oracle Database. This chapter assumes that you have installed XDK with Oracle Database and also installed the demo programs on the Oracle Database Examples media. Refer to "Installing the XDK" for installation instructions and a description of the XDK directory structure.

Example 3-1 shows the UNIX directory structure for the XDK demos and the libraries used by the XDK components. The $ORACLE_HOME/xdk/demo/java subdirectories contain sample programs and data files for the XDK for Java components. The chapters in Part I, "XDK for Java" explain how to understand and use these programs.

Example 3-1 Java XDK Libraries, Utilities, and Demos

- Oracle_home_directory
    | - bin/
         orajaxb
         orapipe
         oraxml
         oraxsl
         transx
    | - lib/
         classgen.jar
         jdev-rt.zip
         oraclexsql.jar
         transx.zip
         xml.jar
         xml2.jar
         xmlcomp.jar
         xmlcomp2.jar
         xmldemo.jar
         xmlmesg.jar
         xmlparserv2.jar
         xschema.jar
         xsqlserializers.jar
         xsu12.jar
    | - jlib/
         orai18n.jar
         orai18n-collation.jar
         orai18n-mapping.jar
         orai18n-utility.jar
    | - jdbc/
         | - lib/
              ojdbc5.jar
    | - rdbms/
         | - jlib/
              xdb.jar

    | - xdk/
         | demo/
            | - java/
                 | - classgen/
                 | - jaxb/
                 | - parser/
                 | - pipeline/
                 | - schema/
                 | - transviewer/
                 | - tranxs/
                 | - xsql/
                 | - xsu/

The subdirectories contain sample programs and data files for the Java XDK components. The chapters in Part I, "XDK for Java" explain how to use these programs to gain an understanding of the most important Java features.

Java XDK Component Dependencies

The Java XDK components are certified and supported with JDK version 5 and version 6. Earlier versions of Java are no longer supported. Figure 3-1 shows the dependencies of Java XDK components when using JDK 5.

Figure 3-1 Java XDK Component Dependencies for JDK 5

Description of Figure 3-1 follows
Description of "Figure 3-1 Java XDK Component Dependencies for JDK 5"

The Java XDK components require the libraries alphabetically listed in Table 3-1. Note that some of the libraries are not specific to the XDK, but are shared among other Oracle Database components.

Table 3-1 Java Libraries for XDK Components

Library
Directory
Includes . . .

classgen.jar

$ORACLE_HOME/lib

XML class generator for Java runtime classes.

Note: This library is maintained for backward compatibility only. You should use the JAXB class generator in xml.jar instead.

jdev-rt.zip

$ORACLE_HOME/lib

Java GUI libraries for use when working with the demos with the JDeveloper IDE.

ojdbc5.jar, ojdbc6.jar

$ORACLE_HOME/jdbc/lib

Oracle JDBC drivers for Java 5, 6. This JAR depends on orai18n.jar for character set support if you use a multibyte character set other than UTF-8, ISO8859-1, or JA16SJIS.

oraclexsql.jar

$ORACLE_HOME/lib

Most of the XSQL Servlet classes needed to construct XSQL pages.

Note: This archive is superseded by xml.jar and is maintained for backward compatibility only.

orai18n.jar

$ORACLE_HOME/jlib

Globalization support for JDK 1.2 or above. It is a wrapper of all other Globalization jars and includes character set converters. If you use a multibyte character set other than UTF-8, ISO8859-1, or JA16SJIS, then place this archive in your CLASSPATH so that JDBC can convert the character set of the input file to the database character set when loading XML files with XSU, TransX Utility, or XSQL Servlet.

orai18n-collation.jar

$ORACLE_HOME/jlib

Globalization collation features: the OraCollator class and the lx3*.glb and lx4001[0-9].glb files.

orai18n-mapping.jar

$ORACLE_HOME/jlib

Globalization locale and character set name mappings: the OraResourceBundle class and lx4000[0-9].glb files. This archive is mainly used by the products that need only locale name mapping tables.

orai18n-utility.jar

$ORACLE_HOME/jlib

Globalization locale objects: the OraLocaleInfo class, the OraNumberFormat and OraDateFormat classes, and the lx[01]*.glb files.

transx.zip

$ORACLE_HOME/lib

TransX Utility classes.

Note: This archive is replaced by xml.jar and is retained for backward compatibility only.

xdb.jar

$ORACLE_HOME/rdbms/jlib

Classes needed by xml.jar and xmlcomp2.jar to access XMLType. It also includes classes needed to access the XML DB Repository as well as the XMLType DOM classes for manipulation of the DOM tree.

xml.jar

$ORACLE_HOME/lib

Classes from the following libraries:

oraclexsql.jar

xsqlserializers.jar

xmlcomp.jar

xmlcomp2.jar

transx.jar

The archive also contains the JAXB and Pipeline Processor classes.

xmlcomp.jar

$ORACLE_HOME/lib

XML JavaBeans that do not depend on the database: DOMBuilder, XSLTransformer, DBAccess, XSDValidator, and XMLDiffer.

Note: This archive is included for backward compatibility only because its classes are included in xml.jar. They do not include the visuals Beans included in previous releases.

xmlcomp2.jar

$ORACLE_HOME/lib

XML JavaBeans that depend on the database: XMLDBAccess and XMLCompress. Thus, it depends on xdb.jar, which includes the classes that support XML DB.

Note: This JAR is included for backward compatibility only because its classes are included in xml.jar. They do not include the visuals Beans included in previous releases.

xmldemo.jar

$ORACLE_HOME/lib

The visual JavaBeans: XMLTreeView, XMLTransformPanel, XMLSourceView, and DBViewer.

xmlmesg.jar

$ORACLE_HOME/lib

Needed if you use XML parser with a language other than English.

xmlparserv2.jar

$ORACLE_HOME/lib

APIs for the following:

DOM and SAX parsers

XML Schema processor

XSLT processor

XML compression

JAXP

Utility functionality such as XMLSAXSerializer and asynchronous DOM Builder

This library includes xschema.jar.

xschema.jar

$ORACLE_HOME/lib

Includes the XML Schema classes contained in xmlparserv2.jar.

Note: This JAR file is maintained for backward compatibility only.

xsqlserializers.jar

$ORACLE_HOME/lib

Serializer classes for XSQL Servlet needed for serialized output such as PDF.

Note: This archive is superseded by xml.jar and is maintained for backward compatibility only.

xsu12.jar

$ORACLE_HOME/lib

Classes that implement XSU. These classes have a dependency on xdb.jar for XMLType access.

See Also:

Oracle Database Globalization Support Guide to learn about the Globalization Support libraries

Oracle Database JDBC Developer's Guide to learn about the JDBC libraries

Oracle XML DB Developer's Guide to learn about XML DB

Setting Up the Java XDK Environment

In the Oracle Database installation of the XDK, you must manually set the $CLASSPATH (UNIX) or %CLASSPATH% (Windows) environment variables. Alternatively, set the -classpath option when compiling and running Java programs at the command line.

This section contains the following topics:

Setting Java XDK Environment Variables for UNIX

Setting Java XDK Environment Variables for Windows

Setting Java XDK Environment Variables for UNIX

Table 3-2 describes the UNIX environment variables required for use with the Java XDK components.

Table 3-2 UNIX Environment Settings for Java XDK Components

Variable
Description

$CLASSPATH

Includes the following (note that a single period "." to represent the current directory is not required but may be useful):

.:${CLASSPATHJ}:${ORACLE_HOME}/lib/xmlparserv2.jar:
${ORACLE_HOME}/lib/xsu12.jar:${ORACLE_HOME}/lib/xml.jar

$CLASSPATHJ

For JDK 5, set as follows:

CLASSPATHJ=${ORACLE_HOME}/jdbc/lib/ojdbc5.jar:${ORACLE_HOME}/jlib/orai18n.jar

The orai18n.jar is needed to support certain character sets.

$JAVA_HOME

Installation directory for the Java JDK, Standard Edition. Modify the path that links to the Java SDK.

$LD_LIBRARY_PATH

For OCI JDBC connections:

${ORACLE_HOME}/lib:${LD_LIBRARY_PATH}

$PATH

${JAVA_HOME}/bin

Testing the Java XDK Environment on UNIX

Table 3-3 describes the command-line utilities included in the Java XDK on UNIX. Before you can use these utilities, you must set up your environment.

Table 3-3 Java XDK Utilities

Executable/Class
Directory/JAR
Description

xsql

$ORACLE_HOME/bin

XSQL command-line utility. The script executes the oracle.xml.xsql.XSQLCommandLine class. Edit this shell script for your environment before use.

See Also: "Using the XSQL Pages Command-Line Utility"

OracleXML

$ORACLE_HOME/lib/xsu12.jar

XSU command-line utility

See Also: "Using the XSU Command-Line Utility"

orajaxb

$ORACLE_HOME/bin

JAXB command-line utility

See Also: "Using the JAXB Class Generator Command-Line Utility"

orapipe

$ORACLE_HOME/bin

Pipeline command-line utility

See Also: "Using the XML Pipeline Processor Command-Line Utility"

oraxml

$ORACLE_HOME/bin

XML parser command-line utility

See Also: "Using the XML Parser Command-Line Utility"

oraxsl

$ORACLE_HOME/bin

XSLT processor command-line utility

See Also: "Using the XSLT Processor Command-Line Utility"

transx

$ORACLE_HOME/bin

TransX command-line utility

See Also: "Using the TransX Command-Line Utility"

If your environment is set up correctly, then the UNIX shell script shown in Example 3-2 should generate version and usage information for the utilities.

Example 3-2 Testing the Java XDK Environment on UNIX

#!/usr/bin/tcsh
echo;echo "BEGIN TESTING";echo
echo;echo "now testing the XSQL utility...";echo
xsql
echo; echo "now testing the XSU utility...";echo
java OracleXML
echo;echo "now testing the JAXB utility...";echo
orajaxb -version
echo;echo "now testing the Pipeline utility...";echo
orapipe -version
echo;echo "now testing the XSLT Processor utility...";echo
oraxsl
echo;echo "now testing the TransX utility...";echo
transx
echo;echo "END TESTING"

Setting Java XDK Environment Variables for Windows

Table 3-4 describes the Windows environment variables required for use with the Java XDK components.

Table 3-4 Windows Environment Settings for Java XDK Components

Variable
Notes

%CLASSPATH%

Includes the following (note that a single period "." to represent the current directory is not required but may be useful):

.;%CLASSPATHJ%;%ORACLE_HOME%\lib\xmlparserv2.jar;
%ORACLE_HOME%\lib\xsu12.jar;%ORACLE_HOME%\lib\xml.jar;
%ORACLE_HOME%\lib\xmlmesg.jar;%ORACLE_HOME%\lib\oraclexsql.jar

%CLASSPATHJ%

For JDK 5, set as follows:

CLASSPATHJ=%ORACLE_HOME%\jdbc\lib\ojdbc5.jar:%ORACLE_HOME%\lib\orai18n.jar

The orai18n.jar is needed to support certain character sets.

%JAVA_HOME%

Installation directory for the Java SDK, Standard Edition. Modify the path that links to the Java SDK.

%PATH%

%JAVA_HOME%\bin

Testing the Java XDK Environment on Windows

Table 3-5 describes the command-line utilities included in the Java XDK on Windows. Before you can use these utilities, you must set up your environment.

Table 3-5 Java XDK Utilities

Batch File/Class
Directory/JAR
Description

xsql.bat

%ORACLE_HOME%\bin

XSQL command-line utility. The batch file executes the oracle.xml.xsql.XSQLCommandLine class. Edit the batch file for your environment before use.

See Also: "Using the XSQL Pages Command-Line Utility"

OracleXML

%ORACLE_HOME%\lib\xsu12.jar

XSU command-line utility

See Also: "Using the XSU Command-Line Utility"

orajaxb.bat

%ORACLE_HOME%\bin

JAXB command-line utility

See Also: "Using the JAXB Class Generator Command-Line Utility"

orapipe.bat

%ORACLE_HOME%\bin

Pipeline command-line utility

See Also: "Using the XML Pipeline Processor Command-Line Utility"

oraxml.bat

%ORACLE_HOME%\bin

XML parser command-line utility

See Also: "Using the XML Parser Command-Line Utility"

oraxsl.bat

%ORACLE_HOME%\bin

XSLT processor command-line utility

See Also: "Using the XSLT Processor Command-Line Utility"

transx.bat

%ORACLE_HOME%\bin

TransX command-line utility

See Also: "Using the TransX Command-Line Utility"

If your environment is set up correctly, then you can run the commands in Example 3-3 at the system prompt to generate version and usage information for the utilities.

Example 3-3 Testing the Java XDK Environment on Windows

xsql.bat
java OracleXML
orajaxb.bat -version
orapipe.bat -version
oraxsl.bat
transx.bat

Verifying the Java XDK Components Version

To obtain the version of XDK you are working with, use javac to compile the Java code shown in Example 3-4.

Example 3-4 XDKVersion.java

//
// XDKVersion.java
//
import java.net.URL;
import oracle.xml.parser.v2.XMLParser;
public class XDKVersion
{
   static public void main(String[] argv)
   {
      System.out.println("You are using version: ");
      System.out.println(XMLParser.getReleaseVersion());
   }
}

After compiling the source file with javac, run the program on the operating system command line as follows:

java XDKVersion
You are using version:
Oracle XML Developers Kit 11.1.0.6.0 - Production

4 XML Parsing for Java

This chapter contains these topics:

Introduction to the XML Parsing for Java

Using XML Parsing for Java: Overview

Parsing XML with DOM

Parsing XML with SAX

Parsing XML with JAXP

Compressing XML

Tips and Techniques for Parsing XML

Introduction to the XML Parsing for Java

This section contains the following topics:

Prerequisites

Standards and Specifications

XML Parsing in Java

DOM in XML Parsing

Scalable DOM

SAX in the XML Parser

JAXP in the XML Parser

Namespace Support in the XML Parser

Validation in the XML Parser

Compression in the XML Parser

Prerequisites

Oracle XML parsing reads an XML document and uses DOM or SAX APIs to provide programmatic access to its content and structure. You can use parsing in validating or nonvalidating mode.

This chapter assumes that you are familiar with the following technologies:

Document Object Model (DOM). DOM is an in-memory tree representation of the structure of an XML document.

Simple API for XML (SAX). SAX is a standard for event-based XML parsing.

Java API for XML Processing (JAXP). JAXP is a standard interface for processing XML with Java applications. It supports the DOM and SAX standards.

Document Type Definition (DTD). An XML DTD defines the legal structure of an XML document.

XML Schema. Like a DTD, an XML schema defines the legal structure of an XML document.

XML Namespaces. Namespaces are a mechanism for differentiating element and attribute names.

Binary XML. Both scalable and nonscalable DOMs can save XML documents in this format.

If you require a general introduction to the preceding technologies, consult the XML resources listed in "Related Documents" of the preface.

Standards and Specifications

The DOM Level 1, Level 2, and Level 3 specifications are W3C Recommendations. You can find links to the specifications for all three levels at the following URL:

http://www.w3.org/DOM/DOMTR

SAX is available in version 1.0, which is deprecated, and 2.0. It is not a W3C specification. You can find the documentation for SAX at the following URL:

http://www.saxproject.org/

XML Namespaces are a W3C Recommendation. You can find the specification at the following URL:

http://www.w3.org/TR/REC-xml-names

JCR 1.0 (also known as JSR 170) defines a standard Java API for applications to interact with content repositories.

See Also:

Oracle XML DB Developer's Guide,

JAXP version 1.2 includes an XSLT framework plus some updates to the parsing API to support DOM Level 2 and SAX version 2.0 and an improved scheme to locate pluggable implementations. JAXP provides support for XML schema and an XSLT compiler. You can access the JAXP specification at the following URL:

http://java.sun.com/xml/downloads/jaxp.html

See Also:

Chapter 31, "XDK Standards" for an account of the standards supported by the XDK

Large Node Handling

DOM Stream access to XML nodes is done by PL/SQL and Java APIs. Nodes in an XML document can now exceed 64 KBytes by a large amount. Thus JPEG, Word, PDF, RTF, and HTML documents can be more readily stored.

See Also:

Oracle XML DB Developer's Guide for complete details on the Java large node capabilities

XML Parsing in Java

XMLParser is the abstract base class for the XML parser for Java. An instantiated parser invokes the parse() method to read an XML document.

XMLDOMImplementation factory methods provide another method to parse Binary XML to create scalable DOM.

Figure 4-1 illustrates the basic parsing process, using XMLParser. The diagram does not apply to XMLDOMImplementation().

Figure 4-1 The XML Parser Process

This graphic is described in the surrounding text.
Description of "Figure 4-1 The XML Parser Process"

The following APIs provide a Java application with access to a parsed XML document:

DOM API, which parses XML documents and builds a tree representation of the documents in memory. Use either a DOMParser object to parse with DOM or the XMLDOMImplementation interface factory methods to create a pluggable, scalable DOM.

SAX API, which processes an XML document as a stream of events, which means that a program cannot access random locations in a document. Use a SAXParser object to parse with SAX.

JAXP, which is a Java-specific API that supports DOM, SAX, and XSL. Use a DocumentBuilder or SAXParser object to parse with JAXP.

The sample XML document in Example 4-1 helps illustrate the differences among DOM, SAX, and JAXP.

Example 4-1 Sample XML Document

<?xml version="1.0"?>
  <EMPLIST>
    <EMP>
     <ENAME>MARY</ENAME>
    </EMP>
    <EMP>
     <ENAME>SCOTT</ENAME>
    </EMP>
  </EMPLIST>

DOM in XML Parsing

DOM builds an in-memory tree representation of the XML document. For example, the DOM API receives the document described in Example 4-1 and creates an in-memory tree as shown in Figure 4-2. DOM provides classes and methods to navigate and process the tree.

In general, the DOM API provides the following advantages:

DOM API is easier to use than SAX because it provides a familiar tree structure of objects.

Structural manipulations of the XML tree, such as re-ordering elements, adding to and deleting elements and attributes, and renaming elements, can be performed.

Interactive applications can store the object model in memory, enabling users to access and manipulate it.

DOM as a standard does not support XPath. However, most XPath implementations use DOM. The Oracle XDK includes DOM API extensions to support XPath.

A pluggable, scalable DOM can be created that considerably improves scalability and efficiency.

DOM Creation

In Java XDK, there are three ways to create a DOM:

Parse a document using DOMParser. This has been the traditional XDK approach.

Create a scalable DOM using XMLDOMImplementation factory methods.

Use an XMLDocument constructor. This is not a common solution in XDK.

Scalable DOM

With Oracle 11g Release 1 (11.1), XDK provides scalable, pluggable support for DOM. This relieves problems of memory inefficiency, limited scalability, and lack of control over the DOM configuration.

For the scalable DOM, the configuration and creation are mainly supported using the XMLDOMImplementation class.

These are important aspects of scalable DOM:

Plug-in Data allows external XML representation to be directly used by Scalable DOM without replicating XML in internal representation.

Scalable DOM is created on top of plug-in XML data through the Reader and InfosetWriter abstract interfaces. XML data can be in different forms, such as Binary XML, XMLType, and third-party DOM, and so on.

Transient nodes. DOM nodes are created lazily and may be freed if not in use.

Binary XML

The scalable DOM can use binary XML as both input and output format. Scalable DOM can interact with the data in two ways:

Through the abstract InfosetReader and InfosetWriter interfaces. Users can (1) use the BinXML implementation of InfosetReader and InfosetWriter to read and write BinXML data, and (2) use other implementations supplied by the user to read and write in other forms of XML infoset.

Through an implementation of the InfosetReader and InfosetWriter adaptor for BinXMLStream.

See Also:

Chapter 5, "Using Binary XML for Java"

Scalable DOM support consists of the following:

Pluggable DOM Support

Lazy Materialization

Configurable DOM Settings

Pluggable DOM Support

Pluggable DOM is an XDK mechanism that enables you to split the DOM API from the data layer. The DOM API is separated from the data by the InfosetReader and InfosetWriter interfaces.

Using pluggable DOM, XML data can be easily moved from one processor to another.

The DOM API includes unified standard APIs on top of the data to support node access, navigation, update processes, and searching capability.

See Also:

"Using Pluggable DOM"

Lazy Materialization

Using the lazy materialization mechanism, XDK only creates nodes that are accessed and frees unused nodes from memory. Applications can process very large XML documents with improved scalability.

See Also:

"Using Lazy Materialization"

Configurable DOM Settings

DOM configurations can be made to suit different applications. You can configure the DOM with different access patterns such as read-only, streaming, transient update, and shadow copy, achieving maximum memory use and performance in your applications.

See Also:

"Using Configurable DOM Settings"

SAX in the XML Parser

Unlike DOM, SAX is event-based, so it does not build in-memory tree representations of input documents. SAX processes the input document element by element and can report events and significant data to callback methods in the application. The XML document in Example 4-1 is parsed as a series of linear events as shown in Figure 4-2.

In general, the SAX API provides the following advantages:

It is useful for search operations and other programs that do not need to manipulate an XML tree.

It does not consume significant memory resources.

It is faster than DOM when retrieving XML documents from a database.

Figure 4-2 Comparing DOM (Tree-Based) and SAX (Event-Based) APIs

This graphic is described in the surrounding text.
Description of "Figure 4-2 Comparing DOM (Tree-Based) and SAX (Event-Based) APIs"

JAXP in the XML Parser

The JAXP API enables you to plug in an implementation of the SAX or DOM parser. The SAX and DOM APIs provided in the Oracle XDK are examples of vendor-specific implementations supported by JAXP.

In general, the advantage of JAXP is that you can use it to write interoperable applications. If an application uses features available through JAXP, then it can very easily switch the implementation.

The main disadvantage of JAXP is that it runs more slowly than vendor-specific APIs. In addition, several features are available through Oracle-specific APIs that are not available through JAXP APIs. Only some of the Oracle-specific features are available through the extension mechanism provided in JAXP. If an application uses these extensions, however, then the flexibility of switching implementation is lost.

Namespace Support in the XML Parser

The XML parser for Java can parse unqualified element types and attribute names as well as those in namespaces. Namespaces are a mechanism to resolve or avoid name collisions between element types or attributes in XML documents by providing "universal" names. Consider the XML document shown in Example 4-2.

Example 4-2 Sample XML Document Without Namespaces

<?xml version='1.0'?>
<addresslist>
  <company>
    <address>500 Oracle Parkway,
             Redwood Shores, CA 94065
    </address>
  </company>
  <!-- ... -->
  <employee>
    <lastname>King</lastname>
    <address>3290 W Big Beaver
             Troy, MI 48084
    </address>
  </employee>
  <!-- ... -->
</addresslist>

Without the use of namespaces, an application processing the XML document in Example 4-2 does not know whether the <address> tag refers to a company or employee address. As shown in Example 4-3, you can use namespaces to distinguish the <address> tags. The example declares the following XML namespaces:

http://www.oracle.com/employee
http://www.oracle.com/company

Example 4-3 associates the com prefix with the first namespace and the emp prefix with the second namespace. Thus, an application can distinguish <com:address> from <emp:address>.

Example 4-3 Sample XML Document with Namespaces

<?xml version='1.0'?>
<addresslist>
<!-- ... -->
  <com:company
    xmlns:com="http://www.oracle.com/company">
    <com:address>500 Oracle Parkway,
             Redwood Shores, CA 94065
    </com:address>
  </com:company>
  <!-- ... -->
  <emp:employee
    xmlns:emp="http://www.oracle.com/employee">
    <emp:lastname>King</emp:lastname>
    <emp:address>3290 W Big Beaver
             Troy, MI 48084
    </emp:address>
</emp:employee>

It is helpful to remember the following terms when parsing documents that use namespaces:

Namespace prefix, which is a namespace prefix declared with xmlns. In Example 4-3, emp and com are namespace prefixes.

Local name, which is the name of an element or attribute without the namespace prefix. In Example 4-3, employee and company are local names.

Qualified name, which is the local name plus the prefix. In Example 4-3, emp:employee and com:company are qualified names.

Namespace URI, which is the URI assigned to xmlns. In Example 4-3, http://www.oracle.com/employee and http://www.oracle.com/company are namespace URIs.

Expanded name, which is obtained by substituting the namespace URI for the namespace prefix. In Example 4-3, http://www.oracle.com/employee:employee and http://www.oracle.com/company:company are expanded element names.

Validation in the XML Parser

Applications invoke the parse() method to parse XML documents. Typically, applications invoke initialization and termination methods in association with the parse() method. You can use the setValidationMode() method defined in oracle.xml.parser.v2.XMLParser to set the parser mode to validating or nonvalidating.

By parsing an XML document according to the rules specified in a DTD or an XML schema, a validating XML parser determines whether the document conforms to the specified DTD or XML schema. If the XML document does conform, then the document is valid, which means that the structure of the document conforms to the DTD or schema rules. A nonvalidating parser checks for well-formedness only.

Table 4-1 shows the flags that you can use in setValidationMode() to set the validation mode in the Oracle XDK parser.

Table 4-1 XML Parser for Java Validation Modes

Name
Value
The XML Parser . . .

Nonvalidating mode

NONVALIDATING

Verifies that the XML is well-formed and parses the data.

DTD validating mode

DTD_VALIDATION

Verifies that the XML is well-formed and validates the XML data against the DTD. The DTD defined in the <!DOCTYPE> declaration must be relative to the location of the input XML document.

Schema validation mode

SCHEMA_VALIDATION

Validates the XML Document according to the XML schema specified for the document.

LAX validation mode

SCHEMA_LAX_VALIDATION

Tries to validate part or all of the instance document as long as it can find the schema definition. It does not raise an error if it cannot find the definition. See the sample program XSDLax.java in the schema directory.

Strict validation mode

SCHEMA_STRICT_VALIDATION

Tries to validate the whole instance document, raising errors if it cannot find the schema definition or if the instance does not conform to the definition.

Partial validation mode

PARTIAL_VALIDATION

Validates all or part of the input XML document according to the DTD, if present. If the DTD is not present, then the parser is set to nonvalidating mode.

Auto validation mode

AUTO_VALIDATION

Validates all or part of the input XML document according to the DTD or XML schema, if present. If neither is present, then the parser is set to nonvalidating mode.

In addition to setting the validation mode with setValidationMode(), you can use the oracle.xml.parser.schema.XSDBuilder class to build an XML schema and then configure the parser to use it by invoking the XMLParser.setXMLSchema() method. In this case, the XML parser automatically sets the validation mode to SCHEMA_STRICT_VALIDATION and ignores the schemaLocation and noNamespaceSchemaLocation attributes. You can also change the validation mode to SCHEMA_LAX_VALIDATION. The XMLParser.setDoctype() method is a parallel method for DTDs, but unlike setXMLSchema() it does not alter the validation mode.

See Also:

Chapter 7, "Using the Schema Processor for Java" to learn about validation

Oracle Database XML Java API Reference to learn about the XMLParser and XSDBuilder classes

Compression in the XML Parser

You can use the XML compressor, which is implemented in the XML parser, to compress and decompress XML documents. The compression algorithm is based on tokenizing the XML tags. The assumption is that any XML document repeats a number of tags and so tokenizing these tags gives considerable compression. The degree of compression depends on the type of document: the larger the tags and the lesser the text content, the better the compression.

The Oracle XML parser generates a binary compressed output from an in-memory DOM tree or SAX events generated from an XML document. Table 4-2 describes the two types of compression.

Table 4-2 XML Compression with DOM and SAX

Type
Description
Compression APIs

DOM-based

The goal is to reduce the size of the XML document without losing the structural and hierarchical information of the DOM tree. The parser serializes an in-memory DOM tree, corresponding to a parsed XML document, and generates a compressed XML output stream. The serialized stream regenerates the DOM tree when read back.

Use the writeExternal() method to generate compressed XML and the readExternal() method to reconstruct it. The methods are in the oracle.xml.parser.v2.XMLDocument class.

SAX-based

The SAX parser generates a compressed stream when it parses an XML file. SAX events generated by the SAX parser are handled by the SAX compression utility, which generates a compressed binary stream. When the binary stream is read back, the SAX events are generated.

To generate compressed XML, instantiate oracle.xml.comp.CXMLHandlerBase by passing an output stream to the constructor. Pass the object to SAXParser.setContentHandler() and then execute the parse() method. Use the oracle.xml.comp.CXMLParser class to decompress the XML.

Note: CXMLHandlerBase implements both SAX 1.0 and 2.0, but because 1.0 is deprecated, it is recommended that you use the 2.0 API.

The compressed streams generated from DOM and SAX are compatible, that is, you can use the compressed stream generated from SAX to generate the DOM tree and vice versa. As with XML documents in general, you can store the compressed XML data output in the database as a BLOB.

When a program parses a large XML document and creates a DOM tree in memory, it can affect performance. You can compress an XML document into a binary stream by serializing the DOM tree. You can regenerate the DOM tree without validating the XML data in the compressed stream. You can treat the compressed stream as a serialized stream, but the data in the stream is more controlled and managed than the compression implemented by Java's default serialization.

Note:

Oracle Text cannot search a compressed XML document. Decompression reduces performance. If you are transferring files between client and server, then HTTP compression can be easier.

Using XML Parsing for Java: Overview

The fundamental component of any XML development is XML parsing. XML parsing for Java is a standalone XML component that parses an XML document (and possibly also a standalone DTD or XML Schema) so that your program can process it. This section contains the following topics:

Using the XML Parser for Java: Basic Process

Running the XML Parser Demo Programs

Using the XML Parser Command-Line Utility

Note:

You can use the parser with any supported JavaVMs. With Oracle9i or higher you can load the parser into the database and use the internal Oracle9i JVM. For other database versions, run the parser in an external JVM and connect to a database through JDBC.

Using the XML Parser for Java: Basic Process

Figure 4-3 shows how to use the XML parser in a typical XML processing application.

Figure 4-3 XML Parser for Java

This graphic is described in the surrounding text.
Description of "Figure 4-3 XML Parser for Java"

The basic process of the application shown in Figure 4-3 is as follows:

The DOM or SAX parser parses input XML documents. For example, the program can parse XML data documents, DTDs, XML schemas, and XSL stylesheets.

If you implement a validating parser, then the processor attempts to validate the XML data document against any supplied DTDs or XML schemas.

See Also:

Chapter 6, "Using the XSLT Processor for Java"

Chapter 7, "Using the Schema Processor for Java" to learn about validation

Oracle Database XML Java API Reference for XML parser classes and methods

Running the XML Parser Demo Programs

Demo programs for the XML parser for Java are included in $ORACLE_HOME/xdk/demo/java/parser. The demo programs are distributed among the subdirectories described in Table 4-3.

Table 4-3 Java Parser Demos

Directory
Contents
These programs ...

common

class.xml
DemoUtil.java
empl.xml
family.dtd
family.xml
iden.xsl
NSExample.xml
traversal.xml

Provide XML files and Java programs for general use with the XML parser. For example, you can use the XSLT stylesheet iden.xsl to achieve an identity transformation of the XML files. DemoUtil.java implements a helper method to create a URL from a file name. This method is used by many of the other demo programs.

comp

DOMCompression.java
DOMDeCompression.java
SAXCompression.java
SAXDeCompression.java
SampleSAXHandler.java
sample.xml
xml.ser

Illustrate DOM and SAX compression:

DOMCompression.java compresses a DOM tree.

DOMDeCompression.java reads back a DOM from a compressed stream.

SAXCompression.java compresses the output from a SAX parser.

SAXDeCompression.java regenerates SAX events from the compressed stream.

SampleSAXHandler.java illustrates use of a handler to handle the events thrown by the SAX DeCompressor.

dom

AutoDetectEncoding.java
DOM2Namespace.java
DOMNamespace.java
DOMRangeSample.java
DOMSample.java
EventSample.java
I18nSafeXMLFileWritingSample.java
NodeIteratorSample.java
ParseXMLFromString.java
TreeWalkerSample.java

Illustrate uses of the DOM API:

DOM2Namespace.java shows how to use DOM Level 2.0 APIs.

DOMNamespace.java shows how to use Namespace extensions to DOM APIs.

DOMRangeSample.java shows how to use DOM Range APIs.

DOMSample.java shows basic use of the DOM APIs.

EventSample.java shows how to use DOM Event APIs.

NodeIteratorSample.java shows how to use DOM Iterator APIs.

TreeWalkerSample.java shows how to use DOM TreeWalker APIs.

jaxp

JAXPExamples.java
age.xsl
general.xml
jaxpone.xml
jaxpone.xsl
jaxpthree.xsl
jaxptwo.xsl
oraContentHandler.java

Illustrate various uses of the JAXP API:

JAXPExamples.java provides a few examples of how to use the JAXP 1.1 API to run the Oracle engine.

oraContentHandler.java implements a SAX content handler. The program invokes methods such as startDocument(), endDocument(), startElement(), and endElement() when it recognizes an XML tag.

sax

SAX2Namespace.java
SAXNamespace.java
SAXSample.java
Tokenizer.java

Illustrate various uses of the SAX APIs:

SAX2Namespace.java shows how to use SAX 2.0.

SAXNamespace.java shows how to use namespace extensions to SAX APIs.

SAXSample.java shows basic use of the SAX APIs.

Tokenizer.java shows how to use the XMLToken interface APIs. The program implements the XMLToken interface, which must be registered with the setTokenHandler() method. A request for XML tokens is registered with the setToken() method. During tokenizing, the parser does not validate the document and does not include or read internal/external utilities.

xslt

XSLSample.java
XSLSample2.java
match.xml
match.xsl
math.xml
math.xsl
number.xml
number.xsl
position.xml
position.xsl
reverse.xml
reverse.xsl
string.xml
string.xsl
style.txt
variable.xml
variable.xsl

Illustrate the transformation of documents with XSLT:

XSLSample.java shows how to use the XSL processing capabilities of the Oracle XML parser. It transforms an input XML document with a given input stylesheet. This demo builds the result of XSL transformations as a DocumentFragment and so does not support xsl:output features.

XSLSample2.java transforms an input XML document with a given input stylesheet. The demo streams the result of the XSL transformation and so supports xsl:output features.

See Also: "Running the XSLT Processor Demo Programs"

Documentation for how to compile and run the sample programs is located in the README. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/parser directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\parser directory (Windows).

Set up your environment as described in "Setting Up the Java XDK Environment".

Change into each of the following subdirectories and run make (UNIX) or Make.bat (Windows) at the command line. For example:

cd comp;make;cd ..
cd jaxp;make;cd ..
cd sax;make;cd ..
cd dom;make;cd ..
cd xslt;make;cd ..

The make file compiles the source code in each directory, runs the programs, and writes the output for each program to a file with an *.out extension.

You can view the *.out files to view the output for the programs.

Using the XML Parser Command-Line Utility

The oraxml utility, which is located in $ORACLE_HOME/bin (UNIX) or %ORACLE_HOME%\bin (Windows), is a command-line interface that parses XML documents. It checks for both well-formedness and validity.

To use oraxml ensure that the following is true:

Your CLASSPATH is set up as described in "Setting Up the Java XDK Environment". In particular, make sure you CLASSPATH environment variable points to the xmlparserv2.jar file.

Your PATH environment variable can find the Java interpreter that comes with the version of the JDK that you are using.

Table 4-4 lists the oraxml command-line options.

Table 4-4 oraxml Command-Line Options

Option
Purpose

-help

Prints the help message

-version

Prints the release version

-novalidate fileName

Checks whether the input file is well-formed

-dtd fileName

Validates the input file with DTD Validation

-schema fileName

Validates the input file with Schema Validation

-log logfile

Writes the errors to the output log file

-comp fileName

Compresses the input XML file

-decomp fileName

Decompresses the input compressed file

-enc fileName

Prints the encoding of the input file

-warning

Show warnings

For example, change into the $ORACLE_HOME/xdk/demo/java/parser/common directory. You can validate the document family.xml against family.dtd by executing the following on the command line:

oraxml -dtd -enc family.xml

The output should appear as follows:

The encoding of the input file: UTF-8The input XML file is parsed without errors using DTD validation mode.

Parsing XML with DOM

The W3C standard library org.w3c.dom defines the Document class as well as classes for the components of a DOM. The Oracle XML parser includes the standard DOM APIs and is compliant with the W3C DOM recommendation. Along with org.w3c.dom, Oracle XML parsing includes classes that implement the DOM APIs and extend them to provide features such as printing document fragments and retrieving namespace information.

This section contains the following topics:

Using the DOM API

DOM Parser Architecture

Performing Basic DOM Parsing

Creating Scalable DOM

Performing DOM Operations with Namespaces

Performing DOM Operations with Events

Performing DOM Operations with Ranges

Performing DOM Operations with TreeWalker

Using the DOM API

To implement DOM-based components in your XML application, you can use the following XDK classes:

oracle.xml.parser.v2.DOMParser. This class implements an XML 1.0 parser according to the W3C recommendation. Because DOMParser extends XMLParser, all methods of XMLParser are available to DOMParser.

See Also:

"DOM Parser Architecture"

oracle.xml.parser.v2.XMLDOMImplementation. This class contains factory methods used to created scalable, pluggable DOM.

For purposes of this discussion, DOMs created with the XMLDOMImplementation class are referred to as scalable or pluggable DOM.

See Also:

"Creating Scalable DOM"

You can also make use of the DOMNamespace and DOM2Namespace classes, which are sample programs included in $ORACLE_HOME/xdk/demo/java/parser/dom.

DOM Parser Architecture

Figure 4-4 is an architectural diagram of the DOM Parser.

Figure 4-4 Basic Architecture of the DOM Parser

This graphic is described in the surrounding text.
Description of "Figure 4-4 Basic Architecture of the DOM Parser"

Performing Basic DOM Parsing

The program DOMSample.java is provided to illustrate the basic steps for parsing an input XML document and accessing it through a DOM.

The program receives an XML file as input, parses it, and prints the elements and attributes in the DOM tree.

The steps provide reference to tables that provide possible methods and interfaces you can use at that point.

Create a DOMParser object by calling the DOMParser() constructor. You can use this parser to parse input XML data documents as well as DTDs. The following code fragment from DOMSample.java illustrates this technique:

DOMParser parser = new DOMParser();

Configure parser properties. See Table 4-5.

The following code fragment from DOMSample.java specifies the error output stream, sets the validation mode to DTD validation, and enables warning messages:

parser.setErrorStream(System.err);
parser.setValidationMode(DOMParser.DTD_VALIDATION);
parser.showWarnings(true);

Parse the input XML document by invoking the parse() method. The program builds a tree of Node objects in memory.

This code fragment from DOMSample.java shows how to parse an instance of the java.net.URL class:

parser.parse(url);

Note that the XML input can be a file, string buffer, or URL. As illustrated by the following code fragment, DOMSample.java accepts a filename as a parameter and calls the createURL helper method to construct a URL object that can be passed to the parser:

public class DOMSample
{
   static public void main(String[] argv)
   {
      try
      {
         if (argv.length != 1)
         {
            // Must pass in the name of the XML file.
            System.err.println("Usage: java DOMSample filename");
            System.exit(1);
         }
         ...
         // Generate a URL from the filename.
         URL url = DemoUtil.createURL(argv[0]);
         ...

Invoke getDocument() to obtain a handle to the root of the in-memory DOM tree, which is an XMLDocument object. You can use this handle to access every part of the parsed XML document. The XMLDocument class implements the interfaces shown in Table 4-6.

This code fragment from DOMSample.java illustrates this technique:

XMLDocument doc = parser.getDocument();

Obtain and manipulate DOM nodes of the retrieved document by calling various XMLDocument methods. See Table 4-7.

The following code fragment from DOMSample.java uses the DOMParser.print() method to print the elements and attributes of the DOM tree:

System.out.print("The elements are: ");
printElements(doc);

System.out.println("The attributes of each element are: ");
printElementAttributes(doc);

The program implements the printElements() method, which calls getElementsByTagName() to obtain a list of all the elements in the DOM tree. It then loops through each item in the list and calls getNodeName() to print the name of each element:

static void printElements(Document doc)
{
   NodeList nl = doc.getElementsByTagName("*");
   Node n;

   for (int i=0; i<nl.getLength(); i++)
   {
      n = nl.item(i);
      System.out.print(n.getNodeName() + " ");
   }

   System.out.println();
}

The program implements the printElementAttributes() method, which calls Document.getElementsByTagName() to obtain a list of all the elements in the DOM tree. It then loops through each element in the list and calls Element.getAttributes() to obtain the list of attributes for the element. It then calls Node.getNodeName() to obtain the attribute name and Node.getNodeValue() to obtain the attribute value:

static void printElementAttributes(Document doc)
{
   NodeList nl = doc.getElementsByTagName("*");
   Element e;
   Node n;
   NamedNodeMap nnm;

   String attrname;
   String attrval;
   int i, len;

   len = nl.getLength();

   for (int j=0; j < len; j++)
   {
      e = (Element)nl.item(j);
      System.out.println(e.getTagName() + ":");
      nnm = e.getAttributes();

      if (nnm != null)
      {
         for (i=0; i<nnm.getLength(); i++)
         {
            n = nnm.item(i);
            attrname = n.getNodeName();
            attrval = n.getNodeValue();
            System.out.print(" " + attrname + " = " + attrval);
         }
      }
      System.out.println();
   }
}

Reset the parser state by invoking the reset() method. The parser is now ready to parse a new document.

Useful Methods and Interfaces

The following tables provide useful methods and interfaces to use in creating an application such as the one just created in "Performing Basic DOM Parsing".

Table 4-5 lists useful configuration methods.

Table 4-5 DOMParser Configuration Methods

Method
Use this method to . . .

setBaseURL()

Set the base URL for loading external entities and DTDs. Call this method if the XML document is an InputStream.

setDoctype()

Specify the DTD to use when parsing.

setErrorStream()

Create an output stream for the output of errors and warnings.

setPreserveWhitespace()

Instruct the parser to preserve the whitespace in the input XML document.

setValidationMode()

Set the validation mode of the parser. Table 4-1 describes the flags that you can use with this method.

showWarnings()

Specify whether the parser should print warnings.

Table 4-6 lists the interfaces that the XMLDocument class implements.

Table 4-6 Some Interfaces Implemented by XMLDocument

Interface
Defines . . .

org.w3c.dom.Node

A single node in the document tree and methods to access and process the node.

org.w3c.dom.Document

A Node that represents the entire XML document.

org.w3c.dom.Element

A Node that represents an XML element.

Table 4-7 lists some useful methods for obtaining nodes.

Table 4-7 Useful XMLDocument Methods

Method
Use this method to . . .

getAttributes()

Generate a NamedNodeMap containing the attributes of this node (if it is an element) or null otherwise.

getElementsbyTagName()

Retrieve recursively all elements that match a given tag name under a certain level. This method supports the * tag, which matches any tag. Call getElementsByTagName("*") through the handle to the root of the document to generate a list of all elements in the document.

getExpandedName()

Obtain the expanded name of the element. This method is specified in the NSName interface.

getLocalName()

Obtain the local name for this element. If an element name is <E1:locn xmlns:E1="http://www.oracle.com/"/>, then locn is the local name.

getNamespaceURI()

Obtain the namespace URI of this node, or null if it is unspecified. If an element name is <E1:locn xmlns:E1="http://www.oracle.com/"/>, then http://www.oracle.com is the namespace URI.

getNodeName()

Obtain the name of a node in the DOM tree.

getNodeValue()

Obtain the value of this node, depending on its type. This mode is in the Node interface.

getPrefix()

Obtain the namespace prefix for an element.

getQualifiedName()

Obtain the qualified name for an element. If an element name is <E1:locn xmlns:E1="http://www.oracle.com/"/>, then E1:locn is the qualified name..

getTagName()

Obtain the name of an element in the DOM tree.

Creating Scalable DOM

This section discusses how to create and use a scalable DOM.

This section contains the following topics:

Using Pluggable DOM

Using Lazy Materialization

Using Configurable DOM Settings

Scalable DOM Applications

Using Pluggable DOM

Pluggable DOM has the DOM API split from the data. The underlying data can be either internal or plug-in, and both can be in binary XML.

Internal Data

To plug in internal data (XML text that has not been parsed), the XML text must be saved as binary XML, then parsed by the DOMParser. The parsed binary XML can be then be plugged into the InfoSetReader of the DOM API layer.

The InfosetReader argument is the interface to the underlying XML data.

Plug-in Data

Plug-in data is data that has already been parsed and therefore can be transferred from one processor to another without requiring parsing.

To create a pluggable DOM, XML data is plugged in through the InfosetReader interface on an XMLDOMImplementation object, for example:

public Document createDocument(InfosetReader reader) throws DOMException

The InfosetReader API is implemented on top of the XDK BinXMLStream. Optional adaptors for other forms of XML data such as DOM4J, JDOM, or JDBC may also be supported. Users can also plug in their own implementations.

InfosetReader serves as the interface between the scalable DOM API layer and the underlying data. It is a generic, stream-based pull API that accesses XML data. The InfosetReader retrieves sequential events from the XML stream and queries the state and data from these events. In the following example, the XML data is scanned to retrieve the QNames and attributes of all elements:

InfosetReader reader;
While (reader.hasNext())
{
   reader.next();
   if (reader.getEventType() == START_ELEMENT)
   {
        QName name = reader.getQName();
        TypedAttributeList attrList = reader.getAttributeList();
     }
}

InfosetReader Options

The InfosetReader interface supports the following functionality:

Copying: To support shadow copy of DOM across documents, a new copy of InfosetReader can be created to ensure thread safety, using the Clone method. An InfosetReader obtained from BinXMLStream always supports this (Optional).

See Also:

"Using Shadow Copy"

Moving Focus: To support lazy materialization, the InfosetReader may have the ability to move focus to any location specified by Offset (Optional).

If (reader.hasSeekSupport())
   reader.seek(offset);

See Also:

"Using Lazy Materialization"

InfosetWriter

InfosetWriter is an extension of the InfosetReader interface that supports data writing. XDK provides an implementation on top of binary XML. Users cannot modify this implementation.

Saving XML Text as Binary XML

To create a scalable DOM from XML text, you must save the XML text as binary XML, before you can run DOMParser on it. You can save the XML text as either of the following:

Binary XML

References to binary XML: You can save the section reference of binary XML instead of actual data, if you know that the data source is available for deserialization.

The following example illustrates how to save as binary XML.

XMLDocument doc;
InfosetWriter writer;
doc.save(writer, false);
writer.close();

To save as references to binary XML, use true as the argument for the save command.

See Also:

Chapter 5, "Using Binary XML for Java"

Using Lazy Materialization

Using lazy materialization, you can plug in an empty DOM, which can pull in more data when needed and free nodes when they are no longer needed.

Pulling Data on Demand

The plug-in DOM architecture creates an empty DOM, which contains a single Document node as the root of the tree. The rest of the DOM tree can be expanded later if it is accessed. A node may have unexpanded child and sibling nodes, but its parent and ancestors are always expanded. Each node maintains the InfoSetReader.Offset property of the next node so that the DOM can pull data additional to create the next node.

Depending on the access method type, DOM nodes may expand more than the set of nodes returned:

DOM Navigation

The DOM navigation interface allows access to neighboring nodes such as first child, last child, parent, previous or next sibling. If node creation is needed, it is always done in document order.

ID Indexing

A DTD or XML schema can specify nodes with the type ID. If the DOM supports ID indexing, those nodes can be directly retrieved using the index. In the case of scalable DOM, retrieval by index does not cause the expansion of all previous nodes, but their ancestor nodes are materialized.

XPath Expressions

XPath evaluation can cause materialization of all intermediate nodes in memory. For example, the descendent axis '//' results in the expansion of the whole subtree, although some nodes might be released after evaluation.

Freeing Nodes When No Longer Needed

Scalable DOM supports either manual or automatic dereferencing of nodes:

Automatic Dereferencing Using Weak References

To enable automatic dereferencing, set PARTIAL_DOM attribute to Boolean.TRUE.

Supporting DOM navigation requires adding cross references among nodes. In automatic dereferencing mode, some of the links are weak references, which can be freed during garbage collection.

Node release is based on the importance of the links: Links to parent nodes cannot be dropped because ancestors provide context for in-scope namespaces and it is difficult to retrieve dropped parent nodes using streaming APIs such as InfosetReader.

The scalable DOM always holds its parent and previous sibling strongly but holds its children and following sibling weakly. When the Java Virtual Machine frees the nodes, references to them are still available in the underlying data so they can be recreated if needed.

Manual Dereferencing:

To enable manual dereferencing, set the attribute PARTIAL_DOM to Boolean.FALSE and create the DOM with plug-in XML data.

In this mode, the DOM depends on the application to explicitly dereference a document fragment from the whole tree. There are no weak references. It is recommended that if an application has a deterministic order of processing the data, to avoid the extra overhead of repeatedly releasing and recreating nodes.

To dereference a node from all other nodes, call freeNode() on it. For example:

Element root = doc.getDocumentElement();
 Node item = root.getFirstChild();
While (item != null)
{
     processItem(item);
     Node tmp = item;
     item = item.getNextSibling();
     ((XMLNode)tmp).freeNode();
}

The freeNode call has no effect on a non-scalable DOM.

Note that dereferencing nodes is different from removing nodes from a DOM tree. The DOM tree does not change when freeNode is called on a DOM node. The node can still be accessed and recreated from its parent, previous, and following siblings. However, a variable that holds the node will throw an error when accessing the node after the node has been freed.

Using Shadow Copy

With shadow copy, the data underneath can be shared to avoid data replications

Cloning, a common operation in XML processing, can be done lazily with pluggable DOM.

When the copy method is used, it creates just the root node of the fragment being copied, and the subtree can be expanded on demand.

Data sharing is for the underlying data, not the DOM nodes themselves. The DOM specification requires that the clone and its original have different node identities, and that they have different parent nodes.

Incorporating DOM Updates

The DOM API supports update operations such as adding, deleting nodes, setting, deleting, changing, and inserting values. When a DOM is created by plugging in XML data, the underlying data is considered external to the DOM. DOM updates are visible from the DOM APIs but the data source remains the same. Normal update operations are available and do not interfere with each other.

To make a modified DOM persistent, you must explicitly save the DOM. This merges all the changes with the original data and serializes the data in persistent storage. If you do not save a modified DOM explicitly, the changes are lost once the transaction ends.

Using the PageManager Interface to Support Internal Data

When XML text is parsed with DOMParser and configured to create a scalable DOM, internal data is cached in the form of binary XML, and the DOM API layer is built on top of the internal data. This provides increased scalability, because the binary XML is more compact than DOM nodes.

For additional scalability, the scalable DOM can use backend storage for binary data through the PageManager interface. Then, binary data can be swapped out of memory when not in use.

This code example illustrates how to use the PageManager interface.

DOMParser parser = new DOMParser();
parser.setAttribute(PARTIAL_DOM, Boolean.TRUE); //enable scalable DOM
parser.setAttribute(PAGE_MANAGER, new FilePageManager("pageFile"));
...
// DOMParser other configuration
parser.parse(fileURL);
XMLDocument doc = parser.getDocument();

If the PageManager interface is not used, then the parser caches the whole document as binary XML.

Using Configurable DOM Settings

When you create a DOM with the XMLDOMImplementation class, you can configure the DOM to suit different applications and achieve maximum efficiency, using the setAttribute method in the XMLDOMImplementation class.

public void setAttribute(String name, Object value) throws IllegalArgumentException

For scalable DOM, call setAttribute for the PARTIAL_DOM and ACCESS_MODE attributes.

Note:

New attribute values always affect the next DOM, not the current one, so an instance of XMLDOMImplementation can be used to create DOMs with different configurations.

PARTIAL_DOM

This attribute indicates whether the DOM is scalable (partial), and whether it takes a Boolean value. DOM creation is scalable when the attribute is set to TRUE and nodes that are not in use are freed and recreated when needed. DOM creation is not scalable when the attribute is set to FALSE or is not set.

ACCESS_MODE

This attribute controls the access of the DOM and applies to both scalable DOM and non-scalable DOM. It has the following values:

UPDATEABLE

The DOM supports all DOM update operations.

UPDATEABLE is the default value for the ACCESS_MODE attribute, in order to maintain backward compatibility with the XDK DOM implementation.

READ_ONLY

DOM can only read this.

Any attempt to modify the DOM tree results in an error, but node creation such as cloning is allowed, as long as the new nodes are not added to the DOM tree.

FORWARD_READ

This value allows forward navigation, such as getFirstChild().getNextSibling(), and getLastChild(), but not backward access, such as getPreviousSibling().

FORWARD_READ can still access parent and ancestor nodes.

STREAMING

DOM access is limited to the stream of nodes in Document Order, similar to SAX-event access.

Following the concept of current node in stream mode, the current node is the last node that has been accessed in document order. Applications can hold nodes in variables and revisit them, but using the DOM method to access any node before the current node causes a DOM error. However, accessing ancestor nodes and attribute nodes is always allowed.

The following illustrates the DOM behavior in stream mode:

Node parent = currentNode.getParentNode(); // OK although parent is before current node

Node child = parent.getFirstChild(); // Error if the current node is not the first child of parent!

Attribute attr = parent.getFirstAttribute();// OK accessing attributes from Element is always //allowed

The following lists the access modes from less restrictive to more restrictive.

UPDATEABLE > READ_ONLY > FORWARD_READ > STREAM_READ

Performance Advantages to Configurable DOM Settings

DOM cannot be modified in READ_ONLY mode, so the whole write buffer is not needed.

DOM does not read backward in FORWARD_READ mode, except to the ancestor node. Therefore, the previous sibling link is not created.

DOM only maintains parent links and does not need to remember data location for a node in STREAM_READ mode. Therefore, it does not need to recreate any node that has been freed.

Scalable DOM Applications

Here is an application that creates and uses a scalable, pluggable DOM:

XMLDOMImplementation domimpl = new XMLDOMImplementation();
domimpl.setAttribute(XMLDocument.SCALABLE_DOM, Boolean.TRUE);
domimpl.setAttribute(XMLDocument.ACCESS_MODE,XMLDocument.UPDATEABLE);
XMLDocument scalableDoc = (XMLDocument) domimpl.createDocument(reader);

Here is an application that creates and uses a scalable, pluggable DOM based on binary XML, which is described in Chapter 5, "Using Binary XML for Java":

BinXMLProcessor proc = BinXMLProcessorFactory.createProcessor();
BinXMLStream bstr = proc.createBinXMLStream();
BinXMLEncoder enc = bstr.getEncoder();
enc.setProperty(BinXMLEncoder.ENC_SCHEMA_AWARE, false);

SAXParser parser = new SAXParser();
parser.setContentHandler(enc.getContentHandler());
parser.setErrorHandler(enc.getErrorHandler());
parser.parse(BinXMLUtil.createURL(xmlfile));

BinXMLDecoder dec = bstr.getDecoder();
InfosetReader reader = dec.getReader();
XMLDOMImplementation domimpl = new XMLDOMImplementation();
domimpl.setAttribute(XMLDocument.SCALABLE_DOM, Boolean.TRUE);
XMLDocument currentDoc = (XMLDocument) domimpl.createDocument(reader);

Performing DOM Operations with Namespaces

The DOM2Namespace.java program illustrates a simple use of the parser and namespace extensions to the DOM APIs. The program receives an XML document, parses it, and prints the elements and attributes in the document.

The initial four steps of the "Performing Basic DOM Parsing", from parser creation to the getDocument() call, are basically the same as for DOM2Namespace.java. The principal difference is in printing the DOM tree, which is step 5. The DOM2Namespace.java program does the following instead:

// Print document elements
printElements(doc);

// Print document element attributes
System.out.println("The attributes of each element are: ");
printElementAttributes(doc);

The printElements() method implemented by DOM2Namespace.java calls getElementsByTagName() to obtain a list of all the elements in the DOM tree. It then loops through each item in the list and casts each Element to an nsElement. For each nsElement it calls nsElement.getPrefix() to get the namespace prefix, nsElement.getLocalName() to get the local name, and nsElement.getNamespaceURI() to get the namespace URI:

static void printElements(Document doc)
{
   NodeList nl = doc.getElementsByTagName("*");
   Element nsElement;
   String prefix;
   String localName;
   String nsName;

   System.out.println("The elements are: ");
   for (int i=0; i < nl.getLength(); i++)
   {
      nsElement = (Element)nl.item(i);

      prefix = nsElement.getPrefix();
      System.out.println("  ELEMENT Prefix Name :" + prefix);

      localName = nsElement.getLocalName();
      System.out.println("  ELEMENT Local Name    :" + localName);

      nsName = nsElement.getNamespaceURI();
      System.out.println("  ELEMENT Namespace     :" + nsName);
   }
   System.out.println();
}

The printElementAttributes() method calls Document.getElementsByTagName() to obtain a NodeList of the elements in the DOM tree. It then loops through each element and calls Element.getAttributes() to obtain the list of attributes for the element as special list called a NamedNodeMap. For each item in the attribute list it calls nsAttr.getPrefix() to get the namespace prefix, nsAttr.getLocalName() to get the local name, and nsAttr.getValue() to obtain the value:

static void printElementAttributes(Document doc)
{
   NodeList nl = doc.getElementsByTagName("*");
   Element e;
   Attr nsAttr;
   String attrpfx;
   String attrname;
   String attrval;
   NamedNodeMap nnm;
   int i, len;

   len = nl.getLength();

   for (int j=0; j < len; j++)
   {
      e = (Element) nl.item(j);
      System.out.println(e.getTagName() + ":");

      nnm = e.getAttributes();

      if (nnm != null)
      {
         for (i=0; i < nnm.getLength(); i++)
         {
            nsAttr = (Attr) nnm.item(i);

            attrpfx = nsAttr.getPrefix();
            attrname = nsAttr.getLocalName();
            attrval = nsAttr.getNodeValue();

            System.out.println(" " + attrpfx + ":" + attrname + " = "
                               + attrval);
         }
      }
      System.out.println();
   }
}

Performing DOM Operations with Events

The EventSample.java program shows how to register various events with an event listener. For example, if a node is added to a specified DOM element, an event is triggered, which causes the listener to print information about the event.

The program follows these steps:

Instantiate an event listener. When a registered change triggers an event, this event is passed to the event listener, which handles it. The following code fragment from EventSample.java shows the implementation of the listener:

eventlistener evtlist = new eventlistener();
...
class eventlistener implements EventListener
{
   public eventlistener(){}
   public void handleEvent(Event e)
   {
      String s = " Event "+e.getType()+" received " + "\n";
      s += " Event is cancelable :"+e.getCancelable()+"\n";
      s += " Event is bubbling event :"+e.getBubbles()+"\n";
      s += " The Target is " + ((Node)(e.getTarget())).getNodeName() + "\n\n";
      System.out.println(s);
   }
}

Instantiate a new XMLDocument and then call getImplementation() to retrieve a DOMImplementation object. You can call the hasFeature() method to determine which features are supported by this implementation. The following code fragment from EventSample.java illustrates this technique:

XMLDocument doc1 = new XMLDocument();
DOMImplementation impl = doc1.getImplementation();

System.out.println("The impl supports Events "+
                   impl.hasFeature("Events", "2.0"));
System.out.println("The impl supports Mutation Events "+
                   impl.hasFeature("MutationEvents", "2.0"));

Register desired events with the listener. The following code fragment from EventSample.java registers three events on the document node:

doc1.addEventListener("DOMNodeRemoved", evtlist, false);
doc1.addEventListener("DOMNodeInserted", evtlist, false);
doc1.addEventListener("DOMCharacterDataModified", evtlist, false);

The following code fragment from EventSample.java creates a node of type XMLElement and then registers three events on this node:

XMLElement el = (XMLElement)doc1.createElement("element");
...
el.addEventListener("DOMNodeRemoved", evtlist, false);
el.addEventListener("DOMNodeRemovedFromDocument", evtlist, false);
el.addEventListener("DOMCharacterDataModified", evtlist, false);
...

Perform actions that trigger events, which are then passed to the listener for handling. The following code fragment from EventSample.java illustrates this technique:

att.setNodeValue("abc");
el.appendChild(el1);
el.appendChild(text);
text.setNodeValue("xyz");
doc1.removeChild(el);

Performing DOM Operations with Ranges

According to the W3C DOM specification, a range identifies a range of content in a Document, DocumentFragment, or Attr. It selects the content between a pair of boundary-points that correspond to the start and the end of the range. Table 4-8 describes useful range methods accessible through XMLDocument.

Table 4-8 Useful Methods in the Range Class

Method
Description

cloneContents()

Duplicates the contents of a range

deleteContents()

Deletes the contents of a range

getCollapsed()

Returns TRUE is the range is collapsed

getEndContainer()

Obtains the node within which the range ends

getStartContainer()

Obtains the node within which the range begins

selectNode()

Selects a node and its contents

selectNodeContents()

Selects the contents within a node

setEnd()

Sets the attributes describing the end of a range

setStart()

Sets the attributes describing the beginning of a range

The DOMRangeSample.java program illustrates some of the things that you can do with ranges.

The initial four steps of the "Performing Basic DOM Parsing", from parser creation to the getDocument() call, are the same as for DOMRangeSample.java. The DOMRangeSample.java program then proceeds by following these steps:

After calling getDocument() to create the XMLDocument, create a range object with createRange() and call setStart() and setEnd() to set its boundaries. The following code fragment from DOMRangeSample.java illustrates this technique:

XMLDocument doc = parser.getDocument();
...
Range r = (Range) doc.createRange();
XMLNode c = (XMLNode) doc.getDocumentElement();

// set the boundaries
r.setStart(c,0);
r.setEnd(c,1);

Call XMLDocument methods to obtain information about the range and manipulate its contents. Table 4-8 describes useful methods. The following code fragment from DOMRangeSample.java selects the contents of the current node and prints it:

r.selectNodeContents(c);
System.out.println(r.toString());

The following code fragment clones a range contents and prints it:

XMLDocumentFragment df =(XMLDocumentFragment) r.cloneContents();
df.print(System.out);

The following code fragment obtains and prints the start and end containers for the range:

c = (XMLNode) r.getStartContainer();
System.out.println(c.getText());
c = (XMLNode) r.getEndContainer();
System.out.println(c.getText());

Only some of the features of the demo program are described in this section. For more detail, refer to the demo program itself.

Performing DOM Operations with TreeWalker

The W3C DOM Level 2 Traversal and Range specification defines the NodeFilter and TreeWalker interfaces. The XDK includes implementations of these interfaces.

A node filter is an object that can filter out certain types of Node objects. For example, it can filter out entity reference nodes but accept element and attribute nodes. You create a node filter by implementing the NodeFilter interface and then passing a Node object to the acceptNode() method. Typically, the acceptNode() method implementation calls getNodeType() to obtain the type of the node and compares it to static variables such as ELEMENT_TYPE, ATTRIBUTE_TYPE, and so forth, and then returns one of the static fields in Table 4-9 based on what it finds.

Table 4-9 Static Fields in the NodeFilter Interface

Method
Description

FILTER_ACCEPT

Accept the node. Navigation methods defined for NodeIterator or TreeWalker will return this node.

FILTER_REJECT

Rejects the node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For TreeWalker, the children of this node will also be rejected. NodeIterators treat this as a synonym for FILTER_SKIP.

FILTER_SKIP

Skips this single node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For both NodeIterator and TreeWalker, the children of this node will still be considered.

You can use TreeWalker objects to traverse a document tree or subtree using the view of the document defined by their whatToShow flags and filters (if any). You can use the XMLDocument.createTreeWalker() method to create a TreeWalker object by specifying the following:

A root node for the tree

A flag that governs the type of nodes it should include in the logical view

A filter for filtering nodes

A flag that determines whether entity references and their descendents should be included

Table 4-10 describes useful methods in the org.w3c.dom.traversal.TreeWalker interface.

Table 4-10 Useful Methods in the TreeWalker Interface

Method
Description

firstChild()

Moves the tree walker to the first visible child of the current node and returns the new node. If the current node has no visible children, then it returns null and retains the current node.

getRoot()

Obtains the root node of the tree walker as specified when it was created.

lastChild()

Moves the tree walker to the last visible child of the current node and returns the new node. If the current node has no visible children, then it returns null and retains the current node.

nextNode()

Moves the tree walker to the next visible node in document order relative to the current node and returns the new node.

The TreeWalkerSample.java program illustrates some of the things that you can do with node filters and tree traversals.

The initial four steps of the "Performing Basic DOM Parsing", from parser creation to the getDocument() call, are the same as for TreeWalkerSample.java. The TreeWalkerSample.java program then proceeds by following these steps:

Create a node filter object. The acceptNode() method in the nf class, which implements the NodeFilter interface, invokes getNodeType() to obtain the type of node. The following code fragment from TreeWalkerSample.java illustrates this technique:

NodeFilter n2 = new nf();
...
class nf implements NodeFilter
{
  public short acceptNode(Node node)
  {
    short type = node.getNodeType();

    if ((type == Node.ELEMENT_NODE) || (type == Node.ATTRIBUTE_NODE))
       return FILTER_ACCEPT;
    if ((type == Node.ENTITY_REFERENCE_NODE))
       return FILTER_REJECT;
    return FILTER_SKIP;
  }
}

Invoke the XMLDocument.createTreeWalker() method to create a tree walker. The following code fragment from TreeWalkerSample.java uses the root node of the XMLDocument as the root node of the tree walker and includes all nodes in the tree:

XMLDocument doc = parser.getDocument();
...
TreeWalker tw = doc.createTreeWalker(doc.getDocumentElement(),NodeFilter.SHOW_ALL,n2,true);

Obtain the root element of the TreeWalker object. The following code fragment illustrates this technique:

XMLNode nn = (XMLNode)tw.getRoot();

Traverse the tree. The following code fragment illustrates how to walk the tree in document order by calling the TreeWalker.nextNode() method:

while (nn != null)
{
  System.out.println(nn.getNodeName() + " " + nn.getNodeValue());
  nn = (XMLNode)tw.nextNode();
}

The following code fragment illustrates how to walk the tree the left depth of the tree by calling the firstChild() method (you can traverse the right depth of the tree by calling the lastChild() method):

 while (nn != null)
 {
   System.out.println(nn.getNodeName() + " " + nn.getNodeValue());
   nn = (XMLNode)tw.firstChild();
 }

Only some of the features of the demo program are described in this section. For more detail, refer to the demo program itself.

Parsing XML with SAX

SAX is a standard interface for event-based XML parsing. This section contains the following topics:

Using the SAX API

Performing Basic SAX Parsing

Performing Basic SAX Parsing with Namespaces

Performing SAX Parsing with XMLTokenizer

Using the SAX API

The SAX API, which is released in a Level 1 and Level 2 versions, is a set of interfaces and classes. We can divide the API into the following categories:

Interfaces implemented by the Oracle XML parser.

Interfaces that you must implement in your application. The SAX 2.0 interfaces are listed in Table 4-11.

Table 4-11 SAX2 Handler Interfaces

Interface
Description

ContentHandler

Receives notifications from the XML parser. The major event-handling methods are startDocument(), endDocument(), startElement(), and endElement() when it recognizes an XML tag. This interface also defines the methods characters() and processingInstruction(), which are invoked when the parser encounters the text in an XML element or an inline processing instruction.

DeclHandler

Receives notifications about DTD declarations in the XML document.

DTDHandler

Processes notations and unparsed (binary) entities.

EntityResolver

Needed to perform redirection of URIs in documents. The resolveEntity() method is invoked when the parser must identify data identified by a URI.

ErrorHandler

Handles parser errors. The program invokes the methods error(), fatalError(), and warning() in response to various parsing errors.

LexicalHandler

Receives notifications about lexical information such as comments and CDATA section boundaries.

Standard SAX classes.

Additional Java classes in org.xml.sax.helper. The SAX 2.0 helper classes are as follows:

AttributeImpl, which makes a persistent copy of an AttributeList

DefaultHandler, which is a base class with default implementations of the SAX2 handler interfaces listed in Table 4-11

LocatorImpl, which makes a persistent snapshot of a Locator's values at specified point in the parse

NamespaceSupport, which adds support for XML namespaces

XMLFilterImpl, which is a base class used by applications that need to modify the stream of events

XMLReaderFactory, which supports loading SAX parsers dynamically

Demonstration classes in the nul package.

Figure 4-5 illustrates how to create a SAX parser and use it to parse an input document.

Figure 4-5 Using the SAXParser Class

This graphic is described in the surrounding text.
Description of "Figure 4-5 Using the SAXParser Class"

The basic stages for parsing an input XML document with SAX are as follows:

Create a SAXParser object and configure its properties (see Table 4-5 for useful property methods). For example, set the validation mode of the parser.

Instantiate an event handler. The program should provide implementations of the handler interfaces in Table 4-11.

Register the event handlers with the parser. You must register your event handlers with the parser so that it knows which methods to invoke when a given event occurs. Table 4-12 lists registration methods available in SAXParser.

Table 4-12 SAXParser Methods for Registering Event Handlers

Method
Use this method to . . .

setContentHandler()

Register a content event handler with an application. The org.xml.sax.DefaultHandler class implements the org.xml.sax.ContentHandler interface. Applications can register a new or different handler in the middle of a parse; the SAX parser must begin using the new handler immediately.

setDTDHandler()

Register a DTD event handler. If the application does not register a DTD handler, all DTD events reported by the SAX parser are silently ignored. Applications may register a new or different handler in the middle of a parse; the SAX parser must begin using the new handler immediately.

setErrorHandler()

Register an error event handler with an application. If the application does not register an error handler, all error events reported by the SAX parser are silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs. Applications may register a new or different handler in the middle of a parse; the SAX parser must begin using the new handler immediately.

setEntityResolver()

Register an entity resolver with an application. If the application does not register an entity resolver, the XMLReader performs its own default resolution. Applications may register a new or different resolver in the middle of a parse; the SAX parser must begin using the new resolver immediately.

Parse the input document with the SAXParser.parse() method. All SAX interfaces are assumed to be synchronous: the parse method must not return until parsing is complete. Readers must wait for an event-handler callback to return before reporting the next event.

When the SAXParser.parse() method is called, the program invokes one of several callback methods implemented in the application. The methods are defined by the ContentHandler, ErrorHandler, DTDHandler, and EntityResolver interfaces implemented in the event handler. For example, the application can call the startElement() method when a start element is encountered.

Performing Basic SAX Parsing

The SAXSample.java program illustrates the basic steps of SAX parsing. The SAXSample class extends HandlerBase. The program receives an XML file as input, parses it, and prints information about the contents of the file.

The program follows these steps:

Store the Locator. The Locator associates a SAX event with a document location. The SAX parser provides location information to the application by passing a Locator instance to the setDocumentLocator() method in the content handler. The application can use the object to obtain the location of any other content handler event in the XML source document. The following code fragment from SAXSample.java illustrates this technique:

Locator locator;

Instantiate a new event handler. The following code fragment from SAXSample.java illustrates this technique:

SAXSample sample = new SAXSample();

Instantiate the SAX parser and configure it. The following code fragment from SAXSample.java sets the mode to DTD validation:

Parser parser = new SAXParser();
((SAXParser)parser).setValidationMode(SAXParser.DTD_VALIDATION);

Register event handlers with the SAX parser. You can use the registration methods in the SAXParser class, but you must implement the handler interfaces yourself. The following code fragment registers the handlers:

parser.setDocumentHandler(sample);
parser.setEntityResolver(sample);
parser.setDTDHandler(sample);
parser.setErrorHandler(sample);

The following code shows some of the DocumentHandler interface implementation:

public void setDocumentLocator (Locator locator)
{
  System.out.println("SetDocumentLocator:");
  this.locator = locator;
}
public void startDocument()
{
  System.out.println("StartDocument");
}
public void endDocument() throws SAXException
{
  System.out.println("EndDocument");
}
public void startElement(String name, AttributeList atts)
                                               throws SAXException
{
  System.out.println("StartElement:"+name);
  for (int i=0;i<atts.getLength();i++)
  {
    String aname = atts.getName(i);
    String type = atts.getType(i);
    String value = atts.getValue(i);
    System.out.println("   "+aname+"("+type+")"+"="+value);
  }
}
...

The following code shows the EntityResolver interface implementation:

public InputSource resolveEntity (String publicId, String systemId)
                      throws SAXException
{
  System.out.println("ResolveEntity:"+publicId+" "+systemId);
  System.out.println("Locator:"+locator.getPublicId()+" locator.getSystemId()+
                    " "+locator.getLineNumber()+" "+locator.getColumnNumber());
  return null;
}

The following code shows the DTDHandler interface implementation:

public void notationDecl (String name, String publicId, String systemId)
{
  System.out.println("NotationDecl:"+name+" "+publicId+" "+systemId);
}
public void unparsedEntityDecl (String name, String publicId,
                                String systemId, String notationName)
{
  System.out.println("UnparsedEntityDecl:"+name + " "+publicId+" "+
                      systemId+" "+notationName);
}

The following code shows the ErrorHandler interface implementation:

public void warning (SAXParseException e)
           throws SAXException
{
  System.out.println("Warning:"+e.getMessage());
}
public void error (SAXParseException e)
           throws SAXException
{
  throw new SAXException(e.getMessage());
}
public void fatalError (SAXParseException e)
          throws SAXException
{
  System.out.println("Fatal error");
  throw new SAXException(e.getMessage());
}

Parse the input XML document. The following code fragment converts the document to a URL and then parses it:

parser.parse(DemoUtil.createURL(argv[0]).toString());

Performing Basic SAX Parsing with Namespaces

This section discusses the SAX2Namespace.java sample program, which implements an event handler named XMLDefaultHandler as a subclass of the org.xml.sax.helpers.DefaultHandler class. The easiest way to implement the ContentHandler interface is to extend the org.xml.sax.helpers.DefaultHandler class. The DefaultHandler class provides some default behavior for handling events, although typically the behavior is to do nothing.

The SAX2Namespace.java program overrides methods for only the events that it cares about. Specifically, the XMLDefaultHandler class implements only two methods: startElement() and endElement(). The startElement event is triggered whenever SAXParser encounters a new element within the XML document. When this event is triggered, the startElement() method prints the namespace information for the element.

The SAX2Namespace.java sample program follows these steps:

Instantiate a new event handler of type DefaultHandler. The following code fragment illustrates this technique:

DefaultHandler defHandler = new XMLDefaultHandler();

Create a SAX parser and set its validation mode. The following code fragment from SAXSample.java sets the mode to DTD validation:

Parser parser = new SAXParser();
((SAXParser)parser).setValidationMode(SAXParser.DTD_VALIDATION);

Register event handlers with the SAX parser. The following code fragment registers handlers for the input document, the DTD, entities, and errors:

parser.setContentHandler(defHandler);
parser.setEntityResolver(defHandler);
parser.setDTDHandler(defHandler);
parser.setErrorHandler(defHandler);

The following code shows the XMLDefaultHandler implementation. The startElement() and endElement() methods print the qualified name, local name, and namespace URI for each element (refer to Table 4-7 for an explanation of these terms):

class XMLDefaultHandler extends DefaultHandler
{
   public void XMLDefaultHandler(){}
   public void startElement(String uri, String localName,
                            String qName, Attributes atts)
   throws SAXException
   {
      System.out.println("ELEMENT Qualified Name:" + qName);
      System.out.println("ELEMENT Local Name    :" + localName);
      System.out.println("ELEMENT Namespace     :" + uri);

      for (int i=0; i<atts.getLength(); i++)
      {
         qName = atts.getQName(i);
         localName = atts.getLocalName(i);
         uri = atts.getURI(i);

         System.out.println(" ATTRIBUTE Qualified Name   :" + qName);
         System.out.println(" ATTRIBUTE Local Name       :" + localName);
         System.out.println(" ATTRIBUTE Namespace        :" + uri);

         // You can get the type and value of the attributes either
         // by index or by the Qualified Name.

         String type = atts.getType(qName);
         String value = atts.getValue(qName);

         System.out.println(" ATTRIBUTE Type             :" + type);
         System.out.println(" ATTRIBUTE Value            :" + value);

         System.out.println();

      }
   }
   public void endElement(String uri, String localName,
                          String qName) throws SAXException
   {
      System.out.println("ELEMENT Qualified Name:" + qName);
      System.out.println("ELEMENT Local Name    :" + localName);
      System.out.println("ELEMENT Namespace     :" + uri);
   }
}

Parse the input XML document. The following code fragment converts the document to a URL and then parses it:

parser.parse(DemoUtil.createURL(argv[0]).toString());

Performing SAX Parsing with XMLTokenizer

You can create a simple SAX parser as a instance of the XMLTokenizer class and use the parser to tokenize the input XML. Table 4-13 lists useful methods in the class.

Table 4-13 XMLTokenizer Methods

Method
Description

setToken()

Register a new token for XML tokenizer.

setErrorStream()

Register a output stream for errors

tokenize()

Tokenizes the input XML

SAX parsers with Tokenizer features must implement the XMLToken interface. The callback method for XMLToken is token(), which receives an XML token and its corresponding value and performs an action. For example, you can implement token() so that it prints the token name followed by the value of the token.

The Tokenizer.java program accepts an XML document as input, parses it, and prints a list of the XML tokens. The program implements a doParse() method that does the following:

Create a URL from the input XML stream:

URL url = DemoUtil.createURL(arg);

Create an XMLTokenizer parser as follows:

parser  = new XMLTokenizer ((XMLToken)new Tokenizer());

Register an output error stream as follows:

parser.setErrorStream  (System.out);

Register tokens with the parser. The following code fragment from Tokenizer.java shows just some of the registered tokens:

parser.setToken (STagName, true);
parser.setToken (EmptyElemTag, true);
parser.setToken (STag, true);
parser.setToken (ETag, true);
parser.setToken (ETagName, true);
...

Tokenize the XML document as follows:

parser.tokenize (url);

The token() callback method determines the action to take when an particular token is encountered. The following code fragment from Tokenizer.java shows some of the implementation of this method:

public void token (int token, String value)
{
   switch (token)
   {
   case XMLToken.STag:
      System.out.println ("STag: " + value);
      break;
   case XMLToken.ETag:
      System.out.println ("ETag: " + value);
      break;
   case XMLToken.EmptyElemTag:
      System.out.println ("EmptyElemTag: " + value);
      break;
   case XMLToken.AttValue:
      System.out.println ("AttValue: " + value);
      break;
   ...
   default:
      break;
   }
}

Parsing XML with JAXP

JAXP enables you to use the SAX and DOM parsers and the XSLT processor in your Java program. This section contains the following topics:

Using the JAXP API

Parsing with JAXP

Performing Basic Transformations with JAXP

Using the JAXP API

The JAXP APIs, which are listed in Table 4-14, have an API structure consisting of abstract classes that provide a thin layer for parser pluggability. Oracle implemented JAXP based on the Sun Microsystems reference implementation.

Table 4-14 JAXP Packages

Package
Description

javax.xml.parsers

Provides standard APIs for DOM 2.0 and SAX 1.0 parsers. The package contains vendor-neutral factory classes that give you a SAXParser and a DocumentBuilder. DocumentBuilder creates a DOM-compliant Document object.

javax.xml.transform

Defines the generic APIs for processing XML transformation and performing a transformation from a source to a result.

javax.xml.transform.dom

Provides DOM-specific transformation APIs.

javax.xml.transform.sax

Provides SAX2-specific transformation APIs.

javax.xml.transform.stream

Provides stream- and URI- specific transformation APIs.

Using the SAX API Through JAXP

You can rely on the factory design pattern to create new SAX parser engines with JAXP. Figure 4-6 illustrates the basic process.

Figure 4-6 SAX Parsing with JAXP

Described in the following text.
Description of "Figure 4-6 SAX Parsing with JAXP"

The basic steps for parsing with SAX through JAXP are as follows:

Create a new SAX parser factory with the SAXParserFactory class.

Configure the factory.

Create a new SAX parser (SAXParser) object from the factory.

Set the event handlers for the SAX parser.

Parse the input XML documents.

Using the DOM API Through JAXP

You can rely on the factory design pattern to create new DOM document builder engines with JAXP. Figure 4-7 illustrates the basic process.

Figure 4-7 DOM Parsing with JAXP

Illustrates the basic process of DOM parsing with JAXP.
Description of "Figure 4-7 DOM Parsing with JAXP"

The basic steps for parsing with DOM through JAXP are as follows:

Create a new DOM parser factory. with the DocumentBuilderFactory class.

Configure the factory.

Create a new DOM builder (DocumentBuilder) object from the factory.

Set the error handler and entity resolver for the DOM builder.

Parse the input XML documents.

Transforming XML Through JAXP

The basic steps for transforming XML through JAXP are as follows:

Create a new transformer factory. Use the TransformerFactory class.

Configure the factory.

Create a new transformer from the factory and specify an XSLT stylesheet.

Configure the transformer.

Transform the document.

Parsing with JAXP

The JAXPExamples.java program illustrates the basic steps of parsing with JAXP. The program implements the following methods and uses them to parse and perform additional processing on XML files in the /jaxp directory:

basic()

identity()

namespaceURI()

templatesHandler()

contentHandler2contentHandler()

contentHandler2DOM()

reader()

xmlFilter()

xmlFilterChain()

The program creates URLs for the jaxpone.xml and jaxpone.xsl sample XML files and then calls the preceding methods in sequence. The basic design of the demo is as follows (to save space only the basic() method is shown):

public class JAXPExamples
{
        public static void main(String argv[])
        throws TransformerException, TransformerConfigurationException,
               IOException, SAXException, ParserConfigurationException,
               FileNotFoundException
        {
        try {
         URL xmlURL = createURL("jaxpone.xml");
         String xmlID = xmlURL.toString();
         URL xslURL = createURL("jaxpone.xsl");
         String xslID = xslURL.toString();
         //
         System.out.println("--- basic ---");
         basic(xmlID, xslID);
         System.out.println();
         ...
      } catch(Exception err) {
        err.printStackTrace();
      }
   }
   //
   public static void basic(String xmlID, String xslID)
      throws TransformerException, TransformerConfigurationException
   {
      TransformerFactory tfactory = TransformerFactory.newInstance();
      Transformer transformer = tfactory.newTransformer(new StreamSource(xslID));
      StreamSource source = new StreamSource(xmlID);
      transformer.transform(source, new StreamResult(System.out));
   }
...
}

The reader() method in JAXPExamples.java program shows a simple technique for parsing an XML document with SAX. It follows these steps:

Create a new instance of a TransformerFactory and then cast it to a SAXTransformerFactory. The application can use the SAX factory to configure and obtain SAX parser instances. For example:

TransformerFactory tfactory = TransformerFactory.newInstance();
SAXTransformerFactory stfactory = (SAXTransformerFactory)tfactory;

Create an XML reader by creating a StreamSource object from a stylesheet and passing it to the factory method newXMLFilter(). This method returns an XMLFilter object that uses the specified Source as the transformation instructions. For example:

URL xslURL = createURL("jaxpone.xsl");
String xslID = xslURL.toString();
...
StreamSource streamSource = new StreamSource(xslID);
XMLReader reader = stfactory.newXMLFilter(streamSource);

Create content handler and register it with the XML reader. The following example creates an instance of the class oraContentHandler, which is created by compiling the oraContentHandler.java program in the demo directory:

ContentHandler contentHandler = new oraContentHandler();
reader.setContentHandler(contentHandler);

The following code fragment shows some of the implementation of the oraContentHandler class:

public class oraContentHandler implements ContentHandler
{
   private static final String TRADE_MARK = "Oracle 9i ";

   public void setDocumentLocator(Locator locator)
   {
      System.out.println(TRADE_MARK + "- setDocumentLocator");
   }

   public void startDocument()
      throws SAXException
   {
      System.out.println(TRADE_MARK + "- startDocument");
   }

   public void endDocument()
      throws SAXException
   {
      System.out.println(TRADE_MARK + "- endDocument");
   }
   ...

Parse the input XML document by passing the InputSource to the XMLReader.parse() method. For example:

InputSource is = new InputSource(xmlID);
reader.parse(is);

Performing Basic Transformations with JAXP

You can use JAXP to transform any class of the interface Source into a class of the interface Result. Table 4-15 shows some sample transformations.

Table 4-15 Transforming Classes with JAXP

Use JAXP to transform this class . . .
Into this class . . .

DOMSource

DOMResult

StreamSource

StreamResult

SAXSource

SAXResult

These transformations accept the following types of input:

XML documents

stylesheets

The ContentHandler class defined in oraContentHandler.java

For example, you can use the identity() method to perform a transformation in which the output XML document is the same as the input XML document. You can use the xmlFilterChain() method to apply three stylesheets in a chain.

The basic() method shows how to perform a basic XSLT transformation. The method follows these steps:

Create a new instance of a TransformerFactory. For example:

TransformerFactory tfactory = TransformerFactory.newInstance();

Create a new XSL transformer from the factory and specify the stylesheet to use for the transformation. The following example specifies the jaxpone.xsl stylesheet:

URL xslURL = createURL("jaxpone.xsl");
String xslID = xslURL.toString();
. . .
Transformer transformer = tfactory.newTransformer(new StreamSource(xslID));

Set the stream source to the input XML document. The following fragment from the basic() method sets the stream source to jaxpone.xml:

URL xmlURL = createURL("jaxpone.xml");
String xmlID = xmlURL.toString();
. . .
StreamSource source = new StreamSource(xmlID);

Transform the document from a StreamSource to a StreamResult. The following example transforms a StreamSource into a StreamResult:

transformer.transform(source, new StreamResult(System.out));

Compressing XML

The Oracle XDK enables you to use SAX or DOM to parse XML and then write the parsed data to a compressed binary stream. You can then reverse the process and reconstruct the XML data. This section contains the following topics:

Compressing and Decompressing XML from DOM

Compressing and Decompressing XML from SAX

Compressing and Decompressing XML from DOM

The DOMCompression.java and DOMDeCompression.java programs illustrate the basic steps of DOM compression and decompression. The most important DOM compression methods are the following:

XMLDocument.writeExternal() saves the state of the object by creating a binary compressed stream with information about the object.

XMLDocument.readExternal() reads the information written in the compressed stream by the writeExternal() method and restores the object.

Compressing a DOM Object

The basic technique for serialization is create an XMLDocument by parsing an XML document, initialize an ObjectOutputStream, and then call XMLDocument.writeExternal() to write the compressed stream.

The DOMCompression.java program follows these steps:

Create a DOM parser, parse an input XML document, and obtain the DOM representation. This technique is described in "Performing Basic DOM Parsing". The following code fragment from DOMCompression.java illustrates this technique:

public class DOMCompression
{
   static OutputStream out = System.out;
   public static void main(String[] args)
   {
      XMLDocument doc = new XMLDocument();
      DOMParser parser = new DOMParser();
      try
      {
        parser.setValidationMode(XMLParser.SCHEMA_VALIDATION);
        parser.setPreserveWhitespace(false);
        parser.retainCDATASection(true);
        parser.parse(createURL(args[0]));
        doc = parser.getDocument();
        ...

Create a FileOutputStream and wrap it in an ObjectOutputStream for serialization. The following code fragment creates the xml.ser output file:

OutputStream os = new FileOutputStream("xml.ser");
ObjectOutputStream oos = new ObjectOutputStream(os);

Serialize the object to the file by calling XMLDocument.writeExternal(). This method saves the state of the object by creating a binary compressed stream with information about this object. The following statement illustrates this technique:

doc.writeExternal(oos);

Decompressing a DOM Object

The basic technique for decompression is to create an ObjectInputStream object and then call XMLDocument.readExternal() to read the compressed stream.The DOMDeCompression.java program follows these steps:

Create a file input stream for the compressed file and wrap it in an ObjectInputStream. The following code fragment from DOMDeCompression.java creates a FileInputStream from the compressed file created in the previous section:

InputStream is;
ObjectInputStream ois;
...
is = new FileInputStream("xml.ser");
ois = new ObjectInputStream(is);

Create a new XML document object to contain the decompressed data. The following code fragment illustrates this technique:

XMLDocument serializedDoc = null;
serializedDoc = new XMLDocument();

Read the compressed file by calling XMLDocument.readExternal(). The following code fragment read the data and prints it to System.out:

serializedDoc.readExternal(ois);
serializedDoc.print(System.out);

Compressing and Decompressing XML from SAX

The SAXCompression.java program illustrates the basic steps of parsing a file with SAX, writing the compressed stream to a file, and then reading the serialized data from the file. The important classes are as follows:

CXMLHandlerBase is a SAX Handler that compresses XML data based on SAX events. To use the SAX compression, implement this interface and register with the SAX parser by calling Parser.setDocumentHandler().

CXMLParser is an XML parser that regenerates SAX events from a compressed stream.

Compressing a SAX Object

The basic technique for serialization is to register a CXMLHandlerBase handler with a SAX parser, initialize an ObjectOutputStream, and then parse the input XML. The SAXCompression.java program follows these steps:

Create a FileOutputStream and wrap it in an ObjectOutputStream. The following code fragment from SAXCompression.java creates the xml.ser file:

String compFile = "xml.ser";
FileOutputStream outStream = new FileOutputStream(compFile);
ObjectOutputStream out = new ObjectOutputStream(outStream);

Create the SAX event handler. The CXMLHandlerBase class implements the ContentHandler, DTDHandler, EntityResolver, and ErrorHandler interfaces. The following code fragment illustrates this technique:

CXMLHandlerBase cxml = new CXMLHandlerBase(out);

Create the SAX parser. The following code fragment illustrates this technique:

SAXParser parser = new SAXParser();

Configure the SAX parser. The following code fragment sets the content handler and entity resolver, and also sets the validation mode:

parser.setContentHandler(cxml);
parser.setEntityResolver(cxml);
parser.setValidationMode(XMLConstants.NONVALIDATING);

Note that oracle.xml.comp.CXMLHandlerBase implements both DocumentHandler and ContentHandler interfaces, but use of the SAX 2.0 ContentHandler interface is preferred.

Parse the XML. The program writes the serialized data to the ObjectOutputStream. The following code fragment illustrates this technique:

parser.parse(url);

Decompressing a SAX Object

The basic technique for deserialization of a SAX object is to create a SAX compression parser with the CXMLParser class, set the content handler for the parser, and then parse the compressed stream.

The SAXDeCompression.java program follows these steps:

Create a SAX event handler. The SampleSAXHandler.java program creates a handler for use by SAXDeCompression.java. The following code fragment from SAXDeCompression.java creates handler object:

SampleSAXHandler xmlHandler = new SampleSAXHandler();

Create the SAX parser by instantiating the CXMLParser class. This class implements the regeneration of XML documents from a compressed stream by generating SAX events from them. The following code fragment illustrates this technique:

CXMLParser parser = new CXMLParser();

Set the event handler for the SAX parser. The following code fragment illustrates this technique:

parser.setContentHandler(xmlHandler);

Parse the compressed stream and generates the SAX events. The following code receives a filename from the command line and parses the XML:

parser.parse(args[0]);

Tips and Techniques for Parsing XML

This section contains the following topics:

Extracting Node Values from a DOM Tree

Merging Documents with appendChild()

Parsing DTDs

Handling Character Sets with the XML Parser

Extracting Node Values from a DOM Tree

You can use the selectNodes() method in the XMLNode class to extract content from a DOM tree or subtree based on the select patterns allowed by XSL. You can use the optional second parameter of selectNodes() to resolve namespace prefixes, that is, to return the expanded namespace URL when given a prefix. The XMLElement class implements NSResolver, so a reference to an XMLElement object can be sent as the second parameter. XMLElement resolves the prefixes based on the input document. You can use the NSResolver interface if you need to override the namespace definitions.

The sample code in Example 4-4 illustrates how to use selectNodes().

Example 4-4 Extracting Contents of a DOM Tree with selectNodes()

//
// selectNodesTest.java
//
import java.io.*;
import oracle.xml.parser.v2.*;
import org.w3c.dom.Node;
import org.w3c.dom.Element;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;

public class selectNodesTest
{
  public static void main(String[] args)
    throws Exception
  {
    // supply an xpath expression
    String pattern = "/family/member/text()";
    // accept a filename on the command line
    // run the program with $ORACLE_HOME/xdk/demo/java/parser/common/family.xml
    String file    = args[0];

    if (args.length == 2)
      pattern = args[1];

    DOMParser dp = new DOMParser();

    dp.parse(DemoUtil.createURL(file));  // include createURL from DemoUtil
    XMLDocument xd = dp.getDocument();
    XMLElement element = (XMLElement) xd.getDocumentElement();
    NodeList nl = element.selectNodes(pattern, element);
    for (int i = 0; i < nl.getLength(); i++)
    {
      System.out.println(nl.item(i).getNodeValue());
    } // end for
  } // end main
} // end selectNodesTest

To test the program, create a file with the code in Example 4-4 and then compile it in the $ORACLE_HOME/xdk/demo/java/parser/common directory. Pass the filename family.xml to the program as a parameter to traverse the <family> tree. The output should be as follows:

% java selectNodesTest family.xml
Sarah
Bob
Joanne
Jim

Now run the following to determine the values of the memberid attributes of all <member> elements in the document:

% java selectNodesTest family.xml //member/@memberid
m1
m2
m3
m4

Merging Documents with appendChild()

Suppose that you want to write a program so that a user can fill in a client-side Java form and obtain an XML document. Suppose that your Java program contains the following variables of type String:

String firstname = "Gianfranco";
String lastname = "Pietraforte";

You can use either of the following techniques to insert this information into an XML document:

Create an XML document in a string and then parse it. For example:

String xml = "<person><first>"+firstname+"</first>"+
     "<last>"+lastname+"</last></person>";
DOMParser d = new DOMParser();
d.parse(new StringReader(xml));
Document xmldoc = d.getDocument();

Use DOM APIs to construct an XML document, creating elements and then appending them to one another. For example:

Document xmldoc = new XMLDocument();
Element e1 = xmldoc.createElement("person");
xmldoc.appendChild(e1);
Element e2 = xmldoc.createElement("firstname");
e1.appendChild(e2);
Text t = xmldoc.createText("Larry");
e2.appendChild(t);

Note that you can only use the second technique on a single DOM tree. For example, suppose that you write the code snippet in Example 4-5.

Example 4-5 Incorrect Use of appendChild()

XMLDocument xmldoc1 = new XMLDocument();
XMLElement e1 = xmldoc1.createElement("person");
XMLDocument xmldoc2 = new XMLDocument();
XMLElement e2 = xmldoc2.createElement("firstname");
e1.appendChild(e2);

The preceding code raises a DOM exception of WRONG_DOCUMENT_ERR when calling XMLElement.appendChild() because the owner document of e1 is xmldoc1 whereas the owner of e2 is xmldoc2. The appendChild() method only works within a single tree, but the code in Example 4-5 uses two different trees.

You can use the XMLDocument.importNode() method, introduced in DOM 2, and the XMLDocument.adoptNode() method, introduced in DOM 3, to copy and paste a DOM document fragment or a DOM node across different XML documents. The commented lines in Example 4-6 show how to perform this task.

Example 4-6 Merging Documents with appendChild

XMLDocument doc1 = new XMLDocument();
XMLElement element1 = doc1.createElement("person");
XMLDocument doc2 = new XMLDocument();
XMLElement element2 = doc2.createElement("firstname");
// element2 = doc1.importNode(element2);
// element2 = doc1.adoptNode(element2);
element1.appendChild(element2);

Parsing DTDs

This section discusses techniques for parsing DTDs. It contains the sections:

Loading External DTDs

Caching DTDs with setDoctype

Loading External DTDs

If you call the DOMParser.parse() method to parse the XML Document as an InputStream, then use the DOMParser.setBaseURL() method to recognize external DTDs within your Java program. This method points to a location where the DTDs are exposed.

The following procedure describes how to load and parse a DTD:

Load the DTD as an InputStream. For example, assume that you want to validate documents against the /mydir/my.dtd external DTD. You can use the following code:

InputStream is = MyClass.class.getResourceAsStream("/mydir/my.dtd");

This code opens ./mydir/my.dtd in the first relative location in the CLASSPATH where it can be found, including the JAR file if it is in the CLASSPATH.

Create a DOM parser and set the validation mode. For example, use this code:

DOMParser d = new DOMParser();
d.setValidationMode(DTD_VALIDATION);

Parse the DTD. The following example passes the InputStream object to the DOMParser.parseDTD() method:

d.parseDTD(is, "rootelementname");

Get the document type and then set it. The getDoctype() method obtains the DTD object and the setDoctype() method sets the DTD to use for parsing. The following example illustrates this technique:

d.setDoctype(d.getDoctype());

The following code demonstrates an alternative technique. You can invoke the parseDTD() method to parse a DTD file separately and get a DTD object:

d.parseDTD(new FileReader("/mydir/my.dtd"));
DTD dtd = d.getDoctype();
parser.setDoctype(dtd);

Parse the input XML document. For example, the following code parses mydoc.xml:

d.parse("mydoc.xml");

Caching DTDs with setDoctype

The XML parser for Java provides for DTD caching in validation and nonvalidation modes through the DOMParser.setDoctype() method. After you set the DTD with this method, the parser caches this DTD for further parsing. Note that DTD caching is optional and is not enabled automatically.

Assume that your program must parse several XML documents with the same DTD. After you parse the first XML document, you can obtain the DTD from the parser and set it as in the following example:

DOMParser parser = new DOMParser();
DTD dtd = parser.getDoctype();
parser.setDoctype(dtd);

The parser caches this DTD and uses it for parsing subsequent XML documents. Example 4-7 provides a more complete illustration of how you can invoke DOMParser.setDoctype() to cache the DTD.

Example 4-7 DTDSample.java

/**
 * DESCRIPTION
 * This program illustrates DTD caching.
 */

import java.net.URL;
import java.io.*;
import org.xml.sax.InputSource;
import oracle.xml.parser.v2.*;

public class DTDSample
{
   static public void main(String[] args)
   {
      try
      {
         if (args.length != 3)
         {
            System.err.println("Usage: java DTDSample dtd rootelement xmldoc");
            System.exit(1);
         }

         // Create a DOM parser
         DOMParser parser = new DOMParser();

         // Configure the parser
         parser.setErrorStream(System.out);
         parser.showWarnings(true);

        // Create a FileReader for the DTD file specified on the command
        // line and wrap it in an InputSource
        FileReader r = new FileReader(args[0]);
        InputSource inSource = new InputSource(r);

        // Create a URL from the command-line argument and use it to set the
        // system identifier
        inSource.setSystemId(DemoUtil.createURL(args[0]).toString());

        // Parse the external DTD from the input source. The second argument is
        // the name of the root element.
        parser.parseDTD(inSource, args[1]);
        DTD dtd = parser.getDoctype();

        // Create a FileReader object from the XML document specified on the
        // command line
        r = new FileReader(args[2]);

        // Wrap the FileReader in an InputSource, create a URL from the filename,
        // and set the system identifier
        inSource = new InputSource(r);
        inSource.setSystemId(DemoUtil.createURL(args[2]).toString());

        // ********************
        parser.setDoctype(dtd);
        // ********************

        parser.setValidationMode(DOMParser.DTD_VALIDATION);
       // parser.setAttribute(DOMParser.USE_DTD_ONLY_FOR_VALIDATION,Boolean.TRUE);
        parser.parse(inSource);

        // Obtain the DOM tree and print
        XMLDocument doc = parser.getDocument();
        doc.print(new PrintWriter(System.out));

      }
      catch (Exception e)
      {
         System.out.println(e.toString());
      }
   }
}

If the cached DTD Object is used only for validation, then set the DOMParser.USE_DTD_ONLY_FOR_VALIDATION attribute. Otherwise, the XML parser will copy the DTD object and add it to the resulting DOM tree. You can set the parser as follows:

parser.setAttribute(DOMParser.USE_DTD_ONLY_FOR_VALIDATION,Boolean.TRUE);

Handling Character Sets with the XML Parser

This section contains the following topics:

Detecting the Encoding of an XML File on the Operating System

Detecting the Encoding of XML Stored in an NCLOB Column

Writing an XML File in a Nondefault Encoding

Working with XML in Strings

Parsing XML Documents with Accented Characters

Handling Special Characters in Tag Names

Detecting the Encoding of an XML File on the Operating System

When reading an XML file stored on the operating system, do not use the FileReader class. Instead, use the XML parser to detect the character encoding of the document automatically. Given a binary FileInputStream with no external encoding information, the parser automatically determines the character encoding based on the byte-order mark and encoding declaration of the XML document. You can parse any well-formed document in any supported encoding with the sample code in the AutoDetectEncoding.java demo. This demo is located in $ORACLE_HOME/xdk/demo/java/parser/dom.

Note:

Include the proper encoding declaration in your document according to the specification. setEncoding() cannot set the encoding for your input document. Rather, it is used with oracle.xml.parser.v2.XMLDocument to set the correct encoding for printing.

Detecting the Encoding of XML Stored in an NCLOB Column

Suppose that you load XML into the an NCLOB column of a database using UTF-8 encoding. The XML contains two UTF-8 multibyte characters:

G(0xc2,0x82)otingen, Br(0xc3,0xbc)ck_W

You write a Java stored function that does the following:

Uses the default connection object to connect to the database.

Runs a SELECT query.

Obtains the oracle.jdbc.OracleResultSet object.

Calls the OracleResultSet.getCLOB() method.

Calls the getAsciiStream() method on the CLOB object.

Executes the following code to get the XML into a DOM object:

DOMParser parser = new DOMParser();
parser.setPreserveWhitespace(true);
parser.parse(istr);
// istr getAsciiStream XMLDocument xmldoc = parser.getDocument();

The program throws an exception stating that the XML contains an invalid UTF-8 encoding even though the character (0xc2, 0x82) is valid UTF-8. The problem is that the character can be distorted when the program calls the OracleResultSet.getAsciiStream() method. To solve this problem, invoke the getUnicodeStream() and getBinaryStream() methods instead of getAsciiStream(). If this technique does not work, then try to print the characters to make sure that they are not distorted before they are sent to the parser in when you call DOMParser.parse(istr).

Writing an XML File in a Nondefault Encoding

You should not use the FileWriter class when writing XML files because it depends on the default character encoding of the runtime environment. The output file can suffer from a parsing error or data loss if the document contains characters that are not available in the default character encoding.

UTF-8 encoding is popular for XML documents, but UTF-8 is not usually the default file encoding of Java. Using a Java class in your program that assumes the default file encoding can cause problems. To avoid these problems, you can use the technique illustrated in the I18nSafeXMLFileWritingSample.java program in $ORACLE_HOME/xdk/demo/java/parser/dom.

Note that you cannot use System.out.println() to output special characters. You need to use a binary output stream such as OutputStreamWriter that is encoding aware. You can construct an OutputStreamWriter and use the write(char[], int, int) method to print, as in the following example:

/* Java encoding string for ISO8859-1*/
OutputStreamWriter out = new OutputStreamWriter(System.out, "8859_1");
OutputStreamWriter.write(...);

Working with XML in Strings

Currently, there is no method that can directly parse an XML document contained in a String. You need to convert the string into an InputStream or InputSource object before parsing.

One technique is to create a ByteArrayInputStream that uses the bytes in the string. For example, assume that xmlDoc is a reference to a string of XML. You can use technique shown in Example 4-8 to convert the string to a byte array, convert the array to a ByteArrwayInputStream, and then parse.

Example 4-8 Converting XML in a String

// create parser
DOMParser parser=new DOMParser();
// create XML document in a string
String xmlDoc =
       "<?xml version='1.0'?>"+
       "<hello>"+
       "  <world/>"+
       "</hello>";
// convert string to bytes to stream
byte aByteArr [] = xmlDoc.getBytes();
ByteArrayInputStream bais = new ByteArrayInputStream(aByteArr,0,aByteArr.length);
//  parse and obtain DOM tree
DOMParser.parse(bais);
XMLDocument doc = parser.getDocument();

Suppose that you want to convert the XMLDocument object created in the previous code back to a string. You can perform this task by wrapping a StringWriter in a PrintWriter. The following example illustrates this technique:

StringWriter sw = new StringWriter();
PrintWriter  pw = new PrintWriter(sw);
doc.print(pw);
String YourDocInString = sw.toString();

ParseXMLFromString.java, which is located in $ORACLE_HOME/xdk/demo/java/parser/dom, is a complete program that creates an XML document as a string and parses it.

Parsing XML Documents with Accented Characters

Assume that an input XML file contains accented characters such as an é. Example 4-9 shows one way to parse an XML document with accented characters.

Example 4-9 Parsing a Document with Accented Characters

DOMParser parser=new DOMParser();
parser.setPreserveWhitespace(true);
parser.setErrorStream(System.err);
parser.setValidationMode(false);
parser.showWarnings(true);
parser.parse (new FileInputStream(new File("file_with_accents.xml")));

When you attempt to parse the XML file, the parser can sometimes throw an "Invalid UTF-8 encoding" exception. If you explicitly set the encoding to UTF-8, or if you do not specify it at all, then the parser interprets an accented character—which has an ASCII value greater than 127—as the first byte of a UTF-8 multibyte sequence. If the subsequent bytes do not form a valid UTF-8 sequence, then you receive an error.

This error means that your XML editor did not save the file with UTF-8 encoding. For example, it may have saved it with ISO-8859-1 encoding. The encoding is a particular scheme used to write the Unicode character number representation to disk. Adding the following element to the top of an XML document does not itself cause your editor to write out the bytes representing the file to disk with UTF-8 encoding:

<?xml version="1.0" encoding="UTF-8"?>

One solution is to read in accented characters in their hex or decimal format within the XML document, for example, &#xd9;. If you prefer not to use this technique, however, then you can set the encoding based on the character set that you were using when you created the XML file. For example, try setting the encoding to ISO-8859-1 (Western European ASCII) or to something different, depending on the tool or operating system you are using.

Handling Special Characters in Tag Names

Special characters such as &, $, and #, and so on are not legal in tag names. For example, if a document names tags after companies, and if the document includes the tag <A&B>, then the parser issues an error about invalid characters.

If you are creating an XML document from scratch, then you can work around this problem by using only valid NameChars. For example, you can name the tag <A_B>, <AB>, <A_AND_B> and so on. If you are generating XML from external data sources such as database tables, however, then XML 1.0 does not address this problem.

The datatype XMLType addresses this problem by providing the setConvertSpecialChars and convert functions in the DBMS_XMLGEN package. You can use these functions to control the use of special characters in SQL names and XML names. The SQL to XML name mapping functions escape invalid XML NameChar characters in the format of _XHHHH_, where HHHH is the Unicode value of the invalid character. For example, table name V$SESSION is mapped to XML name V_X0024_SESSION.

Escaping invalid characters is another workaround to give users a way to serialize names so that they can reload them somewhere else.

5 Using Binary XML for Java

This chapter contains these topics:

Introduction to Binary XML for Java

Models for Using Binary XML

The Parts of Binary XML for Java

Binary XML Vocabulary Management

Using Java Binary XML Package

Introduction to Binary XML for Java

Binary XML was introduced in Oracle 11g Release 1 (11.1). Binary XML makes it possible to encode and decode between XML text and compressed binary XML. For efficiency, the DOM and SAX APIs are provided on top of binary XML for direct consumption by the XML applications. Compression and decompression of fragments of an XML document facilitate incremental processing.

This chapter assumes that you are familiar with the XML Parser for Java.

See Also:

Chapter 4, "XML Parsing for Java"

Binary XML Storage Format

An XMLType storage option is provided to enable storing XML documents in the new binary format. The new storage option is in addition to the existing CLOB and object-relational storage options. XMLType tables and columns can be created using the new binary XML storage option. The XML data in binary format can be accessed and manipulated by all the existing SQL operators and functions and PL/SQL APIs that operate on XMLType.

Binary XML is a compact XML-schema-aware encoding of XML data, but it can be used with XML data that is not based on an XML schema. You can also use binary XML for XML data which is outside the database (in a client-side application, for instance). Binary XML allows for encoding and decoding of XML documents, from text to binary and binary to text. Binary XML is post-parse persistent XML with native database datatypes.

Binary XML provides more efficient database storage, updating, indexing, query performance, and fragment extraction than unstructured storage. It can store data and metadata together or separately.

Binary XML Processors

A binary XML processor is an abstract term for describing a component that processes and transforms binary XML format into text and XML text into binary XML format. It can also provide a cache for storing schemas. The base class for a binary XML processor is BinXMLProcessor. A binary XML processor can originate or receive network protocol requests.

Models for Using Binary XML

There are several models for using binary XML in applications. First, here is a glossary of terms:

Glossary for Binary XML

Here is a glossary of terms for binary XML usage:

doc-id: Each encoded XML document is identified by a unique doc-id. It is either a 16-byte Global User ID (GUID) or an opaque sequence of bytes like a URL.

token table: When a text XML document does not have a schema associated with it, then a token (or symbol) table is used to minimize space for repeated items.

vocabulary id: Can be a schema-id or a namespace URI identification for a token table.

schema-id: A unique opaque binary identifier for a schema scoped to the binary XML processor. The schema-id is unique for a binary XML processor and is identifiable only within the scope of that binary XML processor. The schema-id remains constant even when the schema is evolved. A schema-id represents the entire set of schema documents, including imported and included schemas.

schema version: Every annotated schema has a version number associated with it. The version number is specified as part of the system level annotations. It is incremented by the binary XML processor when a schema is evolved (that is, a new version of the same schema is registered with the binary XML processor).

partial validity: Binary XML stream encoding using schema implies at least partial validity with respect to the schema. Partial validity implies no validation for unique keys, keyrefs, IDs, or IDREFs.

Standalone Model

This is the simplest usage scenario for binary XML. There is a single binary XML processor. The only repository available is the local in-memory vocabulary cache that is not persistent and is only available for the life of the binary XML processor. All schemas must be registered in advance with the binary XML Processor before the encoding, or can be registered automatically when the XML Processor sees the xsi:SchemaLocation tag. For decoding, the schema is already available in the vocabulary cache.

If the decoding occurs in a different binary XML processor, see the different Web Services models described here.

Client-Server Model

In this scenario, the binary XML processor is connected to a database using JDBC. It is assumed that the schema is registered with the database before encoding.

Here is an example of how to achieve that:

BEGIN
   DBMS_XMLSCHEMA.registerSchema(
   SCHEMAURL =>
   'http://xmlns.oracle.com/xdb/documentation/purchaseOrder.xsd',
   SCHEMADOC =>
   bfilename('XMLDIR','purchaseOrder.xsd'),
   CSID => nls_charset_id('AL32UTF8'),
   GENTYPES => FALSE,
   OPTIONS => REGISTER_BINARYXML );
END;
/

Unless a separate connection is specified for data (using associateDataConnection()) it is assumed that all data and metadata is stored and retrieved using a single connection for encoding and decoding.

Web Services Model with Repository

In this scenario there are multiple clients, each running a binary XML processor. One client does the encoding and the other client does the decoding. There is a common repository (that is not necessarily a database) connected to all the clients for metadata storage. It can be a file system or some other repository. The first binary XML processor ensures that the schema is registered with the repository before performing the encoding, or the schema might be automatically registered using the xsi:schemaLocation tag at the time of encoding. The second binary XML processor is used for decoding, is not aware of the location of the schema, and fetches the schema from the repository.

If the first binary XML processor registers a schema and the second binary XML processor registersthe same schema in the repository, the binary XML processor does not compile the schema, but simply returns the vocabulary-id of the existing compiled schema in the local vocabulary cache.

The BinXMLProcessor is not thread-safe, so multiple threads or clients accessing the repository need to implement their own thread safety scheme.

Web Services Model Without Repository

In this scenario, there are multiple clients, each running a binary XML processor. Encoding and decoding can happen on different clients. There is no common metadata repository. The encoder has to ensure that the binary data passed to the next client is independent of schema: that is, has inline token definitions. This can be achieved by setting schemaAware = false and inlineTokenDefs = true, using the setProperty() method, during encoding. While decoding, there is no schema required.

The Parts of Binary XML for Java

The Java XML binary functionality has three parts:

Binary XML encoding - The binary XML encoder converts XML 1.0 infoset to binary XML.

Binary XML decoding - The binary XML decoder converts binary XML to XML infoset.

Binary XML vocabulary management, which includes schema management and token management.

Binary XML Encoding

The encoder is created from the BinXMLStream. It takes as input the XML text and outputs the encoded binary XML to the BinXMLStream it was created from. The encoder reads the XML text using streaming SAX. The encoding of the XML text is based on the results of the XML parsing.

Set the schemaAware flag on the encoder that specifies whether the encoding is schema-aware or schema-less.

For schema-aware encoding, the encoder determines whether the schema with the particular schema URL has been registered with the vocabulary manager. For a repository-based or a database-based processor, the encoder queries the repository or the database for the compiled schema based on the schema URL. If the schema is available in the database, it is fetched from the repository or database in the binary XML format and registered with the local vocabulary manager. The vocabulary is schema.

Also set a flag to indicate that the encoding results in a binary XML stream that is independent of a schema. In this case, the resulting binary XML stream contains all token definitions inline and is not dependent on schema or external token sets.

If the encoding is schema-aware, the encoder uses the datatype information from the schema object for more efficient encoding of the SAX stream. There is a default encoding datatype associated with each schema built-in datatype. Binary XML stream encoding using a schema implies at least partial validity with respect to the schema (For partial validity there is no validation for unique key, or keyref, or ID, or DREFs). If the data is known to be completely valid with respect to a schema, the encoded binary XML stream stores this information.

See Also:

Oracle XML DB Developer's Guide for tables of the binary encoding datatypes and their mappings from XML schema datatypes

If there is no schema associated with the text XML, then integer token ids are generated for repeated items in the text XML. Creating a token table of token ids and token definitions is an important compression technique. The token definitions are stored as token tables in the vocabulary cache. If the property for inline token definitions is set, then the token definitions are present inline.

See Also:

"Token Management"

Another property on the encoder is specifying PSVI (Post Schema Validated Infoset) information as part of the binary stream. If this is set to true then PSVI information can be accessed using XDK extension APIs for PSVI on DOM. If psvi = true then the input XML is fully validated with respect to the schema. If psvi is false then PSVI information is not included in the output binary stream. The default is false.

Binary XML Decoding

The binary XML decoder converts binary XML to XML infoset. The decoder is created from the BinXMLStream; it reads binary XML from this stream and outputs SAX events or provide a pull style InfosetReader API for reading the decoded XML. If a schema is associated with the BinXMLStream, the binary XML decoder retrieves the associated schema object from the vocabulary cache using the vocabulary id before decoding. If the schema is not available in the vocabulary cache, and the connection information to the server is available, then the schema is fetched from the server.

If no schema is associated with BinXMLStream, then the token definitions can be either inline in the BinXMLStream or stored in a token set. If tokens of a corresponding namespace are not stored in the local vocabulary cache, then the token set is fetched from the repository.

Binary XML Vocabulary Management

The binary XML processors are of different types depending on where the metadata (schema or token sets) are located - either local binary XML processor or repository binary XML processor.

Schema Management

For metadata persistence, it is recommended that you use the DB Binary XML processor. In this case, schemas and token sets are registered with the database. The vocabulary manager fetches the schema or token sets from the database and cache it in the local vocabulary cache for encoding and decoding purposes.

See Also:

"Binary XML DB"

If you need to use a persistent metadata repository that is not a database, then you can plug in your own metadata repository. You must implement the interface for communicating with this repository, BinXMLMetadataProvider.

Schema Registration

Register schemas locally with the local binary XML processor. The local binary XML processor contains a vocabulary manager that maintains all schemas submitted by the user for the duration of its existence. The vocabulary manager associated with a local binary XML processor does not provide for schema persistence.

If you register the same schema (same schema location and same target namespace) then the schema is not parsed, and the existing vocabulary id is returned. If a new schema with the same target namespace and a different schema location is registered then the existing schema definition is augmented with the new schema definitions or results in conflict error.

Schema Identification

Each schema is identified by a vocabulary id. The vocabulary id is in the scope of the processor and is unique within the processor. Any document that validates with a schema is required to validate with a latest version of the schema.

Schema Annotations

Binary XML annotations can only appear within the <xsd:appInfo> element in a schema. There are two categories of schema annotations - User-level and System-level. The vocabulary manager interprets these at the time of schema registration. All other types of annotations (for example, database related annotations, is ignored).

User-Level Annotations

These are specified by the user before registration.

encodingType - This can be used within a xsd:element, xsd:attribute or xsd:simpleType elements. It indicates the datatype to be used for encoding the node value of the particular element or attribute. For strings, there is only support for UTF8 encoding in this release.

System-Level Annotations

The vocabulary manager adds these at the time of registration; you cannot overwrite them.

Token Management

Token sets can be fetched from the database or metadata repository, cached in the local vocabulary manager and used for decoding. While encoding, token sets can be pushed to the repository for persistence.

Token definitions can also be included as part of the binary XML stream by setting a flag on the encoder.

Using Java Binary XML Package

A BinXMLStream class represents the binary XML stream. The different storage locations defined for the binary XML Stream are:

InputStream - stream for reading.

OutputStream- stream for writing.

URL - stream for reading.

File - stream for read and write.

BLOB - stream for reading and writing.

Byte array - stream for reading and writing.

In memory - stream for reading and writing.

The BinXMLStream object specifies the type of storage during creation.

A BinXMLStream object can be created from a BinXMLProcessor factory. This factory can be initialized with a JDBC connection (for remote metadata access), connection pool, URL or a PageManagerPool (for lazy in-memory storage). BinXMLEncoder and BinXMLDecoder can be created from the BinXMLStream for encoding or decoding.

1. Here is an example of creating a processor without a repository, registering a schema, encoding XML SAX events into schema-aware binary format, and storing in a file:

BinXMLProcessor  proc = BinXMLProcessorFactory.createProcessor();
proc.registerSchema(schemaURL);
BinXMLStream outbin = proc.createBinaryStream(outFile);
BinXMLEncoder enc = outbin.getEncoder();
enc.setSchemaAware(true);
ContentHandler hdlr = enc.getContentHandler();

In addition to getting the ContentHandler, you can also get the other handlers, such as:

LexicalHandler lexhdlr = enc.getLexicalHandler();
DTDHandler dtdhdlr = encenc.getDTDHandler();
DeclHandler declhdlr = enc.getDeclHandler();
ErrorHandler errhdlr = enc.getErrorHandler();

Use hdlr in the application that generates the SAX events.

2. Here is an example of creating a processor with a database repository, decoding a schema-aware binary stream and reading the decoded XML using pull API. The schema is fetched from the database repository for decoding.

DBBinXMLMetadataProvider dbrep =
     BinXMLMetadataProviderFactory.createDBMetadataProvider();
BinXMLProcessor proc = BinXMLProcessorFactory.createProcessor(dbrep);
BinXMLStream inpbin = proc.createBinaryStream(blob);
BinXMLDecoder dec = inpbin.getDecoder();
InfosetReader xmlreader = dec.getReader();

Use xmlreader to read XML in a pull-style from the decoder.

Binary XML Encoder

The encoder takes XML input, which is parsed and read using SAX events, and outputs binary XML.

Schema-less Option

You can specify the schema-aware or the schema-less option before encoding. The default is schema-less encoding. If the schema-aware option is set, then the encoding is done based on schema(s) specified in the instance document. The annotated schema(s) used for encoding is also required at the time of decoding. If the schema-less option is specified, then the encoding is independent of schema(s), but the tokens are inline by default. To override the default, set Inline-token = false.

Inline-token Option

You can set an option to create a binary XML Stream with inline token definitions before encoding. If "inlining" is turned off, than you must ensure that the processors for the encoder or decoder are using the same metadata repository. The flag Inline-token is ignored if the schema-aware option is true. By default, the token definitions is inline.

Figure 5-1 Binary XML Encoding

Description of Figure 5-1 follows
Description of "Figure 5-1 Binary XML Encoding"

Binary XML Decoder

The binary XML decoder takes binary XML stream as input and generates SAX Events as output, or provides a pull interface to read the decoded XML. In the case of schema-aware binary XML stream, the binary XML decoder interacts with the vocabulary manager to extract the schema information.

If the vocabulary manager does not contain the required schema, and the processor is of type binary XML DB with a valid JDBC connection, then the remote schema is fetched from the database or the metadata repository based on the vocabulary id in the binary XML stream to be decoded. Similarly, the set of token definitions can be fetched from the database or the metadata repository.

Figure 5-2 Binary XML Decoder

Description of Figure 5-2 follows
Description of "Figure 5-2 Binary XML Decoder"

Schema Registration

Here is the flow of this process: If the vocabulary is an XML schema; it takes the XML schema text as input. The schema annotator annotates the schema text with system level annotations. The schema might already have some user level annotations.

The resulting annotated schema is processed by the Schema Builder to build an XML schema object. This XML schema object is stored in the vocabulary cache. The vocabulary cache assigns a unique vocabulary id for each XML schema object, which is returned as output. The annotated DOM representation of the schema is sent to the binary XML encoder.

Resolving xsi:schemaLocation

During encoding, if schemaAware is true and the property ImplcitSchemaRegistration is true, then the first xsi:schemaLocation tag present in the root element of an XML instance document automatically registers that schema in the local vocabulary manager. All other schemaLocation tags are not explicitly registered. If the processor is database-oriented, then the schema is also registered in the database; similarly for any metadata repository based processor.

If the encoding is set to schemaAware is false or ImplcitSchemaRegistration is false, then all xsi:schemaLocation tags are ignored by the encoder.

Binary XML DB

A DBBinXMLMetadataProvider object is either instantiated with a dedicated JDBC connection or a connection pool to access vocabulary information such as schema and token set. The processor is also associated with one or more data connections to access XML data.

A binary XML Processor can communicate with the database for various types of binary XML operations involving storage and retrieval of binary XML schemas, token sets, and binary XML streams. Database communication is involved in the following ways:

Extracting compiled binary XML Schema using the vocabulary id or the schema URL

To retrieve a compiled binary XML schema for encoding, the database is queried based on the schema URL. For decoding the binary XML schema, fetch it from the database based on the vocabulary id.

Storing noncompiled binary XML schema using the schema URL and retrieving the vocabulary id.

When the xsi:schemaLocation tag is encountered during encoding, the schema is registered in the database for persistent storage in the database. The vocabulary id associated with the schema, as well as the binary version of the compiled schema is retrieved back from the database; the compiled schema object is built and stored in the local cache using the vocabulary id returned from the database.

Retrieving a binary token set using namespace URL.

If a binary stream to be decoded is associated with token tables for decoding, these are fetched from the database using the metadata connection.

Storing binary token set using namespace URL

If the XML text has been encoded without a schema, then it results in a token set of token definitions. These token tables can be stored persistently in the database. The metadata connection is used for transferring the token set to the database.

Binary XML stream with remote storage option

It is your responsibility to create a table containing an XMLType column with binary XML for storing the result of encoding and retrieving the binary XML for decoding. Communication with the database can be achieved with SQL*Net and JDBC. Fetch the XMLType object from the output result set of the JDBC query. The BinXMLStream for reading the binary data or for writing out binary data can be created from the XMLType object. The XMLType class must be extended to support reading and writing of binary XML data.

Persistent Storage of Metadata

A local vocabulary manager and cache stores metadata information in the memory for the life of the BinXMLProcessor. Plug in your own back-end storage for metadata by implementing the BinXMLMetadataProvider interface and plugging it into the BinXMLProcessor. Currently only one metadata provider for each processor is supported.

You must code a FileBinXMLMetadataProvider that implements the BinXMLMetadataProvider interface. The encoder and decoder uses these APIs to access metadata from the persisted back-end storage. Set up the configuration information for the persistent storage: for example, root directory in the case of a file system in FileBinXMLMetadataProvider class. Instantiate FileBinXMLMetadataProvider and plug it into the BinXMLProcessor.

6 Using the XSLT Processor for Java

This chapter contains these topics:

Introduction to the XSLT Processor

Using the XSLT Processor for Java: Overview

Transforming XML

Programming with Oracle XSLT Extensions

Tips and Techniques for Transforming XML

Introduction to the XSLT Processor

This section contains the following topics:

Prerequisites

Standards and Specifications

XML Transformation with XSLT 1.0 and 2.0

Prerequisites

XSLT is an XML-based language that you can use to transform one XML document into another text document. For example, you can use XSLT to accept an XML data document as input, perform arithmetic calculations on element values in the document, and generate an XHTML document that shows the calculation results.In XSLT, XPath is used to navigate and process elements in the source node tree. XPath models an XML document as a tree made up of nodes; the types of nodes in the XPath node tree correspond to the types of nodes in a DOM tree.

This chapter assumes that you are familiar with the following W3C standards:

eXtensible Stylesheet Language (XSL) and eXtensible Stylesheet Language Transformation (XSLT). If you require a general introduction to XSLT, consult the XML resources listed in "Related Documents" of the preface.

Standards and Specifications

XSLT is currently available in two versions: a working draft for XSLT 2.0 and the XSLT 1.0 Recommendation. You can find the specifications at the following URLs:

http://www.w3.org/TR/xslt20/

http://www.w3.org/TR/xslt

XPath, which is the navigational language used by XSLT and other XML languages, is available in two versions: a working draft for XPath 2.0 and the XPath 1.0 Recommendation. You can find the specifications for the two XPath versions at the following URLs:

http://www.w3.org/TR/xpath20/

http://www.w3.org/TR/xpath

Oracle XDK XSLT processor implements both the XSLT and XPath 1.0 standards as well as the current working drafts of the XSLT and XPath 2.0 standards. The XDK XSLT processor supports the XPath 2.0 functions and operators. You can find the specification at the following URL:

http://www.w3.org/TR/xpath-functions/

See Also:

Chapter 31, "XDK Standards" for a summary of the standards supported by the XDK

XML Transformation with XSLT 1.0 and 2.0

In Oracle Database 10g, the XDK provides several useful features not included in XSLT 1.0. To use XSLT 2.0, set the version attribute in your stylesheet as follows:

<? xml-stylesheet version="2.0" ... ?>

Some of the most useful XSLT 2.0 features are the following:

User-defined functions

You can use the <xsl:function> declaration to define functions. This element must have one name attribute to define the function name. The value of the name attribute is a QName. The content of the <xsl:function> element is zero or more xsl:param elements that specify the formal arguments of the function, followed by a sequence constructor that defines the value returned by the function.

Note that QName can have a null namespace, but user-defined functions must have a non-null namespace. That is, if abc is defined as a namespace, then add is not a legal user-defined function, but abc:add is.

Grouping

You can use the <xsl:for-each-group> element, current-group() function, and current-grouping-key() function to group items.

Multiple result documents

You can use the <xsl:result-document> element to create a result tree. The content of the <xsl:result-document> element is a sequence constructor for the children of the document node of the tree.

For example, this element enables you to accept an XML document as input and break it into separate documents. You can take an XML document that describes a list of books and generate an XHTML document for each book. You can then validate each output document.

Temporary trees

Instead of representing the intermediate XSL transformation results and XSL variables as strings, as in XSLT 1.0, you can store them as a set of document nodes. The document nodes, which you can construct with the <xsl:variable>, <xsl:param>, and <xsl:with-param> elements, are called temporary trees.

Character mapping

In XSLT 1.0, you had to use the disable-output-escaping attribute of the <xsl:text> and <xsl:value-of> elements to specify character escaping. In XSLT 2.0, you can declare mapping characters with an <xsl:character-map> element as a top level stylesheet element. You can use this element to generate files with reserved or invalid XML characters in the XSLT outputs, such as <, >, and &.

See Also:

http://www.w3.org/TR/xslt20 for explanation and examples of XSLT 2.0 features

Using the XSLT Processor for Java: Overview

The Oracle XDK XSLT processor is a software program that transforms an XML document into another text-based format. For example, the processor can transform XML into XML, HTML, XHTML, or text. You can invoke the processor programmatically by using the APIs or run it from the command line. The XSLT processor can perform the following tasks:

Reads one or more XSLT stylesheets. The processor can apply multiple stylesheets to a single XML input document and generate different results.

Reads one or more input XML documents. The processor can use a single stylesheet to transform multiple XML input documents.

Builds output documents by applying the rules in the stylesheet to the input XML documents. The output is a DOM tree, output stream, or series of SAX events.

Whereas XSLT is a function-based language that generally requires a DOM of the input document and stylesheet to perform the transformation, the Java XDK implementation of the XSLT processor can use SAX to create a stylesheet object to perform transformations with higher efficiency and fewer resources. You can reuse this stylesheet object to transform multiple documents without reparsing the stylesheet.

Using the XSLT Processor: Basic Process

Figure 6-1 depicts the basic design of the XSLT processor for Java.

See Also:

Oracle Database XML Java API Reference to learn about the XMLParser and XSDBuilder classes

Figure 6-1 Using the XSLT Processor for Java

Description of Figure 6-1 follows
Description of "Figure 6-1 Using the XSLT Processor for Java"

Running the XSLT Processor Demo Programs

Demo programs for the XSLT processor for Java are included in $ORACLE_HOME/xdk/demo/java/parser/xslt. Table 6-1 describes the XML files and programs that you can use to test the XSLT processor.

Table 6-1 XSLT Processor Sample Files

File
Description

match.xml

A sample XML document that you can use to test ID selection and pattern matching. Its associated stylesheet is match.xsl.

match.xsl

A sample stylesheet for use with match.xml. You can use it to test simple identity transformations.

math.xml

A sample XML data document that you can use to perform simple arithmetic. Its associated stylesheet is math.xsl.

math.xsl

A sample stylesheet for use with math.xml. The stylesheet outputs an HTML page with the results of arithmetic operations performed on element values in math.xml.

number.xml

A sample XML data document that you can use to test for source tree numbering. The document describes the structure of a book.

number.xsl

A sample stylesheet for us with number.xml. The stylesheet outputs an HTML page that calculates section numbers for the sections in the book described by number.xml.

position.xml

A sample XML data document that you can use to test for position()=X in complex patterns. Its associated stylesheet is position.xsl.

position.xsl

A sample stylesheet for use with position.xml. The stylesheet outputs an HTML page with the results of complex pattern matching.

reverse.xml

A sample XML data document that you can use with reverse.xsl to traverse backward through a tree.

reverse.xsl

A sample stylesheet for us with reverse.xml. The stylesheet output the item numbers in reverse.xml in reverse order.

string.xml

A sample XML data document that you can use to test perform various string test and manipulations. Its associated stylesheet is string.xsl.

string.xsl

A sample stylesheet for us with string.xml. The stylesheet outputs an XML document that displays the results of the string manipulations.

style.txt

A stylesheet that provides the framework for an HTML page. The stylesheet is included by number.xsl.

variable.xml

A sample XML data document that you can use to test the use of XSL variables. The document describes the structure of a book. Its associated stylesheet is variable.xsl.

variable.xsl

A stylesheet for use with variable.xml. The stylesheet makes extensive use of XSL variables.

XSLSample.java

A sample application that offers a simple example of how to use the XSL processing capabilities of the Oracle XSLT processor. The program transforms an input XML document by using an input stylesheet. This program builds the result of XSL transformations as a DocumentFragment and does not show xsl:output features.

Run this program with any XSLT stylesheet in the directory as a first argument and its associated *.xml XML document as a second argument. For example, run the program with variable.xsl and variable.xml or string.xsl and string.xml.

XSLSample2.java

A sample application that offers a simple example of how to use the XSL processing capabilities of the Oracle XSLT processor. The program transforms an input XML document by using an input stylesheet. This program outputs the result to a stream and supports xsl:output features. Like XSLSample.java, you can run it against any pair of XML data documents and stylesheets in the directory.

Documentation for how to compile and run the sample programs is located in the README. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/parser/xslt directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\parser\xslt directory (Windows).

Make sure that your environment variables are set as described in "Setting Up the Java XDK Environment".

Run make (UNIX) or Make.bat (Windows) at the command line. The make file compiles the source code and then runs the XSLSample and XSLSample2 programs for each *.xml file and its associated *.xsl stylesheet. The program writes its output for each transformation to *.out.

You can view the *.out files to see the output for the XML transformations. You can also run the programs on the command line as follows, where name is replaced by match, math, and so forth:

java XSLSample name.xsl name.xml
java XSLSample2 name.xsl name.xml

For example, run the match.xml demos as follows:

java XSLSample match.xsl match.xml
java XSLSample2 match.xsl match.xml

Using the XSLT Processor Command-Line Utility

The XDK includes oraxsl, which is a command-line Java interface that can apply a stylesheet to multiple XML documents. The $ORACLE_HOME/bin/oraxsl and %ORACLE_HOME%\bin\oraxsl.bat shell scripts execute the oracle.xml.jaxb.oraxsl class. To use oraxsl ensure that your CLASSPATH is set as described in "Setting Up the Java XDK Environment".

Use the following syntax on the command line to invoke oraxsl:

oraxsl options source stylesheet result

The oraxsl utility expects a stylesheet, an XML file to transform, and an optional result file. If you do not specify a result file, then the utility sends the transformed document to standard output. If multiple XML documents need to be transformed by a stylesheet, then use the -l or -d options in conjunction with the -s and -r options. These and other options are described in Table 6-2.

Table 6-2 Command Line Options for oraxsl

Option
Description

-w

Shows warnings. By default, warnings are turned off.

-e error_log

Specifies file into which the program writes errors and warnings.

-l xml_file_list

Lists files to be processed.

-d directory

Specifies the directory that contains the files to transform. The default behavior is to process all files in the directory. If only a subset of the files in that directory, for example, one file, need to be processed, then change this behavior by setting -l and specifying the files that need to be processed. You can also change the behavior by using the -x or -i option to select files based on their extension.

-x source_extension

Specifies extensions for the files that should be excluded. Use this option in conjunction with -d. The program does not select any files with the specified extension.

-i source_extension

Specifies extensions for the files that should be included. Use this option in conjunction with -d. The program selects only files with the specified extension.

-s stylesheet

Specifies the stylesheet. If you set -d or -l, then set -s to indicate the stylesheet to be used. You must specify the complete path.

-r result_extension

Specifies the extension to use for results. If you set -d or -l, then set -r to specify the extension to be used for the results of the transformation. So, if you specify the extension out, the program transformed an input document doc to doc.out. By default, the program places the results in the current directory. You can change this behavior by using the -o option, which allows you to specify a directory for the results.

-o result_directory

Specifies the directory in which to place results. You must set this option in conjunction with the -r option.

-p param_list

Lists parameters.

-t num_of_threads

Specifies the number of threads to use for processing. Using multiple threads can provide performance improvements when processing multiple documents.

-v

Generates verbose output. The program prints some debugging information and can help in tracing any problems that are encountered during processing.

-debug

Generates debugging output. By default, debug mode is disabled. Note that a GUI version of the XSLT debugger is available in Oracle JDeveloper.

Using the XSLT Processor Command-Line Utility: Example

You can test oraxsl on the various XML files and stylesheets in $ORACLE_HOME/xdk/demo/java/parser/xslt. Example 6-1 displays the contents of math.xml.

Example 6-1 math.xml

<?xml version="1.0"?>
<doc>
  <n1>5</n1>
  <n2>2</n2>
  <div>-5</div>
  <mod>2</mod>
</doc>

The XSLT stylesheet named math.xsl is shown in Example 6-2.

Example 6-2 math.xsl

<?xml version="1.0"?><xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:template match="doc">
    <HTML>
      <H1>Test for mod.</H1>
      <HR/>
      <P>Should say "1": <xsl:value-of select="5 mod 2"/></P>
      <P>Should say "1": <xsl:value-of select="n1 mod n2"/></P>
      <P>Should say "-1": <xsl:value-of select="div mod mod"/></P>
      <P><xsl:value-of select="div or ((mod)) | or"/></P>
    </HTML>
  </xsl:template>
</xsl:stylesheet

You can run the oraxsl utility on these files to produce HTML output as shown in the following example:

oraxsl math.xml math.xsl math.htm

The output file math.htm is shown in Example 6-3.

Example 6-3 math.htm

<HTML>
   <H1>Test for mod.</H1>
   <HR>
   <P>Should say "1": 1</P>
   <P>Should say "1": 1</P>
   <P>Should say "-1": -1</P>
   <P>true</P>
</HTML>

Transforming XML

This section contains the following topics:

Performing Basic XSL Transformation

Obtaining DOM Results from an XSL Transformation

Performing Basic XSL Transformation

As explained in "Using the XSLT Processor for Java: Overview", the fundamental classes used by the XSLT processor are DOMParser and XSLProcessor. The XSL2Sample.java demo program provides a good illustration of how to use these classes to transform an XML document with an XSLT stylesheet.

Use the following basic steps to write Java programs that use the XSLT processor:

Create a DOM parser object that you can use to parse the XML data documents and XSLT stylesheets. The following code fragment from XSL2Sample.java illustrates how to instantiate a parser:

XMLDocument xml, xsldoc, out;URL xslURL;URL xmlURL;
// ...
parser = new DOMParser();parser.setPreserveWhitespace(true);

Note that by default, the parser does not preserve whitespace unless a DTD is used. It is important to preserve whitespace because it enables XSLT whitespace rules to determine how whitespace is handled.

Parse the XSLT stylesheet with the DOMParser.parse() method. The following code fragment from XSL2Sample.java illustrates how to perform the parse:

xslURL = DemoUtil.createURL(args[0]);
parser.parse(xslURL);
xsldoc = parser.getDocument();

Parse the XML data document with the DOMParser.parse() method. The following code fragment from XSL2Sample.java illustrates how to perform the parse:

xmlURL = DemoUtil.createURL(args[1]);
parser.parse(xmlURL);
xml = parser.getDocument();

Create a new XSLT stylesheet object. You can pass objects of the following classes to the XSLProcessor.newXSLStylesheet() method:

java.io.Reader

java.io.InputStream

XMLDocument

java.net.URL

For example, XSL2Sample.java illustrates how to create a stylesheet object from an XMLDocument object:

XSLProcessor processor = new XSLProcessor();
processor.setBaseURL(xslURL);
XSLStylesheet xsl = processor.newXSLStylesheet(xsldoc);

Set the XSLT processor to display any warnings. For example, XSL2Sample.java calls the showWarnings() and setErrorStream() methods as follows:

processor.showWarnings(true);
processor.setErrorStream(System.err);

Use the XSLProcessor.processXSL() method to apply the stylesheet to the input XML data document. Table 6-3 lists some of the other available XSLProcessor methods.

Table 6-3 XSLProcessor Methods

Method
Description

removeParam()

Removes parameters.

resetParams()

Resets all parameters.

setParam()

Sets parameters for the transformation.

setBaseUrl()

Sets a base URL for any relative references in the stylesheet.

setEntityResolver()

Sets an entity resolver for any relative references in the stylesheet.

setLocale()

Sets a locale for error reporting.

The following code fragment from XSL2Sample.java shows how to apply the stylesheet to the XML document:

processor.processXSL(xsl, xml, System.out);

Process the transformed output. You can transform the results by creating an XML document object, writing to an output stream, or reporting SAX events.

The following code fragment from XSL2Sample.java shows how to print the results:

processor.processXSL(xsl, xml, System.out);

See Also:

http://www.w3.org/TR/xslt

http://www.w3.org/style/XSL

Chapter 4, "XML Parsing for Java"

Obtaining DOM Results from an XSL Transformation

The XSLSample.java demo program illustrates how to generate an oracle.xml.parser.v2.XMLDocumentFragment object as the result of an XSL transformation. An XMLDocumentFragment is a "lightweight" Document object that extracts a portion of an XML document tree. The XMLDocumentFragment class implements the org.w3c.dom.DocumentFragment interface.

The XSL2Sample.java program illustrates how to generate a DocumentFragment object. The basic steps for transforming XML are the same as those described in "Performing Basic XSL Transformation". The only difference is in the arguments passed to the XSLProcessor.processXSL() method. The following code fragment from XSL2Sample.java shows how to create the DOM fragment and then print it to standard output:

XMLDocumentFragment result = processor.processXSL(xsl, xml);
result.print(System.out);

Table 6-4 lists some of the XMLDocumentFragment methods that you can use to manipulate the object.

Table 6-4 XMLDocumentFragment Methods

Method
Description

getAttributes()

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise

getLocalName()

Gets the local name for this element

getNamespaceURI()

Gets the namespace URI of this element

getNextSibling()

Gets the node immediately following the current node

getNodeName()

Gets the name of the node

getNodeType()

Gets a code that represents the type of the underlying object

getParentNode()

Gets the parent of the current node

getPreviousSibling()

Gets the node immediately preceding the current node

reportSAXEvents()

Reports SAX events from a DOM Tree

Programming with Oracle XSLT Extensions

This section contains these topics:

Overview of Oracle XSLT Extensions

Specifying Namespaces for XSLT Extension Functions

Using Static and Non-Static Java Methods in XSLT

Using Constructor Extension Functions

Using Return Value Extension Functions

Overview of Oracle XSLT Extensions

The XSLT 1.0 standard defines two kinds of extensions: extension elements and extension functions. The XDK provides extension functions for XSLT processing that enable users of the XSLT processor to call any Java method from XSL expressions. Note the following guidelines when using Oracle XSLT extensions:

When you define an XSLT extension in a given programming language, you can only use the XSLT stylesheet with XSLT processors that can invoke this extension. Thus, only the Java version of the processor can invoke extension functions that are defined in Java.

Use XSLT extensions only if the built-in XSL functions cannot solve a given problem.

As explained in the following section, the namespace of the extension class must start with the proper URL.

The following Oracle extension functions are particularly useful:

<ora:output>, you can use <ora:output> as a top-level element or in an XSL template. If used as a top-level element, it is similar to the <xsl:output> extension function, except that it has an additional name attribute. When used as a template, it has the additional attributes use and href. This function is useful for creating multiple outputs from one XSL transformation.

<ora:node-set>, which converts a result tree fragment into a node-set. This function is useful when you want to refer the existing text or intermediate text results in XSL for further transformation.

Specifying Namespaces for XSLT Extension Functions

The Oracle Java extension functions belong to the namespace that corresponds to the following URI:

http://www.oracle.com/XSL/Transform/java/

An extension function that belongs to the following namespace refers to methods in the Java classname, so that you can construct URIs in the following format:

http://www.oracle.com/XSL/Transform/java/classname

For example, you can use the following namespace to call java.lang.String methods from XSL expressions:

http://www.oracle.com/XSL/Transform/java/java.lang.String

Note:

When assigning the xsl prefix to a namespace, the correct URI is xmlns:xsl="http://www.w3.org/1999/XSL/Transform". Any other URI fails to give correct output.

Using Static and Non-Static Java Methods in XSLT

If the Java method is a non-static method of the class, then the first parameter is used as the instance on which the method is invoked, and the rest of the parameters are passed to the method. If the extension function is a static method, however, then all the parameters of the extension function are passed as parameters to the static function. Example 6-4 shows how to use the java.lang.Math.ceil() method in an XSLT stylesheet.

Example 6-4 Using a Static Function in an XSLT Stylesheet

<xsl:stylesheet version="1.0"
  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  xmlns:math="http://www.oracle.com/XSL/Transform/java/java.lang.Math">
  <xsl:template match="/">
    <xsl:value-of select="math:ceil('12.34')"/>
  </xsl:template>
</xsl:stylesheet>

For example, you can create Example 6-4 as stylesheet ceil.xsl and then apply it to any well-formed XML document. For example, run the oraxsl utility as follows:

oraxsl ceil.xsl ceil.xsl ceil.out

The output document ceil.out has the following content:

<?xml version = '1.0' encoding = 'UTF-8'?>
13

Note:

The XSL class loader only knows about statically added JARs and paths in the CLASSPATH as well as those specified by wrapper.classpath. Files added dynamically are not visible to XSLT processor.

Using Constructor Extension Functions

The extension function new creates a new instance of the class and acts as the constructor. Example 6-5 creates a new String object with the value "Hello World," stores it in the XSL variable str1, and then outputs it in uppercase.

Example 6-5 Using a Constructor in an XSLT Stylesheet

<xsl:stylesheet version="1.0"
  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  xmlns:jstring="http://www.oracle.com/XSL/Transform/java/java.lang.String">
  <xsl:template match="/">
    <!-- creates a new java.lang.String and stores it in the variable str1 -->
    <xsl:variable name="str1" select="jstring:new('HeLlO wOrLd')"/>
    <xsl:value-of select="jstring:toUpperCase($str1)"/>
  </xsl:template>
</xsl:stylesheet>

For example, you can create this stylesheet as hello.xsl and apply it to any well-formed XML document. For example, run the oraxsl utility as follows:

oraxsl hello.xsl hello.xsl hello.out

The output document hello.out has the following content:

<?xml version = '1.0' encoding = 'UTF-8'?>
HELLO WORLD

Using Return Value Extension Functions

The result of an extension function can be of any type, including the five types defined in XSL and the additional simple XML Schema data types defined in XSLT 2.0:

NodeSet

Boolean

String

Number

ResultTree

You can store these data types in variables or pass to other extension functions. If the result is of one of the five types defined in XSL, then the result can be returned as the result of an XSL expression.

The XSLT Processor supports overloading based on the number of parameters and type. The processor performs implicit type conversion between the five XSL types as defined in XSL. It performs type conversion implicitly among the following datatypes, and also from NodeSet to the following datatypes:

String

Number

Boolean

ResultTree

Overloading based on two types that can be implicitly converted to each other is not permitted. The following overloading results in an error in XSL because String and Number can be implicitly converted to each other:

overloadme(int i){}

overloadme(String s){}

Mapping between XSL datatypes and Java datatypes is done as follows:

String     ->     java.lang.String
Number     ->     int, float, double
Boolean    ->     boolean
NodeSet    ->     NodeList
ResultTree ->     XMLDocumentFragment

The stylesheet in Example 6-6 parses the variable.xml document, which is located in the directory $ORACLE_HOME/xdk/demo/java/parser/xslt, and retrieves the value of the <title> child of the <chapter> element.

Example 6-6 gettitle.xsl

<xsl:stylesheet version="1.0"
  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  xmlns:parser = "http://www.oracle.com/XSL/Transform/java/oracle.xml.parser.v2.DOMParser"
  xmlns:document =
    "http://www.oracle.com/XSL/Transform/java/oracle.xml.parser.v2.XMLDocument">

  <xsl:template match ="/">
    <!-- Create a new instance of the parser and store it in myparser variable -->
    <xsl:variable name="myparser" select="parser:new()"/>

    <!-- Call an instance method of DOMParser. The first parameter is the object.
     The PI is equivalent to $myparser.parse('file:/my_path/variable.xml'). Note
     that you should replace my_path with the absolute path on your system. -->
    <xsl:value-of select="parser:parse($myparser, 'file:/my_path/variable.xml')"/>

    <!-- Get the document node of the XML Dom tree -->
    <xsl:variable name="mydocument" select="parser:getDocument($myparser)"/>

    <!-- Invoke getelementsbytagname on mydocument -->
    <xsl:for-each select="document:getElementsByTagName($mydocument,'chapter')">
      The value of the title element is: <xsl:value-of select="docinfo/title" />
    </xsl:for-each>
  </xsl:template>
</xsl:stylesheet>

You can create Example 6-6 as gettitle.xsl and then run oraxsl as follows:

oraxsl gettitle.xsl gettitle.xsl variable.out

The output document variable.out has the following content:

<?xml version = '1.0' encoding = 'UTF-8'?>
The value of the title element is: Section Tests

Tips and Techniques for Transforming XML

This section lists XSL and XSLT Processor for Java hints, and contains these topics:

Merging XML Documents with XSLT

Creating an HTML Input Form Based on the Columns in a Table

Merging XML Documents with XSLT

"Merging Documents with appendChild()" discusses the DOM technique for merging documents. If the merging operation is simple, then you can also use an XSLT-based approach. Suppose that you want to merge the XML documents in Example 6-7 and Example 6-8.

Example 6-7 msg_w_num.xml

<messages>
  <msg>
    <key>AAA</key>
    <num>01001</num>
  </msg>
  <msg>
    <key>BBB</key>
    <num>01011</num>
  </msg>
</messages>

Example 6-8 msg_w_text.xml

<messages>
  <msg>
    <key>AAA</key>
    <text>This is a Message</text>
  </msg>
  <msg>
    <key>BBB</key>
    <text>This is another Message</text>
  </msg>
</messages>

Example 6-9 displays a sample stylesheet that merges the two XML documents based on matching the <key/> element values.

Example 6-9 msgmerge.xsl

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output indent="yes"/>
  <!-- store msg_w_text.xml in doc2 variable -->
  <xsl:variable name="doc2" select="document('msg_w_text.xml')"/>

  <!-- match each node in input xml document, that is, msg_w_num.xml -->
  <xsl:template match="@*|node()">
     <!-- copy the current node to the result tree -->
     <xsl:copy>
        <xsl:apply-templates select="@*|node()"/>
     </xsl:copy>
  </xsl:template>

  <!-- match each <msg> element in msg_w_num.xml -->
  <xsl:template match="msg">
     <xsl:copy>
        <xsl:apply-templates select="@*|node()"/>
        <!-- insert two spaces so indentation is correct in output document -->
        <xsl:text>  </xsl:text>
        <!-- copy <text> node from msg_w_text.xml into result tree -->
        <text><xsl:value-of
               select="$doc2/messages/msg[key=current()/key]/text"/>
        </text>
     </xsl:copy>
  </xsl:template>
</xsl:stylesheet>

Create the XML files in Example 6-7, Example 6-8, and Example 6-9 and run the following at the command line:

oraxsl msg_w_num.xml msgmerge.xsl msgmerge.xml

Example 6-10 shows the output document, which merges the data contained in msg_w_num.xml and msg_w_text.xml.

Example 6-10 msgmerge.xml

<?xml version = '1.0' encoding = 'UTF-8'?>
<messages>
  <msg>
    <key>AAA</key>
    <num>01001</num>
    <text>This is a Message</text>
   </msg>
  <msg>
    <key>BBB</key>
    <num>01011</num>
    <text>This is another Message</text>
   </msg>
</messages>

This technique is not as efficient for larger files as an equivalent database join of two tables, but it is useful if you have only XML files to work with.

Creating an HTML Input Form Based on the Columns in a Table

Suppose that you want to generate an HTML form for inputting data that uses column names from a database table. You can achieve this goal by using XSU to obtain an XML document based on the user_tab_columns table and XSLT to transform the XML into an HTML form.

Use XSU to generate an XML document based on the columns in the table. For example, suppose that the table is hr.employees. You can run XSU from the command line as follows:

java OracleXML getXML -user "hr/password"\
 "SELECT column_name FROM user_tab_columns WHERE table_name = 'EMPLOYEES'"

Save the XSU output as an XML file called emp_columns.xml. The XML should look like the following, with one <ROW> element corresponding to each column in the table (some <ROW> elements have been removed to conserve space):

<?xml version = '1.0'?><ROWSET>
   <ROW num="1">
      <COLUMN_NAME>EMPLOYEE_ID</COLUMN_NAME>
   </ROW>
   <ROW num="2">
      <COLUMN_NAME>FIRST_NAME</COLUMN_NAME>
   </ROW>
   <!-- rows 3 through 10 -->
   <ROW num="11">
      <COLUMN_NAME>DEPARTMENT_ID</COLUMN_NAME>
   </ROW>
</ROWSET>

Create a stylesheet to transform the XML into HTML. For example, create the columns.xsl stylesheet as follows:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output method="html"/>
  <xsl:template match="/">
    <HTML>
      <xsl:apply-templates select="@*|node()"/>
    </HTML>
  </xsl:template>
  <xsl:template match="ROW">
    <xsl:value-of select="COLUMN_NAME"/>
    <xsl:text>&nbsp;</xsl:text>
    <INPUT NAME="{COLUMN_NAME}"/>
    <BR/>
  </xsl:template>
</xsl:stylesheet>

Run the oraxsl utility to generate the HTML form. For example:

oraxsl emp_columns.xml columns.xsl emp_form.htm

Review the output HTML form, which should have the following contents:

<HTML>
   EMPLOYEE_ID&nbsp;<INPUT NAME="EMPLOYEE_ID"><BR>
   FIRST_NAME&nbsp;<INPUT NAME="FIRST_NAME"><BR>
   LAST_NAME&nbsp;<INPUT NAME="LAST_NAME"><BR>
   EMAIL&nbsp;<INPUT NAME="EMAIL"><BR>
   PHONE_NUMBER&nbsp;<INPUT NAME="PHONE_NUMBER"><BR>
   HIRE_DATE&nbsp;<INPUT NAME="HIRE_DATE"><BR>
   JOB_ID&nbsp;<INPUT NAME="JOB_ID"><BR>
   SALARY&nbsp;<INPUT NAME="SALARY"><BR>
   COMMISSION_PCT&nbsp;<INPUT NAME="COMMISSION_PCT"><BR>
   MANAGER_ID&nbsp;<INPUT NAME="MANAGER_ID"><BR>
   DEPARTMENT_ID&nbsp;<INPUT NAME="DEPARTMENT_ID"><BR>
</HTML>

7 Using the Schema Processor for Java

This chapter contains these topics:

Introduction to XML Validation

Using the XML Schema Processor: Overview

Validating XML with XML Schemas

Tips and Techniques for Programming with XML Schemas

Introduction to XML Validation

This section describes the different techniques for XML validation. It discusses the following topics:

Prerequisites

Standards and Specifications

XML Validation with DTDs

XML Validation with XML Schemas

Differences Between XML Schemas and DTDs

Prerequisites

This chapter assumes that you have working knowledge of the following technologies:

Document Type Definition (DTD). An XML DTD defines the legal structure of an XML document.

XML Schema language. XML Schema defines the legal structure of an XML document.

If you are unfamiliar with these technologies or need to refresh your knowledge, you can consult the XML resources in "Related Documents" of the preface.

See Also:

http://www.w3schools.com/dtd/ for a DTD tutorial

http://www.w3schools.com/schema for an XML Schema language tutorial

Standards and Specifications

XML Schema is a W3C standard. You can find the XML Schema specifications at the following locations:

http://www.w3.org/TR/xmlschema-0/ for the W3C XML Schema Primer

http://www.w3.org/TR/xmlschema-1/ for the definition of the XML Schema language structures

http://www.w3.org/TR/xmlschema-2/ for the definition of the XML Schema language datatypes

The Oracle XML Schema processor supports the W3C XML Schema specifications.

See Also:

Chapter 31, "XDK Standards" for a summary of the standards supported by the XDK

XML Validation with DTDs

DTDs were originally developed for SGML. XML DTDs are a subset of those available in SGML and provide a mechanism for declaring constraints on XML markup. XML DTDs enable the specification of the following:

Which elements can be in your XML documents

The content model of an XML element, that is, whether the element contains only data or has a set of subelements that defines its structure. DTDs can define whether a subelement is optional or mandatory and whether it can occur only once or multiple times.

Attributes of XML elements. DTDs can also specify whether attributes are optional or mandatory.

Entities that are legal in your XML documents.

An XML DTD is not itself written in XML, but is a context-independent grammar for defining the structure of an XML document. You can declare a DTD in an XML document itself or in a separate file from the XML document.

Validation is the process by which you verify an XML document against its associated DTD, ensuring that the structure, use of elements, and use of attributes are consistent with the definitions in the DTD. Thus, applications that handle XML documents can assume that the data matches the definition.

By using the XDK, you can write an application that includes a validating XML parser, that is, a program that parses and validates XML documents against a DTD. Note the following aspects of parsers that perform DTD validation:

Depending on its implementation, a validating parser may stop processing when it encounters an error, or continue.

A validating parser may report warnings and errors as they occur as in summary form at the end of processing.

Most processors can enable or disable validation mode, but they must still process entity definitions and other constructs of DTDs.

DTD Samples in the XDK

Example 7-1 shows the contents of a DTD named family.dtd, which is located in $ORACLE_HOME/xdk/demo/java/parser/common/. The <ELEMENT> tags specify the legal nomenclature and structure of elements in the document, whereas the <ATTLIST> tags specify the legal attributes of elements.

Example 7-1 family.dtd

<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT family (member*)>
<!ATTLIST family lastname CDATA #REQUIRED>
<!ELEMENT member (#PCDATA)>
<!ATTLIST member memberid ID #REQUIRED>
<!ATTLIST member dad IDREF #IMPLIED>
<!ATTLIST member mom IDREF #IMPLIED>

Example 7-2 shows the contents of an XML document named family.xml, which is also located in $ORACLE_HOME/xdk/demo/java/parser/common/. The <!DOCTYPE> element in family.xml specifies that this XML document conforms to the external DTD named family.dtd.

Example 7-2 family.xml

<?xml version="1.0" standalone="no"?>
<!DOCTYPE family SYSTEM "family.dtd">
<family lastname="Smith">
<member memberid="m1">Sarah</member>
<member memberid="m2">Bob</member>
<member memberid="m3" mom="m1" dad="m2">Joanne</member>
<member memberid="m4" mom="m1" dad="m2">Jim</member>
</family>

XML Validation with XML Schemas

The XML Schema language, also known as XML Schema Definition, was created by the W3C to use XML syntax to describe the content and the structure of XML documents. An XML schema is an XML document written in the XML Schema language. An XML schema document contains rules describing the structure of an input XML document, called an instance document. An instance document is valid if and only if it conforms to the rules of the XML schema.

The XML Schema language defines such things as the following:

Which elements and attributes are legal in the instance document

Which elements can be children of other elements

The order and number of child elements

Datatypes for elements and attributes

Default and fixed values for elements and attributes

A validating XML parser tries to determine whether an instance document conforms to the rules of its associated XML schema. By using the XDK, you can write a validating parser that performs this schema validation. Note the following aspects of parsers that perform schema validation:

Depending on its implementation, the parser may stop processing when it encounters an error, or continue.

The parser may report warnings and errors as they occur as in summary form at the end of processing.

The processor must take into account entity definitions and other constructs that are defined in a DTD that is included by the instance document. The XML Schema language does not define what must occurs when an instance document includes both an XML schema and a DTD. Thus, the behavior of the application in such cases depends on the implementation.

XML Schema Samples in the XDK

Example 7-3 shows a sample XML document that contains a purchase report that describes the parts that have been ordered in different regions. This sample file is located at $ORACLE_HOME/xdk/demo/java/schema/report.xml.

Example 7-3 report.xml

<purchaseReport
  xmlns="http://www.example.com/Report"
  xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.example.com/Report  report.xsd"
  period="P3M" periodEnding="1999-12-31">

 <regions>
  <zip code="95819">
   <part number="872-AA" quantity="1"/>
   <part number="926-AA" quantity="1"/>
   <part number="833-AA" quantity="1"/>
   <part number="455-BX" quantity="1"/>
  </zip>
  <zip code="63143">
   <part number="455-BX" quantity="4"/>
  </zip>
 </regions>
 <parts>
  <part number="872-AA">Lawnmower</part>
  <part number="926-AA">Baby Monitor</part>
  <part number="833-AA">Lapis Necklace</part>
  <part number="455-BX">Sturdy Shelves</part>
 </parts>
</purchaseReport>

Example 7-4 shows the XML schema document named report.xsd, which is the sample XML schema document that you can use to validate report.xml. Among other things, the XML schema defines the names of the elements that are legal in the instance document as well as the type of data that the elements can contain.

Example 7-4 report.xsd

<schema targetNamespace="http://www.example.com/Report"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:r="http://www.example.com/Report"
        elementFormDefault="qualified">

 <annotation>
  <documentation xml:lang="en">
   Report schema for Example.com
   Copyright 2000 Example.com. All rights reserved.
  </documentation>
 </annotation>

 <element name="purchaseReport">
  <complexType>
   <sequence>
    <element name="regions" type="r:RegionsType">
     <keyref name="dummy2" refer="r:pNumKey">
      <selector xpath="r:zip/r:part"/>
      <field xpath="@number"/>
     </keyref>
    </element>

    <element name="parts" type="r:PartsType"/>
   </sequence>
   <attribute name="period"       type="duration"/>
   <attribute name="periodEnding" type="date"/>
  </complexType>

  <unique name="dummy1">
   <selector xpath="r:regions/r:zip"/>
   <field xpath="@code"/>
  </unique>

  <key name="pNumKey">
   <selector xpath="r:parts/r:part"/>
   <field xpath="@number"/>
  </key>
 </element>
 <complexType name="RegionsType">
  <sequence>
   <element name="zip" maxOccurs="unbounded">
    <complexType>
     <sequence>
      <element name="part" maxOccurs="unbounded">
       <complexType>
        <complexContent>
         <restriction base="anyType">
          <attribute name="number"   type="r:SKU"/>
          <attribute name="quantity" type="positiveInteger"/>
         </restriction>
        </complexContent>
       </complexType>
      </element>
     </sequence>
     <attribute name="code" type="positiveInteger"/>
    </complexType>
   </element>
  </sequence>
 </complexType>

 <simpleType name="SKU">
  <restriction base="string">
   <pattern value="\d{3}-[A-Z]{2}"/>
  </restriction>
 </simpleType>

 <complexType name="PartsType">
  <sequence>
   <element name="part" maxOccurs="unbounded">
    <complexType>
     <simpleContent>
      <extension base="string">
       <attribute name="number" type="r:SKU"/>
      </extension>
     </simpleContent>
    </complexType>
   </element>
  </sequence>
 </complexType>

</schema>

Differences Between XML Schemas and DTDs

The XML Schema language includes most of the capabilities of the DTD specification. An XML schema serves a similar purpose to a DTD, but is more flexible in specifying document constraints. Table 7-1 compares some of the features between the two validation mechanisms.

Table 7-1 Feature Comparison Between XML Schema and DTD

Feature
XML Schema
DTD

Element nesting

X

X

Element occurrence constraints

X

X

Permitted attributes

X

X

Attribute types and default values

X

X

Written in XML

X

Namespace support

X

Built-In datatypes

X

User-Defined datatypes

X

Include/Import

X

Refinement (inheritance)

X

The following reasons are probably the most persuasive for choosing XML schema validation over DTD validation:

The XML Schema language enables you to define rules for the content of elements and attributes. You achieve control over content by using datatypes. With XML Schema datatypes you can more easily perform actions such as the following:

Declare which elements should contain which types of data, for example, positive integers in one element and years in another

Process data obtained from a database

Define restrictions on data, for example, a number between 10 and 20

Define data formats, for example, dates in the form MM-DD-YYYY

Convert data between different datatypes, for example, strings to dates

Unlike DTD grammar, documents written in the XML Schema language are themselves written in XML. Thus, you can perform the following actions:

Use your XML parser to parse your XML schema

Process your XML schema with the XML DOM

Transform your XML document with XSLT

Reuse your XML schemas in other XML schemas

Extend your XML schema by adding elements and attributes

Reference multiple XML schemas from the same document

Using the XML Schema Processor: Overview

The Oracle XML Schema processor is a SAX-based XML schema validator that you can use to validate instance documents against an XML schema. The processor supports both LAX and strict validation.

You can use the processor in the following ways:

Enable it in the XML parser

Use it with a DOM tree to validate whole or part of an XML document

Use it as a component in a processing pipeline (like a content handler)

You can configure the schema processor in different ways depending on your requirements. For example, you can do the following:

Use a fixed XML schema or automatically build a schema based on the schemaLocation attributes in an instance document.

Set XMLError and entityResolver to gain better control over the validation process.

Determine how much of an instance document should be validated. You can use any of the validation modes specified in Table 4-1. You can also designate a type of element as the root of validation.

Using the XML Schema Processor: Basic Process

The following XDK packages are important for applications that process XML schemas:

oracle.xml.parser.v2, which provides APIs for XML parsing

oracle.xml.parser.schema, which provides APIs for XML Schema processing

The most important classes in the oracle.xml.parser.schema package are described in Table 7-2. These form the core of most XML schema applications.

Table 7-2 oracle.xml.parser.schema Classes

Class/Interface
Description
Methods

XMLSchema class

Represents XML Schema component model. An XMLSchema object is a set of XMLSchemaNodes that belong to different target namespaces. The XSDValidator class uses XMLSchema for schema validation or metadata.

The principal methods are as follows:

get methods such as getElement() and getSchemaTargetNS() obtain information about the XML schema

printSchema() prints information about the XML schema

XMLSchemaNode class

Represents schema components in a target namespace, including type definitions, element and attribute delcarations, and group and attribute group definitions.

The principal methods are get methods such as getElementSet() and getAttributeDeclarations() obtain components of the XML schema.

XSDBuilder class

Builds an XMLSchema object from an XML schema document. The XMLSchema object is a set of objects (Infoset items) corresponding to top-level schema declarations and definitions. The schema document is XML parsed and converted to a DOM tree.

The principal methods are as follows:

build() creates an XMLSchema object.

getObject() returns the XMLSchema object.

setEntityResolver() sets an EntityResolver for resolving imports and includes.

XSDValidator class

Validates an instance XML document against an XML schema. When registered, an XSDValidator object is inserted as a pipeline node between XMLParser and XMLDocument events handlers.

The principal methods are as follows:

get methods such as getCurrentMode() and getElementDeclaration()

set methods such as setXMLProperty() and setDocumentLocator()

startDocument() receives notification of the beginning of the document.

startElement() receives notification of the beginning of the element.

Figure 7-1 depicts the basic process of validating an instance document with the XML Schema processor.

Figure 7-1 XML Schema Processor

Description of Figure 7-1 follows
Description of "Figure 7-1 XML Schema Processor"

The XML Schema processor performs the following major tasks:

A builder (XSDBuilder object) assembles the XML schema from an input XML schema document. Although instance documents and schemas need not exist specifically as files on the operating system, they are commonly referred to as files. They may exist as streams of bytes, fields in a database record, or collections of XML Infoset "Information Items."

This task involves parsing the schema document into an object. The builder creates the schema object explicitly or implicitly:

In explicit mode, you pass in an XML schema when you invoke the processor. "Validating Against Externally Referenced XML Schemas" explains how to build the schema object in explicit mode.

In implicit mode, you do not pass in an XML schema when you invoke the processor because the schema is internally referenced by the instance document. "Validating Against Internally Referenced XML Schemas" explains how to create the schema object in implicit mode.

The XML schema validator uses the schema object to validate the instance document. This task involves the following steps:

A SAX parser parses the instance document into SAX events, which it passes to the validator.

The validator receives SAX events as input and validates them against the schema object, sending an error message if it finds invalid XML components.

"Validation in the XML Parser" describes the validation modes that you can use when validating the instance document. If you do not explicitly set a schema for validation with the XSDBuilder class, then the instance document must have the correct xsi:schemaLocation attribute pointing to the schema file. Otherwise, the program will not perform the validation. If the processor encounters errors, it generates error messages.

The validator sends input SAX events, default values, or post-schema validation information to a DOM builder or application.

See Also:

Oracle Database XML Java API Reference to learn about the XSDBuilder, DOMParser, and SAXParser classes

Chapter 7, "Using the Schema Processor for Java" to learn about the XDK SAX and DOM parsers

Running the XML Schema Processor Demo Programs

Demo programs for the XML Schema processor for Java are included in $ORACLE_HOME/xdk/demo/java/schema. Table 7-3 describes the XML files and programs that you can use to test the XML Schema processor.

Table 7-3 XML Schema Sample Files

File
Description

cat.xsd

A sample XML schema used by the XSDSetSchema.java program to validate catalogue.xml. The cat.xsd schema specifies the structure of a catalogue of books.

catalogue.xml

A sample instance document that the XSDSetSchema.java program uses to validate against the cat.xsd schema.

catalogue_e.xml

A sample instance document used by the XSDSample.java program. When the program tries to validate this document against the cat.xsd schema, it generates schema errors.

DTD2Schema.java

This sample program converts a DTD (first argument) into an XML Schema and uses it to validate an XML file (second argument).

embeded_xsql.xsd

The XML schema used by XSDLax.java. The schema defines the structure of an XSQL page.

embeded_xsql.xml

The instance document used by XSDLax.java.

juicer1.xml

A sample XML document for use with xsdproperty.java. The XML schema that defines this document is juicer1.xsd.

juicer1.xsd

A sample XML schema for use with xsdproperty.java. This XML schema defines juicer1.xml.

juicer2.xml

A sample XML document for use with xsdproperty.java. The XML schema that defines this document is juicer2.xsd.

juicer2.xsd

A sample XML document for use with xsdproperty.java. This XML schema defines juicer2.xml.

report.xml

The sample XML file that XSDSetSchema.java uses to validate against the XML schema report.xsd.

report.xsd

A sample XML schema used by the XSDSetSchema.java program to validate the contents of report.xml. The report.xsd schema specifies the structure of a purchase order.

report_e.xml

When the program validates this sample XML file using XSDSample.java, it generates XML Schema errors.

xsddom.java

This program shows how to validate an instance document by obtain a DOM representation of the document and using an XSDValidator object to validate it.

xsdent.java

This program validates an XML document by redirecting the referenced schema in the SchemaLocation attribute to a local version.

xsdent.xml

This XML document describes a book. The file is used as an input to xsdent.java.

xsdent.xsd

This XML schema document defines the rules for xsdent.xml. The schema document contains a schemaLocation attribute set to xsdent-1.xsd.

xsdent-1.xsd

The XML schema document referenced by the schemaLocation attribute in xsdent.xsd.

xsdproperty.java

This demo shows how to configure the XML Schema processor to validate an XML document based on a complex type or element declaration.

xsdsax.java

This demo shows how to validate an XML document received as a SAX stream.

XSDLax.java

This demo is the same as XSDSetSchema.java but sets the SCHEMA_LAX_VALIDATION flag for LAX validation.

XSDSample.java

This program is a sample driver that you can use to process XML instance documents.

XSDSetSchema.java

This program is a sample driver to process XML instance documents by overriding the schemaLocation. The program uses the XML Schema specification from cat.xsd to validate the contents of catalogue.xml.

Documentation for how to compile and run the sample programs is located in the README in the same directory. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/schema directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\schema directory (Windows).

Run make (UNIX) or Make.bat (Windows) at the command line.

Add xmlparserv2.jar, xschema.jar, and the current directory to the CLASSPATH. These JAR files are located in $ORACLE_HOME/lib (UNIX) and %ORACLE_HOME%\lib (Windows). For example, you can set the CLASSPATH as follows with the tcsh shell on UNIX:

setenv CLASSPATH
 "$CLASSPATH":$ORACLE_HOME/lib/xmlparserv2.jar:$ORACLE_HOME/lib/schema.jar:.

Note that the XML Schema processor requires JDK version 1.2 or higher and is usable on any operating system with Java 1.2 support.

Run the sample programs with the XML files that are included in the directory:

The following examples use report.xsd to validate the contents of report.xml:

java XSDSample report.xml
java XSDSetSchema report.xsd report.xml

The following example validates an instance document in Lax mode:

java XSDLax embeded_xsql.xsd embeded_xsql.xml

The following examples use cat.xsd to validate the contents of catalogue.xml:

java XSDSample catalogue.xml
java XSDSetSchema cat.xsd catalogue.xml

The following examples generates error messages:

java XSDSample catalogue_e.xml
java XSDSample report_e.xml

The following example uses the schemaLocation attribute in xsdent.xsd to redirect the XML schema to xsdent-1.xsd for validation:

java xsdent xsdent.xml xsdent.xsd

The following example generates a SAX stream from report.xml and validates it against the XML schema defined in report.xsd:

java xsdsax report.xsd report.xml

The following example creates a DOM representation of report.xml and validates it against the XML schema defined in report.xsd:

java xsddom report.xsd report.xml

The following examples configure validation starting with an element declaration or complex type definition:

java xsdproperty juicer1.xml juicer1.xsd http://www.juicers.org \
juicersType false > juicersType.out

java xsdproperty juicer2.xml juicer2.xsd http://www.juicers.org \
Juicers true > juicers_e.out

The following example converts a DTD (dtd2schema.dtd) into an XML schema and uses it to validate an instance document (dtd2schema.xml):

java DTD2Schema dtd2schema.dtd dtd2schema.xml

Using the XML Schema Processor Command-Line Utility

"Using the XML Parser Command-Line Utility" describes how to run the oraxml command-line utility. You can use this utility to validate instance documents against XML schemas and DTDs.

Using oraxml to Validate Against a Schema

Change into the $ORACLE_HOME/xdk/demo/java/schema directory. Example 7-5 shows how you can validate report.xml against report.xsd by executing the following on the command line.

Example 7-5 Using oraxml to Validate Against a Schema

oraxml -schema -enc report.xml

You should obtain the following output:

The encoding of the input file: UTF-8
The input XML file is parsed without errors using Schema validation mode.

Using oraxml to Validate Against a DTD

Change into the $ORACLE_HOME/xdk/demo/java/parser/common directory. Example 7-6 shows how you can validate family.xml against family.dtd by executing the following on the command line.

Example 7-6 Using oraxml to Validate Against a DTD

oraxml -dtd -enc family.xml

You should obtain the following output:

The encoding of the input file: UTF-8
 The input XML file is parsed without errors using DTD validation mode.

Validating XML with XML Schemas

This section includes the following topics:

Validating Against Internally Referenced XML Schemas

Validating Against Externally Referenced XML Schemas

Validating a Subsection of an XML Document

Validating XML from a SAX Stream

Validating XML from a DOM

Validating XML from Designed Types and Elements

Validating XML with the XSDValidator Bean

Validating Against Internally Referenced XML Schemas

The $ORACLE_HOME/xdk/demo/java/schema/XSDSample.java program illustrates how to validate against an implicit XML Schema. The validation mode is implicit because the XML schema is referenced in the instance document itself.

Follow the steps in this section to write programs that use the setValidationMode() method of the oracle.xml.parser.v2.DOMParser class:

Create a DOM parser to use for the validation of an instance document. The following code fragment from XSDSample.java illustrates how to create the DOMParser object:

public class XSDSample
{
   public static void main(String[] args) throws Exception
   {
      if (args.length != 1)
      {
         System.out.println("Usage: java XSDSample <filename>");
         return;
      }
      process (args[0]);
   }

   public static void process (String xmlURI) throws Exception
   {
      DOMParser dp  = new DOMParser();
      URL       url = createURL(xmlURI);
      ...
   }
...
}

createURL() is a helper method that constructs a URL from a filename passed to the program as an argument.

Set the validation mode for the validating DOM parser with the DOMParser.setValidationMode() method. For example, XSDSample.java shows how to specify XML schema validation:

dp.setValidationMode(XMLParser.SCHEMA_VALIDATION);
dp.setPreserveWhitespace(true);

Set the output error stream with the DOMParser.setErrorStream() method. For example, XSDSample.java sets the error stream for the DOM parser object as follows:

dp.setErrorStream (System.out);

Validate the instance document with the DOMParser.parse() method. You do not have to create an XML schema object explicitly because the schema is internally referenced by the instance document. For example, XSDSample.java validates the instance document as follows:

try
{
  System.out.println("Parsing "+xmlURI);
  dp.parse(url);
  System.out.println("The input file <"+xmlURI+"> parsed without errors");
}
catch (XMLParseException pe)
{
  System.out.println("Parser Exception: " + pe.getMessage());
}
catch (Exception e)
{
  System.out.println("NonParserException: " + e.getMessage());
}

Validating Against Externally Referenced XML Schemas

The $ORACLE_HOME/xdk/demo/java/schema/XSDSetSchema.java program illustrates how to validate an XML schema explicitly. The validation mode is explicit because you use the XSDBuilder class to specify the schema to use for validation: the schema is not specified in the instance document as in implicit validation.

Follow the basic steps in this section to write Java programs that use the build() method of the oracle.xml.parser.schema.XSDBuilder class:

Build an XML schema object from the XML schema document with the XSDBuilder.build() method. The following code fragment from XSDSetSchema.java illustrates how to create the object:

public class XSDSetSchema
{
   public static void main(String[] args) throws Exception
   {
      if (args.length != 2)
      {
         System.out.println("Usage: java XSDSample <schema_file> <xml_file>");
         return;
      }

      XSDBuilder builder = new XSDBuilder();
      URL    url =  createURL(args[0]);

      // Build XML Schema Object
      XMLSchema schemadoc = (XMLSchema)builder.build(url);
      process(args[1], schemadoc);
   }
. . .

The createURL() method is a helper method that constructs a URL from the schema document filename specified on the command line.

Create a DOM parser to use for validation of the instance document. The following code from XSDSetSchema.java illustrates how to pass the instance document filename and XML schema object to the process() method:

public static void process(String xmlURI, XMLSchema schemadoc)throws Exception{
   DOMParser dp  = new DOMParser();
   URL       url = createURL (xmlURI);
   . . .

Specify the schema object to use for validation with the DOMParser.setXMLSchema() method. This step is not necessary in implicit validation mode because the instance document already references the schema. For example, XSDSetSchema.java specifies the schema as follows:

dp.setXMLSchema(schemadoc);

Set the validation mode for the DOM parser object with the DOMParser.setValidationMode() method. For example, XSDSample.java shows how to specify XML schema validation:

dp.setValidationMode(XMLParser.SCHEMA_VALIDATION);
dp.setPreserveWhitespace(true);

Set the output error stream for the parser with the DOMParser.setErrorStream() method. For example, XSDSetSchema.java sets it as follows:

dp.setErrorStream (System.out);

Validate the instance document against the XML schema with the DOMParser.parse() method. For example, XSDSetSchema.java includes the following code:

try
{
   System.out.println("Parsing "+xmlURI);
   dp.parse (url);
   System.out.println("The input file <"+xmlURI+"> parsed without errors");
}
catch (XMLParseException pe)
{
   System.out.println("Parser Exception: " + pe.getMessage());
}
catch (Exception e)
{
   System.out.println ("NonParserException: " + e.getMessage());
}

Validating a Subsection of an XML Document

In LAX mode, you can validate parts of the XML content of an instance document without validating the whole document. A LAX parser indicates that the processor should perform validation for elements in the instance document that are declared in an associated XML schema. The processor does not consider the instance document invalid if it contains no elements declared in the schema.

By using LAX mode, you can define the schema only for the part of the XML that you want to validate. The $ORACLE_HOME/xdk/demo/java/schema/XSDLax.java program illustrates how to use LAX validation. The program follows the basic steps described in "Validating Against Externally Referenced XML Schemas":

Build an XML schema object from the user-specified XML schema document.

Create a DOM parser to use for validation of the instance document.

Specify the XML schema to use for validation.

Set the validation mode for the DOM parser object.

Set the output error stream for the parser.

Validate the instance document against the XML schema by calling DOMParser.parse().

To enable LAX validation, the program sets the validation mode in the parser to SCHEMA_LAX_VALIDATION rather than to SCHEMA_VALIDATION. The following code fragment from XSDLax.java illustrates this technique:

dp.setXMLSchema(schemadoc);
dp.setValidationMode(XMLParser.SCHEMA_LAX_VALIDATION);
dp.setPreserveWhitespace (true);
. . .

You can test LAX validation by running the sample program as follows:

java XSDLax embeded_xsql.xsd embeded_xsql.xml

Validating XML from a SAX Stream

The $ORACLE_HOME/xdk/demo/java/schema/xsdsax.java program illustrates how to validate an XML document received as a SAX stream. You instantiate an XSDValidator and register it with the SAX parser as the content handler.

Follow the steps in this section to write programs that validate XML from a SAX stream:

Build an XML schema object from the user-specified XML schema document by invoking the XSDBuilder.build() method. The following code fragment from illustrates how to create the object:

XSDBuilder builder = new XSDBuilder();
URL    url =  XMLUtil.createURL(args[0]);

// Build XML Schema Object
XMLSchema schemadoc = (XMLSchema)builder.build(url);
process(args[1], schemadoc);
. . .

createURL() is a helper method that constructs a URL from the filename specified on the command line.

Create a SAX parser (SAXParser object) to use for validation of the instance document. The following code fragment from saxxsd.java passes the handles to the XML document and schema document to the process() method:

process(args[1], schemadoc);...public static void process(String xmlURI, XMLSchema schemadoc)
throws Exception
{
    SAXParser dp  = new SAXParser();
...

Configure the SAX parser. The following code fragment sets the validation mode for the SAX parser object with the XSDBuilder.setValidationMode() method:

dp.setPreserveWhitespace (true);
dp.setValidationMode(XMLParser.NONVALIDATING);

Create and configure a validator (XSDValidator object). The following code fragment illustrates this technique:

XMLError err;... err = new XMLError();
...
XSDValidator validator = new XSDValidator();
...
validator.setError(err);

Specify the XML schema to use for validation by invoking the XSDBuilder.setXMLProperty() method. The first argument is the name of the property, which is fixedSchema, and the second is the reference to the XML schema object. The following code fragment illustrates this technique:

validator.setXMLProperty(XSDNode.FIXED_SCHEMA, schemadoc);
...

Register the validator as the SAX content handler for the parser. The following code fragment illustrates this technique:

dp.setContentHandler(validator);
...

Validate the instance document against the XML schema by invoking the SAXParser.parse() method. The following code fragment illustrates this technique:

dp.parse (url);

Validating XML from a DOM

The $ORACLE_HOME/xdk/demo/java/schema/xsddom.java program shows how to validate an instance document by obtain a DOM representation of the document and using an XSDValidator object to validate it.

The xsddom.java program follows these steps:

Build an XML schema object from the user-specified XML schema document by invoking the XSDBuilder.build() method. The following code fragment from illustrates how to create the object:

XSDBuilder builder = new XSDBuilder();
URL    url =  XMLUtil.createURL(args[0]);

XMLSchema schemadoc = (XMLSchema)builder.build(url);
process(args[1], schemadoc);

createURL() is a helper method that constructs a URL from the filename specified on the command line.

Create a DOM parser (DOMParser object) to use for validation of the instance document. The following code fragment from domxsd.java passes the handles to the XML document and schema document to the process() method:

process(args[1], schemadoc);...public static void process(String xmlURI, XMLSchema schemadoc)
throws Exception
{
    DOMParser dp  = new DOMParser();
    . . .

Configure the DOM parser. The following code fragment sets the validation mode for the parser object with the DOMParser.setValidationMode() method:

dp.setPreserveWhitespace (true);
dp.setValidationMode(XMLParser.NONVALIDATING);
dp.setErrorStream (System.out);

Parse the instance document. The following code fragment illustrates this technique:

dp.parse (url);

Obtain the DOM representation of the input document. The following code fragment illustrates this technique:

XMLDocument doc = dp.getDocument();

Create and configure a validator (XSDValidator object). The following code fragment illustrates this technique:

XMLError err;... err = new XMLError();
...
XSDValidator validator = new XSDValidator();
...
validator.setError(err);

Specify the schema object to use for validation by invoking the XSDBuilder.setXMLProperty() method. The first argument is the name of the property, which in this example is fixedSchema, and the second is the reference to the schema object. The following code fragment illustrates this technique:

validator.setXMLProperty(XSDNode.FIXED_SCHEMA, schemadoc);
. . .

Obtain the root element (XMLElement) of the DOM tree and validate. The following code fragment illustrates this technique:

XMLElement root = (XMLElement)doc.getDocumentElement();
XMLElement copy = (XMLElement)root.validateContent(validator, true);
copy.print(System.out);

Validating XML from Designed Types and Elements

The $ORACLE_HOME/xdk/demo/java/schema/xsdproperty.java program shows how to configure the XML Schema processor to validate an XML document based on a complex type or element declaration.

The xsdproperty.java program follows these steps:

Create String objects for the instance document name, XML schema name, root node namespace, root node local name, and specification of element or complex type ("true" means the root node is an element declaration). The following code fragment illustrates this technique:

String xmlfile = args[0];
String xsdfile =  args[1];
...
String ns = args[2]; //namespace for the root node
String nm = args[3]; //root node's local name
String el = args[4]; //true if root node is element declaration,
                     // otherwise, the root node is a complex type

Create an XSD builder and use it to create the schema object. The following code fragment illustrates this technique:

XSDBuilder builder = new XSDBuilder();
URL    url =  XMLUtil.createURL(xsdfile);
XMLSchema  schema;
...
schema = (XMLSchema) builder.build(url);

Obtain the node. Invoke different methods depending on whether the node is an element declaration or a complex type:

If the node is an element declaration, pass the local name and namespace to the getElement() method of the schema object.

If the node is an element declaration, pass the namespace, local name, and root complex type to the getType() method of the schema object.

xsdproperty.java uses the following control structure:

QxName qname = new QxName(ns, nm);
...
XSDNode nd;
...
if (el.equals("true"))
{
  nd = schema.getElement(ns, nm);
  /* process ... */
}
else
{
  nd = schema.getType(ns, nm, XSDNode.TYPE);
  /* process ... */
}

After obtaining the node, create a new parser and set the schema to the parser to enable schema validation. The following code fragment illustrates this technique:

DOMParser dp  = new DOMParser();
URL       url = XMLUtil.createURL (xmlURI);

Set properties on the parser and then parse the URL. Invoke the schemaValidatorProperty() method as follows:

Set the root element or type property on the parser to a fully qualified name.

For a top-level element declaration, set the property name to XSDNode.ROOT_ELEMENT and the value to a QName, as illustrated by the process1() method.

For a top-level type definition, set the property name to XSDNode.ROOT_TYPE and the value to a QName, as illustrated by the process2() method.

Set the root node property on the parser to an element or complex type node.

For an element node, set the property name to XSDNode.ROOT_NODE and the value to an XSDElement node, as illustrated by the process3() method.

For a type node, set the property name to XSDNode.ROOT_NODE and the value to an XSDComplexType node, as illustrated by the process3() method.

The following code fragment shows the sequence of method invocation:

if (el.equals("true"))
{
   nd = schema.getElement(ns, nm);
   process1(xmlfile, schema, qname);
   process3(xmlfile, schema, nd);
}
else
{
   nd = schema.getType(ns, nm, XSDNode.TYPE);
   process2(xmlfile, schema, qname);
   process3(xmlfile, schema, nd);
}

The processing methods are implemented as follows:

  static void process1(String xmlURI, XMLSchema schema, QxName qname)
      throws Exception
  {
    /* create parser... */
    dp.setXMLSchema(schema);
    dp.setSchemaValidatorProperty(XSDNode.ROOT_ELEMENT, qname);
    dp.setPreserveWhitespace (true);
    dp.setErrorStream (System.out);
    dp.parse (url);
    ...
  }

  static void process2(String xmlURI, XMLSchema schema, QxName qname)
      throws Exception
  {
      /* create parser... */
    dp.setXMLSchema(schema);
    dp.setSchemaValidatorProperty(XSDNode.ROOT_TYPE, qname);
    dp.setPreserveWhitespace (true);
    dp.setErrorStream (System.out);
    dp.parse (url);
    ...
  }

  static void process3(String xmlURI, XMLSchema schema, XSDNode node)
      throws Exception
  {
      /* create parser... */

    dp.setXMLSchema(schema);
    dp.setSchemaValidatorProperty(XSDNode.ROOT_NODE, node);
    dp.setPreserveWhitespace (true);
    dp.setErrorStream (System.out);
    dp.parse (url);
    ...
  }

Validating XML with the XSDValidator Bean

The oracle.xml.schemavalidator.XSDValidator bean encapsulates the oracle.xml.parser.schema.XSDValidator class and adds functionality for validating a DOM tree. The parser builds the DOM tree for the instance document and XML schema document and validates the instance document against the schema.

The XSDValidatorSample.java program in $ORACLE_HOME/xdk/demo/java/transviewer illustrates how to use the XSDValidator bean.

Follow the basic steps in this section to write Java programs that use the XSDValidator bean:

Parse the instance document with the DOMParser.parse() method. The following code fragment from XSDValidatorSample.java illustrates this technique:

URL xmlinstanceurl, schemaurl;
XMLDocument xmldoc1,xmldoc2;

// get the URL for the input files
xmlinstanceurl = createURL(args[0]);
// Parse the XML Instance document first
xmldoc1 = parseXMLDocument(xmlinstanceurl);

createURL() is a helper method that creates a URL from a filename. The parseXMLDocument() method receives a URL as input and parses it with the DOMParser.parse() method as follows:

DOMParser parser = new DOMParser();
parser.parse(xmlurl);
return parser.getDocument();

Parse the XML schema document with the DOMParser.parse() method. The following code from XSDValidatorSample.java illustrates this technique:

schemaurl = createURL(args[1]);xmldoc2 = parseXMLDocument(schemaurl);

Build the schema object from the parsed XML schema with the XSDBuilder.build() method. The following code fragment from XSDValidatorSample.java illustrates this technique:

XSDBuilder xsdbuild =  new XSDBuilder();
. . .
xmlschema = (XMLSchema)xsdbuild.build(xmldoc2, createURL(args+"builder"));

Specify the schema object to use for validation by passing a reference to the XSDValidator.setSchema() method. The following code fragment from XSDValidatorSample.java creates the validator and sets the schema:

XSDValidator xsdval = new XSDValidator();
. . .
xsdval.setSchema(xmlschema);

Set the error output stream for the validator by invoking the XSDValidator.setError() method. The following code fragment from XSDValidatorSample.java illustrates how to create the object:

Properties p = new Properties(System.getProperties());
p.load(new FileInputStream("demo.properties"));
System.setProperties(p);
. . .
XMLError err = new XMLError();
. . .
err.setErrorHandler(new DocErrorHandler());
. . .
xsdval.setError(err);

Validate the instance document against the schema by passing a reference to instance document to the XSDValidator.validate() method. For example, XSDValidatorSample.java includes the following code fragment:

xsdval.validate(xmldoc1);

Tips and Techniques for Programming with XML Schemas

This section contains the following topics:

Overriding the Schema Location with an Entity Resolver

Converting DTDs to XML Schemas

Overriding the Schema Location with an Entity Resolver

When the XSDBuilder builds a schema, it may need to include or import other schemas specified as URLs in the schemaLocation attribute. The xsdent.java demo described in Table 7-3 illustrates this case. The document element in xsdent.xml file contains the following attribute:

xsi:schemaLocation =  "http://www.somewhere.org/BookCatalogue
                       xsdent.xsd">

The xsdent.xsd document contains the following elements:

<schema xmlns="http://www.w3.org/2001/XMLSchema"
               targetNamespace="http://www.somewhere.org/BookCatalogue"
               xmlns:catd = "http://www.somewhere.org/Digest"
               xmlns:cat  = "http://www.somewhere.org/BookCatalogue"
               elementFormDefault="qualified">
<import namespace = "http://www.somewhere.org/Digest"
        schemaLocation = "xsdent-1.xsd" />

In some cases, you may want to override the schema locations specified in <import> and supply the builder with the required schema documents. For example, you may have downloaded the schemas documents from external Web sites and stored them in a database. In such cases, you can set an entity resolver in the XSDBuilder. XSDBuilder passes the schema location to the resolver, which returns an InputStream, Reader, or URL as an InputSource. The builder can read the schema documents from the InputSource.

The xsdent.java program illustrates how you can override the schema location with an entity resolver. You must implement the EntityResolver interface, instantiate the entity resolver, and set it in the XML schema builder. In the demo code, sampleEntityResolver1 returns InputSource as an InputStream whereas sampleEntityResolver2 returns InputSource as a URL.

Follow these basic steps:

Create a new XML schema builder as follows:

XSDBuilder builder = new XSDBuilder();

Set the builder to your entity resolver. An entity resolver is a class that implements the EntityResolver interface. The purpose of the resolver is to enable the XML reader to intercept any external entities before including them. The following code fragment creates an entity resolver and sets it in the builder:

builder.setEntityResolver(new sampleEntityResolver1());

The sampleEntityResolver1 class implements the resolveEntity() method. You can use this method to redirect external system identifiers to local URIs. The source code is as follows:

class sampleEntityResolver1 implements EntityResolver
{
   public InputSource resolveEntity (String targetNS,  String systemId)
   throws SAXException, IOException
   {
      // perform any validation check if needed based on targetNS & systemId
      InputSource mySource = null;
      URL u = XMLUtil.createURL(systemId);
      // Create input source with InputStream as input
      mySource = new InputSource(u.openStream());
      mySource.setSystemId(systemId);
      return mySource;
   }
}

Note that sampleEntityResolver1 initializes the InputSource with a stream.

Build the XML schema object. The following code illustrates this technique:

schemadoc = builder.build(url);

Validate the instance document against the XML schema. The program executes the following statement:

process(xmlfile, schemadoc);

The process() method creates a DOM parser, configures it, and invokes the parse() method. The method is implemented as follows:

public static void process(String xmlURI, Object schemadoc)
    throws Exception
{
  DOMParser dp  = new DOMParser();
  URL       url = XMLUtil.createURL (xmlURI);

  dp.setXMLSchema(schemadoc);
  dp.setValidationMode(XMLParser.SCHEMA_VALIDATION);
  dp.setPreserveWhitespace (true);
  dp.setErrorStream (System.out);
  try {
     dp.parse (url);
     ...
}

Converting DTDs to XML Schemas

Because of the power and flexibility of the XML Schema language, you may want to convert your existing DTDs to XML Schema documents. The XDK API enables you to perform this transformation.

The $ORACLE_HOME/xdk/demo/java/schema/DTD2Schema.java program illustrates how to convert a DTD. You can test the program as follows:

java DTD2Schema dtd2schema.dtd dtd2schema.xml

Follow these basic steps to convert a DTD to an XML schema document:

Parse the DTD with the DOMParser.parseDTD() method. The following code fragment from DTD2Schema.java illustrates how to create the DTD object:

XSDBuilder builder = new XSDBuilder();
URL dtdURL = createURL(args[0]);
DTD dtd = getDTD(dtdURL, "abc");

The getDTD() method is implemented as follows:

private static DTD getDTD(URL dtdURL, String rootName)
   throws Exception
{
   DOMParser parser = new DOMParser();
   DTD dtd;
   parser.setValidationMode(true);
   parser.setErrorStream(System.out);
   parser.showWarnings(true);
   parser.parseDTD(dtdURL, rootName);
   dtd = (DTD)parser.getDoctype();
   return dtd;
}

Convert the DTD to an XML schema DOM tree with the DTD.convertDTD2Sdhema() method. The following code fragment from DTD2Schema.java illustrates this technique:

XMLDocument dtddoc = dtd.convertDTD2Schema();

Write the XML schema DOM tree to an output stream with the XMLDocument.print() method. The following code fragment from DTD2Schema.java illustrates this technique:

FileOutputStream fos = new FileOutputStream("dtd2schema.xsd.out");
dtddoc.print(fos);

Create an XML schema object from the schema DOM tree with the XSDBuilder.build() method. The following code fragment from DTD2Schema.java illustrates this technique:

XMLSchema schemadoc = (XMLSchema)builder.build(dtddoc, null);

Validate an instance document against the XML schema with the DOMParser.parse() method. The following code fragment from DTD2Schema.java illustrates this technique:

validate(args[1], schemadoc);

The validate() method is implemented as follows:

DOMParser dp  = new DOMParser();
URL       url = createURL (xmlURI);
dp.setXMLSchema(schemadoc);
dp.setValidationMode(XMLParser.SCHEMA_VALIDATION);
dp.setPreserveWhitespace (true);
dp.setErrorStream (System.out);
try
{
   System.out.println("Parsing "+xmlURI);
   dp.parse (url);
   System.out.println("The input file <"+xmlURI+"> parsed without errors");
}
...

8 Using the JAXB Class Generator

This chapter contains the following topics:

Introduction to the JAXB Class Generator

Using the JAXB Class Generator: Overview

Processing XML with the JAXB Class Generator

Note:

Use the JAXB class generator for new applications in order to use the object binding feature for XML data. The Oracle9i class generator for Java is deprecated. Oracle Database 10g supports the Oracle9i class generator for backward compatibility.

Introduction to the JAXB Class Generator

This section provides an introduction to the Java Architecture for XML Binding (JAXB). It discusses the following topics:

Prerequisites

Standards and Specifications

Marshalling and Unmarshalling with JAXB

Validation with JAXB

JAXB Customization

Prerequisites

This chapter assumes that you already have some familiarity with the following topics:

Java Architecture for XML Binding (JAXB). If you require a more thorough introduction to JAXB than is possible in this chapter, consult the XML resources listed in "Related Documents" of the preface.

XML Schema language. Refer to Chapter 7, "Using the Schema Processor for Java" for an overview and links to suggested reading.

Standards and Specifications

The Oracle JAXB processor implements JSR-31 "The Java Architecture for XML Binding (JAXB)", Version 1.0, which is a recommendation of the JCP (Java Community Process).

The Oracle Database XDK implementation of the JAXB 1.0 specification does not support the following optional features:

Javadoc generation

Fail Fast validation

External customization file

XML Schema concepts described in section E.2 of the specification

JSR is a Java Specification Request of the JCP. You can find a description of the JSR at the following URL:

http://jcp.org/en/jsr/overview

See Also:

Chapter 31, "XDK Standards" for a summary of the standards supported by the XDK

JAXB Class Generator Features

The JAXB class generator for Java generates the interfaces and the implementation classes corresponding to an XML Schema. Its principal advantage to Java developers is automation of the mapping between XML documents and Java code, which enables programs to use generated code to read, manipulate, and re-create XML data. The Java classes, which can be extended, give the developer access to the XML data without knowledge of the underlying XML data structure.

In short, the Oracle JAXB class generator provides the following advantages for XML application development in Java:

Speed

Because the schema-to-code conversion is automated, you can rapidly generate Java code from an input XML schema.

Ease of use

You can call generated get and set methods rather than code your own from scratch.

Automated data conversion

You can automate the conversion of XML document data into Java datatypes.

Customization

JAXB provides a flexible framework that enables you to customize the binding of XML elements and attributes.

Marshalling and Unmarshalling with JAXB

JAXB is an API and set of tools that maps XML data to Java objects. JAXB simplifies access to an XML document from a Java program by presenting the XML document to the program in a Java format.

You can use the JAXB API and tools to perform the following basic tasks:

Generate and compile JAXB classes from an XML schema with the orajaxb command-line utility.

To use the JAXB class generator to generate Java classes you must provide it with an XML schema. DTDs are not supported by JAXB. As explained in "Converting DTDs to XML Schemas", however, you can use the DTD2Schema program to convert a DTD to an XML schema. Afterwards, you can use the JAXB class generator to generate classes from the schema.

The JAXB compiler generates Java classes that map to constraints in the source XML schema. The classes implements get and set methods that you can use to obtain and specify data for each type of element and attribute in the schema.

Process XML documents by instantiating the generated classes in a Java program.

Specifically, you can write a program that uses the JAXB binding framework to perform the following tasks:

Unmarshal the XML documents.

As explained in the JAXB specification, unmarshalling is defined as moving data from an XML document to the Java-generated objects.

Validate the XML documents.

You can validate before or during the unmarshalling of the contents into the content tree. You can also validate on demand by calling the validation API on the Java object. Refer to "Validation with JAXB".

Modify Java content objects.

The content tree of data objects represents the structure and content of the source XML documents. You can use the set methods defined for a class to modify the content of elements and attributes.

Marshal Java content objects back to XML.

In contrast to unmarshalling, marshalling is creating an XML document from Java objects by traversing a content tree of instances of Java classes. You can serialize the data to a DOM tree, SAX content handler, transformation result, or output stream.

Validation with JAXB

A Java content tree is considered valid with respect to an XML schema when marshalling the tree generates a valid XML document.

JAXB applications can perform validation in the following circumstances:

Unmarshalling-time validation that notifies the application of errors and warnings during unmarshalling. If unmarshalling includes validation that is error-free, then the input XML document and the Java content tree are valid.

On-demand validation of a Java content tree initiated by the application.

Fail-fast validation that gives immediate results while updating the Java content tree with set and get methods. As specified in "Standards and Specifications", fail-fast validation is an optional feature in the JAXB 1.0 specification that is not supported in the XDK implementation of the JAXB class generator.

JAXB applications must be able to marshal a valid Java content tree, but they are not required to ensure that the Java content tree is valid before calling one of the marshalling APIs. The marshalling process does not itself validate the content tree. Programs are merely required to throw a javax/xml/bind/MarshalException when marshalling fails due to invalid content.

JAXB Customization

The declared element and type names in an XML schema do not always provide the most useful Java class names. You can override the default JAXB bindings by using custom binding declarations, which are described in the JAXB specification. These declarations enable you to customize your generated JAXB classes beyond the XML-specific constraints in an XML schema to include Java-specific refinements such as class and package name mappings.

You can annotate the schema to perform the following customizations:

Bind XML names to user-defined Java class names

Name the package, derived classes, and methods

Choose which elements to bind to which classes

Decide how to bind each attribute and element declaration to a property in the appropriate content class

Choose the type of each attribute-value or content specification

Several of the demos programs listed in Table 8-2 illustrate JAXB customizations.

See Also:

Chapter 4, "Customizing JAXB Bindings," in the JAXB tutorial at http://java.sun.com/webservices/tutorial.html

"Customizing a Class Name in a Top-Level Element" for a detailed explanation of a customization demo

Using the JAXB Class Generator: Overview

This section contains the following topics:

Using the JAXB Processor: Basic Process

Running the XML Schema Processor Demo Programs

Using the JAXB Class Generator Command-Line Utility

Using the JAXB Processor: Basic Process

The XDK JAXB API exposes the following packages:

javax.xml.bind, which provides a runtime binding framework for client applications including unmarshalling, marshalling, and validation

javax.xml.bind.util, which provides useful client utility classes

The most important classes and interfaces in the javax.xml.bind package are described in Table 8-1. These form the core of most JAXB applications.

Table 8-1 javax.xml.bind Classes and Interfaces

Class/Interface
Description
Methods

JAXBContext class

Provides an abstraction for managing the XML/Java binding information necessary to implement the JAXB binding framework operations: unmarshal, marshal, and validate. A client application obtains new instances of this class by invoking the newInstance() method.

The principal methods are as follows:

newInstance() creates a JAXB content class. Supply this method the name of the package containing the generated classes.

createMarshaller() creates a marshaller that you can use to convert a content tree to XML.

createUnmarshaller() creates an unmarshaller that you can use to convert XML to a content tree.

createValidator() creates a Validator object that can validate a java content tree against its source schema.

Marshaller interface

Governs the process of serializing Java content trees into XML data.

The principal methods are as follows:

getEventHandler() returns the current or default event handler.

getProperty() obtains the property in the underlying implementation of marshaller.

marshal() marshals the content tree into a DOM, SAX2 events, output stream, transformation result, or Writer.

setEventHandler() creates a Validator object that validates a java content tree against its source schema.

Unmarshaller interface

Governs the process of deserializing XML data into newly created Java content trees, optionally validating the XML data as it is unmarshalled.

The principal methods are as follows:

getEventHandler() returns the current or default event handler.

getUnmarshallerHandler() returns an unmarshaller handler object usable as a component in an XML pipeline.

isValidating() indicates whether the unmarshaller is set to validate mode.

setEventHandler() allows an application to register a ValidationEventHandler.

setValidating() specifies whether the unmarshaller should validate during unmarshal operations.

marshal() unmarshals XML data from the specified file, URL, input stream, input source, SAX, or DOM.

Validator interface

Controls the validation of content trees during runtime. Specifically, this interface controls on-demand validation, which enables clients to receive data about validation errors and warnings detected in the Java content tree.

The principal methods are as follows:

getEventHandler() returns the current or default event handler.

setEventHandler() allows an application to register a ValidationEventHandler.

validate() validates Java content trees on-demand at runtime. This method can validate any arbitrary subtree of the Java content tree.

validateRoot() validates the Java content tree rooted at rootObj. You can use this method to validate an entire Java content tree.

Figure 8-1 depicts the process flow of a framework that uses the JAXB class generator.

Figure 8-1 JAXB Class Generator for Java

This graphic is described in the following text.
Description of "Figure 8-1 JAXB Class Generator for Java"

The basic stages of the process illustrated in Figure 8-1 are as follows:

The XML parser parses the XML schema and sends the parsed data to the JAXB class generator.

The class generator creates Java classes and interfaces based on the input XML schema.

By default, one XML element or type declaration generates one interface and one class. For example, if the schema defines an element named <anElement>, then by default the JAXB class generator generates a source file named AnElement.java and another named AnElementImpl.java. You can use customize binding declarations to override the default binding of XML Schema components to Java representations.

The Java compiler compiles the .java source files into class files. All of the generated classes, source files, and application code must be compiled.

Your Java application uses the compiled classes and the binding framework to perform the following types of tasks:

Create a JAXB context. You use this context to create the marshaller and unmarshaller.

Build object trees representing XML data that is valid against the XML schema. You can perform this task by either unmarshalling the data from an XML document that conforms to the schema or instantiating the classes.

Access and modify the data.

Optionally validate the modifications to the data relative to the constraints expressed in the XML schema.

Marshal the data to new XML documents.

See Also:

Oracle Database XML Java API Reference for details of the JAXB API

"Processing XML with the JAXB Class Generator" for detailed explanations of JAXB processing

Running the XML Schema Processor Demo Programs

Demo programs for the JAXB class generator for Java are included in $ORACLE_HOME/xdk/demo/java/jaxb. Specifically, the XDK includes the JAXB demos listed in Table 8-2.

Table 8-2 JAXB Class Generator Demos

Program
Subdirectory within Oracle Home
Demonstrates . . .

SampleApp1.java

/xdk/demo/java/jaxb/Sample1

The binding of top-level element and complexType definitions in the sample1.xsd schema to Java classes.

SampleApp2.java

/xdk/demo/java/jaxb/Sample2

The binding of a top-level element with an inline simpleType definition in the sample2.xsd schema.

SampleApp3.java

/xdk/demo/java/jaxb/Sample3

The binding of a top-level complexType element that is derived by extension from another top-level complexType definition. Refer to "Binding Complex Types" for a detailed explanation of this program.

SampleApp4.java

/xdk/demo/java/jaxb/Sample4

The binding of a content model within a complexType that refers to a top-level named group.

SampleApp5.java

/xdk/demo/java/jaxb/Sample5

The binding of <choice> with maxOccurs unbounded within a complexType.

SampleApp6.java

/xdk/demo/java/jaxb/Sample6

The binding of atomic datatypes.

SampleApp7.java

/xdk/demo/java/jaxb/Sample7

The binding a complexType definition in which mixed="true".

SampleApp8.java

/xdk/demo/java/jaxb/Sample8

The binding of elements and types declared in two different namespaces.

SampleApp9.java

/xdk/demo/java/jaxb/Sample9

The customization of a Java package name.

SampleApp10.java

/xdk/demo/java/jaxb/Sample10

The customization of class name in a top-level element. Refer to "Customizing a Class Name in a Top-Level Element" for a detailed explanation of this program.

SampleApp11.java

/xdk/demo/java/jaxb/Sample11

The customization of class name of a local element occurring in a repeating model group declared inside a complexType element.

SampleApp12.java

/xdk/demo/java/jaxb/Sample12

The customization of the attribute name.

SampleApp13.java

/xdk/demo/java/jaxb/Sample13

The javaType customization specified on a global simpleType. The javaType customization specifies the parse and print method declared on a user-defined class.

SampleApp14.java

/xdk/demo/java/jaxb/Sample14

The customization of the typesafe enum class name.

You can find documentation that describes how to compile and run the sample programs in the README in the same directory. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/jaxb directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\jaxb directory (Windows).

Make sure that your environment variables are set as described in "Setting Up the Java XDK Environment".

Run make (UNIX) or Make.bat (Windows) at the system prompt. The make utility performs the following sequential actions for each sample subdirectory:

Runs the orajaxb utility to generate Java class files based on an input XML schema. For most of the demos, the output classfiles are written to the generated subdirectory. For example, the make file performs the following commands for the sample1.xsd schema in the Sample1 subdirectory:

cd ./Sample1; $(JAVA_HOME)/bin/java -classpath "$(MAKE_CLASSPATH)" \
oracle.xml.jaxb.orajaxb -schema sample1.xsd -targetPkg generated; echo;

Runs the javac utility to compile the Java classes. For example, the make utility performs the following commands for the Java class files in the Sample1/generated/ subdirectory:

cd ./Sample1/generated; $(JAVA_HOME)/bin/javac -classpath \
"$(MAKE_CLASSPATH)" *.java

Runs the javac utility to compile a sample Java application that uses the classes compiled in the preceding step. For example, the make utility compiles the SampleApp1.java program:

cd ./Sample1; $(JAVA_HOME)/bin/javac -classpath "$(MAKE_CLASSPATH)" \
SampleApp1.java

Runs the sample Java application and writes the results to a log file. For example, the make utility executes the SampleApp1 class and writes the output to sample1.out:

cd ./Sample1; $(JAVA_HOME)/bin/java -classpath "$(MAKE_CLASSPATH)" \SampleApp1 > sample1.out

Using the JAXB Class Generator Command-Line Utility

The XDK includes orajaxb, which is a command-line Java interface that generates Java classes from input XML schemas. The $ORACLE_HOME/bin/orajaxb and %ORACLE_HOME%\bin\orajaxb.bat shell scripts execute the oracle.xml.jaxb.orajaxb class. To use orajaxb ensure that your CLASSPATH is set as described in "Setting Up the Java XDK Environment".

Table 8-3 lists the orajaxb command-line options.

Table 8-3 orajaxb Command-Line Options

Option
Purpose

-help

Prints the help message.

-version

Prints the release version.

-outputdir OutputDir

Specifies the directory in which to generate the Java source files. If the schema has a namespace, then the program generates the java code in the package (corresponding to the namespace) referenced from the outputDir. By default, the current directory is the outputDir.

-schema SchemaFile

Specifies the input XML schema.

-targetPkg targetPkg

Specifies the target package name. This option overrides any binding customization for package name as well as the default package name algorithm defined in the JAXB Specification.

-interface

Generates the interfaces only.

-verbose

Lists the generated classes and interfaces.

-defaultCus fileName

Generates the default customization file.

-extension

Allows vendor specific extensions and does not strictly follow the compatibility rules specified in Appendix E.2 of the JAXB 1.0 specification. When specified, the program ignores JAXB 1.0 unsupported features such as notations, substitution groups, and any attributes.

Using the JAXB Class Generator Command-Line Utility: Example

To test orjaxb, change into the $ORACLE_HOME/xdk/demo/java/jaxb/Sample1 directory. If you have run make, then the directory should contain the following files:

SampleApp1.class
SampleApp1.java
generated/
sample1.out
sample1.xml
sample1.xsd

The sample.xsd file is the XML schema associated with sample1.xml. The generated/ subdirectory contains the classes generated from the input schema. You can test orajaxb by deleting the contents of generated/ and regenerating the classes as follows:

rm generated/*
orajaxb -schema sample1.xsd -targetPkg generated -verbose

The terminal should display the following output:

generated/CType.java
generated/AComplexType.java
generated/AnElement.java
generated/RElemOfCTypeInSameNs.java
generated/RType.java
generated/RElemOfSTypeInSameNs.java

generated/CTypeImpl.java
generated/AComplexTypeImpl.java
generated/AnElementImpl.java
generated/RElemOfCTypeInSameNsImpl.java
generated/RTypeImpl.java
generated/RElemOfSTypeInSameNsImpl.java
generated/ObjectFactory.java

JAXB Features Not Supported in the XDK

The Oracle Database XDK implementation of the JAXB specification does not support the following features:

Javadoc generation

XML Schema component "any" and substitution groups

Processing XML with the JAXB Class Generator

This section contains the following topics:

Binding Complex Types

Customizing a Class Name in a Top-Level Element

Binding Complex Types

The Sample3.java program illustrates how to bind a complex type definition to a Java content interface. One complex type defined in the XML schema is derived by extension from another complex type.

Defining the Schema

Example 8-1 illustrates the XML data document that provides the input to the sample application. The sample3.xml document describes the address of an employee.

Example 8-1 sample3.xml

<?xml version="1.0"?>
<myAddress xmlns = "http://www.oracle.com/sample3/"
           xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation = "http://www.oracle.com/sample3 sample3.xsd">
    <name>James Bond</name>
    <doorNumber>420</doorNumber>
    <street>Oracle parkway</street>
    <city>Redwood shores</city>
    <state>CA</state>
    <zip>94065</zip>
    <country>United States</country>
</myAddress>

The XML schema shown in Example 8-2 defines the structure that you use to validate sample3.xml. The schema defines two complex types and one element, which are defined as follows:

The first complex type, which is named Address, is a sequence of elements. Each element in the sequence describes one part of the address: name, door number, and so forth.

The second complex type, which is named USAddress, uses the <extension base="exp:Address"> element to extend Address by adding U.S.-specific elements to the Address sequence: state, zip, and so forth. The exp prefix specifies the http://www.oracle.com/sample3/ namespace.

The element is named myAddress and is of type exp:USAddress. The exp prefix specifies the http://www.oracle.com/sample3/ namespace. In sample3.xml, the myAddress top-level element, which is in namespace http://www.oracle.com/sample3/, conforms to the schema definition.

Example 8-2 sample3.xsd

<?xml version="1.0"?>

<!-- Binding a complex type definition to java content interface
 The complex type definition is derived by extension
-->

<schema xmlns = "http://www.w3.org/2001/XMLSchema"
        xmlns:exp="http://www.oracle.com/sample3/"
        targetNamespace="http://www.oracle.com/sample3/"
        elementFormDefault="qualified">

   <complexType name="Address">
      <sequence>
         <element name="name" type="string"/>
         <element name="doorNumber" type="short"/>
         <element name="street" type="string"/>
         <element name="city" type="string"/>
      </sequence>
   </complexType>

  <complexType name="USAddress">
    <complexContent>
     <extension base="exp:Address">
       <sequence>
          <element name="state" type="string"/>
          <element name="zip" type="integer"/>
          <element name="country" type="string"/>
       </sequence>
     </extension>
    </complexContent>
  </complexType>

  <element name="myAddress" type="exp:USAddress"/>

</schema>

Generating and Compiling the Java Classes

If you have an XML document and corresponding XML schema, then the next stage of processing is to generate the Java classes from the XML schema. You can use the JAXB command-line interface described in "Using the JAXB Class Generator Command-Line Utility" to perform this task.

Assuming that your environment is set up as described in "Setting Up the Java XDK Environment", you can create the source files in the generated package as follows:

cd $ORACLE_HOME/xdk/demo/java/jaxb/Sample3
orajaxb -schema sample1.xsd -targetPkg generated

The preceding orajaxb command should create the following source files in the ./generated/ subdirectory:

Address.java
AddressImpl.java
MyAddress.java
MyAddressImpl.java
ObjectFactory.java
USAddress.java
USAddressImpl.java

The complex types Address and USAddress each has two associated source files, as does the element MyAddress. The source file named after the element contains the interface; the file with the suffix Impl contains the class that implements the interface. For example, Address.java contains the interface Address, whereas AddressImpl.java contains the class that implements Address.

The content of the Address.java source file is shown in Example 8-3.

Example 8-3 Address.java

package generated;
public interface Address
{
   public void setName(java.lang.String n);
   public java.lang.String getName();
   public void setDoorNumber(short d);
   public short getDoorNumber();
   public void setStreet(java.lang.String s);
   public java.lang.String getStreet();
   public void setCity(java.lang.String c);
   public java.lang.String getCity();
}

The Address complex type defined a sequence of elements: name, doorNumber, street, and city. Consequently, the Address interface includes a get and set method signature for each of the four elements. For example, the interface includes getName() for retrieving data in the <name> element and setName() for modifying data in this element.

You can compile the Java source files with javac as follows:

cd $ORACLE_HOME/xdk/demo/java/jaxb/Sample3/generated
javac *.java

Processing the XML Data

Sample3.java shows how you can process the sample3.xml document by using the Java class files that you generated in "Generating and Compiling the Java Classes". The sample program unmarshals the XML data document, marshals it, and uses the generated classes to print and modify the address data.

The Sample3.java program processes the data as follows:

Create strings for the XML data document file name and the name of the directory that contains the generated classes. This name is the package name. For example:

String fileName = "sample3.xml";
String instancePath = "generated";

Instantiate a JAXB context by invoking JAXBContext.newInstance(). A client application obtains a new instance of this class by initializing it with a context path. The path contains a list of Java package names that contain the interfaces available to the marshaller. The following statement illustrates this technique:

JAXBContext jc = JAXBContext.newInstance(instancePath);

Instantiate the unmarshaller. The Unmarshaller class governs the process of deserializing XML data into newly created objects, optionally validating the XML data as it is unmarshalled. The following statement illustrates this technique:

Unmarshaller u = jc.createUnmarshaller();

Unmarshal the XML document. Invoke the Unmarshaller.unmarshal() method to deserialize the sample3.xml document and return the content trees as an Object. You can create a URL from the XML filename by invoking the fileToUrl() helper method. The following statement illustrates this technique:

Object obj = u.unmarshal(fileToURL(fileName));

Instantiate a marshaller. The Marshaller class governs the process of serializing Java content trees back into XML data. The following statement illustrates this technique:

Marshaller m = jc.createMarshaller();

Marshal the content tree. Invoke the Marshaller.marshal() method to marshal the content tree Object returned by the unmarshaller. You can serialize the data to a DOM tree, SAX content handler, transformation result, or output stream. The following statement serializes the XML data, including markup, as an output stream:

m.marshal(obj, System.out);

By default, the marshaller uses UTF-8 encoding when writing XML data to an output stream.

Print the contents of the XML document. The program implements a process() method that accepts the content tree and marshaller as parameters.

The first stage of processing prints the data in the XML document without the XML markup. The method casts the Object generated by the marshaller into type MyAddress. It proceeds to invoke a series of methods whose method names are constructed by prefixing get to the name of an XML element. For example, to obtain the data in the <city> element in Example 8-1, the program invokes getCity(). The following code fragment illustrates this technique:

public static void process(Object obj, Marshaller m) throws Throwable
{
   generated.MyAddress elem = (generated.MyAddress)obj;
   System.out.println();
   System.out.println(" My address is: ");
   System.out.println("  name:  "  + elem.getName() + "\n"  +
                      "  doorNumber " + elem.getDoorNumber() + "\n" +
                      "  street: " + elem.getStreet() + "\n" +
                      "  city:   " + elem.getCity() + "\n"  +
                      "  state:  " + elem.getState() + "\n" +
                      "  zip:  " + elem.getZip() + "\n" +
                      "  country:  " + elem.getCountry() + "\n" +
                      "\n" );
...

Change the XML data and print it. The process() method continues by invoking set methods that are analogous to the preceding get methods. The name of each set method is constructed by prefixing set to the name of an XML element. For example, setCountry() changes the value in the <country> element. The following statements illustrate this technique:

short num = 550;
elem.setDoorNumber(num);
elem.setCountry("India");
num = 10100;
elem.setZip(new java.math.BigInteger("100100"));
elem.setCity("Noida");
elem.setState("Delhi");

After changing the data, the program prints the data by invoking the same get methods as in the previous step.

Customizing a Class Name in a Top-Level Element

The Sample10.java program illustrates one form of JAXB customization. The program shows you can change the name of a class that corresponds to an element in the input XML schema.

Defining the Schema

Example 8-4 shows the XML data document that provides the input to the sample application. The sample10.xml document describes a business.

Example 8-4 sample10.xml

<?xml version="1.0"?>
<business xmlns="http://jaxbcustomized/sample10/">
   <title>Software Development</title>
   <owner>Larry Peterson</owner>
   <id>45123</id>
</business>

Example 8-5 shows the XML schema that defines the structure of sample10.xml. The schema defines one complex type and one element as follows:

The complex type, which is named businessType, is a sequence of elements. Each element in the sequence describes a part of the business: title, owner, and id.

The element, which is named business, is of type biz:businessType. The biz prefix specifies the http://jaxbcustomized/sample10/ namespace. In sample10.xml, the business top-level element, which is in namespace http://jaxbcustomized/sample10/, conforms to the schema definition.

Example 8-5 sample10.xsd

<?xml version="1.0"?>

<!-- Customization of class name in top level element -->

<schema xmlns="http://www.w3.org/2001/XMLSchema"
        targetNamespace="http://jaxbcustomized/sample10/"
        xmlns:biz="http://jaxbcustomized/sample10/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="1.0"
        elementFormDefault="qualified">

   <element name="business" type="biz:businessType">
      <annotation>
         <appinfo>
            <jaxb:class name="myBusiness"/>
         </appinfo>
      </annotation>
   </element>

   <complexType name="businessType">
      <sequence>
         <element name="title" type="string"/>
         <element name="owner" type="string"/>
         <element name="id" type="integer"/>
      </sequence>
   </complexType>

</schema>

Customizing the Schema Binding

The schema shown in Example 8-5 customizes the binding of the business element by means of an inline binding declaration. The general form for inline customizations is the following:

<xs:annotation>
   <xs:appinfo>
      .
      .
      binding declarations
      .
      .
   </xs:appinfo>
</xs:annotation>

Example 8-5 uses the <class> binding declaration to bind a schema element to a Java class name. You can use the declaration to customize the name for an interface or the class that implements an interface. The JAXB class generator supports the following syntax for <class> customizations:

<class [ name = "className"] >

The name attribute specifies the name of the derived Java interface. Example 8-5 contains the following customization:

<jaxb:class name="myBusiness"/>

Thus, the schema binds the business element to the interface myBusiness rather than to the interface business, which is the default.

Generating and Compiling the Java Classes

After you have an XML document and corresponding XML schema, the next stage is to generate the Java classes from the XML schema. You can use the JAXB command-line interface to perform this task.

If your environment is set up as described in "Setting Up the Java XDK Environment", then you can create the source files in the generated package as follows:

cd $ORACLE_HOME/xdk/demo/java/jaxb/Sample10
orajaxb -schema sample10.xsd

Because the preceding command does not specify a target package, the package name is constructed from the target namespace of the schema, which is http://jaxbcustomized/sample10/ . Consequently, the utility generates the following source files in the ./jaxbcustomized/sample10/ subdirectory:

BusinessType.java
BusinessTypeImpl.java
MyBusiness.java
MyBusinessImpl.java
ObjectFactory.java

Note that the complex type businessType has two source files, BusinessType.java and BusinessTypeImpl.java. Because of the JAXB customization, the business element is bound to interface MyBusiness and implementing class MyBusinessImpl.

The content of the BusinessType.java source file is shown in Example 8-6.

Example 8-6 BusinessType.java

package jaxbcustomized.sample10;

public interface BusinessType
{
   public void setTitle(java.lang.String t);
   public java.lang.String getTitle();
   public void setOwner(java.lang.String o);
   public java.lang.String getOwner();
   public void setId(java.math.BigInteger i);
   public java.math.BigInteger getId();
}

The BusinessType complex type defined a sequence of elements: title, owner, and id. Consequently, the Address interface includes a get and set method signature for each of the elements. For example, the interface includes getTitle() for retrieving data in the <title> element and setTitle() for modifying data in this element.

You can compile the Java source files with javac as follows:

cd $ORACLE_HOME/xdk/demo/java/jaxb/Sample10/jaxbcustomized/sample10
javac *.java

Processing the XML Data

The Sample10.java source file shows how you can process the data in the sample10.xml document by using the class files that you generated in "Generating and Compiling the Java Classes". The sample program unmarshals the XML document, prints its content, and marshals the XML to standard output.

The Sample10.java program processes the XML data as follows:

Create strings for the XML data document file name and the name of the directory that contains the generated classes. This name is the package name. For example:

String fileName = "sample10.xml";
String instancePath = "jaxbcustomized.sample10";

Instantiate a JAXB context by invoking the JAXBContext.newInstance() method. The following statement illustrates this technique:

JAXBContext jc = JAXBContext.newInstance(instancePath);

Create the unmarshaller. The following statement illustrates this technique:

Unmarshaller u = jc.createUnmarshaller();

Unmarshal the XML document. The program unmarshals the document twice: it first returns an Object and then uses a cast to return a MyBusiness object. The following statement illustrates this technique:

Object obj = u.unmarshal(fileToURL(fileName));
jaxbcustomized.sample10.MyBusiness bus =
         (jaxbcustomized.sample10.MyBusiness) u.unmarshal(fileToURL(fileName));

Print the contents of the XML document. The program invokes the get methods on the MyBusiness object. The following code fragment illustrates this technique:

System.out.println("My business details are: ");
System.out.println("    title: " + bus.getTitle());
System.out.println("    owner: " + bus.getOwner());
System.out.println("    id:    " + bus.getId().toString());
System.out.println();

Create a marshaller. The following statement illustrates this technique:

Marshaller m = jc.createMarshaller();

Configure the marshaller. You can invoke setProperty() to configure various properties the marshaller. The JAXB_FORMATTED_OUTPUT constant specifies that the marshaller should format the resulting XML data with line breaks and indentation. The following statements illustrate this technique:

m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, new Boolean(true));

Marshal the content tree. The following statement serializes the XML data, including markup, as an output stream:

m.marshal(bus, System.out);

By default, the marshaller uses UTF-8 encoding when writing XML data to an output stream.

9 Using the XML Pipeline Processor for Java

This chapter contains these topics:

Introduction to the XML Pipeline Processor

Using the XML Pipeline Processor: Overview

Processing XML in a Pipeline

Introduction to the XML Pipeline Processor

This section contains the following topics:

Prerequisites

Standards and Specifications

Multistage XML Processing

Customized Pipeline Processes

Prerequisites

This chapter assumes that you are familiar with the following topics:

XML Pipeline Definition Language. This XML vocabulary enables you to describe the processing relations between XML resources. If you require a more thorough introduction to the Pipeline Definition Language, consult the XML resources listed in "Related Documents" of the preface.

Document Object Model (DOM). DOM is an in-memory tree representation of the structure of an XML document.

Simple API for XML (SAX). SAX is a standard for event-based XML parsing.

XML Schema language. Refer to Chapter 7, "Using the Schema Processor for Java" for an overview and links to suggested reading.

Standards and Specifications

The Oracle XML Pipeline processor is based on the W3C XML Pipeline Definition Language Version 1.0 Note. The W3C Note defines an XML vocabulary rather than an API. You can find the Pipeline specification at the following URL:

http://www.w3.org/TR/xml-pipeline/

"Pipeline Definition Language Standard for the XDK for Java" describes the differences between the Oracle XDK implementation of the Oracle XML Pipeline processor and the W3C Note.

See Also:

Table 31-1, "Summary of XML Standards Supported by the XDK"

Multistage XML Processing

The Oracle XML Pipeline processor is built on the XML Pipeline Definition Language. The processor can take an input XML pipeline document and execute pipeline processes according to derived dependencies. A pipeline document, which is written in XML, specifies the processes to be executed in a declarative manner. You can associate Java classes with processes by using the <processdef/> element in the pipeline document.

Use the Pipeline processor for mutistage processing, which occurs when you process XML components sequentially or in parallel. The output of one stage of processing can become the input of another stage of processing. You can write a pipeline document that defines the inputs and outputs of the processes. Figure 9-1 illustrates a possible pipeline sequence.

Figure 9-1 Pipeline Processing

Describes a possible pipeline sequence.
Description of "Figure 9-1 Pipeline Processing"

In addition to the XML Pipeline processor itself, the XDK provides an API for processes that you can pipe together in a pipeline document. Table 9-2 summarizes the classes provided in the oracle.xml.pipeline.processes package.

The typical stages of processing XML in a pipeline are as follows:

Parse the input XML documents. The oracle.xml.pipeline.processes package includes DOMParserProcess for DOM parsing and SAXParserProcess for SAX parsing.

Validate the input XML documents.

Serialize or transform the input documents. Note that the Pipeline processor does not enable you to connect the SAX parser to the XSLT processor, which requires a DOM.

In multistage processing, SAX is ideal for filtering and searching large XML documents. You should use DOM when you need to change XML content or require efficient dynamic access to the content.

See Also:

"Processing XML in a Pipeline" to learn how to write a pipeline document that provides the input for a pipeline application

Customized Pipeline Processes

The oracle.xml.pipeline.controller.Process class is the base class for all pipeline process definitions. The classes in the oracle.xml.pipeline.processes package extend this base class. To create a customized pipeline process, you need to create a class that extends the Process class.

At the minimum, every custom process should override the do-nothing initialize() and execute() methods of the Process class. If the customized process accepts SAX events as input, then it should override the SAXContentHandler() method to return the appropriate ContentHandler that handles incoming SAX events. It should also override the SAXErrorHandler() method to return the appropriate ErrorHandler. Table 9-1 provides further descriptions of the preceding methods.

Table 9-1 Methods in the oracle.xml.pipeline.controller.Process Class

Class
Description

initialize()

Initializes the process before execution.

Call getInput() to fetch a specific input object associated with the process element and call supportType() to indicate the types of input supported. Analogously, call getOutput() and supportType() for output.

execute()

Executes the process.

Call getInParaValue(), getInput(), or getInputSource() to fetch the inputs to the process. If a custom process outputs SAX events, then it should call the getSAXContentHandler() and getSAXErrorHandler() methods in execute() to get the SAX handlers of the following processes in the pipeline.

Call setOutputResult(), getOutputStream(), getOutputWriter() or setOutParam() to set the outputs or outparams generated by this process.

Call getErrorSource(), getErrorStream(), or getErrorDocument() to access the pipeline error element associated with this process element. If an exception occurs during execute(), call error() or info() to propagate it to the PipelineErrorHandler.

SAXContentHandler()

Returns the SAX ContentHandler.

If dependencies from other processes are not available at this time, then return null. When these dependencies are available the method will be executed till the end.

SAXErrorHandler()

Returns the SAX ErrorHandler.

If you do not override this method, then the JAXB processor uses the default error handler implemented by this class to handle SAX errors.

See Also:

Oracle Database XML Java API Reference to learn about the oracle.xml.pipeline.processes package

Using the XML Pipeline Processor: Overview

This section contains the following topics:

Using the XML Pipeline Processor: Basic Process

Running the XML Pipeline Processor Demo Programs

Using the XML Pipeline Processor Command-Line Utility

Using the XML Pipeline Processor: Basic Process

The XML Pipeline processor is accessible through the following packages:

oracle.xml.pipeline.controller, which provides an XML Pipeline controller that executes XML processes in a pipeline based on dependencies.

oracle.xml.pipeline.processes, which provides wrapper classes for XML processes that can be executed by the XML Pipeline controller. The oracle.xml.pipeline.processes package contains the classes that you can use to design a pipeline application framework. Each class extends the oracle.xml.pipeline.controller.Process class.

Table 9-2 lists the components in the package. You can connect these components and processes through a combination of the XML Pipeline processor and a pipeline document.

Table 9-2 Classes in oracle.xml.pipeline.processes

Class
Description

CompressReaderProcess

Receives compressed XML and outputs parsed XML.

CompressWriterProcess

Receives XML parsed with DOM or SAX and outputs compressed XML.

DOMParserProcess

Parses incoming XML and outputs a DOM tree.

SAXParserProcess

Parses incoming XML and outputs SAX events.

XPathProcess

Accepts a DOM as input, uses an XPath pattern to select one or more nodes from an XML Document or an XML DocumentFragment, and outputs a Document or DocumentFragment.

XSDSchemaBuilder

Parses an XML schema and outputs a schema object for validation. This process is built into the XML Pipeline processor and builds schema objects used for validating XML documents.

XSDValProcess

Validates against a local schema, analyzes the results, and reports errors if necessary.

XSLProcess

Accepts DOM as input, applies an XSL stylesheet, and outputs the result of the transformation.

XSLStylesheetProcess

Receives an XSL stylesheet as a stream or DOM and creates an XSLStylesheet object.

Figure 9-2 illustrates how to pass a pipeline document to a Java application that uses the XML Pipeline processor, configure the processor, and execute the pipeline.

Figure 9-2 Using the Pipeline Processor for Java

The program flow of an XML Pipeline processor application.
Description of "Figure 9-2 Using the Pipeline Processor for Java"

The basic steps are as follows:

Instantiate a pipeline document, which forms the input to the pipeline execution. Create the object by passing a FileReader to the constructor as follows:

PipelineDoc pipe;
FileReader f;
pipe = new PipelineDoc((Reader)f, false);

Instantiate a pipeline processor. PipelineProcessor is the top-level class that executes the pipeline. Table 9-3 describes some of the available methods.

Table 9-3 PipelineProcessor Methods

Method
Description

executePipeline()

Executes the pipeline based on the PipelineDoc set by invoking setPipelineDoc().

getExecutionMode()

Gets the type of execution mode: PIPELINE_SEQUENTIAL or PIPELINE_PARALLEL.

setErrorHandler()

Sets the error handler for the pipeline. This call is mandatory to execute the pipeline.

setExecutionMode()

Sets the execution mode. PIPELINE_PARALLEL is the default and specifies that the processes in the pipeline should execute in parallel. PIPELINE_SEQUENTIAL specifies that the processes in the pipeline should execute sequentially.

setForce()

Sets execution behavior. If TRUE, then the pipeline executes regardless of whether the target is up-to-date with respect to the pipeline inputs.

setPipelineDoc()

Sets the PipelineDoc object for the pipeline.

The following statement instantiates the pipeline processor:

proc = new PipelineProcessor();

Set the processor to the pipeline document. For example:

proc.setPipelineDoc(pipe);

Set the execution mode for the processor and perform any other needed configuration. For example, set the mode by passing a constant to PipelineProcessor.setExecutionMode().

The following statement specifies sequential execution:

proc.setExecutionMode(PipelineConstants.PIPELINE_SEQUENTIAL);

Instantiate an error handler. The error handler must implement the PipelineErrorHandler interface. For example:

errHandler = new PipelineSampleErrHdlr(logname);

Set the error handler for the processor by invoking setErrorHandler(). For example:

proc.setErrorHandler(errHandler);

Execute the pipeline. For example:

proc.executePipeline();

See Also:

Oracle Database XML Java API Reference to learn about the oracle.xml.pipeline subpackages

"Creating a Pipeline Document"

Running the XML Pipeline Processor Demo Programs

Demo programs for the XML Pipeline processor are included in $ORACLE_HOME/xdk/demo/java/pipeline. Table 9-4 describes the XML files and Java source files that you can use to test the utility.

Table 9-4 Pipeline Processor Sample Files

File
Description

README

A text file that describes how to set up the Pipeline processor demos.

PipelineSample.java

A sample Pipeline processor application. The program takes pipedoc.xml as its first argument.

PipelineSampleErrHdlr.java

A sample program to create an error handler used by PipelineSample.

book.xml

A sample XML document that describes a series of books. This document is specified as an input by pipedoc.xml, pipedoc2.xml, and pipedocerr.xml.

book.xsl

An XSLT stylesheet that transforms the list of books in book.xml into an HTML table.

book_err.xsl

An XSLT stylesheet specified as an input by the pipedocerr.xml pipeline document. This stylesheet contains an intentional error.

id.xsl

An XSLT stylesheet specified as an input by the pipedoc3.xml pipeline document.

items.xsd

An XML schema document specified as an input by the pipedoc3.xml pipeline document.

pipedoc.xml

A pipeline document. This document specifies that process p1 should parse book.xml with DOM, process p2 should parse book.xsl and create a stylesheet object, and process p3 should apply the stylesheet to the DOM to generate myresult.html.

pipedoc2.xml

A pipeline document. This document specifies that process p1 should parse book.xml with SAX, process p2 should generate compressed XML compxml from the SAX events, and process p3 should regenerate the XML from the compressed stream as myresult2.html.

pipedoc3.xml

A pipeline document. This document specifies that a process p5 should parse po.xml with DOM, process p1 should select a single node from the DOM tree with an XPath expression, process p4 should parse items.xsd and generate a schema object, process p6 should validate the selected node against the schema, process p3 should parse id.xsl and generate a stylesheet object, and validated node to produce myresult3.html.

pipedocerr.xml

A pipeline document. This document specifies that process p1 should parse book.xml with DOM, process p2 should parse book_err.xsl and generate a stylesheet object if it encounters no errors and apply an inline stylesheet if it encounters errors, and process p3 should apply the stylesheet to the DOM to generate myresulterr.html. Because book_err.xsl contains an error, the program should write the text contents of the input XML to myresulterr.html.

po.xml

A sample XML document that describes a purchase order. This document is specified as an input by pipedoc3.xml.

Documentation for how to compile and run the sample programs is located in the README. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/pipeline directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\pipeline directory (Windows).

Make sure that your environment variables are set as described in "Setting Up the Java XDK Environment".

Run make (UNIX) or Make.bat (Windows) at the system prompt to generate class files for PipelineSample.java and PipelineSampleErrHdler.java and run the demo programs. The programs write output files to the log subdirectory.

Alternatively, you can run the demo programs manually by using the following syntax:

java PipelineSample pipedoc pipelog [ seq | para ]

The pipedoc option specifies which pipeline document to use. The pipelog option specifies the name of the pipeline log file, which is optional unless you specify seq or para, in which case a filename is required. If you do not specify a log file, then the program generates pipeline.log by default. The seq option processes threads sequentially; para processes in parallel. If you specify neither seq or para, then the default is parallel processing.

View the files generated from the pipeline, which are all named with the initial string myresult, and the log files.

Using the XML Pipeline Processor Command-Line Utility

The command-line interface for the XML Pipeline processor is named orapipe. The Pipeline processor is packaged with Oracle database. By default, the Oracle Universal Installer installs the utility on disk in $ORACLE_HOME/bin.

Before running the utility for the first time, make sure that your environment variables are set as described in "Setting Up the Java XDK Environment". Run orapipe at the operating system command line with the following syntax:

orapipe options pipedoc

The pipedoc is the pipeline document, which is required. Table 9-5 describes the available options for the orapipe utility.

Table 9-5 orapipe Command-Line Options

Option
Purpose

-help

Prints the help message

-log logfile

Writes errors and messages to the specified log file. The default is pipeline.log.

-noinfo

Does not log informational items. The default is on.

-nowarning

Does not log warnings. The default is on.

-validate

Validates the input pipedoc with the pipeline schema. Validation is turned off by default. If outparam feature is used, then validate fails with the current pipeline schema because this is an additional feature.

-version

Prints the release version.

-sequential

Executes the pipeline in sequential mode. The default is parallel.

-force

Executes pipeline even if target is up-to-date. By default no force is specified.

-attr name value

Sets the value of $name to the specified value. For example, if the attribute name is source and the value is book.xml, then you can pass this value to an element in the pipeline document as follows: <input ... label="$source">.

Processing XML in a Pipeline

This section contains the following topics:

Creating a Pipeline Document

Writing a Pipeline Processor Application

Writing a Pipeline Error Handler

Creating a Pipeline Document

To use the Oracle XML Pipeline processor, you must create an XML document according to the rules of the Pipeline Definition Language specified in the W3C Note.

The W3C specification defines the XML processing components and the inputs and outputs for these processes. The XML Pipeline processor includes support for the following XDK components:

XML parser

XML compressor

XML Schema validator

XSLT processor

Example of a Pipeline Document

The XML Pipeline processor executes a sequence of XML processing according to the rules in the pipeline document and returns a result. Example 9-1 shows pipedoc.xml, which is a sample pipeline document included in the demo directory.

Example 9-1 pipedoc.xml

<pipeline xmlns="http://www.w3.org/2002/02/xml-pipeline"
          xml:base="http://example.org/">

  <param name="target" select="myresult.html"/>

  <processdef name="domparser.p"
   definition="oracle.xml.pipeline.processes.DOMParserProcess"/>
  <processdef name="xslstylesheet.p"
   definition="oracle.xml.pipeline.processes.XSLStylesheetProcess"/>
  <processdef name="xslprocess.p"
   definition="oracle.xml.pipeline.processes.XSLProcess"/>

   <process id="p2" type="xslstylesheet.p" ignore-errors="false">
     <input name="xsl" label="book.xsl"/>
     <outparam name="stylesheet" label="xslstyle"/>
   </process>

   <process id="p3" type="xslprocess.p" ignore-errors="false">
     <param name="stylesheet" label="xslstyle"/>
     <input name="document" label="xmldoc"/>
     <output name="result" label="myresult.html"/>
   </process>

  <process id="p1" type="domparser.p" ignore-errors="true">
     <input name="xmlsource" label="book.xml "/>
     <output name="dom" label="xmldoc"/>
     <param name="preserveWhitespace" select="true"></param>
     <error name="dom">
       <html xmlns="http://www/w3/org/1999/xhtml">
         <head>
            <title>DOMParser Failure!</title>
         </head>
         <body>
           <h1>Error parsing document</h1>
         </body>
       </html>
     </error>
  </process>

</pipeline>

Processes Specified in the Pipeline Document

In Example 9-1, three processes are called and associated with Java classes in the oracle.xml.pipeline.processes package. The pipeline document uses the <processdef/> element to make the following associations:

domparser.p is associated with the DOMParserProcess class

xslstylesheet.p is associated with the XSLStylesheetProcess class

xslprocess.p is associated with the XSLProcess class

Processing Architecture Specified in the Pipeline Document

The PipelineSample program accepts the pipedoc.xml document shown in Example 9-1 as input along with XML documents book.xml and book.xsl. The basic design of the pipeline is as follows:

Parse the incoming book.xml document and generate a DOM tree. This task is performed by DOMParserProcess.

Parse book.xsl as a stream and generate an XSLStylesheet object. This task is performed by XSLStylesheetProcess.

Receive the DOM of book.xml as input, apply the stylesheet object, and write the result to myresult.html. This task is performed by XSLProcess.

Note the following aspects of the processing architecture used in the pipeline document:

The target information set, http://example.org/myresult.html, is inferred from the default value of the target parameter and the xml:base setting.

The process p2 has an input of book.xsl and an output parameter with the label xslstyle, so it has to run to produce the input for p3.

The p3 process depends on input parameter xslstyle and document xmldoc.

The p3 process has an output parameter with the label http://example.org/myresult.html, so it has to run to produce the target.

The process p1 depends on input document book.xml and outputs xmldoc, so it has to run to produce the input for p3.

In Example 9-1, more than one order of processing can satisfy all of the dependencies. Given the rules, the XML Pipeline processor must process p3 last but can process p1 and p2 in either order or process them in parallel.

Writing a Pipeline Processor Application

The PipelineSample.java source file illustrates a basic pipeline application. You can use the application with any of the pipeline documents in Table 9-4 to parse and transform an input XML document.

The basic steps of the program are as follows:

Perform the initial setup. The program declares references of type FileReader (for the input XML file), PipelineDoc (for the input pipeline document), and PipelineProcessor (for the processor). The first argument is the pipeline document, which is required. If a second argument is received, then it is stored in the logname String. The following code fragment illustrates this technique:

public static void main(String[] args)
{
  FileReader f;
  PipelineDoc pipe;
  PipelineProcessor proc;

  if (args.length < 1)
  {
    System.out.println("First argument needed, other arguments are ".
                       "optional:");
    System.out.println("pipedoc.xml <output_log> <'seq'>");
    return;
  }
  if (args.length > 1)
    logname = args[1];
  ...

Create a FileReader object by passing the first command-line argument to the constructor as the filename. For example:

f = new FileReader(args[0]);

Create a PipelineDoc object by passing the reference to the FileReader object. The following example casts the FileReader to a Reader and specifies no validation:

pipe = new PipelineDoc((Reader)f, false);

Instantiate an XML Pipeline processor. The following statement instantiates the pipeline processor:

proc = new PipelineProcessor();

Set the processor to the pipeline document. For example:

proc.setPipelineDoc(pipe);

Set the execution mode for the processor and perform any other configuration. The following code fragment uses a condition to determine the execution mode. If three or more arguments are passed to the program, then it sets the mode to sequential or parallel depending on which argument is passed. For example:

String execMode = null;
if (args.length > 2)
{
   execMode = args[2];
   if(execMode.startsWith("seq"))
      proc.setExecutionMode(PipelineConstants.PIPELINE_SEQUENTIAL);
   else if (execMode.startsWith("para"))
      proc.setExecutionMode(PipelineConstants.PIPELINE_PARALLEL);
}

Instantiate an error handler. The error handler must implement the PipelineErrorHandler interface. The program uses the PipelineSampleErrHdler shown in PipelineSampleErrHdlr.java. The following code fragment illustrates this technique:

errHandler = new PipelineSampleErrHdlr(logname);

Set the error handler for the processor by invoking setErrorHandler(). The following statement illustrates this technique:

proc.setErrorHandler(errHandler);

Execute the pipeline. The following statement illustrates this technique:

proc.executePipeline();

See Also:

Oracle Database XML Java API Reference to learn about the oracle.xml.pipeline subpackages

Writing a Pipeline Error Handler

An application calling the XML Pipeline processor must implement the PipelineErrorHandler interface to handle errors received from the processor. Set the error handler in the processor by calling setErrorHandler(). When writing the error handler, you can choose to throw an exception for different types of errors.

The oracle.xml.pipeline.controller.PipelineErrorHandler interface declares the methods shown in Table 9-6, all of which return void.

Table 9-6 PipelineErrorHandler Methods

Method
Description

error(java.lang.String msg, PipelineException e)

Handles PipelineException errors.

fatalError(java.lang.String msg, PipelineException e)

Handles fatal PipelineException errors.

warning(java.lang.String msg, PipelineException e)

Handles PipelineException warnings.

info(java.lang.String msg)

Prints optional, additional information about errors.

The first three methods in Table 9-6 receive a reference to an oracle.xml.pipeline.controller.PipelineException object. The following methods of the PipelineException class are especially useful:

getExceptionType(), which obtains the type of exception thrown

getProcessId(), which obtains the process ID where the exception occurred

getMessage(), which returns the message string of this Throwable error

The PipelineSampleErrHdler.java source file implements a basic error handler for use with the PipelineSample program. The basic steps are as follows:

Implement a constructor. The constructor accepts the name of a log file and wraps it in a FileWriter object as follows:

PipelineSampleErrHdlr(String logFile) throws IOException
{
  log = new PrintWriter(new FileWriter(logFile));
}

Implement the error() method. This implementation prints the process ID, exception type, and error message. It also increments a variable holding the error count. For example:

public void error (String msg, PipelineException e) throws Exception
{
  log.println("\nError in: " + e.getProcessId());
  log.println("Type: " + e.getExceptionType());
  log.println("Message: " +  e.getMessage());
  log.println("Error message: " + msg);
  log.flush();
  errCount++;
}

Implement the fatalError() method. This implementation follows the pattern of error(). For example:

public void fatalError (String msg, PipelineException e) throws Exception
{
  log.println("\nFatalError in: " + e.getProcessId());
  log.println("Type: " + e.getExceptionType());
  log.println("Message: " +  e.getMessage());
  log.println("Error message: " + msg);
  log.flush();
  errCount++;
}

Implement the warning() method. This implementation follows the basic pattern of error() except it increments the warnCount variable rather than the errCount variable. For example:

public void warning (String msg, PipelineException e) throws Exception
{
  log.println("\nWarning in: " + e.getProcessId());
  log.println("Message: " +  e.getMessage());
  log.println("Error message: " + msg);
  log.flush();
  warnCount++;
}

Implement the info() method. Unlike the preceding methods, this method does not receive a PipelineException reference as input. The following implementation prints the String received by the method and increments the value of the warnCount variable:

public void info (String msg)
{
  log.println("\nInfo : " + msg);
  log.flush();
  warnCount++;
}

Implement a method to close the PrintWriter. The following code implements the method closeLog(), which prints the number of errors and warnings and calls PrintWriter.close():

public void closeLog()
{
  log.println("\nTotal Errors: " + errCount + "\nTotal Warnings: " +
               warnCount);
  log.flush();
  log.close();
}

See Also:

Oracle Database XML Java API Reference to learn about the PipelineErrorHandler interface and the PipelineException class

10 Using XDK JavaBeans

This chapter contains these topics:

Introduction to XDK JavaBeans

Using the XDK JavaBeans: Overview

Processing XML with the XDK JavaBeans

Introduction to XDK JavaBeans

The Oracle XML JavaBeans are a set of XML components that you can use in Java applications and applets.

This section contains the following topics:

Prerequisites

Standards and Specifications

XDK JavaBeans Features

Prerequisites

This chapter assumes that you are familiar with the following technologies:

JavaBeans. JavaBeans components, or Beans, are reusable software components that can be manipulated visually in a builder tool.

Java Database Connectivity (JDBC). Database connectivity is included with the XDK JavaBeans. The beans can connect directly to a JDBC-enabled database to retrieve and store XML and XSL files.

Document Object Model (DOM). DOM is an in-memory tree representation of the structure of an XML document.

Simple API for XML (SAX). SAX is a standard for event-based XML parsing.

XML Schema language. Refer to Chapter 7, "Using the Schema Processor for Java" for an overview and links to suggested reading.

Standards and Specifications

The XDK JavaBeans require version 1.2 or higher of the XDK and can be used with any version of JDK 1.2 or above. All of the XDK beans conform to the Sun JavaBeans specification and include the required BeanInfo class that extends java.beans.SimpleBeanInfo.

The JavaBeans 1.01 specification, which describes JavaBeans as present in JDK 1.1, is available at the following URL:

http://java.sun.com/products/javabeans/docs/spec.html

The additions for the Java 2 platform to the JavaBeans core specification provide developers with standard means to create more sophisticated JavaBeans components. The JavaBeans specifications for Java 2 are available at the following URL:

http://java.sun.com/products/javabeans/glasgow/index.html

See Also:

Chapter 31, "XDK Standards" for a summary of the standards supported by the XDK

XDK JavaBeans Features

The Oracle XDK JavaBeans facilitate the addition of GUIs to XML applications. Bean encapsulation includes documentation and descriptors that you can access directly from Java IDEs such as Oracle JDeveloper.

The XDK includes the following beans:

DOMBuilder

XSLTransformer

DBAccess

XMLDiff

XMLCompress

XMLDBAccess

XSDValidator

DOMBuilder

The oracle.xml.async.DOMBuilder bean constructs a DOM tree from an XML document. The DOMBuilder JavaBean encapsulates the XML parser for Java DOMParser class with a bean interface and enhances by supporting asynchronous parsing. By registering a listener, Java programs can initiate parsing of large or successive documents and immediately return control to the caller.

One of the main benefits of this bean is increased efficiency when parsing multiple files, especially if the files are large. DOMBuilder can also provide asynchronous parsing in a background thread in interactive visual applications. Without asynchronous parsing, the GUI is useless until the document to be parsed. With DOMBuilder, the application calls the parse method and then resumes control. The application can display a progress bar, allow the user to cancel the parse, and so forth.

See Also:

"Using the DOMBuilder JavaBean: Basic Process"

XSLTransformer

The oracle.xml.async.XSLTransformer bean supports asynchronous transformation. It accepts an XML document, applies an XSLT stylesheet, and creates an output file. The XSLTransformer JavaBean enables you to transform an XML document to almost any text-based format, including XML, HTML, and DDL. This bean can also be used as the basis of a server-side application or servlet to render an XML document, such as an XML representation of a query result, into HTML for display in a browser.

The main benefit of the XSLTransformer bean is that it can transform multiple files in parallel. Like DOMBuilder, you can also use it in visual applications to avoid long periods of time when the GUI is nonresponsive. By implementing the XSLTransformerListener interface, the calling application receives notification when the transformation completes.

See Also:

"Using the XSLTransformer JavaBean: Basic Process"

DBAccess

The oracle.xml.dbaccess.DBAccess bean maintains CLOB tables that contain multiple XML and text documents. You can use it when you need to store and retrieve XML documents in the database, but do not need to process them within the database. Java applications that use the DBAccess bean connect to the database through JDBC. Note that XML documents stored in CLOB tables that are not of type XMLType do not have their entities expanded.

The DBAccess bean enables you to do perform the following tasks:

Create and delete tables of type CLOB.

Query the contents of CLOB tables.

Perform INSERT, UPDATE, and DELETE operations on XML documents stored in CLOB tables.

XMLDBAccess

The oracle.xml.xmldbaccess.XMLDBAccess bean extends the DBAccess bean to support XML documents stored in XMLType tables. The class provides methods to list, delete, or retrieve XMLType instances and their tables. For example, the getXMLXPathTextData() method retrieves the value of an XPath expression from an XML document.

DBAccess JavaBean maintains XMLType tables that can hold multiple XML and text documents. Each XML or text document is stored as a row in the table. The table is created with the following SQL statement:

CREATE TABLE (FILENAME   CHAR( ) UNIQUE,
              FILEDATA   SYS.XMLType);

The FILENAME field holds a unique string used as a key to retrieve, update, or delete the row. Document text is stored in the FILEDATA field.

The XMLDBAccess bean performs the following tasks:

Creates and deletes XMLType tables

Lists the contents of an XMLType column

Performs INSERT, UPDATE, and DELETE operations on XML documents stored in XMLType tables

See Also:

"Using the XMLDBAccess JavaBean: Basic Process"

XMLDiff

When comparing XML documents, it is usually unhelpful to compare them character by character. Most XML comparisons are concerned with differences in structure and significant textual content, not differences in whitespace. The oracle.xml.differ.XMLDiff bean performs the following useful tasks:

Constructs and compares the DOM trees for two input XML documents and indicates whether the documents are different.

Provides a graphical display of the differences between two XML files. Specifically, you can see node insert, delete, modify, or move.

Generates an XSLT stylesheet that can convert one of the input XML documents into the other document.

The XMLDiff bean is especially useful in pipeline applications. For example, an application could update an XML document, compare it with a previous version of the document, and store the XSLT stylesheet that shows the differences between them.

See Also:

Chapter 9, "Using the XML Pipeline Processor for Java"

"Using the XMLDiff JavaBean: Basic Process"

XMLCompress

As explained in "Compressing XML", the Oracle XML parser includes a compressor that can serialize XML document objects as binary streams. Although a useful tool, compression with XML parser has the following disadvantages:

When XML data is deserialized, it must be reparsed.

The encapsulation of XML data in tags greatly increase its size.

The oracle.xml.xmlcomp.XMLCompress bean is an encapsulation of the XML compression functionality. It provides the following advantages when serializing and deserializing XML:

It encapsulates the method that serializes the DOM, which results in a stream.

XML processors can regenerate the DOM from the compressed stream without reparsing the XML.

The bean supports compression and decompression of input XML parsed by DOMParser or SAXParser. DOM compression supports inputs of type XMLType, CLOB, and BLOB.

To use different parsing options, parse the document before input and then pass the XMLDocument object to the compressor bean. The compression factor is a rough value based on the file size of the input XML file and the compressed file. The limitation of the compression factor method is that it can only be used when the compression is performed with java.io.File objects as parameters.

XSDValidator

The oracle.xml.schemavalidator.XSDValidator bean encapsulates the XSDValidator class and adds capabilities for validating a DOM tree. One of the most useful features of this bean concerns validation errors. If the application throws a validation error, the getStackList() method returns a list of DOM tree paths that lead to the invalid node. Nodes with errors are returned in a vector of stack trees in which the top element of the stack represents the root node. You can obtain child nodes by pulling them from the stack. To use getStackList() you must use instantiate the java.util.Vector and java.util.Stack classes.

Using the XDK JavaBeans: Overview

This section contains the following topics:

Using the XDK JavaBeans: Basic Process

Running the JavaBean Demo Programs

Using the XDK JavaBeans: Basic Process

This section describes the program flow of Java applications that use the more useful beans: DOMBuilder, XSLTransformer, XMLDBAccess, and XMLDiff. The section contains the following topics:

Using the DOMBuilder JavaBean: Basic Process

Using the XSLTransformer JavaBean: Basic Process

Using the XMLDBAccess JavaBean: Basic Process

Using the XMLDiff JavaBean: Basic Process

Using the DOMBuilder JavaBean: Basic Process

The DOMBuilder class implements an XML 1.0 parser according to the W3C recommendation. It parses an XML document and builds a DOM tree. The parsing is done in a separate thread. The DOMBuilderListener interface must be used for notification when the tree is built.

When developing applications that use this bean, you should import the following subpackages:

oracle.xml.async, which provides asynchronous Java beans for DOM building

oracle.xml.parser.v2, which provides APIs for SAX, DOM, and XSLT

The oracle.xml.parser.v2 subpackage is described in detail in Chapter 4, "XML Parsing for Java". The most important DOM-related classes and interfaces in the javax.xml.async package are described in Table 10-1.

Table 10-1 javax.xml.async DOM-Related Classes and Interfaces

Class/Interface
Description

DOMBuilder class

Encapsulates an XML parser to parse an XML document and build a DOM tree. The parsing is done in a separate thread. The DOMBuilderListener interface must be used for notification when the tree is built.

DOMBuilderEvent class

Instantiates the event object that DOMBuilder uses to notify all registered listeners about parse events.

DOMBuilderListener interface

Must be implemented so that the program can receive notifications about events during the asynchronous parsing. The class implementing this interface must be added to the DOMBuilder with the addDOMBuilderListener() method.

DOMBuildeErrorEvent class

Defines the error event that is sent when parse exception occurs.

DOMBuilderErrorListener interface

Must be implemented so that the program can receive notifications when errors are found during parsing. The class implementing this interface must be added to the DOMBuilder with the addDOMBuilderErrorListener() method.

Figure 10-1 depicts the basic process of an application that uses the DOMBuilder JavaBean.

Figure 10-1 DOMBuilder JavaBean Usage

Graphic is described in the following text.
Description of "Figure 10-1 DOMBuilder JavaBean Usage"

Figure 10-1 shows the following stages of XML processing:

Parse the input XML document. The program can receive the XML document as a file, string buffer, or URL.

Add the DOMBuilder listener. The program invokes the method DOMBuilder.addDOMBuilderListener(DOMBuilderListener).

Parse the XML document. The program invokes the DOMBuilder.parse() method.

Optionally, process the parsed result further.

Call the listener when the program receives an asynchronous call. The listener, which must implement the DOMBuilderListener interface, is called by invoking the DOMBuilderOver() method.

The available DOMBuilderListener methods are:

domBuilderError(DOMBuilderEvent), which is called when parse errors occur.

domBuilderOver(DOMBuilderEvent), which is called when parsing completes.

domBuilderStarted(DOMBuilderEvent), which is called when parsing begins.

Fetch the DOM. Invoke the DOMBuilder.getDocument() method to fetch the resulting DOM document and output it.

Using the XSLTransformer JavaBean: Basic Process

The XSLTransformer bean encapsulates the Java XML parser XSLT processing engine with a bean interface and extends its functionality to permit asynchronous transformation. By registering a listener, your Java application can transform large and successive documents by having the control returned immediately to the caller.

When developing applications that use this bean, you should import the following subpackages:

oracle.xml.async, which provides asynchronous Java beans for XSL transformations

oracle.xml.parser.v2, which provides APIs for XML parsing SAX, DOM, and XSLT

The oracle.xml.parser.v2 subpackage is described in detail in Chapter 4, "XML Parsing for Java". The most important XSL-related classes and interfaces in the javax.xml.async package are described in Table 10-2.

Table 10-2 javax.xml.async XSL-Related Classes and Interfaces

Class/Interface
Description

XSLTransformer class

Applies XSL transformation in a background thread.

XSLTransformerEvent class

Represents the event object used by XSLTransformer to notify XSL transformation events to all of its registered listeners.

XSLTransformerListener interface

Must be implemented so that the program can receive notifications about events during asynchronous transformation. The class implementing this interface must be added to the XSLTransformer with the addXSLTransformerListener() method.

XSLTransformerErrorEvent class

Instantiates the error event object that XSLTransformer uses to notify all registered listeners about transformation error events.

XSLTransformerErrorListener interface

Must be implemented so that the program can receive notifications about error events during the asynchronous transformation. The class implementing this interface must be added to the XSLTransformer using addXSLTransformerListener() method.

Figure 10-2 illustrates XSLTransformer bean usage.

Figure 10-2 XSLTransformer JavaBean Usage

This graphic illustrates the use of the XSLTransformer bean.
Description of "Figure 10-2 XSLTransformer JavaBean Usage"

Figure 10-2 goes through the following stages:

Input an XSLT stylesheet and XML instance document.

Add an XSLT listener. The program invokes the XSLTransfomer.addXSLTransformerListener()method.

Apply the stylesheets. The XSLTransfomer.processXSL() method initiates the XSL transformation in the background.

Optionally, perform further processing with the XSLTransformer bean.

Call the XSLT listener when the program receives an asynchronous call. The listener, which must implement the XSLTransformerListener interface, is called by invoking the xslTransformerOver() method.

Fetch the result of the transformation. Invoke the XSLTransformer.getResult() method to return the XML document fragment for the resulting document.

Output the XML document fragment.

Using the XMLDBAccess JavaBean: Basic Process

When developing applications that use the XMLDBAccess bean, you should use the following subpackages:

oracle.xml.xmldbaccess, which includes the XMLDBAccess bean

oracle.xml.parser.v2, which provides APIs for XML parsing SAX, DOM, and XSLT

The oracle.xml.parser.v2 subpackage is described in detail in Chapter 4, "XML Parsing for Java". Some of the more important methods in the XMLDBAccess class are described in Table 10-3.

Table 10-3 XMLDBAccess Methods

Class/Interface
Description

createXMLTypeTable()

Creates an XMLType table.

insertXMLTypeData()

Inserts a text file as a row in an XMLType table.

replaceXMLTypeData()

Replaces a text file as a row in an XMLType table.

getXMLTypeTableNames()

Retrieves all XML tables with names starting with a specified string.

getXMLTypeData()

Retrieves text file from an XMLType table.

getXMLTypeXPathTextData()

Retrieves the text data based on the XPath expression from an XMLType table.

Figure 10-3 illustrates typical XMLDBAccess bean usage. It shows how the DBAccess bean maintains and manipulates XML documents stored in XMLTypes.

Figure 10-3 XMLDBAccess JavaBean Usage

This graphic is described in the following text.
Description of "Figure 10-3 XMLDBAccess JavaBean Usage"

For example, an XMLDBAaccess program could process XML documents in the following stages:

Create an XMLType table. Invoke createXMLTypeTable() by passing it database connection information and a table name.

List the XMLType tables. Invoke getXMLTypeTableNames() by passing it database connection information and an empty string.

Load XML data into the table. Invoke replaceXMLTypeData() by passing it database connection information, the table name, the XML file name, and a string containing the XML.

Retrieve the XML data into a String. Invoke getXMLTypeData() by passing it the connection information, the table name, and the XML file name.

Retrieve XML data based on an XPath expression. Invoke getXMLXPathTextData() by passing it the connection information, the table name, the XML file name, and the XPath expression.

Close the connection.

Using the XMLDiff JavaBean: Basic Process

When developing applications that use the XMLDiff bean, you typically use the following subpackages:

oracle.xml.xmldiff, which includes the XMLDiff bean

oracle.xml.parser.v2, which provides APIs for XML parsing SAX, DOM, and XSLT

oracle.xml.async, which provides asynchronous Java beans for DOM building

The oracle.xml.parser.v2 subpackage is described in detail in Chapter 4, "XML Parsing for Java". Some important methods in the XMLDiff class are described in Table 10-4.

Table 10-4 XMLDiff Methods

Class/Interface
Description

diff()

Determines the differences between two input XML files or two XMLDocument objects.

generateXSL()

Generates an XSL file that represents the differences between the input two XML files. The first XML file can be transformed into the second XML file with the generated stylesheet. If the XML files are the same, then the XSL generated can transform the first XML file into the second XML file, where the first and second files are equivalent.

Related methods are generateXSLDoc() and generateXSLFile().

setFiles()

Sets the XML files that need to be compared.

getDocument1()

Gets the document root as an XMLDocument object of the first XML tree. getDocument2() is the equivalent method for the second tree.

getDiffPane1()

Gets the text panel as JTextPane object that visually shows the diffs in the first XML file. getDiffPane2() is the equivalent method for the second file.

Figure 10-4 illustrates typical XMLDiff bean usage. It shows how XMLDiff bean compares and displays the differences between input XML documents.

Figure 10-4 XMLDiff JavaBean Usage

This graphic is described in the following text.
Description of "Figure 10-4 XMLDiff JavaBean Usage"

For example, an XMLDiff program could process XML documents in the following stages:

Create an XMLDiff object.

Set the files to be compared. Create File objects for the input files and pass references to the objects to XMLDiff.setFiles().

Compare the documents. The diff() method returns false if the XML files are the same and true if they are different.

Respond depending on the whether the input XML documents are the same or different. For example, if they are the same, invoke JOptionPane.showMessageDialog() to print a message.

Generate an XSLT stylesheet that shows the differences between the input XML documents. For example, generateXSLDoc() generates an XSL stylesheet as an XMLDocument.

Display the DOM trees created by XMLDiff.

Running the JavaBean Demo Programs

Demo programs for the XDK JavaBeans are included in the $ORACLE_HOME/xdk/demo/java/transviewer directory. The demos illustrate the use of the XDK beans described in "XDK JavaBeans Features" as well as some visual beans that are now deprecated. The following list shows all of the beans used in the demos:

XSLTransformer

DOMBuilder

DBAccess

XMLDBAccess

XMLDiff

XMLCompress

XSDValidator

oracle.xml.srcviewer.XMLSourceView (deprecated)

oracle.xml.treeviewer.XMLTreeView (deprecated)

oracle.xml.transformer.XMLTransformPanel (deprecated)

oracle.xml.dbviewer.DBViewer (deprecated)

Although the visual beans are deprecated, they remain useful as educational tools. Consequently, the deprecated beans are included in $ORACLE_HOME/lib/xmldemo.jar. The nondeprecated beans are included in $ORACLE_HOME/lib/xml.jar.

Table 10-5 lists the sample programs provided in the demo directory. The first column of the table indicates which sample program use deprecated beans.

Table 10-5 JavaBean Sample Java Source Files

Sample
File Name
Description

sample1

(deprecated)

XMLTransformPanelSample.java

A visual application that uses the XMLTransformPanel, DOMBuilder, and XSLTransformer beans. This bean applies XSL transformations to XML documents and shows the result.

See Also: "Running sample1"

sample2

(deprecated)

ViewSample.java

A sample visual application that uses the XMLSourceView and XMLTreeView beans. It visualizes XML document files.

See Also: "Running sample2"

sample3

AsyncTransformSample.java

A nonvisual application that uses the XSLTransformer and DOMBuilder beans. It applies the XSLT stylesheet specified in doc.xsl on all .xml files in the current directory. It writes the results to files with the extension .log.

See Also: "Running sample3"

sample4

(deprecated)

DBViewSample.java

A visual application that uses the DBViewer bean to implement a simple application that handles insurance claims.

See Also: "Running sample4"

DBViewClaims.java

This JFrame subclass is instantiated in the DBViewFrame class, which is in turn instantiated in the DBViewSample program.

DBViewFrame.java

This JFrame subclass is instantiated in the DBViewSample program.

sample5

XMLDBAccessSample.java

A nonvisual application for the XMLDBAccess bean. This program demonstrates how to use the XMLDBAccess bean APIs to store and retrieve XML documents in XMLType tables.

To use XMLType, an Oracle database is necessary along with xdb.jar. The program accepts values for HOSTNAME, PORT, SID, USERID, and PASSWORD. The program creates tables in the database and loads data from file booklist.xml. The program writes output to xmldbaccess.log.

See Also: "Running sample5"

sample6

(deprecated)

XMLDiffSample.java

A visual application that uses the XMLDiff bean to find differences between two XML files and generate an XSLT stylesheet. You can use this stylesheet to transform the first input XML into the second input XML file.

See Also: "Running sample6"

XMLDiffFrame.java

A class that implements the ActionListener interface. This class is used by the XMLDiffSample program.

XMLDiffSrcView.java

A JPanel subclass used by the XMLDiffSample program.

sample7

(deprecated)

compviewer.java

A visual application that uses the XMLCompress bean to compress XML. The XML input can be an XML file or XML data obtained through a SQL query. The application enables you to decompress the compressed stream and view the resulting DOM tree.

See Also: "Running sample7"

compstreamdata.java

A simple class that pipes information from the GUI to the bean. This class is used in dbpanel.java, filepanel.java, and xmlcompressutil.java.

dbpanel.java

A JPanel subclass used in xmlcompressutil.java.

filepanel.java

A JPanel subclass used in xmlcompressutil.java.

xmlcompressutil.java

A JPanel subclass used in compviewer.java.

sample8

(deprecated)

XMLSchemaTreeViewer.java

A visual application that uses the Treeviewer, sourceviewer, and XSDValidator beans. The application accepts an XML instance document and an XML schema document as inputs. The application parses both the documents and validates the instance document against the schema. If the document is invalid, then the nodes where the errors occurred are highlighted and an error message is shown in a tool tip.

See Also: "Running sample8"

TreeViewerValidate.java

A JPanel subclass that displays a parsed XML instance document as a tree. This class is used by the XMLSchemaTreeViewer.java program.

sample9

(deprecated)

XMLSrcViewer.java

A visual application that uses the sourceviewer and XSDValidator beans. The demo takes an XML file as input. You can select the validation mode: DTD, XML schema, or no validation. The program validates the XML data file against the DTD or schema and displays it with syntax highlighting. It also logs validation errors. For schema validation it also highlights the error nodes appropriately. External and internal DTDs can be viewed.

See Also: "Running sample9"

XMLSrcViewPanel.java

A class that shows how to use the XMLSourceView and DTDSourceView objects. This class is used by the XMLSrcViewer.java program.Each XMLSourceView object is set as a Component of a JPanel by invoking goButton_actionPerformed(). The XML file to be viewed is parsed and the resulting XML document is set in the XMLSourceView object by invoking makeSrcPane(). The highlighting and DTD display properties are specified at this time. For performing schema validation, build the schema object by invoking makeSchemaValPane(). You can can check for errors and display the source code accordingly with different highlights. You can retrieve a list of schema validation errors from the XMLSourceView by invoking dumpErrors().

sample10

XSDValidatorSample.java

An application that shows how to use the XSDValidator bean. It accepts an XML file and an XML schema file as input. The program displays errors occurring during validation, including line numbers.

See Also: "Running sample10"

Table 10-6 describes additional files that are used by the demo programs.

Table 10-6 JavaBean Sample Files

File Name
Description

XMLDiffData1.txt

An XML document used by the XMLDiffSample.java program. By default the 2 XML files XMLDiffData1.txt and XMLDiffData2.txt are compared and the output XSLT is stored as XMLDiffSample.xsl.

XMLDiffData2.txt

An XML document used by the XMLDiffSample.java program. By default the 2 XML files XMLDiffData1.txt and XMLDiffData2.txt are compared and the output XSLT is stored as XMLDiffSample.xsl.

booklist.xml

An XML document for use by XMLDBAccessSample.java.

claim.sql

An XML document used by ViewSample.java and XMLDBAccessSample.java.

doc.xml

An XML document for use by AsyncTransformSample.java.

doc.xsl

An XSLT stylesheet for use by AsyncTransformSample.java.

emptable.xsl

An XSLT stylesheet for use by AsyncTransformSample.java, ViewSample.java, or XMLTransformPanelSample.java.

note_in_dtd.xml

A sample XML document for use in XMLSrcViewer.java. You can use this file in DTD validation mode to view an internal DTD with validation errors. An internal DTD can be optionally displayed along with the XML data.

purchaseorder.xml

An XML document used by the XSDValidatorSample.java program. The instance document purchaseorder.xml does not comply with XML schema defined in purchaseorder.xsd, which causes the program to display the errors.

purchaseorder.xsd

An XML schema document used by the XSDValidatorSample.java program. The instance document purchaseorder.xml does not comply with XML schema defined in purchaseorder.xsd, which causes the program to display the errors.

Documentation for how to compile and run the sample programs is located in the README in the same directory. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/transviewer directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\transviewer directory (Windows).

Make sure that your environment variables are set as described in "Setting Up the Java XDK Environment". The beans require JDK 1.2 or higher. The DBViewer and DBTransformPanel beans require JDK 1.2.2 when rendering HTML. Prior versions of the JDK may not render HTML in the result buffer properly.

Edit the Makefile (UNIX) or Make.bat (Windows) for your environment. In particular, do the following:

Change the JDKPATH in the Makefile to point to your JDK path.

Change PATHSEP to the appropriate path separator for your operating system.

Change the HOSTNAME, PORT, SID, USERID, and PASSWORD parameters so that you can connect to the database through the JDBC thin driver. These parameters are used in sample4 and sample5.

Run make (UNIX) or Make.bat (Windows) at the system prompt to generate the class files.

Run gmake as follows to run the demos:

gmake sample1
gmake sample2
gmake sample3
gmake sample4
gmake sample5
gmake sample6
gmake sample7
gmake sample8
gmake sample9
gmake sample10

The following sections explain how to run the demos.

Running sample1

Sample1 is the program that uses the XMLTransViewer bean. You can run the program manually as follows:

java XMLTransformPanelSample

You can use the program to import and export XML files from Oracle database, store XSL transformation files in the database, and apply stylesheets to XML interactively. To use the database connectivity feature in this program, you need to know the network name of the computer where the database runs, the port (usually 1521), and the name of the Oracle instance (usually orcl). You also need an account with CREATE TABLE privileges. If you have installed the sample schemas, then you can use the account hr. You can the XMLTransViewer program to apply stylesheet transformation to XML files and display the result.The program displays a panel with tabs on the top and the bottom. The first two top tabs are used to switch between the XML buffer and the XSLT buffer. The third tab performs XSL transformation on the XML buffer and displays the result. The first two tabs on the bottom can be used to load and save data from Oracle database and from the file system. The remaining bottom tabs switch the display of the current content to tree view, XML source, edit mode and, in case of the result view after the transformation, HTML.

Running sample2

Sample2 is a GUI-based demo for the XMLSourceView and XMLTreeView beans, which are deprecated. The ViewSample program displays the booklist.xml file in separate source and tree views. You can run the program manually as follows:

java ViewSample

Running sample3

Sample3 is a nonvisual demo for the asynchronous DOMBuilder and XSLTransformer beans. The AsyncTransformSample program applies the doc.xsl XSLT stylesheet to all *.xml files in the current directory. The program writes output to files with the extension .log. You can run the program as follows:

java AsyncTransformSample

Running sample4

Sample4 is a visual demo for the DBViewer bean, which is deprecated. It runs in the following stages:

It starts SQL*Plus, connects to the database with the USERID and PASSWORD specified in the Makefile, and runs the claim.sql script. This script creates a number of tables, views, and types for use by the DBViewSample demo program.

It runs the DBViewSample program as follows:

java -classpath "$(MAKE_CLASSPATH)" DBViewSample

JDBC connection information is hard-coded in the DBViewClaims.java source file, which implements a class used by the demo. Specifically, the program assumes the values for USERID, PASSWORD, and so forth set in the Makefile. If your configuration is different, navigate to line 92 in DBViewClaims.java and modify setUsername(), setPassword(), and so forth with values that reflect your Oracle database configuration.

Running sample5

Sample5 is a nonvisual demo for the XMLDBAccess bean. It uses the XMLType objects to store XML documents inside the database.The following program connects to the database with the Java thin client, creates XMLType tables, and loads the data from booklist.xml. To run the program you must specify the following pieces of information as command-line arguments:

Host name (for example, myhost)

Port number (for example, 1521)

SID of the database (for example, ORCL)

Database account in which the tables will be created (for example, hr)

Password for the database account (for example, hr)

For example, you can run the program as follows:

java XMLDBAccessSample myhost 1521 ORCL hr hr

The following text shows sample output from dbaccess.log:

Demo for createXMLTypeTables():
Table +'testxmltype' successfully created.

Demo for listXMLTypeTables():
tablenamename=TESTXMLTYPE

Demo for replaceXMLTypeData() (similar to insert):
XML Data from +'booklist.xml' successfully replaced in table 'testxmltype'.

Demo for getXMLTypeData():
XMLType data fetched:
<?xml version="1.0"?>
<booklist>
  <book isbn="1234-123456-1234">
    <title>C Programming Language</title>
    <author>Kernighan and Ritchie</author>
    <publisher>EEE</publisher>
    <price>7.99</price>
  </book>
...
  <book isbn="1230-23498-2349879">
    <title>Emperor's New Mind</title>
    <author>Roger Penrose</author>
    <publisher>Oxford Publishing Company</publisher>
    <price>15.99</price>
  </book>
</booklist>

Demo for getXMLTypeXPathTextData():
Data fetched using XPath exp '/booklist/book[3]':
<book isbn="2137-598354-65978">
  <title>Twelve Red Herrings</title>
  <author>Jeffrey Archer</author>
  <publisher>Harper Collins</publisher>
  <price>12.95</price>
</book>

Running sample6

The sample6 program is a visual demo for the XMLDiff bean. The XMLDiffSample class invokes a GUI that enables you to choose the input data files from the File menu by selecting Compare XML Files. The Transform menu enables you to apply the generated XSLT generated to the first input XML. Select Save As in the File menu to save the output XML file, which will be the same as the second input file. By default, the program compares XMLDiffData1.txt to XMLDiffData2.txt and stores the XSLT output as XMLDiffSample.xsl.

You can run the program manually as follows:

java -mx50m XMLDiffSample XMLDiffData1.txt XMLDiffData2.txt

If the input XML files use a DTD that accesses a URL outside a firewall, then modify XMLDiffSample.java to include the proxy server settings before the setFiles() call. For example, modify the program as follows:

/* Set proxy to access dtd through firewall */
Properties p = System.getProperties();
p.put("proxyHost", "www.proxyservername.com");
p.put("proxyPort", "80");
p.put("proxySet", "true");
/* You will also have to import java.util.*; */

Running sample7

The sample7 visual demo illustrates the use of the XMLCompress bean. The compviewer class invokes a GUI which lets the user compress and uncompress XML files and data obtained from the database. The loading options enable the user to retrieve the data either from a file system or a database. This application does not support loading and saving compressed data from the database. The compression factor indicates a rough estimate by which the XML data is reduced.

You can run the program manually as follows:

java compviewer

Running sample8

The sample8 demo illustrates the use of the XMLTreeViewer bean. The XMLSchemaTreeViewer program enables the user to view an XMLDocument in a tree format. The user can input a schema document and validate the instance document against the schema. If the document is invalid, then the invalid nodes are highlighted with the error message. Also, the program displays a log of all the line information in a separate panel, which enables the user to edit the instance document and revaluated. Test the program with sample files purchaseorder.xml and purchaseorder.xsd. The instance document purchaseorder.xml does not comply with schema defined in purchaseorder.xsd.

You can run the program manually as follows:

java XMLSchemaTreeViewer

Running sample9

The sample9 demo illustrates the use of the SourceViewer bean. The XMLSrcViewer program enables you to view an XML document or a DTD with syntax highlighting turned on. You can validate the XML document against an input XML Schema or DTD. The DTD can be internal or external.

If the validation is successful, then you can view the instance document and XML schema or DTD in the Source View pane. If errors were encountered during schema validation, then an error log with line numbers is available in the Error pane. The Source View pane shows the XML document with error nodes highlighted.You can use sample files purchaseorder.xml and purchaseorder.xsd for testing XML schema validation with errors. You can use note_in_dtd.xml with DTD validation mode to view an internal DTD with validation errors. You can run the program manually as follows:

java XMLSrcViewer

Running sample10

The sample10 demo illustrates the use of the XSDValidator bean. The XSDValidatorSample program's two input arguments are an XML document and its associated XML schema. The program displays errors occurring during validation, including line numbers.

The following program uses purchaseorder.xsd to validate the contents of purchaseorder.xml:

java XSDValidatorSample purchaseorder.xml purchaseorder.xsd

The XML document fails (intentionally) to validate against the schema. The program displays the following errors:

Sample purchaseorder.xml purchaseorder.xsd
<Line 2, Column 41>: XML-24523: (Error) Invalid value 'abc' for attribute: 'orderDate'
#document->purchaseOrder
<Line 7, Column 27>: XML-24525: (Error) Invalid text 'CA' in element: 'state'
#document->purchaseOrder->shipTo->state->#text
<Line 8, Column 25>: XML-24525: (Error) Invalid text 'sd' in element: 'zip'
#document->purchaseOrder->shipTo->zip->#text
<Line 14, Column 27>: XML-24525: (Error) Invalid text 'PA' in element: 'state'
#document->purchaseOrder->billTo->state->#text
<Line 17, Column 22>: XML-24534: (Error) Element 'coment' not expected.
#document->purchaseOrder->coment
<Line 29, Column 31>: XML-24534: (Error) Element 'shipDae' not expected.
#document->purchaseOrder->items->item->shipDae

Processing XML with the XDK JavaBeans

This section contains the following topics:

Processing XML Asynchronously with the DOMBuilder and XSLTransformer Beans

Comparing XML Documents with the XMLDiff Bean

Processing XML Asynchronously with the DOMBuilder and XSLTransformer Beans

As explained in "DOMBuilder" and "XSLTransformer", you can use XDK beans to perform asynchronous XML processing.

The AsyncTransformSample.java program illustrates how to use both the DOMBuilder and XSLTransformer beans. The program implements the following methods:

runDOMBuilders()

runXSLTransformer()

saveResult()

makeXSLDocument()

createURL()

init()

exitWithError()

asyncTransform()

The basic architecture of the program is as follows:

The program declares and initializes the fields used by the class. Note that the input XSLT stylesheet is hard-coded in the program as doc.xsl. The class defines the following fields:

String        basedir = new String (".");
OutputStream  errors = System.err;
Vector        xmlfiles = new Vector();
int           numXMLDocs = 1;
String        xslFile = new String ("doc.xsl");
URL           xslURL;
XMLDocument   xsldoc

The main() method invokes the init() method to perform the initial setup. This method lists the files in the current directory, and if it finds files that end in the extension .xml, it adds them to a Vector object. The implementation for the init() method is as follows:

boolean init () throws Exception
{
   File     directory = new File (basedir);
   String[] dirfiles = directory.list();
   for (int j = 0; j < dirfiles.length; j++)
   {
      String dirfile = dirfiles[j];

      if (!dirfile.endsWith(".xml"))
          continue;

       xmlfiles.addElement(dirfile);
   }

   if (xmlfiles.isEmpty()) {
      System.out.println("No files in directory were selected for processing");
      return false;
   }
   numXMLDocs = xmlfiles.size();

   return true;
}

The main() method instantiates AsyncTransformSample as follows:

AsyncTransformSample inst = new AsyncTransformSample();

The main() method invokes the asyncTransform() method. The asyncTransform() method performs the following main tasks:

Invokes makeXSLDocument() to parse the input XSLT stylesheet.

Calls runDOMBuilders() to initiate parsing of the instance documents, that is, the documents to be transformed, and then transforms them.

After initiating the XML processing, the program resumes control and waits while the processing occurs in the background. When the last request completes, the method exits.

The following code shows the implementation of the asyncTransform() method:

void asyncTransform () throws Exception
{
   System.err.println (numXMLDocs +
            " XML documents will be transformed" +
            " using XSLT stylesheet specified in " + xslFile +
            " with " +  numXMLDocs + " threads");

   makeXSLDocument ();
   runDOMBuilders ();

   // wait for the last request to complete
   while (rm.activeFound())
      Thread.sleep(100);
}

The following sections explain the makeXSLDocument() and runDOMBuilders() methods.

Parsing the Input XSLT Stylesheet

The makeXSLDocument() method illustrates a simple DOM parse of the input stylesheet. It does not use asynchronous parsing. The technique is the same described in "Performing Basic DOM Parsing".

The method follows these steps:

Create a new DOMParser() object. The following code fragment from DOMSample.java illustrates this technique:

DOMParser parser = new DOMParser();

Configure the parser. The following code fragment specifies that whitespace should be preserved:

parser.setPreserveWhitespace(true);

Create a URL object from the input stylesheet. The following code fragment invokes the createURL() helper method to accomplish this task:

xslURL = createURL (xslFile);

Parse the input XSLT stylesheet. The following statement illustrates this technique:

parser.parse (xslURL);

Obtain a handle to the root of the in-memory DOM tree. You can use the XMLDocument object to access every part of the parsed XML document. The following statement illustrates this technique:

xsldoc = parser.getDocument();

Processing the XML Documents Asynchronously

The runDOMBuilders() method illustrates how you can use the DOMBuilder and XSLTransformer beans to perform asynchronous processing. The parsing and transforming of the XML occurs in the background.

The method follows these steps:

Create a resource manager to manage the input XML documents. The program creates a for loop and obtains the XML documents. The following code fragment illustrates this technique:

rm = new ResourceManager (numXMLDocs);
for (int i = 0; i < numXMLDocs; i++)
{
   rm.getResource();
   ...
}

Instantiate the DOM builder bean for each input XML document. For example:

DOMBuilder builder = new DOMBuilder(i);

Create a URL object from the XML file name. For example:

DOMBuilder builder = new DOMBuilder(i);
URL  xmlURL = createURL(basedir + "/" + (String)xmlfiles.elementAt(i));
if (xmlURL == null)
   exitWithError("File " + (String)xmlfiles.elementAt(i) + " not found");

Configure the DOM builder. The following code fragment specifies the preservation of whitespace and sets the base URL for the document:

builder.setPreserveWhitespace(true);
builder.setBaseURL (createURL(basedir + "/"));

Add the listener for the DOM builder. The program adds the listener by invoking addDOMBuilderListener().

The class instantiated to create the listener must implement the DOMBuilderListener interface. The program provides a do-nothing implementation for domBuilderStarted() and domBuilderError(), but must provide a substantive implementation for domBuilderOver(), which is the method called when the parse of the XML document completes. The method invokes runXSLTransformer(), which is the method that transforms the XML. Refer to "Transforming the XML with the XSLTransformer Bean" for an explanation of this method.

The following code fragment illustrates how to add the listener:

builder.addDOMBuilderListener
(
   new DOMBuilderListener()
   {
      public void domBuilderStarted(DOMBuilderEvent p0) {}
      public void domBuilderError(DOMBuilderEvent p0) {}
      public synchronized void domBuilderOver(DOMBuilderEvent p0)
      {
         DOMBuilder bld = (DOMBuilder)p0.getSource();
         runXSLTransformer (bld.getDocument(), bld.getId());
      }
   }
);

Add the error listener for the DOM builder. The program adds the listener by invoking addDOMBuilderErrorListener().

The class instantiated to create the listener must implement the DOMBuilderErrorListener interface. The following code fragment show the implementation:

builder.addDOMBuilderErrorListener
(
   new DOMBuilderErrorListener()
   {
      public void domBuilderErrorCalled(DOMBuilderErrorEvent p0)
      {
         int id = ((DOMBuilder)p0.getSource()).getId();
         exitWithError("Error occurred while parsing " +
            xmlfiles.elementAt(id) + ": " +
            p0.getException().getMessage());
      }
   }
);

Parse the document. The following statement illustrates this technique:

builder.parse (xmlURL);
System.err.println("Parsing file " + xmlfiles.elementAt(i));

Transforming the XML with the XSLTransformer Bean

When the DOM parse completes, the DOM listener receives notification. The domBuilderOver() method implements the behavior in response to this event. The program passes the DOM to the runXSLTransformer() method, which initiates the XSL transformation.

The method follows these steps:

Instantiate the XSLTransformer bean. This object performs the XSLT processing. The following statement illustrates this technique:

XSLTransformer processor = new XSLTransformer (id);

Create a new stylesheet object. For example:

XSLStylesheet  xsl       = new XSLStylesheet (xsldoc, xslURL);

Configure the XSLT processor. For example, the following statement sets the processor to show warnings and configures the error output stream:

processor.showWarnings (true);
processor.setErrorStream (errors);

Add the listener for the XSLT processor. The program adds the listener by invoking addXSLTransformerListener().

The class instantiated to create the listener must implement the XSLTransformerListener interface. The program provides a do-nothing implementation for xslTransformerStarted() and xslTransformerError(), but must provide a substantive implementation for xslTransformerOver(), which is the method called when the parse of the XML document completes. The method invokes saveResult(), which prints the transformation result to a file.

The following code fragment illustrates how to add the listener:

processor.addXSLTransformerListener
(
   new XSLTransformerListener()
   {
      public void xslTransformerStarted (XSLTransformerEvent p0) {}
      public void xslTransformerError(XSLTransformerEvent p0) {}
      public void xslTransformerOver (XSLTransformerEvent p0)
      {
         XSLTransformer trans = (XSLTransformer)p0.getSource();
         saveResult (trans.getResult(),  trans.getId());
      }
   }
);

Add the error listener for the XSLT processor. The program adds the listener by invoking addXSLTransformerErrorListener().

The class instantiated to create the listener must implement the XSLTransformerErrorListener interface. The following code fragment show the implementation:

processor.addXSLTransformerErrorListener
(
   new XSLTransformerErrorListener()
   {
      public void xslTransformerErrorCalled(XSLTransformerErrorEvent p0)
      {
         int i = ((XSLTransformer)p0.getSource()).getId();
         exitWithError("Error occurred while processing " +
                       xmlfiles.elementAt(i) + ": " +
                       p0.getException().getMessage());
      }
   }
);

Transform the XML document with the XSLT stylesheet. The following statement illustrates this technique:

processor.processXSL (xsl, xml);

Comparing XML Documents with the XMLDiff Bean

As explained in "XMLDiff", you can use XDK beans to compare the structure and significant content of XML documents.

The XMLDiffSample.java program illustrates how to use the XMLDiff bean. The program implements the following methods:

showDiffs()

doXSLTransform()

createURL()

The basic architecture of the program is as follows:

The program declares and initializes the fields used by the class. Note that one field is of type XMLDiffFrame, which is the class implemented in the XMLDiffFrame.java demo. The class defines the following fields:

protected XMLDocument doc1;   /* DOM tree for first file */
protected XMLDocument doc2;   /* DOM tree for second file */
protected static XMLDiffFrame diffFrame; /* GUI frame */
protected static XMLDiffSample dfxApp;   /* XMLDiff sample application */
protected static XMLDiff xmlDiff;        /* XML diff object */
protected static XMLDocument xslDoc;     /* parsed xsl file */
protected static String outFile = new String("XMLDiffSample.xsl"); /* output
                                                              xsl file name */

The main() method creates an XMLDiffSample object as follows:

dfxApp = new XMLDiffSample();

The main() method adds and initializes a JFrame to display the output of the comparison. The following code illustrates this technique:

diffFrame = new XMLDiffFrame(dfxApp);
diffFrame.addTransformMenu();

The main() method instantiates the XMLDiff bean. The following code illustrates this technique:

xmlDiff = new XMLDiff();

The main() method invokes the showDiffs() method. This method performs the following tasks:

Invokes XMLDiff.diff() to compare the input XML documents.

Generates and displays an XSLT stylsheet that can transform one input document into the other document.

The following code fragment shows the showDiffs() method call:

if (args.length == 3)
  outFile = args[2];
if(args.length >= 2)
  dfxApp.showDiffs(new File(args[0]), new File(args[1]));
diffFrame.setVisible(true);

The following section explains the showDiffs() method.

Comparing the XML Files and Generating a Stylesheet

The showDiffs() method illustrates the use of the XMLDiff bean.

The method follows these steps:

Set the files for the XMLDiff processor. The following statement illustrates this technique:

xmlDiff.setFiles(file1, file2);

Compare the files. The diff() method returns a boolean value that indicates whether the input documents have identical structure and content. If they are equivalent, then the method prints a message to the JFrame implemented by the XMLDiffFrame class. The following code fragment illustrates this technique:

if(!xmlDiff.diff())
{
  JOptionPane.showMessageDialog
  (
    diffFrame,
    "Files are equivalent in XML representation",
    "XMLDiffSample Message",
    JOptionPane.PLAIN_MESSAGE
  );
}

Generate a DOM for the XSLT stylesheet that shows the differences between the two documents. The following code fragment illustrates this technique:

xslDoc = xmlDiff.generateXSLDoc();

Display the documents in the JFrame implemented by XMLDiffFrame. Note that XMLDiffFrame instantiates the XMLSourceView bean, which is deprecated. The method follows these steps:

Create the source pane for the input documents. Pass the DOM handles of the two documents to the diffFrame object to make the source pane:

diffFrame.makeSrcPane(xmlDiff.getDocument1(), xmlDiff.getDocument2());

Create the pane that shows the differences between the documents. Pass references to the text panes to diffFrame as follows:

diffFrame.makeDiffSrcPane(new XMLDiffSrcView(xmlDiff.getDiffPane1()),
                          new XMLDiffSrcView(xmlDiff.getDiffPane2()));

Create the pane for the XSLT stylesheet. Pass the DOM of the stylesheet as follows:

diffFrame.makeXslPane(xslDoc, "Diff XSL Script");
diffFrame.makeXslTabbedPane();

11 Using the XML SQL Utility (XSU)

This chapter contains these topics:

Introduction to the XML SQL Utility (XSU)

Using the XML SQL Utility: Overview

Programming with the XSU Java API

Programming with the XSU PL/SQL API

Tips and Techniques for Programming with XSU

Introduction to the XML SQL Utility (XSU)

XML SQL Utility (XSU) is an XDK component that enables you to transfer XML data through Oracle SQL statements. You can use XSU to perform the following tasks:

Transform data in object-relational database tables or views into XML. XSU can query the database and return the result set as an XML document.

Extract data from an XML document and use canonical mapping to insert the data into a table or a view or update or delete values of the appropriate columns or attributes.

This section contains the following topics:

Prerequisites

XSU Features

XSU Restrictions

Prerequisites

This chapter assumes that you are familiar with the following technologies:

Oracle Database SQL. XSU transfers XML to and from a database through SELECT statements and DML.

PL/SQL. The XDK supplies a PL/SQL API for XSU that mirrors the Java API.

Java Database Connectivity (JDBC). Java applications that use XSU to transfer XML to and from a database require a JDBC connection.

XSU Features

XSU has the following key features:

Dynamically generates DTDs or XML schemas.

Generates XML documents in their string or DOM representations.

Performs simple transformations during generation such as modifying default tag names for each <ROW> element. You can also register an XSL transformation that XSU applies to the generated XML documents as needed.

Generates XML as a stream of SAX2 callbacks.

Supports XML attributes during generation, which enables you to specify that a particular column or group of columns maps to an XML attribute instead of an XML element.

Allows SQL to XML tag escaping. Sometimes column names are not valid XML tag names. To avoid this problem you can either alias all the column names or turn on tag escaping.

Supports XMLType columns in objects or tables.

Inserts XML into relational database tables or views. When given an XML document, XSU can also update or delete records from a database object.

XSU Restrictions

Note the following restrictions when using XSU:

XSU can only store data in a single table. You can store XML across tables, however, by using the Oracle XSLT processor to transform a document into multiple documents and inserting them separately. You can also define views over multiple tables and perform insertions into the views. If a view is non-updatable (because of complex joins), then you can use INSTEAD OF triggers over the views to perform the inserts.

You cannot use XSU to load XML data stored in attributes into a database schema, but you can use an XSLT transformation to change the attributes into elements.

By default XSU is case sensitive. You can either use the correct case or specify that case should be ignored.

XSU cannot generate a relational database schema from an input DTD.

Inserting into XMLType tables using XSU is not supported. XMLType columns are supported.

Using the XML SQL Utility: Overview

This section contains the following topics:

Using XSU: Basic Process

Installing XSU

Running the XSU Demo Programs

Using the XSU Command-Line Utility

Using XSU: Basic Process

XSU is accessible through the following interfaces:

The OracleXMLQuery and OracleXMLSave Java classes in the oracle.xml.sql.query package. Use the OracleXMLQuery class to generate XML from relational data and OracleXMLSave class to perform DML.

The PL/SQL packages DBMS_XMLQuery and DBMS_XMLSave, which mirror the Java classes.

You can write the following types of XSU applications:

Java programs that run inside the database and access the internal XSU Java API

Java programs that run on the client and access the client-side XSU Java API

PL/SQL programs that access XSU through PL/SQL packages

Generating XML with the XSU Java API: Basic Process

The OracleXMLQuery class makes up the XML generation part of the XSU Java API. Figure 11-1 illustrates the basic process for generating XML with XSU.

The basic steps in Figure 11-1 are as follows:

Figure 11-1 Generating XML with XSU

Description of Figure 11-1 follows
Description of "Figure 11-1 Generating XML with XSU"

Create a JDBC connection to the database. Normally, you establish a connection with the DriverManager class, which manages a set of JDBC drivers. After the JDBC drivers are loaded, call getConnection(). When it finds the right driver, this method returns a Connection object that represents a database session. All SQL statements are executed within the context of this session.

You have the following options:

Create the connection with the JDBC OCI driver. The following code fragment illustrates this technique:

// import the Oracle driver class
import oracle.jdbc.*;
// load the Oracle JDBC driver
DriverManager.registerDriver(new oracle.jdbc.OracleDriver());
// create the connection
Connection conn =
   DriverManager.getConnection("jdbc:oracle:oci:@","hr","password");

The preceding example uses the default connection for the JDBC OCI driver.

Create the connection with the JDBC thin driver. The thin driver is written in pure Java and can be called from any Java program. The following code fragment illustrates this technique:

Connection conn =
   DriverManager.getConnection("jdbc:oracle:thin:@dlsun489:1521:ORCL",
     "hr","password");

The thin driver requires the host name (dlsun489), port number (1521), and the Oracle SID (ORCL). The database must have an active TCP/IP listener.

Use default connection used by the server-side internal JDBC driver. This driver runs within a default session and default transaction context. You are already connected to the database; your SQL operations are part of the default transaction. Thus, you do not need to register the driver. Create the Connection object as follows:

Connection conn = new oracle.jdbc.OracleDriver().defaultConnection ();

Note:

OracleXMLDataSetExtJdbc is used only for Oracle JDBC, whereas OracleXMLDataSetGenJdbc is used for non-Oracle JDBC. These classes are in the oracle.xml.sql.dataset package.

Create an XML query object and assign it a SQL query. You create an OracleXMLQuery Class instance by passing a SQL query to the constructor, as shown in the following example:

OracleXMLQuery qry = new OracleXMLQuery (conn, "SELECT * from EMPLOYEES");

Configure the XML query object by invoking OracleXMLQuery methods. The following example specifies that only 20 rows should be included in the result set:

xmlQry.setMaxRows(20);

Return a DOM object or string by invoking OracleXMLQuery methods. For example, obtain a DOM object as follows:

XMLDocument domDoc = (XMLDocument)qry.getXMLDOM();

Obtain a string object as follows:

String xmlString = qry.getXMLString();

Perform additional processing on the string or DOM as needed.

See Also:

Oracle Database Java Developer's Guide to learn about Oracle JDBC

Oracle Database XML Java API Reference to learn about OracleXMLQuery methods

Performing DML with the XSU Java API: Basic Process

Use the OracleXMLSave class to insert, update, and delete XML in the database. Figure 11-2 illustrates the basic process.

Figure 11-2 Storing XML in the Database Using XSU

Description of Figure 11-2 follows
Description of "Figure 11-2 Storing XML in the Database Using XSU"

The basic steps in Figure 11-2 are as follows:

Create a JDBC connection to the database. This step is identical to the first step described in "Generating XML with the XSU Java API: Basic Process".

Create an XML save object and assign it a table on which to perform DML. Pass a table or view name to the constructor, as shown in the following example:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Specify the primary key columns. For example, the following code specifies that employee_id is the key column:

String [] keyColNames = new String[1];
keyColNames[0] = "EMPLOYEE_ID";
sav.setKeyColumnList(keyColNames);

Configure the XML save object by invoking OracleXMLSave methods. The following example specifies an update of the salary and job_id columns:

String[] updateColNames = new String[2];
updateColNames[0] = "SALARY";
updateColNames[1] = "JOB_ID";
sav.setUpdateColumnList(updateColNames); // set the columns to update

Invoke the insertXML(), updateXML(), or deleteXML() methods on the OracleXMLSave object. The following example illustrates an update:

// Assume that the user passes in this XML document as the first argument
sav.updateXML(sav.getURL(argv[0]));

When performing the DML, XSU performs the following tasks:

Parses the input XML document.

Matches element names to column names in the target table or view.

Converts the elements to SQL types and binds them to the appropriate statement.

Close the OracleXMLSave object and deallocate all contexts associated with it, as shown in the following example:

sav.close();

See Also:

Oracle Database Java Developer's Guide to learn about JDBC

Oracle Database XML Java API Reference to learn about OracleXMLSave

Generating XML with the XSU PL/SQL API: Basic Process

The XSU PL/SQL API reflects the Java API in the generation and storage of XML documents from and to a database. DBMS_XMLQuery is the PL/SQL package that reflects the methods in the OracleXMLQuery Java class. This package has a context handle associated with it. Create a context by calling one of the constructor-like functions to get the handle and then use the handle in all subsequent calls.

Note:

For improved performance, consider using the C-based DBMS_XMLGEN, which is written in C and built into the database, rather than DBMS_XMLQUERY.

XSU supports the XMLType datatype. Using XSU with XMLType is useful if, for example, you have XMLType columns in objects or tables.

Generating XML results in a CLOB that contains the XML document. To use DBMS_XMLQuery and the XSU generation engine, follow these basic steps:

Declare a variable for the XML query context and a variable for the generated XML. For example:

v_queryCtx  DBMS_XMLQuery.ctxType;
v_result    CLOB;

Obtain a context handle by calling the DBMS_XMLQuery.newContext function and supplying it the query, either as a CLOB or a VARCHAR2. The following example registers a query to select the rows from the employees table with the WHERE clause containing the bind variables :EMPLOYEE_ID and :FIRST_NAME:

v_queryCtx = DBMS_XMLQuery.newContext('SELECT * FROM employees
                   WHERE employee_id=:EMPLOYEE_ID AND first_name=:FIRST_NAME');

Bind values to the query. The binds work by binding a name to the position. clearBindValues clears all the bind variables, whereas setBindValue sets a single bind variable with a string value. For example, bind the employee_id and first_name values as shown:

DBMS_XMLQuery.setBindValue(v_queryCtx,'EMPLOYEE_ID',20);
DBMS_XMLQuery.setBindValue(v_queryCtx,'FIRST_NAME','John');

Configure the query context. Set optional arguments such as the ROW tag name, the ROWSET tag name, or the number of rows to fetch, and so on. The following example specifies changes the default ROWSET element name to EMPSET:

DBMS_XMLQuery.setRowSetTag(v_queryCtx,'EMPSET');

Fetch the results. You can obtain the XML as a CLOB with the getXML function, which generates XML with or without a DTD or XML schema. The following example applies bind values to the statement and gets the result corresponding to the predicate employee_id = 20 and first_name = 'John':

v_result := DBMS_XMLQuery.getXML(v_queryCtx);

Process the results of the XML generation. For example, suppose that your program declared the following variables:

v_xmlstr VARCHAR2(32767);
v_line   VARCHAR2(2000);

You can print the CLOB stored in v_result as follows:

v_xmlstr := DBMS_LOB.SUBSTR(v_result,32767);
LOOP
  EXIT WHEN v_xmlstr IS NULL;
  v_line := substr(v_xmlstr,1,INSTR(v_xmlstr,CHR(10))-1);
  DBMS_OUTPUT.PUT_LINE('| ' || v_line);
  v_xmlstr := SUBSTR(v_xmlstr,INSTR(v_xmlstr,CHR(10))+1);
END LOOP;

Close the context. For example:

DBMS_XMLQuery.closeContext(v_queryCtx);

Performing DML with the PL/SQL API: Basic Process

DBMS_XMLSave is the PL/SQL package that reflects the methods in the OracleXMLSave Java class. This package has a context handle associated with it. Create a context by calling one of the constructor-like functions to get the handle and then use the handle in all subsequent calls.

To use DBMS_XMLSave, follow these basic steps:

Declare a variable for the XML save context and a variable for the number of rows touched by the DML. For example:

savCtx DBMS_XMLSave.ctxType;
v_rows   NUMBER;

Create a context handle by calling the DBMS_XMLSave.newContext function and supply it the table name to use for the DML operations.

savCtx  := DBMS_XMLSave.newContext('hr.employees');

Set options based on the type of DML that you want to perform.

For inserts you can set the list of columns to insert into the setUpdateColumn function. The default is to insert values into all columns. The following example sets five columns in the employees table:

DBMS_XMLSave.setUpdateColumn(savCtx,'EMPLOYEE_ID');
DBMS_XMLSave.setUpdateColumn(savCtx,'LAST_NAME');
DBMS_XMLSave.setUpdateColumn(savCtx,'EMAIL');
DBMS_XMLSave.setUpdatecolumn(savCtx,'JOB_ID');
DBMS_XMLSave.setUpdateColumn(savCtx,'HIRE_DATE');

For updates you must supply the list of key columns. Optionally, you can then supply the list of columns for update. In this case, the tags in the XML document matching the key column names will be used in the WHERE clause of the UPDATE statement and the tags matching the update column list will be used in the SET clause of the UPDATE statement. For example:

DBMS_XMLSave.setKeyColumn(savCtx,'employee_id'); -- set key column
-- set list of columns to update.
DBMS_XMLSave.setUpdateColumn(savCtx,'salary');
DBMS_XMLSave.setUpdateColumn(savCtx,'job_id');

For deletes the default is to create a WHERE clause to match all the tag values present in each <ROW> element of the document supplied. To override this behavior, set the list of key columns. In this case only those tag values whose tag names match these columns are used to identify the rows to delete (in effect used in the WHERE clause of the DELETE statement). For example:

DBMS_XMLSave.setKeyColumn(savCtx,'EMPLOYEE_ID');

Supply a context and XML document to the insertXML, updateXML, or deleteXML functions. For example:

v_rows := DBMS_XMLSave.deleteXML(savCtx,xmlDoc);

Repeat the DML any number of times if needed.

Close the context. For example:

DBMS_XMLSave.closeContext(savCtx);

For a model use the Java examples described in "Programming with the XSU Java API".

Installing XSU

XSU is included in the Oracle Database software CD along with the other XDK utilities. "Java XDK Component Dependencies" describes the XSU components and dependencies.

By default, the Oracle Universal Installer installs XSU on disk and loads it into the database. No user intervention is required. If you did not load XSU in the database when installing Oracle, you can install XSU manually as follows:

Make sure that Oracle XML DB is installed.

Load the xsu12.jar file into the database. This JAR file, which has a dependency on xdb.jar for XMLType access, is described in Table 3-1.

Run the $ORACLE_HOME/rdbms/admin/dbmsxsu.sql script. This SQL script builds the XSU PL/SQL API.

As explained in "Using XSU: Basic Process", you do not have to load XSU into the database in order to use it. XSU can reside in any tier that supports Java.

The following sections describe your installation options:

Installing XSU in the Database

Installing XSU in an Application Server

Installing XSU in a Web Server

Installing XSU in the Database

Figure 11-3 shows the typical architecture for applications that use the XSU libraries installed in the database. XML generated from XSU running in the database can be placed in advanced queues in the database to be queued to other systems or clients. You deliver the XML internally through stored procedures in the database or externally through web or application servers.

In Figure 11-3 all lines are bidirectional. Because XSU can generate as well as save data, resources can deliver XML to XSU running inside the database, which can then insert it in the appropriate database tables.

Figure 11-3 Running XSU in the Database

Description of Figure 11-3 follows
Description of "Figure 11-3 Running XSU in the Database"

Installing XSU in an Application Server

Your application architecture may need to use an application server in the middle tier. The application tier can be an Oracle database, Oracle application server, or a third-party application server that supports Java programs.

You can generate XML in the middle tier from SQL queries or ResultSets for various reasons, for example, to integrate different JDBC data sources in the middle tier. In this case, you can install the XSU in your middle tier, thereby enabling your Java programs to make use of XSU through its Java API.

Figure 11-4 shows a typical architecture for running XSU in a middle tier. In the middle tier, data from JDBC sources is converted by XSU into XML and then sent to Web servers or other systems. Again, the process is bidirectional, which means that the data can be put back into the JDBC sources (database tables or views) by means of XSU. If an Oracle database itself is used as the application server, then you can use the PL/SQL front-end instead of Java.

Figure 11-4 Running XSU in the MIddle Tier

Description of Figure 11-4 follows
Description of "Figure 11-4 Running XSU in the MIddle Tier"

Installing XSU in a Web Server

Figure 11-5 shows that XSU can live in the Web server as long as the Web server supports Java servlets. In this way you can write Java servlets that use XSU. XSQL Servlet is a standard servlet provided by Oracle. It is built on top of XSU and provides a template-like interface to XSU functionality. To perform XML processing in the Web server and avoid intricate servlet programming, you can use the XSQL Servlet.

Figure 11-5 Running XSU in a Web Server

Description of Figure 11-5 follows
Description of "Figure 11-5 Running XSU in a Web Server"

See Also:

Oracle XML DB Developer's Guide, especially the chapter on generating XML, for examples on using XSU with XMLType

Oracle Database XML Java API Reference to learn about the classes OracleXMLQuery and OracleXMLSave

Oracle Database PL/SQL Packages and Types Reference to learn about the packages DBMS_XMLQuery and DBMS_XMLSave

Chapter 14, "Using the XSQL Pages Publishing Framework" to learn about XSQL Servlet

Running the XSU Demo Programs

Demo programs for XSU are included in $ORACLE_HOME/xdk/demo/java/xsu. Table 11-1 describes the XML files and programs that you can use to test XSU.

Table 11-1 XSU Sample Files

File
Description

bindSQLVariables.sql

An PL/SQL script that binds values for EMPLOYEE_ID and FIRST_NAME to columns in the employees table. Refer to "Binding Values in XSU".

changeElementName.sql

A PL/SQL program that obtains the first 20 rows of the employees table as an XML document. Refer to "Specifying Element Names with DBMS_XMLQuery".

createObjRelSchema.sql

A SQL script that sets up an object-relational schema and populates it. Refer to "XML Mapping Against an Object-Relational Schema".

createObjRelSchema2.sql

A SQL script that sets up an object-relational schema and populates it. Refer to "Altering the Database Schema or SQL Query".

createRelSchema.sql

A SQL script that creates a relational table and then creates a customer view that contains a customer object on top of it. Refer to "Altering the Database Schema or SQL Query".

customer.xml

An XML document that describes a customer. Refer to "Altering the Database Schema or SQL Query".

deleteEmployeeByKey.sql

A PL/SQL program that deletes an employee by primary key. Refer to "Deleting by Key with DBMS_XMLSave: Example".

deleteEmployeeByRow.sql

A PL/SQL program that deletes an employee by row. Refer to "Deleting by Row with DBMS_XMLSave: Example".

domTest.java

A program that generates a DOM tree and then traverses it in document order, printing the nodes one by one. Refer to "Generating a DOM Tree with OracleXMLQuery".

index.txt

A README that describes the programs in the demo directory.

insProc.sql

A PL/SQL program that inserts an XML document into a table. Refer to "Inserting Values into All Columns with DBMS_XMLSave".

insertClob.sql

A SQL script that creates a table called xmldocument and stores an XML document in the table as a CLOB. Refer to "Inserting Values into All Columns with DBMS_XMLSave".

insertClob2.sql

A SQL script that inserts an XML document into the xmldocument table. Refer to "Inserting into a Subset of Columns with DBMS_XMLSave".

insertClob3.sql

A SQL script that inserts an XML document into the xmldocument table. Refer to "Updating with Key Columns with DBMS_XMLSave".

insertClob4.sql

A SQL script that inserts an XML document into the xmldocument table. Refer to "Specifying a List of Columns with DBMS_XMLSave: Example".

insertEmployee.sql

A PL/SQL script that calls the insProc stored procedure and inserts an employee into the employees table. Refer to "Inserting XML with DBMS_XMLSave".

insertEmployee2.sql

A PL/SQL script that invokes the testInsert procedure to insert the XML data for an employee into the hr.employees table. Refer to "Inserting into a Subset of Columns with DBMS_XMLSave".

mapColumnToAtt.sql

A SQL script that queries the employees table, rendering employee_id as an XML attribute. Refer to "Altering the Database Schema or SQL Query".

new_emp.xml

An XML document that describes a new employee. Refer to "Running the testInsert Program".

new_emp2.xml

An XML document that describes a new employee. Refer to "Running the testInsertSubset Program".

noRowsTest.java

A program that throws an exception when there are no more rows. Refer to "Raising a No Rows Exception".

pageTest.java

A program that uses the JDBC ResultSet to generate XML one page at a time. Refer to "Generating Scrollable Result Sets".

paginateResults.java

A program that generates an XML page that paginates results. Refer to "Paginating Results with OracleXMLQuery: Example".

paginateResults.sql

A PL/SQL script that paginates results. It skips the first 3 rows of the employees table and then prints the rest of the rows 10 at a time by setting skipRows to 3 for the first batch of 10 rows and then to 0 for the rest of the batches. Refer to "Paginating Results with DBMS_XMLQuery".

printClobOut.sql

A PL/SQL script that prints a CLOB to the output buffer. Refer to "Generating XML from Simple Queries with DBMS_XMLQuery".

raiseException.sql

A PL/SQL script that invokes the DBMS_XMLQuery.getExceptionContent procedure. Refer to "Handling Exceptions in the XSU PL/SQL API".

refCurTest.java

A program that generates XML from the results of the SQL query defined in the testRefCur function. Refer to "Generating XML from Cursor Objects".

samp1.java

A program that queries the scott.emp table, then generates an XML document from the query results.

samp10.java

A program that inserts sampdoc.xml into the xmltest_tab1 table.

samp2.java

A program that queries the scott.emp table, then generates an XML document from the query results. This program demonstrates how you can customize the generated XML document.

sampdoc.xml

A sample XML data document that samp10.java inserts into the database.

samps.sql

A SQL script that creates the xmltest_tab1 table used by samp10.java.

simpleQuery.sql

A PL/SQL script that selects 20 rows from the hr.employees table and obtains an XML document as a CLOB. Refer to "Generating XML from Simple Queries with DBMS_XMLQuery".

testDML.sql

A PL/SQL script that uses the same context and settings to perform DML depending on user input. Refer to "Reusing the Context Handle with DBMS_XMLSave".

testDeleteKey.java

A program that limits the number of elements used to identify a row, which improves performance by caching the DELETE statement and batching transactions. Refer to "Deleting by Key with OracleXMLSave".

testDeleteKey.sql

A PL/SQL script that deletes a row from the employees table for every <ROW> element in an input XML document. Refer to "Deleting by Key with DBMS_XMLSave: Example".

testDeleteRow.java

A program that accepts an XML document filename as input and deletes the rows corresponding to the elements in the document. Refer to "Deleting by Row with OracleXMLSave".

testDeleteRow.sql

A SQL script that deletes a row from the employees table for every <ROW> element in an input XML document. Refer to "Deleting by Row with DBMS_XMLSave: Example".

testException.java

A sample program shown that throws a runtime exception and then obtains the parent exception by invoking Exception.getParentException(). Refer to "Obtaining the Parent Exception".

testInsert.java

A Java program that inserts XML values into all columns of the hr.employees table. Refer to "Inserting XML into All Columns with OracleXMLSave".

testInsert.sql

A PL/SQL script that inserts XML data into a subset of columns. Refer to "Inserting into a Subset of Columns with DBMS_XMLSave".

testInsertSubset.java

A program shown that inserts XML data into a subset of columns. Refer to "Inserting XML into a Subset of Columns with OracleXMLSave".

testRef.sql

A PL/SQL script that creates a function that defines a REF cursor and returns it. Every time the testRefCur function is called, it opens a cursor object for the SELECT query and returns that cursor instance. Refer to "Generating XML from Cursor Objects".

testUpdate.java

A sample program that updates the hr.employees table by invoking the OracleXMLSave.setKeyColumnList() method. Refer to "Updating Rows with OracleXMLSave".

testUpdateKey.sql

A PL/SQL that creates a PL/SQL procedure called testUpdateKey that uses the employee_id column of the employees table as a primary key. Refer to "Updating with Key Columns with DBMS_XMLSave".

testUpdateList.java

Suppose only want to update the salary and job title for each employee and ignore the other information. If you know that all the elements to be updated are the same for all ROW elements in the XML document, then you can use the OracleXMLSave.setUpdateColumnNames() method to specify the columns. Refer to "Updating a Column List with OracleXMLSave".

testUpdateSubset.sql

A SQL script that creates the procedure testUpdateSubset. The procedure specifies the employee_id column as the key and specifies that salary and job_id should be updated. Refer to "Specifying a List of Columns with DBMS_XMLSave: Example".

testXMLSQL.java

A sample program that uses XSU to generate XML as a String object. This program queries the hr.employees table and prints the result set to standard output. Refer to "Generating a String with OracleXMLQuery".

upd_emp.xml

An XML document that contains updated salary and other information for a series of employees. Refer to "Running the testUpdate Program".

upd_emp2.xml

An XML document that contains updated salary and other information for a series of employees. Refer to "Running the testUpdate Program".

updateEmployee.sql

An XML document that contains new data for two employees. Refer to "Running the testUpdateList Program".

updateEmployee2.sql

A PL/SQL script that passes an XML document to the testUpdateSubset procedure and generates two UPDATE statements. Refer to "Specifying a List of Columns with DBMS_XMLSave: Example".

The steps for running the demos are:

Change into the $ORACLE_HOME/xdk/demo/java/xsu directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\xsu directory (Windows).

Make sure that your environment variables are set as described in "Setting Up the Java XDK Environment". In particular, make sure that the Java classpath includes xsu12.jar for XSU and ojdbc5.jar (Java 1.5) for JDBC. If you use a multibyte character set other than UTF-8, ISO8859-1, or JA16SJIS, then place orai18n.jar in your classpath so that JDBC can convert the character set of the input file to the database character set.

Compile the Java programs as shown in the following example:

javac samp1.java samp2.java samp10.java

Connect to an Oracle database as hr and run the SQL script createRelSchema:

CONNECT hr
@$ORACLE_HOME/xdk/demo/java/xsu/createRelSchema

The following sections describe the XSU demos in detail.

Using the XSU Command-Line Utility

The XDK includes a command-line Java interface for XSU. XSU command-line options are provided through the Java class OracleXML. To use this API ensure that your Java classpath is set as described in "Setting Up the Java XDK Environment".

To print usage information for XSU to standard output, run the following command:

java OracleXML

To use XSU, invoke it with either the getXML or putXML parameter as follows:

java OracleXML getXML options
java OracleXML putXML options

Table 11-2 describes the getXML options.

Table 11-2 getXML Options

getXML Option
Description

-user "username/password"

Specifies the username and password to connect to the database. If this is not specified, then the user defaults to scott/tiger. Note that the connect string is also specified. You can specify the username and password as part of the connect string.

-conn "JDBC_connect_string"

Specifies the JDBC database connect string. By default the connect string is: "jdbc:oracle:oci:@".

-withDTD

Instructs the XSU to generate the DTD along with the XML document.

-withSchema

Instructs the XSU to generate the schema along with the XML document.

-rowsetTag tag_name

Specifies the rowset tag, which is tag that encloses all the XML elements corresponding to the records returned by the query. The default rowset tag is <ROWSET>. If you specify an empty string ("") for rowset, then XSU omits the rowset element.

-rowTag tag_name

Specifies the row tag that encloses the data corresponding to a database row. The default row tag is <ROW>. If you specify an empty string ("") for the row tag, then XSU omits the row tag.

-rowIdAttr row_id_attribute_name

Names the attribute of the ROW element that keeps track of the cardinality of the rows. By default this attribute is num. If you specify an empty string as the rowID attribute, then XSU omits the attribute.

-rowIdColumn row_Id_column_name

Specifies that the value of one of the scalar columns from the query is to be used as the value of the rowID attribute.

-collectionIdAttr collect_id_attr_name

Names the attribute of an XML list element that keeps track of the cardinality of the elements of the list. The generated XML lists correspond to either a cursor query, or collection. If you specify an empty string ("") as the rowID attribute, then XSU omits the attribute.

-useTypeForCollElemTag

Specifies the use type name for the column-element tag. By default XSU uses the column-name_item.

-useNullAttrId

Specifies the attribute NULL (TRUE/FALSE) to indicate the nullness of an element.

-styleSheet stylesheet_URI

Specifies the stylesheet in the XML processing instruction.

-stylesheetType stylesheet_type

Specifies the stylesheet type in the XML processing instruction.

-setXSLT URI

Specifies the XSLT stylesheet to apply to the XML document.

-setXSLTRef URI

Sets the XSLT external entity reference.

-useLowerCase | -useUpperCase

Generates lowercase or uppercase tag names. The default is to match the case of the SQL object names from which the tags are generated.

-withEscaping

Specifies the treatment of characters that are legal in SQL object names but illegal in XML tags. If such a character is encountered, then it is escaped so that it does not throw an exception.

-errorTag error tag_name

Specifies the tag to enclose error messages that are formatted as XML.

-raiseException

Specifies that XSU should throw a Java exception. By default XSU catches any error and produces the XML error.

-raiseNoRowsException

Raises an exception if no rows are returned.

-useStrictLegalXMLCharCheck

Performs strict checking on input data.

-maxRows maximum_rows

Specifies the maximum number of rows to be retrieved and converted to XML.

-skipRows number_of_rows_to_skip

Specifies the number of rows to be skipped.

-encoding encoding_name

Specifies the character set encoding of the generated XML.

-dateFormat date_format

Specifies the date format for the date values in the XML document.

-fileName SQL_query_fileName | SQL_query

Specifies the file name that contains the query or the query itself.

Table 11-3 describes the putXML options.

Table 11-3 putXML Options

putXML Options
Description

-user "username/password"

Specifies the username and password to connect to the database. If not specified, the user defaults to scott/tiger. The connect string is also specified; you can specify the username and password as part of the connect string.

-conn "JDBC_connect_string"

Specifies the JDBC database connect string. By default the connect string is: "jdbc:oracle:oci:@".

-batchSize batching_size

Specifies the batch size that controls the number of rows that are batched together and inserted in a single trip to the database to improve performance.

-commitBatch commit_size

Specifies the number of inserted records after which a commit is to be executed. If the autocommit is TRUE (the default), then setting commitBatch has no consequence.

-rowTag tag_name

Specifies the row tag, which is tag used to enclose the data corresponding to a database row. The default row tag is <ROW>. If you specify an empty string for the row tag, then XSU omits the row tag.

-dateFormat date_format

Specifies the date format for the date values in the XML document.

-withEscaping

Turns on reverse mapping if SQL to XML name escaping was used when generating the doc.

-ignoreCase

Makes the matching of the column names with tag names case insensitive. For example, EmpNo matches with EMPNO if ignoreCase is on.

-preserveWhitespace

Preserves the whitespace in the inserted XML document.

-setXSLT URI

Specifies the XSLT to apply to the XML document before inserting.

-setXSLTRef URI

Sets the XSLT external entity reference.

-fileName file_name | -URL URL | -xmlDoc xml_document

Specifies the XML document to insert: a local file, a URL, or an XML document as a string on the command line.

table_name

Specifies the name of the table to put the values into.

Generating XML with the XSU Command-Line Utility

To generate XML from the database schema use the getXML parameter. For example, to generate an XML document by querying the employees table in the hr schema, you can use the following syntax:

java OracleXML getXML -user "hr/password" "SELECT * FROM employees"

The preceding command performs the following tasks:

Connects to the current default database

Executes the specified SELECT query

Converts the SQL result set to XML

Prints the XML to standard output

The getXML parameter supports a wide range of options, which are explained in Table 11-2.

Generating XMLType Data with the XSU Command-Line Utility

You can use XSU to generate XML from tables with XMLType columns. Suppose that you run the demo script setup_xmltype.sql to create and populate the parts table. You can generate XML from this table with XSU as follows:

java OracleXML getXML -user "hr/password" -rowTag "Part" "SELECT * FROM parts"

The output of the command is shown below:

<?xml version = '1.0'?>
<ROWSET>
   <Part num="1">
      <PARTNO>1735</PARTNO>
      <PARTNAME>Gizmo</PARTNAME>
      <PARTDESC>
         <Description>
           <Title>Description of the Gizmo</Title>
           <Author>John Smith</Author>
           <Body>
             The <b>Gizmo</b> is <i>grand</i>.
           </Body>
         </Description>
      </PARTDESC>
   </Part>
</ROWSET>

Performing DML with the XSU Command-Line Utility

To insert an XML document called new_employees.xml into the hr.employees table, use the following syntax:

java OracleXML putXML -user "hr/password" -fileName "new_employees.xml" employees

The preceding command performs the following tasks:

Connects to the current database as hr

Reads the XML document named new_emp.xml

Parses the XML document, matching the tags with column names

Inserts the values appropriately into the employees table

The getXML parameter supports a wide range of options, which are explained in Table 11-2.

Programming with the XSU Java API

This section contains the following topics:

Generating a String with OracleXMLQuery

Generating a DOM Tree with OracleXMLQuery

Paginating Results with OracleXMLQuery

Generating Scrollable Result Sets

Generating XML from Cursor Objects

Inserting Rows with OracleXMLSave

Updating Rows with OracleXMLSave

Deleting Rows with OracleXMLSave

Handling XSU Java Exceptions

Generating a String with OracleXMLQuery

The testXMLSQL.java demo program uses XSU to generate XML as a String object. This program queries the hr.employees table and prints the result set to standard output.

The testXMLSQL.java program follows these steps:

Register the JDBC driver and create a database connection. The following code fragment uses the OCI JDBC driver and connects with the username hr:

import oracle.jdbc.*;...Connection conn  = getConnection("hr","password");
...
private static Connection getConnection(String username, String password)
    throws SQLException
{
// register the JDBC driver
  DriverManager.registerDriver(new oracle.jdbc.OracleDriver());
// create the connection using the OCI driver
  Connection conn =
    DriverManager.getConnection("jdbc:oracle:oci:@",username,password);
  return conn;
}

Create an XML query object and initialize it with a SQL query. The following code fragment initializes the object with a SELECT statement on hr.employees:

OracleXMLQuery qry = new OracleXMLQuery(conn, "SELECT * FROM employees");

Obtain the query result set as a String object. The getXMLString() method transforms the object-relational data specified in the constructor into an XML document. The following example illustrates this technique:

String str = qry.getXMLString();

Close the query object to release any resources, as shown in the following code:

qry.close();

Running the testXMLSQL Program

To run the testXMLSQL.java program perform the following steps:

Compile testXMLSQL.java with javac.

Execute java testXMLSQL on the command line.

You must have the CLASSPATH pointing to this directory for the Java executable to find the class. Alternatively, use visual Java tools such as Oracle JDeveloper to compile and run this program. When run, this program prints out the XML file to the screen. The following shows sample output with some rows edited out:

<?xml version = '1.0'?>
<ROWSET>
   <ROW num="1">
      <EMPLOYEE_ID>100</EMPLOYEE_ID>
      <FIRST_NAME>Steven</FIRST_NAME>
      <LAST_NAME>King</LAST_NAME>
      <EMAIL>SKING</EMAIL>
      <PHONE_NUMBER>515.123.4567</PHONE_NUMBER>
      <HIRE_DATE>6/17/1987 0:0:0</HIRE_DATE>
      <JOB_ID>AD_PRES</JOB_ID>
      <SALARY>24000</SALARY>
      <DEPARTMENT_ID>90</DEPARTMENT_ID>
   </ROW>
<!-- ROW num="2" through num="107" ... -->
</ROWSET>

Generating a DOM Tree with OracleXMLQuery

To generate a DOM tree from the XML generated by XSU, you can directly request a DOM document from XSU. This technique saves the overhead of creating a string representation of the XML document and then parsing it to generate the DOM tree.

XSU calls the Oracle XML parser to construct the DOM tree from the data values. The domTest.java demo program generates a DOM tree and then traverses it in document order, printing the nodes one by one.

The first two steps in the domTest.java program are the same as for the testXMLSQL.java program described in "Generating a String with OracleXMLQuery". The program proceeds as follows:

Obtain the DOM by invoking getXMLDOM() method. The following example illustrates this technique:

XMLDocument domDoc = (XMLDocument)qry.getXMLDOM();

Print the DOM tree. The following code prints to standard output:

domDoc.print(System.out);

You can also create a StringWriter and wrap it in a PrintWriter as follows:

StringWriter s = new StringWriter(10000);
domDoc.print(new PrintWriter(s));
System.out.println(" The string version ---> \n"+s.toString());

After compiling the program, run it from the command line as follows:

java domTest

Paginating Results with OracleXMLQuery

This section contains the following topics:

Limiting the Number of Rows in the Result Set

Keeping the Object Open for the Duration of the User's Session

Paginating Results with OracleXMLQuery: Example

Limiting the Number of Rows in the Result Set

In testXMLSQL.java and domTest.java, XSU generated XML from all rows returned by the query. Suppose that you query a table that contains 1000 rows, but you want only 100 rows at a time. One approach is to execute one query to obtain the first 100 rows, another to obtain the next 100 rows, and so on. With this technique you cannot skip the first five rows of the query and then generate the result. To avoid these problems, use the following Java methods:

OracleXMLSave.setSkipRows() forces XSU to skip the desired number of rows before starting to generate the result. The command-line equivalent to this method is the -skipRows parameter.

OracleXMLSave.setMaxRows() limits the number of rows converted to XML. The command-line equivalent to this method is the -maxRows parameter.

Example 11-1 sets skipRows to a value of 5 and maxRows to a value of 1, which causes XSU to skip the first 5 rows and then generate XML for the next row when querying the hr.employees table.

Example 11-1 Specifying skipRows and maxRows on the Command Line

java OracleXML getXML -user "hr/password" -skipRows 5 -maxRows 1 \
  "SELECT * FROM employees"

The following shows sample output (only row 6 of the query result set is returned):

<?xml version = '1.0'?>
<ROWSET>
   <ROW num="6">
      <EMPLOYEE_ID>105</EMPLOYEE_ID>
      <FIRST_NAME>David</FIRST_NAME>
      <LAST_NAME>Austin</LAST_NAME>
      <EMAIL>DAUSTIN</EMAIL>
      <PHONE_NUMBER>590.423.4569</PHONE_NUMBER>
      <HIRE_DATE>6/25/1997 0:0:0</HIRE_DATE>
      <JOB_ID>IT_PROG</JOB_ID>
      <SALARY>4800</SALARY>
      <MANAGER_ID>103</MANAGER_ID>
      <DEPARTMENT_ID>60</DEPARTMENT_ID>
   </ROW>
</ROWSET>

Keeping the Object Open for the Duration of the User's Session

In some situations you may want to keep the query object open for the duration of the user session. You can handle such cases with the maxRows() method and the keepObjectOpen() method.

Consider a Web search engine that paginates search results. The first page lists 10 results, the next page lists 10 more, and so on. To perform this task with XSU, request 10 rows at a time and keep the ResultSet open so that the next time you ask XSU for more results, it starts generating from where the last generation finished. If OracleXMLQuery creates a result set from the SQL query string, then it typically closes the ResultSet internally because it assumes no more results are required. Thus, you should invoke keepObjectOpen() to keep the cursor active.

A different case requiring an open query object is when the number of rows or number of columns in a row is very large. In this case, you can generate multiple small documents rather than one large document.

See Also:

"Paginating Results with OracleXMLQuery: Example"

Paginating Results with OracleXMLQuery: Example

The paginateResults.java program shows how you can generate an XML page that paginates results. The output XML displays only 20 rows of the hr table.

The first step of the paginateResults.java program, which creates the connection, is the same as in testXMLSQL.java. The program continues as follows:

Create a SQL statement object and initialize it with a SQL query. The following code fragment sets two options in java.sql.ResultSet:

Statement stmt = conn.createStatement(ResultSet.TYPE_SCROLL_SENSITIVE,
                                      ResultSet.CONCUR_READ_ONLY);

Create the query as a string and execute it by invoking Statement.executeQuery(). The return object is of type ResultSet. The following example illustrates this technique:

String sCmd = "SELECT first_name, last_name FROM hr.employees";
ResultSet rs = stmt.executeQuery(sCmd);

Create the query object, as shown in the following code:

OracleXMLQuery xmlQry = new OracleXMLQuery(conn, rs);

Configure the query object. The following code specifies that the query object should be open for the duration of the session. It also limits the number of rows returned to 20:

xmlQry.keepObjectOpen(true);
xmlQry.setRowsetTag("ROWSET");
xmlQry.setRowTag("ROW");
xmlQry.setMaxRows(20);

Retrieve the result as a String and print:

String sXML = xmlQry.getXMLString();
System.out.println(sXML);

After compiling the program, run it from the command line as follows:

java paginateResults

Generating Scrollable Result Sets

In some situations you may want to perform a query and then retrieve a previous page of results from within the result set. To enable scrolling, instantiate the Oracle.jdbc.ResultSet class. You can use the ResultSet object to move back and forth within the result set and use XSU to generate XML each time.

The pageTest.java program shows how to use the JDBC ResultSet to generate XML a page at a time. Using ResultSet may be necessary in cases that are not handled directly by XSU, for example, when setting the batch size and binding values.

The pageTest.java program creates a pageTest object and initializes it with a SQL query. The constructor for the pageTest object performs the following steps:

Create a JDBC connection by calling the same getConnection() method defined in paginateResults.java:

Connection conn;
...
conn  = getConnection("hr","password");

Create a statement as follows:

Statement stmt;
...
stmt = conn.createStatement();

Execute the query passed to the constructor to obtain the scrollable result set. The following code illustrates this technique:

ResultSet rset = stmt.executeQuery(sqlQuery);

Create a query object by passing references to the connection and result set objects to the constructor. The following code fragment illustrates this technique:

OracleXMLQuery qry;
...
qry = new OracleXMLQuery(conn,rset);

Configure the query object. The following code fragment specifies that the query object should be kept open and that it should raise an exception when there are no more rows:

qry.keepObjectOpen(true);
qry.setRaiseNoRowsException(true);
qry.setRaiseException(true);

After creating the query object by passing it the string "SELECT * FROM employees", the program loops through the result set. The getResult() method receives integer values specifying the start row and end row of the set. It sets the maximum number of rows to retrieve by calculating the difference of these values and then retrieves the result as a string. The following while loop retrieves and prints ten rows at a time:

int i = 0;
while ((str = test.getResult(i,i+10))!= null)
{
  System.out.println(str);
  i+= 10;
}

After compiling the program, run it from the command line as follows:

java pageTest

Generating XML from Cursor Objects

The OracleXMLQuery class provides XML conversion only for query strings or ResultSet objects. If your program uses PL/SQL procedures that return REF cursors, then how do you perform the conversion? You can use the ResultSet conversion mechanism described in "Generating Scrollable Result Sets".

REF cursors are references to cursor objects in PL/SQL. These cursor objects are SQL statements over which a program can iterate to obtain a set of values. The cursor objects are converted into OracleResultSet objects in the Java world. In your Java program you can initialize a CallableStatement object, execute a PL/SQL function that returns a cursor variable, obtain the OracleResultSet object, and then send it to the OracleXMLQuery object to obtain the desired XML.

Consider the testRef PL/SQL package defined in the testRef.sql script. It creates a function that defines a REF cursor and returns it. Every time the testRefCur PL/SQL function is called, it opens a cursor object for the SELECT query and returns that cursor instance. To convert the object to XML, do the following:

Run the testRef.sql script to create the testRef package in the hr schema.

Compile and run the refCurTest.java program to generate XML from the results of the SQL query defined in the testRefCur function.

To apply the stylesheet, you can use the applyStylesheet command, which forces the stylesheet to be applied before generating the output.

Inserting Rows with OracleXMLSave

To insert a document into a table or view, supply the table or view name and then the document. XSU parses the document (if a string is given) and then creates an INSERT statement into which it binds all the values. By default XSU inserts values into all columns of the table or view. An absent element is treated as a NULL value. The following example shows how you can store the XML document generated from the hr.employees table in the table.

Inserting XML into All Columns with OracleXMLSave

The testInsert.java demo program inserts XML values into all columns of the hr.employees table.

The program follows these steps:

Create a JDBC OCI connection. The program calls the same getConnection() method used by the previous examples in this chapter:

Connection conn = getConnection("hr","password");

Create an XML save object. You initialize the object by passing it the Connection reference and the name of the table on which you want to perform DML. The following example illustrates this technique:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Insert the data in an input XML document into the hr.employees table. The following code fragment creates a URL from the document filename specified on the command line:

sav.insertXML(sav.getURL(argv[0]));

Close the XML save object as follows:

sav.close();

Running the testInsert Program

Assume that you write the new_emp.xml document to describe new employee Janet Smith, who has employee ID 7369. You pass the filename new_emp.xml as an argument to the testInsert program as follows:

java testInsert "new_emp.xml"

The program inserts a new row in the employees table that contains the values for the columns specified. Any absent element inside the row element is treated as NULL.

Running the program generates an INSERT statement of the following form:

INSERT INTO hr.employees
  (employee_id, first_name, last_name, email, phone_number, hire_date,
   salary, commission_pct, manager_id, department_id)
VALUES
  (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);

XSU matches the element tags in the input XML document that match the column names and binds their values.

Inserting XML into a Subset of Columns with OracleXMLSave

In some circumstances you may not want to insert values into all columns. For example, the group of values that you obtain may not be the complete set, requiring you to use triggers or default values for the remaining columns. The testInsertSubset.java demo program shows how to handle this case.

The program follows these steps:

Create a JDBC OCI connection. The program calls the same getConnection() method used by the previous examples in this chapter:

Connection conn = getConnection("hr","password");

Create an XML save object. Initialize the object by passing it the Connection reference and the name of the table on which you want to perform DML. The following example illustrates this technique:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Create an array of strings. Each element of the array should contain the name of a column in which values will be inserted. The following code fragment specifies the names of five columns:

String [] colNames = new String[5];
colNames[0] = "EMPLOYEE_ID";
colNames[1] = "LAST_NAME";
colNames[2] = "EMAIL";
colNames[3] = "JOB_ID";
colNames[4] = "HIRE_DATE";

Configure the XML save object to update the specified columns. The following statement passes a reference to the array to the OracleXMLSave.setUpdateColumnList() method:

sav.setUpdateColumnList(colNames);

Insert the data in an input XML document into the hr.employees table. The following code fragment creates a URL from the document filename specified on the command line:

sav.insertXML(sav.getURL(argv[0]));

Close the XML save object as follows:

sav.close();

Running the testInsertSubset Program

Assume that you use the new_emp2.xml document to store data for new employee Adams, who has employee ID 7400. You pass new_emp2.xml as an argument to the testInsert program as follows:

java testInsert new_emp2.xml

The program ignores values for the columns that were not specified in the input file. It performs an INSERT for each ROW element in the input and batches the INSERT statements by default.

The program generates the following INSERT statement:

INSERT INTO hr.employees (employee_id, last_name, email, job_id, hire_date)
  VALUES (?, ?, ?, ?, ?);

Updating Rows with OracleXMLSave

To update the fields in a table or view, supply the table or view name and then the XML document. XSU parses the document (if a string is given) and then creates one or more UPDATE statements into which it binds all the values. The following examples show how you can use an XML document to update the hr.employees table.

Updating with Key Columns with OracleXMLSave

The testUpdate.java demo program updates the hr.employees table by invoking the OracleXMLSave.setKeyColumnList() method.

The testUpdate.java program follows these steps:

Create a JDBC OCI connection. The program calls the same getConnection() method used by the previous examples in this chapter:

Connection conn = getConnection("hr","password");

Create an XML save object. You initialize the object by passing it the Connection reference and the name of the table on which you want to perform DML. The following example illustrates this technique:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Create a single-element String array to hold the name of the primary key column in the table to be updated. The following code fragment specifies the name of the employee_id column:

String [] keyColNames = new String[1];
colNames[0] = "EMPLOYEE_ID";

Set the XML save object to the primary key specified in the array. The following statement passes a reference to the keyColNames array to the OracleXMLSave.setKeyColumnList() method:

sav.setKeyColumnList(keyColNames);

Update the rows specified in the input XML document. The following statement creates a URL from the filename specified on the command line:

sav.updateXML(sav.getURL(argv[0]));

Close the XML save object as follows:

sav.close();

Running the testUpdate Program

You can use XSU to update specified fields in a table. Example 11-2 shows upd_emp.xml, which contains updated salary and other information for the two employees that you just added, 7369 and 7400.

Example 11-2 upd_emp.xml

<?xml version='1.0'?>
<ROWSET>
 <ROW num="1">
    <EMPLOYEE_ID>7400</EMPLOYEE_ID>
    <SALARY>3250</SALARY>
 </ROW>
 <ROW num="2">
    <EMPLOYEE_ID>7369</EMPLOYEE_ID>
    <JOB_ID>SA_REP</JOB_ID>
    <MANAGER_ID>145</MANAGER_ID>
 </ROW>
<!-- additional rows ... -->
</ROWSET>

For updates, supply XSU with the list of key column names in the WHERE clause of the UPDATE statement. In the hr.employees table the employee_id column is the key.

Pass the filename upd_emp.xml as an argument to the preceding program as follows:

java testUpdate upd_emp.xml

The program generates two UPDATE statements. For the first ROW element, the program generates an UPDATE statement to update the SALARY field as follows:

UPDATE hr.employees SET salary = 3250 WHERE employee_id = 7400;

For the second ROW element the program generates the following statement:

UPDATE hr.employees SET job_id = 'SA_REP' AND MANAGER_ID = 145
  WHERE employee_id = 7369;

Updating a Column List with OracleXMLSave

You may want to update a table by using only a subset of the elements in an XML document. You can achieve this goal by specifying a list of columns. This technique speeds processing because XSU uses the same UPDATE statement with bind variables for all the ROW elements. You can also ignore other tags in the XML document.

Note:

When you specify a list of columns to update, if an element corresponding to one of the update columns is absent, XSU treats it as NULL.

Suppose you want to update the salary and job title for each employee and ignore the other data. If you know that all the elements to be updated are the same for all ROW elements in the XML document, then you can use the OracleXMLSave.setUpdateColumnNames() method to specify the columns. The testUpdateList.java program illustrates this technique.

The testUpdateList.java program follows these steps:

Create a JDBC OCI connection. The program calls the same getConnection() method used by the previous examples in this chapter:

Connection conn = getConnection("hr","password");

Create an XML save object. You initialize the object by passing it the Connection reference and the name of the table on which you want to perform DML. The following example illustrates this technique:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Create an array of type String to hold the name of the primary key column in the table to be updated. The array contains only one element, which is the name of the primary key column in the table to be updated. The following code fragment specifies the name of the employee_id column:

String [] colNames = new String[1];
colNames[0] = "EMPLOYEE_ID";

Set the XML save object to the primary key specified in the array. The following statement passes a reference to the colNames array to the OracleXMLSave.setKeyColumnList() method:

sav.setKeyColumnList(keyColNames);

Create an array of type String to hold the name of the columns to be updated. The following code fragment specifies the name of the employee_id column:

String[] updateColNames = new String[2];
updateColNames[0] = "SALARY";
updateColNames[1] = "JOB_ID";

Set the XML save object to the list of columns to be updated. The following statement performs this task:

sav.setUpdateColumnList(updateColNames);

Update the rows specified in the input XML document. The following code fragment creates a URL from the filename specified on the command line:

sav.updateXML(sav.getURL(argv[0]));

Close the XML save object as follows:

sav.close();

Running the testUpdateList Program

Suppose that you use the sample XML document upd_emp2.xml to store new data for employees Steven King, who has an employee ID of 100, and William Gietz, who has an employee ID of 206. You pass upd_emp2.xml as an argument to the testUpdateList program as follows:

java testUpdateList upd_emp2.xml

In this example, the program generates two UPDATE statements. For the first ROW element, the program generates the following statement:

UPDATE hr.employees SET salary = 8350 AND job_id = 'AC_ACCOUNT'
  WHERE employee_id = 100;

For the second ROW element the program generates the following statement:

UPDATE hr.employees SET salary = 25000 AND job_id = 'AD_PRES'
  WHERE employee_id = 206;

Deleting Rows with OracleXMLSave

When deleting from XML documents, you can specify a list of key columns. XSU uses these columns in the WHERE clause of the DELETE statement. If you do not supply the key column names, then XSU creates a new DELETE statement for each ROW element of the XML document. The list of columns in the WHERE clause of the DELETE statement matches those in the ROW element.

Deleting by Row with OracleXMLSave

The testDeleteRow.java demo program accepts an XML document filename as input and deletes the rows corresponding to the elements in the document.

The testDeleteRow.java program follows these steps:

Create a JDBC OCI connection. The program calls the same getConnection() method used by the previous examples in this chapter:

Connection conn = getConnection("hr","password");

Create an XML save object. You initialize the object by passing it the Connection reference and the name of the table on which you want to perform DML. The following example illustrates this technique:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Delete the rows specified in the input XML document. The following code fragment creates a URL from the filename specified on the command line:

sav.deleteXML(sav.getURL(argv[0]));

Close the XML save object as follows:

sav.close();

Running the testDelete Program

Suppose that you want to delete the employees 7400 and 7369 that you added in "Inserting Rows with OracleXMLSave".

To make this example work correctly, connect to the database and disable a constraint on the hr.job_history table:

CONNECT hr
ALTER TABLE job_history
  DISABLE CONSTRAINT JHIST_EMP_FK;
EXIT

Now pass upd_emp.xml to the testDeleteRow program as follows:

java testDeleteRow upd_emp.xml

The program forms the DELETE statements based on the tag names present in each ROW element in the XML document. It executes the following statements:

DELETE FROM hr.employees WHERE salary = 3250 AND employee_id = 7400;
DELETE FROM hr.employees WHERE job_id = 'SA_REP' AND MANAGER_ID = 145
  AND employee_id = 7369;

Deleting by Key with OracleXMLSave

To only use the key values as predicates on the DELETE statement, invoke the OracleXMLSave.setKeyColumnList() method. This approach limits the number of elements used to identify a row, which has the benefit of improving performance by caching the DELETE statement and batching transactions. The testDeleteKey.java program illustrates this technique.

The testDeleteKey.java program follows these steps:

Create a JDBC OCI connection. The program calls the same getConnection() method used by the previous examples in this chapter:

Connection conn = getConnection("hr","password");

Create an XML save object. You initialize the object by passing it the Connection reference and the name of the table on which you want to perform DML. The following example illustrates this technique:

OracleXMLSave sav = new OracleXMLSave(conn, "employees");

Create an array of type String to hold the name of the primary key column in the table. The array contains only one element. The following code fragment specifies the name of the employee_id column:

String [] colNames = new String[1];
colNames[0] = "EMPLOYEE_ID";

Set the XML save object to the primary key specified in the array. The following statement passes a reference to the colNames array to the OracleXMLSave.setKeyColumnList() method:

sav.setKeyColumnList(keyColNames);

Delete the rows specified in the input XML document. The following code fragment creates a URL from the filename specified on the command line:

sav.deleteXML(sav.getURL(argv[0]));

Close the XML save object as follows:

sav.close();

Running the testDeleteKey Program

Suppose that you want to delete employees 7400 and 7369 that you added in "Updating with Key Columns with OracleXMLSave". Note that if you already deleted these employees in the previous example, you can first add them back to the employees table as follows:

java testInsert new_emp.xml
java testInsert new_emp2.xml

Delete employees 7400 and 7369 by passing the same upd_emp.xml document to the testDeleteRow program as follows:

java testDeleteKey upd_emp.xml

The program forms the following single generated DELETE statement:

DELETE FROM hr.employees WHERE employee_id=?;

The program executes the following DELETE statements, one for each employee:

DELETE FROM hr.employees WHERE employee_id = 7400;
DELETE FROM hr.employees WHERE employee_id = 7369;

Handling XSU Java Exceptions

XSU catches all exceptions that occur during processing and throws oracle.xml.sql.OracleXMLSQLException, which is a generic runtime exception. The calling program does not have to catch this exception if it can still perform the appropriate action. The exception class provides methods to obtain error messages and also get any existing parent exception.

Obtaining the Parent Exception

The testException.java demo program throws a runtime exception and then obtains the parent exception by invoking Exception.getParentException().

Running the preceding program generates the following error message:

Caught SQL Exception:ORA-00904: "SD": invalid identifier

Raising a No Rows Exception

When there are no rows to process, XSU returns a null string. You can throw an exception every time there are no more rows, however, so that the program can process this exception through exception handlers. When a program invokes OracleXMLQuery.setRaiseNoRowsException(), XSU raises an oracle.xml.sql.OracleXMLSQLNoRowsException whenever there are no rows to generate for the output. This is a runtime exception and need not be caught.

The noRowsTest.java demo program instantiates the pageTest class defined in pageTest.java. The condition to check the termination changed from checking whether the result is null to an exception handler.

The noRowsTest.java program creates a pageTest object and initializes it with a SQL query. The program proceeds as follows:

Configure the query object or raise a no rows exception. The following code fragment illustrates this technique:

pageTest test = new pageTest("SELECT * from employees");
...
test.qry.setRaiseNoRowsException(true);

Loop through the result set infinitely, retrieving ten rows at a time. When no rows are available, the program throws an exception. The following code fragment calls pageTest.nextPage(), which scrolls through the result set ten rows at a time:

try
{
  while(true)
    System.out.println(test.nextPage());
}

Catch the no rows exception and print "END OF OUTPUT". The following code illustrates this technique:

catch(oracle.xml.sql.OracleXMLSQLNoRowsException e)
{
  System.out.println(" END OF OUTPUT ");
  try
  {
    test.close();
  }
  catch ( Exception ae )
  {
    ae.printStackTrace(System.out);
  }
}

After compiling the program, run it from the command line as follows:

java noRowsTest

Programming with the XSU PL/SQL API

This chapter contains the following topics:

Generating XML from Simple Queries with DBMS_XMLQuery

Specifying Element Names with DBMS_XMLQuery

Paginating Results with DBMS_XMLQuery

Setting Stylesheets in XSU

Binding Values in XSU

Inserting XML with DBMS_XMLSave

Updating with DBMS_XMLSave

Deleting with DBMS_XMLSave

Handling Exceptions in the XSU PL/SQL API

Reusing the Context Handle with DBMS_XMLSave

Note:

For increased performance, consider using DBMS_XMLGen and DBMS_XMLStore as alternatives to DBMS_XMLQuery and DBMS_XMLSave. The two former packages are written in C and are built in to the database kernel. You can also use SQL/XML functions such as XML_Element for XML access in the database.

Generating XML from Simple Queries with DBMS_XMLQuery

This section shows how you can use the DBMS_XMLQuery package to generate XML from a SQL query. To make the example work, connect to the database as hr and run the printClobOut.sql script. The script creates printClobOut, which is a simple procedure that prints a CLOB to the output buffer. If you run the printClobOut procedure in SQL*Plus, it prints the input CLOB to the screen. Set server output to ON to see the results. You may have to increase your display buffer to see all the output.

Run the simpleQuery.sql script to select 20 rows from the hr.employees table and obtain an XML document as a CLOB. The program first gets the context handle by passing in a query and then calls the getXML function to obtain the CLOB value. The document is in the same encoding as the database character set. This sample application assumes that you created the printClobOut procedure by running printClobOut.sql.

Specifying Element Names with DBMS_XMLQuery

With the XSU PL/SQL API you can change the default ROW and the ROWSET element names, which are the default names placed around each row of the result and around the whole output XML document. Use the PL/SQL procedures setRowTagName and setRowSetTagName to accomplish this task.

Connect as hr and run the changeElementName.sql script in SQL*Plus to obtain the first 20 rows of the employees table as an XML document. The anonymous PL/SQL block changes the ROW and ROWSET element names to EMP and EMPSET. Note that the block calls the printClobOut procedure that you created by running printClobOut.sql.

The generated XML document has an <EMPSET> document element. Each row is separated with the <EMP> tag.

Paginating Results with DBMS_XMLQuery

You can paginate query results by calling the following PL/SQL functions:

setMaxRows sets the maximum number of rows to be converted to XML. This maximum is relative to the current row position from which the previous result was generated.

setSkipRows specifies the number of rows to skip before converting the row values to XML.

Run the paginateResult.sql script to execute an anonymous block that paginates results. It skips the first 3 rows of the employees table and prints the rest of the rows 10 at a time by setting skipRows to 3 for the first batch of 10 rows and then to 0 for the rest of the batches. For multiple fetches, you must determine when there are no more rows to fetch, which you can do by calling setRaiseNoRowsException. This procedure raises an exception if no rows are written to the CLOB. This exception can be caught and used as the termination condition.

Setting Stylesheets in XSU

The XSU PL/SQL API provides the ability to set stylesheets on the generated XML documents as follows:

Set the stylesheet header in the result with the setStylesheetHeader procedure. This procedure adds the XML processing instruction that includes the stylesheet.

Apply a stylesheet to the resulting XML document before generation. This method increases performance dramatically because otherwise the XML document must be generated as a CLOB, sent to the parser again, and have the stylesheet applied. XSU generates a DOM document, calls the parser, applies the stylesheet and then generates the result. To apply the stylesheet to the resulting XML document, use the setXSLT procedure, which uses the stylesheet to generate the result.

Binding Values in XSU

The XSU PL/SQL API provides the ability to bind values to a SQL statement. The SQL statement can contain named bind variables, which must be prefixed with a colon (:). The bindSQLVariables.sql script runs an anonymous PL/SQL block that binds values for EMPLOYEE_ID and FIRST_NAME to columns in the employees table.

Inserting XML with DBMS_XMLSave

To insert a document into a table or view, supply the table or the view name and then the XML document. XSU parses the XML document (if a string is given) and then creates an INSERT statement into which it binds all the values. By default, XSU inserts values into all the columns of the table or view and treats absent elements as NULL.

Inserting Values into All Columns with DBMS_XMLSave

Run the insProc.sql demo script to create a PL/SQL stored procedure, insProc, which accepts the following parameters:

An XML document as a CLOB

The name of the table in which to insert the document

You can invoke the insProc procedure to insert an XML document into the table.

Run the insertClob.sql script to create a table called xmldocument and store an XML document in the table as a CLOB. The XML document describes employee 7370, Liz Gardner, whom you want to insert into the hr.employees table.

Example 11-3 insertClob.sql

CREATE TABLE hr.xmldocument
  (docid   NUMBER PRIMARY KEY,
  xml_text CLOB);
-- insert an XML document into the CLOB column
INSERT INTO hr.xmldocument (docid,xml_text)
VALUES (1,
       '<?xml version="1.0"?>
       <ROWSET>
        <ROW num="1">
           <EMPLOYEE_ID>7370</EMPLOYEE_ID>
           <FIRST_NAME>Liz</FIRST_NAME>
           <LAST_NAME>Gardner</LAST_NAME>
           <EMAIL>liz.gardner@business.com</EMAIL>
           <PHONE_NUMBER>650-555-6127</PHONE_NUMBER>
           <HIRE_DATE>12/18/2004 0:0:0</HIRE_DATE>
           <SALARY>3000</SALARY>
           <COMMISSION_PCT>0</COMMISSION_PCT>
           <JOB_ID>SH_CLERK</JOB_ID>
           <MANAGER_ID>103</MANAGER_ID>
           <DEPARTMENT_ID>20</DEPARTMENT_ID>
        </ROW>
       </ROWSET>');

Run the insertEmployee.sql script shown in Example 11-4 to call the insProc stored procedure and insert Liz Gardner into the employees table.

Example 11-4 insertEmployee.sql

DECLARE
  v_xml_text CLOB;
BEGIN
  SELECT xml_text
    INTO v_xml_text
  FROM hr.xmldocument
  WHERE docid = 1;
  insProc(v_xml_text, 'employees');
END;
/

As in "Inserting Rows with OracleXMLSave", running the callinsProc procedure generates an INSERT statement of the form shown in Example 11-5.

Example 11-5 Form of the INSERT Statement

INSERT INTO hr.employees
  (employee_id, first_name, last_name, email, phone_number, hire_date,
   salary, commission_pct, manager_id, department_id)
VALUES
  (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);

XSU matches the element tags in the input XML document that match the column names and binds their values.

Inserting into a Subset of Columns with DBMS_XMLSave

As explained in "Inserting XML into a Subset of Columns with OracleXMLSave", you may not want to insert values into all columns. You can create a list of column names for insert processing and pass it to the DBMS_XMLSave procedure. You can set these values by calling the setUpdateColumnName procedure repeatedly and passing in a column name to update every time. Clear the column name settings by invoking clearUpdateColumnList.

Run the testInsert.sql demo script to create a PL/SQL stored procedure called testInsert. You can use this procedure to insert XML data of type CLOB into the hr.employees table.

Run the insertClob2.sql script shown in Example 11-6 to insert an XML document describing new employee Jordan into a CLOB column of the xmldocument table. Note that the document does not contain an element corresponding to every column in the employees table.

Example 11-6 insertClob2.sql

-- insert an XML document into the CLOB column  of the xmldocument table with only
-- some of the possible elements
INSERT INTO hr.xmldocument (docid, xml_text)
VALUES (2,
       '<?xml version="1.0"?>
       <ROWSET>
        <ROW num="1">
           <EMPLOYEE_ID>7401</EMPLOYEE_ID>
           <LAST_NAME>Jordan</LAST_NAME>
           <EMAIL>jim.jordan@business.com</EMAIL>
           <JOB_ID>SH_CLERK</JOB_ID>
           <HIRE_DATE>12/17/2004 0:0:0</HIRE_DATE>
        </ROW>
       </ROWSET>');

Running the insertEmployee2.sql script shown in Example 11-7 inserts the data for employee Jim Jordan into a subset of the columns in the hr.employees table.

Example 11-7 insertEmployee2.sql

DECLARE
  v_xml_text CLOB;
BEGIN
  SELECT xml_text
    INTO v_xml_text
  FROM hr.xmldocument
  WHERE docid = 2;
  testInsert(v_xml_text);
END;
/

As in "Inserting XML into a Subset of Columns with OracleXMLSave", calling testInsert generates the following INSERT statement:

INSERT INTO hr.employees (employee_id, last_name, email, job_id, hire_date)
  VALUES (?, ?, ?, ?, ?);

Updating with DBMS_XMLSave

As described in "Updating Rows with OracleXMLSave", you can use an XML document to update specified fields in a table. You can either specify a column to use as a key or pass a list of columns for updating.

Updating with Key Columns with DBMS_XMLSave

Run the testUpdateKey.sql script to create a PL/SQL procedure called testUpdateKey. This procedure uses the employee_id column of the hr.employees table as a primary key.

Run the insertClob3.sql script shown in shown in Example 11-8 to insert an XML document into the CLOB column of the xmldocument table. The document specifies a new salary for employee 7400 and a new job ID and manager ID for employee 7369.

Example 11-8 insertClob3.sql

INSERT INTO hr.xmldocument (docid, xml_text)
VALUES (3,
       '<?xml version="1.0"?>
        <ROWSET>
         <ROW num="1">
            <EMPLOYEE_ID>7400</EMPLOYEE_ID>
            <SALARY>3250</SALARY>
         </ROW>
         <ROW num="2">
            <EMPLOYEE_ID>7369</EMPLOYEE_ID>
            <JOB_ID>SA_REP</JOB_ID>
            <MANAGER_ID>145</MANAGER_ID>
         </ROW>
        </ROWSET>');

Run the updateEmployee.sql script shown in Example 11-9 to pass the XML document to the testUpdateKey procedure and generate two UPDATE statements.

Example 11-9 updateEmployee.sql

DECLARE
  v_xml_text CLOB;
BEGIN
  SELECT xml_text
    INTO v_xml_text
  FROM hr.xmldocument
  WHERE docid = 3;
  testUpdateKey(v_xml_text);
END;
/

For the first ROW element, the program generates an UPDATE statement as follows:

UPDATE hr.employees SET salary = 3250 WHERE employee_id = 7400;

For the second ROW element the program generates the following statement:

UPDATE hr.employees SET job_id = 'SA_REP' AND MANAGER_ID = 145
  WHERE employee_id = 7369;

Specifying a List of Columns with DBMS_XMLSave: Example

As described in "Updating a Column List with OracleXMLSave", you can specify a list of columns to update.

Run the testUpdateSubset.sql script creates the PL/SQL procedure testUpdateSubset. The procedure uses the employee_id column as key and updates only the salary and job_id columns of the hr.employees table.

Run the insertClob4.sql script to insert an XML document into the xmldocument table. The <ROW> elements in the document describe employees 100 and 206. Each <ROW> element has ten subelements that contain descriptive text.

Run the updateEmployee2.sql script shown in Example 11-10 to pass the XML CLOB to the testUpdateSubset procedure and generate two UPDATE statements.

Example 11-10 updateEmployee2.sql

DECLARE
  v_xml_text CLOB;
BEGIN
  SELECT xml_text
    INTO v_xml_text
  FROM hr.xmldocument
  WHERE docid = 4;
  testUpdateSubset(v_xml_text);
END;
/

The procedure updates only those columns specified in the setUpdateColumn procedure, salary and email, for employees 100 and 206.

Deleting with DBMS_XMLSave

As described in "Deleting Rows with OracleXMLSave", you can supply a list of key columns that XSU uses to determine which rows to delete. XSU specifies these columns in the WHERE clause of the DELETE statement.

Deleting by Row with DBMS_XMLSave: Example

Create the testDeleteRow PL/SQL procedure by running the testDeleteRow.sql script. The procedure deletes a row from the hr.employees table for every <ROW> element in an input XML document.

Suppose that you want to delete the employee Jim Jordan that you added in Example 11-7. Run the deleteEmployeeByRow.sql script shown in Example 11-11 to pass the XML document as a CLOB to the testDeleteRow stored procedure.

Example 11-11 Deleting by Row

DECLARE
  v_xml_text CLOB;
BEGIN
  SELECT xml_text
    INTO v_xml_text
  FROM hr.xmldocument
  WHERE docid = 2;
  testDeleteRow(v_xml_text);
END;
/

The preceding call to testDeleteRow generates the following DELETE statement:

DELETE FROM hr.employees
  WHERE employee_id = 7401 AND last_name = 'JORDAN'
  AND email = 'jim.jordan@business.com' AND job_id = 'SH_CLERK'
  AND hire_date = '12/17/2004 0:0:0';

The program forms the DELETE statements based on the tag names present in each <ROW> element in the XML document.

Deleting by Key with DBMS_XMLSave: Example

As explained in "Deleting by Key with OracleXMLSave", you can specify a column to use as a primary key for the deletions. Use the DBMS_XMLSave.setKeyColumn function to specify the key.

The testDeleteKey procedure created by running testDeleteKey.sql deletes a row from the employees table for every <ROW> element in an input XML document.

Suppose that you want to delete the employee Liz Gardner that you added in Example 11-4. Run the deleteEmployeeByKey.sql script shown in Example 11-12 to pass the XML document as a CLOB to the testDeleteKey stored procedure.

Example 11-12 Deleting by Key

DECLARE
  v_xml_text CLOB;
BEGIN
  SELECT xml_text
    INTO v_xml_text
  FROM hr.xmldocument
  WHERE docid = 1;
  testDeleteKey(v_xml_text);
END;
/

In the preceding procedure call, XSU generates a single DELETE statement of the following form:

DELETE FROM hr.employees WHERE employee_id=?

XSU uses this statement for all ROW elements in the input XML document.

Handling Exceptions in the XSU PL/SQL API

Good PL/SQL coding practice accounts for possible exceptions. The anonymous PL/SQL block in raiseException.sql demonstrates how to invoke the DBMS_XMLQuery.getExceptionContent procedure. Run the script in SQL*Plus to print the following error message:

Exception caught 904 ORA-00904: "Z": invalid identifier

Reusing the Context Handle with DBMS_XMLSave

In the DML examples described in the preceding sections, you can use the same context handle to perform more than one operation. That is, you can perform more than one INSERT with the same context provided that all of the insertions access the same table specified when creating the save context. You can also use the same context to mix DML statements.

The testDML.sql script shows how to use the same context and settings to perform DML depending on user input. The example uses a PL/SQL supplied package static variable to store the context so that the same context can be used for all function calls.

In the testDML package created by the script, you create a context once for the whole package (and thus the session) and reuse the context for multiple DML operations.

Note:

The key column employee_id is used both for updates and deletes as a way of identifying the row.

You can call any of the three procedures created by the script to update the employees table:

testDML.insertXML(xmlclob);
testDML.deleteXML(xmlclob);
testDML.updateXML(xmlclob);

Each procedure call uses the same context, which improves the performance of these operations, particularly if these operations are performed frequently.

Tips and Techniques for Programming with XSU

This section provides additional tips and techniques for writing programs with XSU. It contains the following topics:

How XSU Maps Between SQL and XML

How XSU Processes SQL Statements

How XSU Maps Between SQL and XML

The fundamental component of a table is a column, whereas the fundamental components of an XML document are elements and attributes. How do tables map to XML documents? For example, if the hr.employees table has a column called last_name, how is this structure represented in XML: as an <EMPLOYEES> element with a last_name attribute or as a <LAST_NAME> element within a different root element? This section answers such questions by describing how SQL maps to XML and vice versa. It contains the following topics:

Default SQL to XML Mapping

Default XML to SQL Mapping

Customizing Generated XML

Default SQL to XML Mapping

Assume that you want to display data from some column of the hr.employees table as an XML document. You run XSU at the command line as follows:

java OracleXML getXML -user "hr/password" -withschema \
  "SELECT employee_id, last_name, hire_date FROM employees"

XSU outputs an XML document based on the input query. The root element of the document is <DOCUMENT>. The following shows sample output, with extraneous lines replaced by comments:

<?xml version = '1.0'?>
<DOCUMENT xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <!-- children of schema element ... -->
   </xsd:schema>
   <ROWSET xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="#/DOCUMENT/xsd:schema[not(@targetNamespace)]">
      <ROW num="1">
         <EMPLOYEE_ID>100</EMPLOYEE_ID>
         <LAST_NAME>King</LAST_NAME>
         <HIRE_DATE>6/17/1987 0:0:0</HIRE_DATE>
      </ROW>
      <!-- additional rows ... -->
   </ROWSET>
</DOCUMENT>

In the generated XML, the rows returned by the SQL query are children of the <ROWSET> element. The XML document has the following features:

The <ROWSET> element has zero or more <ROW> child elements corresponding to the number of rows returned. If the query generates no rows, then no <ROW> elements are included; if the query generates one row, then one <ROW> element is included, and so forth.

Each <ROW> element contains data from one of the table rows. Specifically, each <ROW> element has one or more child elements whose names and content are identical to the database columns specified in the SELECT statement.

XML Mapping Against an Object-Relational Schema

Assume a case in which you generate an XML document from an object-relational schema. Run the createObjRelSchema.sql script in SQL*Plus to set up and populate an object-relational schema. The schema contains a dept1 table with two columns that employ user-defined types.

You can query the dept1 table as follows by invoking XSU from the command line:

% java OracleXML getXML -user "hr/password" -withschema "SELECT * FROM dept1"

XSU returns the XML document shown in Example 11-13, which is altered so that extraneous lines are replaced by comments.

Example 11-13 XSU-Generated Sample Document

<?xml version='1.0'?>
<DOCUMENT xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <schema targetNamespace="http://xmlns.oracle.com/xdb/SYSTEM"
           xmlns="http://www.w3.org/2001/XMLSchema"
           xmlns:SYSTEM="http://xmlns.oracle.com/xdb/SYSTEM">
   <!-- children of schema element ... -->
   </xsd:schema>
   <ROWSET xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="#/DOCUMENT/xsd:schema[not(@targetNamespace)]">
      <ROW num="1">
         <DEPTNO>120</DEPTNO>
         <DEPTNAME>Treasury</DEPTNAME>
         <DEPTADDR>
            <STREET>2004 Charade Rd</STREET>
            <CITY>Seattle</CITY>
            <STATE>WA</STATE>
            <ZIP>98199</ZIP>
         </DEPTADDR>
         <EMPLIST>
            <EMPLIST_ITEM>
               <EMPLOYEE_ID>1</EMPLOYEE_ID>
               <LAST_NAME>Mehta</LAST_NAME>
               <SALARY>6000</SALARY>
               <EMPLOYEE_ADDRESS>
                  <STREET>500 Main Road</STREET>
                  <CITY>Seattle</CITY>
                  <STATE>WA</STATE>
                  <ZIP>98199</ZIP>
               </EMPLOYEE_ADDRESS>
            </EMPLIST_ITEM>
         </EMPLIST>
      </ROW>
   </ROWSET>
</DOCUMENT>

As in the previous example, the mapping is canonical, that is, <ROWSET> contains <ROW> child elements, which in turn contain child elements corresponding to the columns in dept1. For example, the <DEPTNAME> element corresponds to the dept1.deptname column. The elements corresponding to scalar type columns contain the data from the columns.

Default Mapping of Complex Type Columns to XML

The situation is more complex with elements corresponding to a complex type column. In Example 11-13, <DEPTADDR> corresponds to the dept1.deptAddr column, which is of object type AddressType. Consequently, <DEPTADDR> contains child elements corresponding to the attributes specified in the type AddressType. The AddressType attribute street corresponds to the child XML element <STREET> and so forth. These sub-elements can contain data or subelements of their own, depending on whether the attribute they correspond to is of a simple or complex type.

Default Mapping of Collections to XML

When dealing with elements corresponding to database collections, the situation is also different. In Example 11-13, the <EMPLIST> element corresponds to the emplist column of type EmployeeListType. Consequently, the <EMPLIST> element contains a list of <EMPLIST_ITEM> elements, each corresponding to one of the elements of the collection. Note the following:

The <ROW> elements contain a cardinality attribute num.

If a particular column or attribute value is NULL, then for that row, the corresponding XML element is left out altogether.

If a top-level scalar column name starts with the at sign (@) character, then the column is mapped to an XML attribute instead of an XML element.

Default XML to SQL Mapping

XML to SQL mapping is the reverse of SQL to XML mapping. Consider the following differences when using XSU to map XML to SQL:

When transforming XML to SQL, XSU ignores XML attributes. Thus, there is really no mapping of XML attributes to SQL.

When transforming SQL to XML, XSU performs the mapping on a single ResultSet created by a SQL query. The query can span multiple database tables or views. When transforming XML into SQL, note the following:

To insert one XML document into multiple tables or views, you must create an object-relational view over the target schema.

If the view is not updatable, then you can use INSTEAD OF INSERT triggers.

If the XML document does not perfectly map to the target database schema, then you can perform the following actions:

Modify the target. Create an object-relational view over the target schema and make the view the new target.

Modify the XML document by using XSLT to transform the XML document. You can register the XSLT stylesheet with XSU so that the incoming XML is automatically transformed before it attempts any mapping.

Modify XSU's XML-to-SQL mapping. You can instruct XSU to perform case-insensitive matching of XML elements to database columns or attributes. For example, you can instruct XSU to do the following:

Use the name of the element corresponding to a database row instead of ROW.

Specify the date format to use when parsing dates in the XML document.

Customizing Generated XML

In some circumstances you may need to generate XML with a specific structure. Because the desired structure may differ from the default structure of the generated XML document, you want to have some flexibility in this process. You can customize the structure of a generated XML document by using one of the following methods:

Altering the Database Schema or SQL Query

Modifying XSU

Altering the Database Schema or SQL Query

You can perform source customizations by altering the SQL query or the database schema. The simplest and most powerful source customizations include the following:

In the database schema, create an object-relational view that maps to the desired XML document structure.

In your query, do the following:

Use cursor subqueries or cast-multiset constructs to create nesting in the XML document that comes from a flat schema.

Alias column and attribute names to obtain the desired XML element names.

Alias top-level scalar type columns with identifiers that begin with the at sign (@) to make them map to an XML attribute instead of an XML element. For example, executing the following statement generates an XML document in which the <ROW> element has the attribute empno:

SELECT employee_name AS "@empno",... FROM employees;

Consider the customer.xml document shown in Example 11-14.

Example 11-14 customer.xml

<?xml version = "1.0"?>
<ROWSET>
 <ROW num="1">
  <CUSTOMER>
   <CUSTOMERID>1044</CUSTOMERID>
   <FIRSTNAME>Paul</FIRSTNAME>
   <LASTNAME>Astoria</LASTNAME>
   <HOMEADDRESS>
    <STREET>123 Cherry Lane</STREET>
    <CITY>SF</CITY>
    <STATE>CA</STATE>
    <ZIP>94132</ZIP>
   </HOMEADDRESS>
  </CUSTOMER>
 </ROW>
</ROWSET>

Suppose that you need to design a set of database tables to store this data. Because the XML is nested more than one level, you can use an object-relational database schema that maps canonically to the preceding XML document. Run the createObjRelSchema2.sql script in SQL*Plus to create such a database schema.

You can load the data in the customer.xml document into the customer_tab table created by the script. Invoke XSU for Java from the command line as follows:

java OracleXML putXML -user "hr/password" -fileName customer.xml customer_tab

To load customer.xml into a database schema that is not object-relational, you can create objects in views on top of a standard relational schema. For example, you can create a relational table that contains the necessary columns, then create a customer view that contains a customer object on top of it, as shown in the createRelSchema.sql script in Example 11-15.

Example 11-15 createRelSchema.sql

CREATE TABLE hr.cust_tab
 ( customerid NUMBER(10),
   firstname VARCHAR2(20),
   lastname VARCHAR2(20),
   street VARCHAR2(40),
   city VARCHAR2(20),
   state VARCHAR2(20),
   zip VARCHAR2(20)
 );

CREATE VIEW customer_view
AS
SELECT customer_type(customerid, firstname, lastname,
       address_type(street,city,state,zip)) customer
FROM cust_tab;

You can load data into customer_view as follows:

java OracleXML putXML -user "hr/password" -fileName customer.xml customer_view

Alternatively, you can flatten your XML by means of XSLT and then insert it directly into a relational schema. However, this is the least recommended option.

Suppose that you want to map a particular column or a group of columns to an XML attribute instead of an XML element. To achieve this functionality, you can create an alias for the column name and prepend the at sign (@) before the name of this alias. For example, you can use the mapColumnToAtt.sql script to query the hr.employees table, rendering employee_id as an XML attribute.

You can run the mapColumnToAtt.sql script from the command line as follows:

java OracleXML getXML -user "hr/password" -fileName "mapColumnToAtt.sql"

Note:

All attributes must appear before any non-attribute.

Modifying XSU

XSU enables you to modify the rules that it uses to transform SQL data into XML. You can make any of the following changes when mapping SQL to XML:

Change or omit the <ROWSET> or <ROW> tag.

Change or omit the attribute num, which is the cardinality attribute of the <ROW> element.

Specify the case for the generated XML element names.

Specify that XML elements corresponding to elements of a collection must have a cardinality attribute.

Specify the format for dates in the XML document.

Specify that null values in the XML document have to be indicated with a nullness attribute rather then by omission of the element.

How XSU Processes SQL Statements

This section describes how XSU interacts with the database:

How XSU Queries the Database

How XSU Inserts Rows

How XSU Updates Rows

How XSU Deletes Rows

How XSU Commits After DML

How XSU Queries the Database

XSU executes SQL queries and retrieves the ResultSet from the database. XSU then acquires and analyzes metadata about the ResultSet. Using the mapping described in "Default SQL to XML Mapping", XSU processes the SQL result set and converts it into an XML document.

XSU cannot handle certain types of queries, especially those that mix columns of type LONG or LONG RAW with CURSOR() expressions in the SELECT clause. LONG and LONG RAW are two examples of datatypes that JDBC accesses as streams and whose use is deprecated. If you migrate these columns to CLOBs, then the queries succeed.

How XSU Inserts Rows

When inserting the contents of an XML document into a table or view, XSU performs the following steps:

Retrieves metadata about the target table or view.

Generates a SQL INSERT statement based on the metadata. For example, assume that the target table is dept1 and the XML document is generated from dept1. XSU generates the following INSERT statement:

INSERT INTO dept1 (deptno, deptname, deptaddr, emplist) VALUES (?,?,?,?)

Parses the XML document, and for each record, it binds the appropriate values to the appropriate columns or attributes. For example, it binds the values for INSERT statement as follows:

deptno   <- 100
deptname <- SPORTS
deptaddr <- AddressType('100 Redwood Shores Pkwy','Redwood Shores',
                        'CA','94065')
emplist  <- EmployeeListType(EmployeeType(7369,'John',100000,
            AddressType('300 Embarcadero','Palo Alto','CA','94056'),...)

Executes the statement. You can optimize INSERT processing to insert in batches and commit in batches.

See Also:

"Default SQL to XML Mapping"

"Inserting Rows with OracleXMLSave" for more detail on batching

How XSU Updates Rows

Updates and delete statements differ from inserts in that they can affect more than one row in the database table. For inserts, each <ROW> element of the XML document can affect at most one row in the table if no triggers or constraints are on the table. With updates and deletes, the XML element can match more than one row if the matching columns are not key columns in the table.

For update statements, you must provide a list of key columns that XSU must identify the row to update. For example, assume that you have an XML document that contains the following fragment:

<ROWSET>
  <ROW num="1">
    <DEPTNO>100</DEPTNO>
    <DEPTNAME>SportsDept</DEPTNAME>
  </ROW>
</ROWSET>

You want to change the DEPTNAME value from Sports to SportsDept. If you supply the DEPTNO as the key column, then XSU generates the following UPDATE statement:

UPDATE dept1 SET deptname = ? WHERE deptno = ?

XSU binds the values in the following way:

deptno <- 100
deptname <- SportsDept

For updates, you can also choose to update only a set of columns and not all the elements present in the XML document.

See Also:

"Updating Rows with OracleXMLSave"

How XSU Deletes Rows

For deletes, you can choose to provide a set of key columns so that XSU can identify the rows to be deleted. If you do not provide the set of key columns, then the DELETE statement tries to match all the columns in the document. Assume that you pass the following document to XSU:

<ROWSET>
 <ROW num="1">
  <DEPTNO>100</DEPTNO>
  <DEPTNAME>Sports</DEPTNAME>
  <DEPTADDR>
      <STREET>100 Redwood Shores Pkwy</STREET>
      <CITY>Redwood Shores</CITY>
      <STATE>CA</STATE>
      <ZIP>94065</ZIP>
  </DEPTADDR>
 </ROW>
 <!-- additional rows ... -->
</ROWSET>

XSU builds a DELETE statement for each ROW element:

DELETE FROM dept1 WHERE deptno = ? AND deptname = ? AND deptaddr = ?

The binding is as follows:

deptno   <- 100
deptname <- sports
deptaddr <- addresstype('100 redwood shores pkwy','redwood city','ca',
            '94065')

See Also:

"Deleting Rows with OracleXMLSave"

How XSU Commits After DML

By default XSU performs no explicit commits. If AUTOCOMMIT is on, which is the default for a JDBC connection, then after each batch of statement executions XSU executes a COMMIT. You can override this behavior by turning AUTOCOMMIT off and then using setCommitBatch to specify the number of statement executions before XSU should commit. If an error occurs, then XSU rolls back to either the state the target table was in before the call to XSU, or the state after the last commit made during the current call to XSU.

12 Using the TransX Utility

This chapter contains these topics:

Introduction to the TransX Utility

Using the TransX Utility: Overview

Loading Data with the TransX Utility

See Also:

Chapter 13, "Data Loading Format (DLF) Specification"

Introduction to the TransX Utility

TransX Utility enables you to transfer XML to a database. More specifically, the TransX utility is an application of XML SQL Utility (XSU) that loads translated seed data and messages into a database schema. If you have data to be populated into a database in multiple languages, then the utility provides the functionality that you would otherwise need to develop with XSU.

The TransX utility is particularly useful when handling multilingual XML. The utility does the following:

Automatically manages the change variables, start sequences, and additional SQL statements that would otherwise require multiple inserts or sessions. Thus, translation vendors do not need to work with unfamiliar SQL and PL/SQL scripts.

Automates character encoding. Consequently, loading errors due to incorrect encoding are impossible so long as the data file conforms to the XML standard.

Reduces globalization costs by preparing strings to be translated, translating the strings, and loading them into the database.

Minimizes translation data format errors and accurately loads the translation contents into pre-determined locations in the database. When the data is in a predefined format, the TransX utility validates it.

Eliminates syntax errors due to varying Globalization Support settings.

Does not require the UNISTR construct for every piece of NCHAR data.

Prerequisites

This chapter assumes that you are familiar with XML SQL Utility (XSU) because TransX is an application of XSU.

See Also:

Chapter 11, "Using the XML SQL Utility (XSU)"

TransX UtilityFeatures

This section describes the following features of the TransX utility:

Simplified Multilingual Data Loading

Simplified Data Format Support and Interface

Additional TransX Utility Features

Simplified Multilingual Data Loading

When inserting multilingual data or data translations into an Oracle database, or when encoding, each XML file requires validation. The traditional translation data loading method is to change the NLS_LANG environment variable setting when switching load files. This variable sets the language and territory used by the client application and the database server. It also sets the client character set, which is the character set for data entered or displayed by a client program.

In the traditional method, each load file is encoded in a character set suitable for its language, which is necessary because translations must be performed in the same file format—typically in a SQL script—as the original. The NLS_LANG setting changes as files are loaded to adapt to the character set that corresponds to the language. As well as consuming time, this approach is error-prone because the encoding metadata is separate from the data itself.

With the TransX utility you use an XML document with a predefined format called a dataset. The dataset contains the encoding information and the data so that you can transfer multilingual data without changing NLS_LANG settings. The TransX utility frees development and translation groups by maintaining the correct character set while loading XML data into the database.

See Also:

Oracle Database Globalization Support Guide to learn about the NLS_LANG environment variable

Simplified Data Format Support and Interface

The TransX utility provides a command-line interface and programmable API. The utility complies with a data format defined to be the canonical method for the representation of seed data loaded into the database. The format is intuitive and simplified for use by translation groups. The format specification defines how translators can describe the data so that it is loaded in an expected way. You can represent the values in the data set with scalar values or expressions such as constants, sequences, and queries.

Additional TransX Utility Features

Table 12-1 describes other useful TransX utility features.

Table 12-1 TransX Utility Features

Feature
TransX Utility . . .

Command-line interface

Provides easy-to-use commands.

User API

Exposes a Java API.

Validation

Validates the data format and reports errors.

Whitespace handling

Does not consider whitespace characters in the data set as significant unless otherwise specified in various granularity.

Unloading

Exports the result into the standard data format based on an input query.

Intimacy with translation exchange format

Enables transformation to and from translation exchange format.

Localized user interface

Provides messages in many languages.

Using the TransX Utility: Overview

This section contains the following topics:

Using the TransX Utility: Basic Process

Running the TransX Utility Demo Programs

Using the TransX Command-Line Utility

Using the TransX Utility: Basic Process

TransX is accessible through the following API:

oracle.xml.transx.loader class, which contains the getLoader() method to obtain a TransX instance

oracle.xml.transx.TransX interface, which is the TransX API

Figure 12-1 illustrates the basic process for using the TransX API to transfer XML to an Oracle database.

Figure 12-1 Basic Process of a TransX Application

This graphic is described in the following text.
Description of "Figure 12-1 Basic Process of a TransX Application"

The basic process of a TransX application is as follows:

Create a TransX loader object. Instantiate the TransX class by calling getLoader() as follows:

TransX  transx = loader.getLoader();

Start a data loading session by supplying database connection information with TransX.open(). You create a session by supplying the JDBC connect string, database username, and database password. You have the following options:

Create the connection with the JDBC OCI driver. The following code fragment illustrates this technique and connects with the supplied user name and password:

transx.open( "jdbc:oracle:oci8:@", user, passwd );

Create the connection with the JDBC thin driver. The thin driver is written in pure Java and can be called from any Java program. The following code fragment illustrates this technique and connects:

transx.open( "jdbc:oracle:thin:@//myhost:1521/myservicename", user,passwd);

The thin driver requires the host name (myhost), port number (1521), and the service name (myservicename). The database must have an active TCP/IP listener.

Note:

If you are just validating your data format, then you do not need to establish a database connection because the validation is performed by TransX. Thus, you can invoke the TransX.validate() method without a preceding open() call.

Configure the TransX loader. Table 12-2 describes configuration methods.

Table 12-2 TransX Configuration Methods

Method
Description

setLoadingMode()

Sets the operation mode on duplicates. The mode determines TransX behavior when there are one or more existing rows in the database whose values in the key columns are the same as those in the dataset to be loaded. You can specify the constants EXCEPTION_ON_DUPLICATES, SKIP_DUPLICATES, or UPDATE_DUPLICATES in class oracle.xml.transx.LoadingMode. By default the loader skips duplicates.

setNormalizeLangTag()

Sets the case of language tag. By default the loader uses the style specified in the normalize-langtag attribute on DLF.

setPreserveWhitespace()

Specifies how the loader should handle whitespace. The default is FALSE, which means that the loader ignores the type of whitespace characters in the dataset and loads them as space characters. The loader treats consecutive whitespace characters in the dataset as one space character.

setValidationMode()

Sets the validation mode. The default is TRUE, which means that the loader performs validation of the dataset format against the canonical schema definition on each load() call. The validation mode should be disabled only if the dataset has already been validated.

The following example specifies that the loader should skip duplicate rows and not validate the dataset:

transx.setLoadingMode( LoadingMode.SKIP_DUPLICATES );
transx.setValidationMode( false );

Load the datasets by invoking TransX.load(). The same JDBC connection is used during the iteration of the load operations. For example, load three datasets as follows:

String  datasrc[] = {"data1.xml", "data2.xml", "data3.xml"};
...
for ( int i = 0 ; i < datasrc.length ; i++ )
{
  transx.load( datasrc[i] );
}

Close the loading session by invoking TransX.close(). This method call closes the database connection:

transx.close();

See Also:

Oracle Database Java Developer's Guide to learn about Oracle JDBC

Oracle Database XML Java API Reference to learn about TransX classes and methods

Running the TransX Utility Demo Programs

Demo programs for the TransX utility are included in $ORACLE_HOME/xdk/demo/java/transx. Table 12-3 describes the XML files and programs that you can use to test the utility.

Table 12-3 TransX Utility Sample Files

File
Description

README

A text file that describes how to set up the TransX demos.

emp-dlf.xml

A sample output file. The following command generates a file emp.xml that contains all data in the table emp:

transx -s "jdbc:oracle:thin:@//myhost:1521/myservicename" user
 -pw emp.xml emp

The emp-dlf.xml file should be identical to emp.xml.

txclean.sql

A SQL file that drops the tables and sequences created for the demo.

txdemo1.java

A sample Java application that creates a JDBC connection and loads three datasets into the database.

txdemo1.sql

A SQL script that creates two tables and a sequence for use by the demo application.

txdemo1.xml

A sample dataset.

Documentation for how to compile and run the sample programs is located in the README. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/java/transx directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\transx directory (Windows).

Make sure that your environment variables are set as described in "Setting Up the Java XDK Environment". It is recommended that you set the $ORACLE_SID (UNIX) or %ORACLE_SID% (Windows) environment variables to the default database.

Note:

For security purposes, do not expose passwords in command-line interfaces. If "-pw" is specified instead of the password in TransX, the user will be prompted for the password [ Enter password : ]. When the user types the password, it will not be echoed; instead, "*"s will be printed in the command window.

Set up the sample database objects by executing txdemo1.sql. Connect to the database and run the txdemo1.sql script as follows:

@txdemo1

Run the TransX utility from the command line. For example, assume that you want to connect with the Java thin driver and that your host is myhost, your port is 1521, and your service name is myservicename. Enter the user name where the token user appears. You can execute the following command to load dataset txdemo1.xml:

transx "jdbc:oracle:thin:@//myhost:1521/myservicename" user -pw txdemo1.xml

When the operation is successful, nothing is printed out on your terminal.

Query the database to determine whether the load was successful. For example:

SELECT * FROM i18n_messages;

Drop the demo objects to prepare for another test. Connect to the database and run the txclean.sql script as follows:

@txclean

Compile the Java demo program. For example:

javac txdemo1.java

Run the Java program, using the same JDBC and database connection data that you used when invoking the command-line interface. For example:

java txdemo1 "jdbc:oracle:thin:@//myhost:1521/myservicename" user -pw\
              txdemo1.xml

Perform the same query test (step 5) and clean-up operation (step 6) as before.

Run the TransX Utility to unload data into the predefined XML format. For example:

transx -s "jdbc:oracle:thin:@//myhost:1521/myservicename" user -pw emp.xml emp

Compare the data in emp.xml with emp-dlf.xml.

Note:

For simplicity in demonstrating this feature, this example does not perform the password management techniques that a deployed system normally uses. In a production environment, follow the Oracle Database password management guidelines, and disable any sample accounts. See Oracle Database Security Guide for password management guidelines and other security recommendations.

Using the TransX Command-Line Utility

TransX utility is packaged with Oracle Database. By default, the Oracle Universal Installer installs the utility on disk. As explained in "Java XDK Component Dependencies", the TransX library is $ORACLE_HOME/lib/xml.jar (UNIX) and %ORACLE_HOME%\lib\xml.jar (Windows).

You can run the TransX utility from the operating system command line with the following syntax:

java oracle.xml.transx.loader

The XDK includes a script version of TransX named $ORACLE_HOME/bin/transx (UNIX) and %ORACLE_HOME%\bin\transx.bat (Windows). Assuming that your PATH variable is set correctly, you can run TransX as follows:

transx options parameters
transx.bat options parameters

For example, the following command shows valid syntax:

transx -s "jdbc:oracle:thin:@//myhost:1521/myservicename" user -pw emp.xml emp

TransX utility Command-Line Options

Table 12-4 describes the options for the TransX utility.

Table 12-4 TransX utility Command-line Options

Option
Meaning
Description

-u

Update existing rows.

Does not skip existing rows but updates them. To exclude a column from the update operation, set the useforupdate attribute to no.

-e

Raise exception if a row is already existing in the database.

Throws an exception if a duplicate row is found. By default, TransX skips duplicate rows. Rows are considered duplicate if the values for lookup-key column(s) in the database and the data set are the same.

-x

Print data in the database in the predefined format.

Similar to the -s option, it causes the utility to perform the opposite operation of loading. Unlike the -s option, it prints to stdout. Redirecting this output to a file is discouraged because intervention of the operating system may result in data loss due to unexpected transcoding.

-s

Save data in the database into a file in the predefined format.

Performs unloading. TransX Utility queries the database, formats the result into the predefined XML format, and stores it under the specified file name.

-p

Print the XML to load.

Prints out the data set for insert in the canonical format of XSU.

-t

Print the XML for update.

Prints out the data set for update in the canonical format of XSU.

-o

Omit validation (as the data set is parsed it is validated by default).

Causes TransX Utility to skip the format validation, which is performed by default.

-v

Validate the data format and exit without loading.

Causes TransX Utility to perform validation and exit.

-w

Preserve white space.

Causes TransX Utility to treat whitespace characters (such as \t, \r, \n, and ' ') as significant. The utility condenses consecutive whitespace characters in string data elements into one space character by default.

-l

Set the case of language tag.

Causes TransX Utility to override the style of normalizing the case of language tag specified in the normalize-langtag attribute on DLF or the setNormalizeLangTag() method on the TransX API. Valid options are -ls, -lu and -ll for standard, uppercase and lowercase, respectively.

Note the following command-line option exceptions:

-u and -e are mutually exclusive.

-v must be the only option followed by data, as shown in the examples.

-x must be the only option followed by connect information and a SQL query, as shown in the examples.

Omitting all arguments results in the display of the usage information shown in Table 12-4.

TransX Utility Command-Line Parameters

Table 12-5 describes the command-line parameters for the TransX utility.

Table 12-5 TransX utility Command-line Parameters

Parameter
Description

connect_string

The JDBC connect string. See Oracle Database JDBC Developer's Guide,

username

Database user name.

password

Password for the database user, or "-pw".

datasource

An XML document specified by filename or URL.

options

Described in Table 12-4, "TransX utility Command-line Options".

See Also:

Oracle Database XML Java API Reference for complete details of the TransX interface

Loading Data with the TransX Utility

The TransX utility is especially useful for populating a database with multilingual data. To use the utility to transfer data in and out of a database schema you must create a dataset that maps to this schema. This section describes a typical use scenario in which you use TransX to organize translated application messages in a database.

This section contains the following topics:

Storing Messages in the Database

Creating a Dataset in a Predefined Format

Loading the Data

Querying the Data

Storing Messages in the Database

To build an internationalized system, it is essential to decouple localizable resources from business logic. A typical example of such a resource is translated text information. Data that is specific to a particular region and shares a common language and cultural conventions must be organized with a resource management facility that can retrieve locale-specific information. A database is often used to store such data because of easy maintenance and flexibility.

Assume that you create the table with the structure and content shown in Example 12-1 and insert data.

Example 12-1 Structure of Table translated_messages

CREATE TABLE translated_messages
(
  MESSAGE_ID       NUMBER(4)
     CONSTRAINT tm_mess_id_nn NOT NULL
, LANGUAGE_ID      VARCHAR2(42)
, MESSAGE          VARCHAR2(200)
);

The column language_id is defined in this table so that applications can retrieve messages based on the preferred language of the end user. It contains abbreviations of language names to identify the language of messages.

Example 12-2 shows sample data for the table.

Example 12-2 Query of translated_messages

MESSAGE_ID  LANGUAGE_ID  MESSAGE
----------  -----------  ----------------------------------
1           us           Welcome to System X
2           us           Please enter username and password

See Also:

Oracle Database Globalization Support Guide for Oracle language abbreviations

Creating a Dataset in a Predefined Format

Chapter 13, "Data Loading Format (DLF) Specification" describes the complete syntax of the Data Loading Format (DLF) language. This language is used to create a DLF document that provides the input to TransX.

Given the dataset (the input data) in the canonical format, the TransX utility loads the data into the designated locations in the database. Note that TransX does not create the database objects: you must create the tables or views before attempting to load data.

An XML document that represents the translated_messages table created in Example 12-1 looks something like Example 12-3. The dataset reflects the structure of the target table, which in this case is called translated_messages.

Example 12-3 example.xml

<?xml version="1.0"?>
<table name="translated_messages">
  <!-- Specify the unique identifier -->
  <lookup-key>
    <column name="message_id" />
    <column name="language_id" />
  </lookup-key>
  <!-- Specify the columns into which data will be inserted -->
  <columns>
    <column name="message_id"  type="number"/>
    <column name="language_id" type="string" constant="us" translate="yes"/>
    <column name="message"     type="string" translate="yes"/>
  </columns>
  <!-- Specify the data to be inserted -->
  <dataset>
    <row>
      <col name="message_id">1</col>
      <col name="message" translation-note="dnt'X'">Welcome to System X</col>
    </row>
    <row>
      <col name="message_id">2</col>
      <col name="message">Please enter username and password</col>
    </row>
    <!-- ... -->
  </dataset>
</table>

Format of the Input XML Document

The XML document in Example 12-3 starts with the following declaration:

<?xml version="1.0"?>

Its root element <table>, which has an attribute that specifies the name of the table, encloses all the other elements:

<table name="translated_messages">
...
</table>

As explained in "Elements in DLF", the <table> element contains three subsections:

Lookup Key Elements

Metadata Elements

Data Elements

The preceding sections map to elements in Example 12-3 as follows:

<lookup-key>...</lookup-key>
<columns>...</columns>
<dataset>...</dataset>

The lookup keys are columns used to evaluate rows if they already exist in the database. Because we want a pair of message and language IDs to identify a unique string, the document lists the corresponding columns. Thus, the message_id, language_id, and message columns in table translated_messages map to the attributes in the <column> element as follows:

<column name="message_id"  type="number"/>
<column name="language_id" type="string" constant="us" translate="yes"/>
<column name="message"     type="string" translate="yes"/>

The columns section should mirror the table structure because it specifies which piece of data in the dataset section maps to which table column. The column names should be consistent throughout the XML dataset and database. You can use the <column> attributes in Table 12-6 to describe the data to be loaded. Note that these attributes form a subset of the DLF attributes described in "Attributes in DLF".

Table 12-6 <column> Attributes

Attribute
Description
Example

type

Specifies the datatype of a column in the dataset. This attribute specifies the kind of text contained in the <col> element in the dataset. Depending on this type, the data loading tool applies different datatype conventions to the data.

<column name="col" type="string" />

constant

Specifies a constant value. A column with a fixed value for each row does not have to repeat that same value.

<column name="col" type="string" constant="us" />

language

The language attribute indicates that the column is the language column, which stores a language tag. It works in the same way as the constant attribute, except for the role to declare the column is the language column.

<column name="language" type="string" language="us" />

sequence

Specifies a sequence in the database used to fill in the value for this column.

<column name="id" type="number" sequence="id_sq" />

translate

Indicates whether the text of this column or parameter is to be translated.

<column name="msg" type="string" translate="yes"/>

The constant attribute of a <column> element specifies a value to be stored into the corresponding column for every row in the dataset section. Because in this example we are working in the original language, the language_id column is set to the value us.

Defining the Language Column

Alternatively, the language_id column may use the language attribute instead of the constant attribute. A DLF document with the language attribute can use the lang attribute in the xml namespace. A language column can use the "%x" placeholder to get its value from the standard xml:lang attribute at the root table element.Thus translate="yes" is not needed, because the value "%x" does not have to be translated. The result of loading this DLF is the same as Example 10-3.

Example 12-4 example.xml with a Language Attribute

<?xml version="1.0"?>
<table xml:lang="us" name="translated_messages">
  <!-- Specify the unique identifier -->
  <lookup-key>
    <column name="message_id" />
    <column name="language_id" />
  </lookup-key>
  <!-- Specify the columns into which data will be inserted -->
  <columns>
    <column name="message_id"  type="number"/>
    <column name="language_id" type="string" language="%x"/>
    <column name="message"     type="string" translate="yes"/>
  </columns>
  <!-- Specify the data to be inserted -->
  <dataset>
    <row>
      <col name="message_id">1</col>
      <col name="message" translation-note="dnt'X'">Welcome to System X</col>
    </row>
    <row>
      <col name="message_id">2</col>
      <col name="message">Please enter username and password</col>
    </row>
    <!-- ... -->
  </dataset>
</table>

As explained in Table 13-10, the valid values for the type attribute are string, number, date, and dateTime. These values correspond to the datatypes defined in the XML schema standard, so each piece of data should conform to the respective datatype definition. In particular, it is important to use the ISO 8601 format for the date and dateTime datatypes, as shown in Table 12-7.

Table 12-7 date and dateTime Formats

Datatype
Format
Example

date

CCYY-MM-DD

2009-05-20

dateTime

CCYY-MM-DDThh:mm:ss

2009-05-20T16:01:37

Example 12-5 shows how you can represent a table row with dateTime data in a TransX dataset.

Example 12-5 dateTime Row

<row>
  <col name="article_id">12345678</col>
  <col name="author_id">10500</col>
  <col name="submission">2002-03-09T16:01:37</col>
  <col name="title">...</col>
  <!-- some columns follows -->
</row>

Specifying Translations in a Dataset

As explained in "Attributes in DLF", you can use the translation attribute to specify whether the column contains translated data. In Example 12-3, two <column> elements use the translate attribute differently. The attribute for the language_id column specifies that the value of the constant attribute should be translated:

<column name="language_id" type="string" constant="us" translate="yes"/>

In contrast, the following translate attribute requests translation of the data in the dataset section with a name that matches this column:

<column name="message"     type="string" translate="yes"/>

For example, the preceding element specifies that the following messages in the dataset section should be translated:

<col name="message" translation-note="dnt'X'">Welcome to System X</col>
<col name="message">Please enter username and password</col>

When translating messages for applications, you may decide that specified words or phrases should be left untranslated. The translation-note attribute shown in the preceding example achieves this goal.

An XSLT processor can convert the preceding format into another format for exchanging translation data among localization service providers for use with XML-based translation tools. This transformation insulates developers from tasks such as keeping track of revisions, categorizing translatable strings into units, and so on.

Example 12-6 shows what the document in Example 12-3 looks like after translation.

Example 12-6 example_es.xml

<?xml version="1.0"?>
<table xml:lang="es" name="translated_messages">
<!-- Specify the unique identifier -->
<lookup-key>
<column name="message_id" />
<column name="language_id" />
</lookup-key>
<!-- Specify the columns into which data will be inserted -->
<columns>
<column name="message_id" type="number"/>
<column name="language_id" type="string" constant="es"
translate="yes"/>

Example 12-7 shows what the document in Example 12-4 looks like after translation. Unlike the previous example, the column definition is not changed.

Example 12-7 example_es.xml with a Language Attribute

<?xml version="1.0"?>
<table xml:lang="es"  name="translated_messages">
  <!-- Specify the unique identifier -->
  <lookup-key>
    <column name="message_id" />
    <column name="language_id" />
  </lookup-key>
  <!-- Specify the columns into which data will be inserted -->
  <columns>
    <column name="message_id"  type="number"/>
    <column name="language_id" type="string" language="%x"/>

:
:

If you use a text editor or a traditional text-based translation tool during the translation process, it is important to maintain the encoding of the document. After a document is translated, it may be in a different encoding from the original. As explained in "XML Declaration in DLF", If the translated document is in an encoding other than Unicode, then add the encoding declaration to the XML declaration on the first line. A declaration for non-Unicode encoding looks like the following:

<?xml version="1.0" encoding="ISO-8859-15"?>

To ensure that the translation process does not lose syntactic integrity, process the document as XML. Otherwise, you can check the format by specifying the -v option of the command-line interface. If a syntactic error exists, the utility prints the location and description of the error. You must fix errors for the data transfer to succeed.

See Also:

Chapter 13, "Data Loading Format (DLF) Specification"

Loading the Data

Suppose that you want to load the sample documents in Example 12-3 and Example 12-8 into the translated_messages table that you created in Example 12-1. You can use the sample program in Example 12-8, which you can find in the TransX demo directory, to load the data.

Example 12-8 txdemo1.java

// Copyright (c) 2001 All rights reserved Oracle Corporation

import oracle.xml.transx.*;

public class txdemo1 {

  /**
   * Constructor
   */
  public txdemo1() {
  }

  /**
   * main
   * @param args
   *
   * args[0] : connect string
   * args[1] : username
   * args[2] : password
   * args[3+] : xml file names
   */
  public static void main(String[] args) throws Exception {

    // instantiate a transx class
    TransX  transx = loader.getLoader();

    // start a data loading session
    transx.open( args[0], args[1], args[2] );

    // specify operation modes
    transx.setLoadingMode( LoadingMode.SKIP_DUPLICATES );
    transx.setValidationMode( false );

    // load the dataset(s)
    for ( int i = 3 ; i < args.length ; i++ )
    {
      transx.load( args[i] );
    }

    // cleanup
    transx.close();
  }
}

The txdemo1.java program follows these steps:

Create a TransX loader object. For example:

TransX  transx = loader.getLoader();

Open a data loading session. The first three command-line parameters are the JDBC connect string, database username, and database password. These parameters are passed to the TransX.open() method. The program includes the following statement:

transx.open( args[0], args[1], args[2] );

Configure the TransX loader. The program configures the loader to skip duplicate rows and to validate the input dataset. The program includes the following statements:

transx.setLoadingMode( LoadingMode.SKIP_DUPLICATES );
transx.setValidationMode( false );

Load the data. The first three command-line parameters specify connection information; any additional parameters specify input XML documents. The program invokes the load() method for every specified document:

for ( int i = 3 ; i < args.length ; i++ )
{
  transx.load( args[i] );
}

Close the data loading session. The program includes the following statement:

transx.close();

After compiling the program with javac, you can run it from the command line. The following example uses the Java thin driver to connect to instance mydb on port 1521 of computer myhost. It connects to the user schema and loads the XML documents example.xml and example_es.xml:

java txdemo1 "jdbc:oracle:thin:@//myhost:1521/mydb" user -pw example.xml
     example_es.xml

In building a multilingual software system, translations usually become available at a later stage of development. They also tend to evolve over a period of time. If you need to add messages to the database, then you can add new rows in your <dataset> definition by running the TransX utility again. TransX recognizes which rows are new and inserts only the new messages based on the columns specified in the <lookup-key> section. If some messages are updated, then run TransX with the -u option to update existing rows with the data specified in XML, as shown in the following example:

transx -u "jdbc:oracle:thin:@//myhost:1521/mydb" user -pw example.xml
       example_es.xml

Querying the Data

After using the program in Example 12-8 to load the data, you can query the translated_messages table to see the results. The results should look like the following:

MESSAGE_ID  LANGUAGE_ID  MESSAGE
----------  -----------  ----------------------------------
1           us           Welcome to System X
1           es           Bienvenido al Sistema X
2           us           Please enter username and password
2           es           Porfavor entre su nombre de usuario y su contraseña

An application can retrieve a message in a specific language by using the language_id and message_id columns in a WHERE clause. For example, you can execute the following query:

SELECT message
FROM   translated_messages
WHERE  message_id = 2
AND    language_id = 'es';

MESSAGE
----------------------------------
Porfavor entre su nombre de usuario y su contraseña

13 Data Loading Format (DLF) Specification

This chapter describes version 1.0 of the Data Loading Format (DLF), which is the standard format to describe translated messages and seed data loaded into the database by the TransX utility. It contains the following topics:

Introduction to DLF

General Structure of DLF

DLF Specifications

DLF Examples

DLF References

See Also:

Chapter 12, "Using the TransX Utility"

Introduction to DLF

DLF defines a standard format for loading data with the TransX utility. It is intended to supersede loading data with SQL scripts. DLF provides the following advantages:

Format validation. Validation results in fewer errors during the translation and loading processes.

Ease of use. The user does not have to maintain the character encoding of each data file to correspond with the language used in the data file.

DLF is based on the XML 1.0 specification.

Naming Conventions for DLF

This section describes the naming conventions used in this document.

Elements and Attributes

The following naming conventions for elements and attributes are used throughout this specification:

Standard English letters

Lowercase letters only

Hyphen (-) may be used for concatenation

Attribute names must be consistently defined throughout

Industry-standard terminology should be followed wherever possible

Values

Values are case-sensitive except for some attribute values used for column names. All predefined attribute values are lowercase. No element values are defined by this specification.

File Extensions

No file extension is recommended by this specification. A future version of this specification may recommend that documents use an extension that conforms to an 8.3 standard.

General Structure of DLF

Data Loading Format is XML, so it begins with an XML declaration. After the XML declaration comes the DLF document itself, enclosed within the <table> element. A DLF document is composed of the following required sections:

The <lookup-key> element contains a list of column names that determine whether existing rows in the database are duplicates of the rows in the dataset definition included in the <dataset> element.

The <columns> element contains metadata about the <dataset> such as the names, datatypes, and attributes of columns.

The <dataset> element contains a <row> element for each row, which in turn contains a <col> element that corresponds to a piece of data that is loaded in a database column. In this way a DLF document looks similar to the familiar tabular format in printing data in the database and allows easy editing.

DLF provides one optional section, which is enclosed within a <translation> element. This section may precede the required sections.

In addition, DLF provides information about TransX utility processing. Such information includes but is not limited to the following:

The <query> element is used to retrieve the value to be loaded to the column from a SQL query.

The sequence attribute is used to retrieve the value to be loaded to the column from a sequence object in the database.

The constant attribute is used to specify a constant value to the column.

The language attribute is used to specify the language identifier to be loaded to the column.

Tree Structure of DLF

This section shows the possible structure of a DLF document as a tree. Each element is represented as <element_name>, where element_name is the name of an element. Attributes have no markup. Each element and attribute is followed by notation indicating its possible occurrence. Table 13-1 describes the occurrence notation.

Table 13-1 Notation for Occurrence of Attributes and Elements

Symbol
Meaning

1

one

+

one or more

?

zero or one

*

zero or more

(a|b|c)

exactly one of a, b, and c

Example 13-1 shows the tree structure of a DLF document. The elements are described in "Elements in DLF". The attributes are described in "Attributes in DLF".

Example 13-1 DLF Tree Structure

<table>1
 |
 +---- lang?
 |
 +---- space?
 |
 +---- normalize-langtag?
 |
 +---- <translation>?
 |     |
 |     +---- <target>+
 |     |     |
 |     |     +---- <language ID>
 |     |
 |     +---- <restype>+
 |           |
 |           +---- name1
 |           |
 |           +---- expansion?
 |
 +---- <lookup-key>1
 |     |
 |     +---- <column>*
 |           |
 |           +---- name1
 |
 +---- <columns>1
 |     |
 |     +---- <column>+
 |           |
 |           +---- name1
 |           |
 |           +---- type1
 |           |
 |           +---- translate?
 |           |
 |           +---- translation-note?
 |           |
 |           +---- constant?
 |           |
 |           +---- language?
 |           |
 |           +---- sequence?
 |           |
 |           +---- virtual?
 |           |
 |           +---- useforupdate?
 |           |
 |           +---- maxsize?
 |           |
 |           +---- size-unit?
 |           |
 |           +---- restype?
 |           |
 |           +---- space?
 |           |
 |           +---- (<query>|<sql>)?
 |                 |
 |                 +---- text1
 |                 |
 |                 +---- <parameter>*
 |                       |
 |                       +---- id1
 |                       |
 |                       +---- (col|constant)1
 |                       |
 |                       +---- translate?
 |                       |
 |                       +---- trans-key?
 |                       |
 |                       +---- translation-note?
 |
 |
 +---- <dataset>1
       |
       +---- <row>+
             |
             +---- space?
             |
             +---- <col>*
                   |
                   +---- space?
                   |
                   +---- name1
                   |
                   +---- trans-key?
                   |
                   +---- translation-note?
                   |
                   +---- <the text element for the data>

DLF Specifications

This section contains the following topics:

XML Declaration in DLF

Entity References in DLF

Elements in DLF

Attributes in DLF

XML Declaration in DLF

The XML declaration starts an XML entity. It indicates the XML version and can be used to declare the encoding of the file, as in the following example:

<?xml version="1.0" encoding="iso-8859-1" ?>

As in all XML files, the default encoding for a DLF file is assumed to be either UTF-8, which is a superset of the 7-bit ASCII character set, or UTF-16, which is conceptually UCS-2 with surrogate pairs for code points above 65,535. Thus, for these character sets, the encoding declaration is not necessary. Furthermore, all XML parsers support these character sets. If the encoding is UTF-16, then the first character of the file must be the Unicode Byte-Order-Mark, #xFEFF, which indicates the endianness of the file.

Other character sets supported by Oracle XML parsers include all Oracle character sets and commonly used IANA character set and Java encodings. The names of these character sets can be found in the parser documentation. You must declare these with encoding declarations if the document does not have an external source of encoding information such as from the execution environment or the network protocol. Therefore, it is recommended that you use a Unicode character encoding so that you can dispense with the encoding declaration. The recommended practice is to encode the document in UTF-8 and use the following declaration:

<?xml version="1.0" ?>

Entity References in DLF

There are five entity references predefined by XML. These entity references are listed in Table 13-2. The &lt; and &amp; entity references must always be used in place of the character they reference.

Table 13-2 Entity References

Entity Reference
Meaning

&lt;

Less than sign (<)

&gt;

Greater than sign (>)

&amp;

Ampersand (&)

&apos;

Apostrophe or single quote (')

&quot;

Straight, double quotation mark (")

Elements in DLF

The DLF elements shown in Example 13-1 are divided into the categories described in Table 13-3. Attributes are shared among them. The attributes are described in "Attributes in DLF".

Table 13-3 DLF Elements

Type of Element
Tag

Top Level Table Element

<table>

Translation Elements

<target>, <restype>

Lookup Key Elements

<lookup-key>, <column>

Metadata Elements

<columns>, <column>, <query>, <sql>, <parameter>

Data Elements

<dataset>, <row>, <col>

Top Level Table Element

Table 13-10 describes the top level table element.

Table 13-4 Top Level Table Element

Tag
Description
Required Attributes
Optional Attributes
Contents

<table>

Corresponds to a single table. It encloses all the other elements of the document.

name

lang, space, normalize-langtag

The order of the elements within <table> is as follows:

<translation> (optional)

<lookup-key>

<columns>

<dataset>

Translation Elements

Table 13-5 describes the translation elements.

Table 13-5 Translation Elements

Tag
Description
Required Attributes
Optional Attributes
Contents

<translation>

Contains generic information pertinent to translation.

None

None

Zero or more <target> elements and zero or more <restype> elements

<target>

Specifies a language to which this document is translated.

None

None

A language identifier as defined by [IETFRFC1766]

<restype>

Declares a type of resource.

name

expansion

Empty element

Lookup Key Elements

Table 13-6 describes the lookup key elements.

Table 13-6 Lookup Key Elements

Tag
Description
Required Attributes
Optional Attributes
Contents

<lookup-key>

Contains the <column> element(s) based on which the TransX recognizes the rows as identical or duplicate.

name

None

Zero or more <column> elements

<column>

A <column> element under <lookup-key> element indicates a column to be used to recognize the rows as identical or duplicate. Columns with the same values in specified column(s) are considered duplicate, regardless of the values in the other column(s). A lookup key <column> must have corresponding <col>umns in the <dataset> portion or be declared as a <column> with a constant expression or a <query> in the <columns> section.

name

None

Empty element

Metadata Elements

Table 13-7 describes the metadata elements.

Table 13-7 Metadata Elements

Tag
Description
Required Attributes
Optional Attributes
Contents

<columns>

Contains data about the data to be loaded.

None

None

One or more <column> elements

<column>

Specifies a column that corresponds to <col> elements under the <dataset> element. Once a <column> is defined the corresponding <col> element must appear in every <row> unless the column has the sequence, constant or query attribute.

name, type in either order.

The recommended sequence is name, type, then optional attributes.

translate, constant, sequence, virtual, useforupdate, maxsize, size-unit, restype in any order

Zero or one <query> or <sql> element

<query>

Specifies a SQL query whose result is used to fill in the column to which this element belongs.

text

None

Zero or more <parameter> elements

<sql>

Specifies a SQL statement whose result, if any, is used to fill in the column to which this element belongs.

text

None

Zero or more <parameter> elements

<parameter>

Specifies a parameter of a <query> element.

id and either col or constant.

If col is specified, the referenced column cannot have the query, constant, or sequence attributes.

translate, trans-key

Empty

Data Elements

Table 13-8 describes the data elements.

Table 13-8 Data Elements

Tag
Description
Required Attributes
Optional Attributes
Contents

<dataset>

Contains data to be loaded into the database.

None

None

One or more <row> elements

<row>

Contains data about the data to be loaded <dataset> element.

None

None

Zero or more <col> elements

<col>

Specifies an instance of a piece of data to be loaded to a database column, or in the case of a virtual column, a piece of data to be used to obtain an actual data to be loaded to a database column.

name

trans-key

Data for use by applications

Attributes in DLF

This section lists the various attributes used in the DLF elements. An attribute is never specified more than once for each element. Along with some of the attributes are the Recommended Attribute Values. Values for these attributes are case sensitive.

Table 13-9 Attributes

Type of Attribute
Attributes

DLF Attributes

name, type, translate, constant, sequence, virtual, useforupdate, maxsize, size-unit, restype, text, id, col, trans-key, translation-note, normalize-langtag

XML Namespace Attributes

xml:space

DLF Attributes

Table 13-10 describes the DLF attributes.

Table 13-10 DLF Attributes

Attribute
Description
Value Description
Default Value
Used by Elements

lang

Specifies the language of the document.

This is equivalent to the xml:lang attribute.

The values of the attribute are language identifiers as defined by [IETFRFC4646].

This attribute does not affect data loading operation in any way.

None; if absent, "en" is assumed

<table>

normalize-langtag

Specifies how to normalize the case of language tag.

"none", "standard", "uppercase" or "lowercase".

The meanings are as follows:

none - no normalization. the values in the language column on DLF are used as they are

standard - the style as recommended by the standards

* lowercase for the 2 letter language code

* uppercase for the 2 letter country code

* titlecase for the 4 letter script code

* lowercase for others

uppercase - uppercase everything

lowercase - lowercase everything

none

<table>

space

Specifies how white spaces (ASCII spaces, tabs and line-breaks) should be treated.

"default" or "preserve"

The value "default" signals that applications' default white-space processing modes are acceptable; the value "preserve" indicates the intent that applications preserve all whitespace. If this intent is declared at the root table element, it is considered to apply to all string data elements in the whole document. If declared at column level, it is considered to apply to the specified column of every row. If this attribute is declared in the dataset section, the intent applies to the immediate text data only. Declaration at the document or column level may be overridden with another instance of the space attribute.

"default"

<table>, <column>, <col>

name

Specifies the name of an object such as table, column, restype, and so forth.

String: This is a database table name for the <table> element, and a column name for the <column> or <col> element.

n/a

<table>, <column>, <col>

type

The datatype of a column in the dataset. This attribute specifies the kind of text contained in the <col> element in the dataset. Depending on this type, TransX may apply different processes to the data.

Because implicit datatype conversion is provided by XSU and JDBC, TransX does not do its own parsing based on this type information. It uses this attribute to choose appropriate intermediate data types in Java for columns of date or dateTime type, in which case the standard date formats are accepted.

String: possible values are "number", "string", "date", "dateTime" or "binary".

The lexical representation of a value of number type should be supplied in the SQL language syntax, no matter what the current locale is. The SQL syntax uses no digit grouping separator (usually comma), but uses a dot as the decimal separator (usually dot).For the binary data type, the data value specified in a text field between the col tags indicates the name of a file that contains the actual binary data. Raw data cannot be embedded in the text field.For the other data types (string, date, and dateTime) the representation is constrained by the corresponding types in the XML Schema specification.For the sake of simplicity, DLF only accepts standard date formats of XML Schema in the form "CCYY-MM-DDThh:mm:ss" (dateTime) or "CCYY-MM-DD" (date). No other date format is recognized.

TransX uses this attribute for the following:

Bind virtual columns to parameters of a query

Bind the result of a query to a corresponding column

n/a

<column>

translate

Indicates whether or not the text of this column or parameter should be translated.

Either "yes" or "no"

"no"

<column>, <parameter>

constant

Specifies a constant value for this column or parameter.

The value of this column for every row

n/a

<column>, <parameter>

language

Specifies language identifier for this column

Language identifier or a placeholder. "%x" gets the value from the xml:lang attribute of the root table element.

n/a

<column>

sequence

Specifies a sequence in the database used to fill in the value for this column.

String: The name of a sequence in the database

n/a

<column>

virtual

Indicates that this column provides data used to construct another piece of data, which in turn is loaded into the database. A virtual column does not exist in the database. It is typically used to provide a value of a parameter in a query. A virtual column cannot be a lookup-key column. A virtual column with a query throws the result away.

Either "yes" or "no"

"no"

<column>

useforupdate

Indicates whether the value of this column is used for the update when uploading seed data. This attribute has no effect unless TransX is in the mode to update duplicate rows. A virtual column cannot have this attribute set to yes.

Either "yes" or "no". If this attribute is set to "no", then the value of the column remains unchanged on the update operation.

"yes"

<column>

maxsize

Specifies the maximum size for the data for this column.

Numeric value in the unit specified by the size-unit attribute. If this attribute is set and the size-unit is not set, the size is assumed to be in characters.

None

<column>

size-unit

Specifies the unit of size specified in the maxsize attribute.

Units. Recommended values are "char" for characters, "byte" for bytes.

For supplemental characters, they take two "char" units.

"char"

<column>

restype

Indicates the type of data contained in this column.

A resource type. The value must match with the name of a <restype> element.

None

<column>

expansion

Indicates the maximum size up to which translated strings are allowed to become longer for this type of resource.

A numeric value in percentage of increase.

0%

<restype>

text

Specifies a SQL query statement to obtain a value to put in the column to which the query belongs.

A SQL statement. Zero or more parameters can be specified with an identifier preceded by a colon. The statement should return a single row of a single value. Any excessive result is discarded.

n/a

<query>

id

Specifies a placeholder used in a SQL query statement with parameters. The value of the column specified by the sibling col attribute is associated as a parameter to the query.

String: an identifier that appears in the text attribute of the parent query element.

Empty string

<parameter>

col

Specifies a column to be associated with a placeholder in the query specified by the sibling id attribute.

String: a column name. The column must be other than the column this attribute is a part of.

n/a

<parameter>

trans-key

Specifies a key for translation.

String: a translation key. The value has to be unique in a translation domain.

n/a

<col>, <parameter>

translation-note

Specifies notes for translation.

String: Translation notes.

n/a

<col>, <column>, <parameter>

XML Namespace Attributes

Table 13-11 describes the XML namespace attributes.

Table 13-11 XML Namespace Attributes

Attribute
Description
Value Description
Default Value
Used by Elements

xml:space

Specifies how whitespace (ASCII spaces, tabs and line-breaks) should be treated.

"default" or "preserve"

The value "default" signals that applications' default whitespace processing modes are acceptable for this element; the value "preserve" indicates the intent that applications preserve all the whitespace. This declared intent is considered to apply to all elements within the content of the element where it is specified, unless overridden with another instance of the xml:space attribute.

"default"

None

xml:lang

Specifies the language of the content.

A language tag defined by RFC 4646.

n/a

table

DLF Examples

This section contains the following topics:

Minimal DLF Document

Typical DLF Document

Localized DLF Document

Minimal DLF Document

Example 13-2 shows a minimal DLF document.

Example 13-2 Minimal DLF Document

<?xml version="1.0" ?>
<table name="dual">
 <lookup-key/>
 <columns>
  <column name="DUMMY" type="string">
 </columns>
 <dataset>
  <row>
   <col name="DUMMY">X</col>
  </row>
 </dataset>
</table>

Typical DLF Document

Example 13-3 shows a sample DLF document that contains seed data for the CLK_STATUS_L table.

Example 13-3 Sample DLF Document

<!--
  - $Header: $
  -
  - Copyright (c) 2001 Oracle Corporation. All Rights Reserved.
  -
  - NAME
  -   status.xml - Seed file for the CLK_STATUS_L table
  -
  - DESCRIPTION
  -   This file contains seed data for the Status level table.
  -
  - NOTES
  -
  - MODIFIED   (MM/DD/YY)
  -   dchiba    06/11/01 - Adaption to enhancements of data loading tool
  -   dchiba    05/23/01 - Adaption to generic data loading tool
  -   rbolsius  05/07/01 - Created
  -->

<table name="clk_status_l" xml:space="preserve">
  <lookup-key>
    <!--column name="status_id" /-->
    <column name="status_code" />
  </lookup-key>

  <columns>
    <column name="status_id"          type="number" sequence="clk_status_seq" useforupdate="no"/>
    <column name="status_code"        type="number" />
    <column name="status_name"        type="string" translate="yes" />
    <column name="status_description" type="string" translate="yes" />
    <column name="version_created"    type="number" constant="0" />
    <column name="version_updated"    type="number" constant="0" />
    <column name="status_type_code"   type="string" virtual="yes" />
    <column name="status_type_id"     type="number" >
      <query text="select status_type_id from clk_status_type_l where status_type_code = :1" >
        <parameter id="1" col="status_type_code" />
      </query>
    </column>
  </columns>

  <dataset>

    <row>
      <col name="status_code" >100</col>
      <col name="status_name" trans-key="stts-name-1" >Continue</col>
      <col name="status_description" trans-key="stts-desc-1" >
        The client should continue with its request.</col>
      <col name="status_type_code" >INFO</col>
    </row>

    <row>
      <col name="status_code" >101</col>
      <col name="status_name" trans-key="stts-name-2" >Switching Protocols</col>
      <col name="status_description" trans-key="stts-desc-2" >
        The server understands and is willing to comply with the client''s
        request (via the Upgrade message header field) for a change in the
        application protocol being used on this connection.</col>
      <col name="status_type_code" >INFO</col>
    </row>

    <row>
      <col name="status_code" >200</col>
      <col name="status_name" trans-key="stts-name-3" >OK</col>
      <col name="status_description" trans-key="stts-desc-3" >
        The request has succeeded.</col>
      <col name="status_type_code" >SUCCESS</col>
    </row>

    <row>
      <col name="status_code" >201</col>
      <col name="status_name" trans-key="stts-name-4" >Created</col>
      <col name="status_description" trans-key="stts-desc-4" >
        The request has been fulfilled and resulted in a new resource being
        created.</col>
      <col name="status_type_code" >SUCCESS</col>
    </row>

    <row>
      <col name="status_code" >202</col>
      <col name="status_name" trans-key="stts-name-5" >Accepted</col>
      <col name="status_description" trans-key="stts-desc-5" >
        The request has been accepted for processing, but the processing has
        not been completed.</col>
      <col name="status_type_code" >SUCCESS</col>
    </row>

    <row>
      <col name="status_code" >203</col>
      <col name="status_name" trans-key="stts-name-6" >Non-Authoritative Information</col>
      <col name="status_description" trans-key="stts-desc-6" >
        The returned metainformation in the entity-header is not the
        definitive set as available from the origin server, but is gathered
        from a local or a third-party copy.</col>
      <col name="status_type_code" >SUCCESS</col>
    </row>

    <row>
      <col name="status_code" >204</col>
      <col name="status_name" trans-key="stts-name-7" >No Content</col>
      <col name="status_description" trans-key="stts-desc-7" >
        The server has fulfilled the request but does not need to return an
        entity-body, and might want to return updated metainformation.</col>
      <col name="status_type_code" >SUCCESS</col>
    </row>

    <!-- ... -->

  </dataset>
</table>

Localized DLF Document

Example 13-4 shows an example of elements and attributes for localization.

Example 13-4 DLF with Localization

<?xml version="1.0"?>
<table name="table_name" xml:lang="en" xml:space="preserve">

<translation>
<target>ar</target>
<target>bs</target>
<target>es</target>
<restype name="alt" expansion="50%"/>
<restype name="foo" expansion="50%"/>
<restype name="bar" expansion="30%"/>
</translation>

<lookup-key><column name="resid" /></lookup-key>

<columns>
<column name="resid" type="number" sequence="seq_foo" useforupdate="no"/>
<column name="image" type="binary"/>
<column name="alt_text" type="string" translate="yes" maxsize="30"
        size-unit="byte" restype="alt"/>

</columns>

<dataset>
<col name="image">foo1.gif</col>
<col name="alt_text">Hello world</col>
</dataset>

</table>

DLF References

See the following references for further information:

[IETFRFC4646] Tags for the Identification of Languages
http://www.ietf.org/rfc/rfc4646

14 Using the XSQL Pages Publishing Framework

This chapter contains these topics:

Introduction to the XSQL Pages Publishing Framework

Using the XSQL Pages Publishing Framework: Overview

Generating and Transforming XML with XSQL Servlet

Using XSQL in Java Programs

XSQL Pages Tips and Techniques

Introduction to the XSQL Pages Publishing Framework

The Oracle XSQL pages publishing framework is an extensible platform for publishing XML in multiple formats. The Java-based XSQL servlet, which is the center of the framework, provides a declarative interface for dynamically publishing dynamic Web content based on relational data.

The XSQL framework combines the power of SQL, XML, and XSLT. You can use it to create declarative templates called XSQL pages to perform the following actions:

Assemble dynamic XML datagrams based on parameterized SQL queries

Transform datagrams with XSLT to generate a result in an XML, HTML, or text-based format

An XSQL page, so called because its default extension is .xsql, is an XML file that contains instructions for the XSQL servlet. The Example 14-1 shows a simple XSQL page. It uses the <xsql:query> action element to query the hr.employees table.

Example 14-1 Sample XSQL Page

<?xml version="1.0">
<?xml-stylesheet type="text/xsl" href="emplist.xsl"?>
<xsql:query connection="hr" xmlns:xsql="urn:oracle-xsql">
 SELECT * FROM employees
</xsql:query>

You can present a browser client with the data returned from the query in Example 14-1. Assembling and transforming information for publishing requires no programming. You can perform most tasks in a declarative way. If one of the built-in features does not fit your needs, however, then you can use Java to integrate custom data sources or perform customized server-side processing.

In the XSQL pages framework, the assembly of information to be published is separate from presentation. This architectural feature enables you to do the following:

Present the same data in multiple ways, including tailoring the presentation appropriately to the type of client device making the request (browser, cellular phone, PDA, and so on)

Reuse data by aggregating existing pages into new ones

Revise and enhance the presentation independently of the content

Prerequisites

This chapter assumes that you are familiar with the following technologies:

Oracle Database SQL. The XSQL framework accesses data in a database.

PL/SQL. The XDK supplies a PL/SQL API for XSU that mirrors the Java API.

Java Database Connectivity (JDBC). The XSQL pages framework depends on a JDBC driver for database connections.

eXtensible Stylesheet Language Transformation (XSLT). You can use XSLT to transform the data into a format appropriate for delivery to the user.

XML SQL Utility (XSU). The XSQL pages framework uses XSU to query the database.

Using the XSQL Pages Publishing Framework: Overview

This section contains the following topics:

Using the XSQL Pages Framework: Basic Process

Setting Up the XSQL Pages Framework

Running the XSQL Pages Demo Programs

Using the XSQL Pages Command-Line Utility

Using the XSQL Pages Framework: Basic Process

The XSQL page processor engine interprets, caches, and processes the contents of XSQL pages. Figure 14-1 shows the basic architecture of the XSQL pages publishing framework. The XSQL page processor provides access from the following entry points:

From the command line or in batch mode with the XSQL command-line utility. The oracle.xml.xsql.XSQLCommandLine class is the command-line interface.

Over the Web by using the XSQL servlet installed in a Web server. The oracle.xml.xsql.XSQLServlet class is the servlet interface.

As part of JSP applications by using <jsp:include> to include a template or <jsp:forward> to forward a template.

Programmatically by using the oracle.xml.xsql.XSQLRequest Java class.

Figure 14-1 XSQL Pages Framework Architecture

This graphic is described in the following text.
Description of "Figure 14-1 XSQL Pages Framework Architecture"

You can run the same XSQL pages from any of the access points shown in Figure 14-1. Regardless of which way you use the XSQL page processor, it performs the following actions to generate a result:

Receives a request to process an XSQL page. The request can come from the command line utility or programmatically from an XSQLRequest object.

Assembles an XML datagram by using the result of one or more SQL queries. The query is specified in the <xsql:query> element of the XSQL page.

Returns this XML datagram to the requestor.

Optionally transforms the datagram into any XML, HTML, or text-based format.

Figure 14-2 shows a typical Web-based scenario in which a Web server receives an HTTP request for Page.xsql, which contains a reference to the XSLT stylesheet Style.xsl. The XSQL page contains a database query.

Figure 14-2 Web Access to XSQL Pages

This graphic is described in the following text.
Description of "Figure 14-2 Web Access to XSQL Pages"

The XSQL page processor shown in Figure 14-2 performs the following steps:

Receives a request from the XSQL Servlet to process Page.xsql.

Parses Page.xsql with the Oracle XML Parser and caches it.

Connects to the database based on the value of the connection attribute on the document element.

Generates the XML datagram by replacing each XSQL action element, for example, <xsql:query>, with the XML results returned by its built-in action handler.

Parses the Style.xsl stylesheet and caches it.

Transforms the datagram by passing it and the Style.xsl stylesheet to the Oracle XSLT processor.

Returns the resulting XML or HTML document to the requester.

During the transformation step in this process, you can use stylesheets that conform to the W3C XSLT 1.0 or 2.0 standard to transform the assembled datagram into document formats such as the following:

HTML for browser display

Wireless Markup Language (WML) for wireless devices

Scalable Vector Graphics (SVG) for data-driven charts, graphs, and diagrams

XML Stylesheet Formatting Objects (XSL-FO), for rendering into Adobe PDF

Text documents such as e-mails, SQL scripts, Java programs, and so on

Arbitrary XML-based document formats

Setting Up the XSQL Pages Framework

You can develop and use XSQL pages in various scenarios. This section describes the following topics:

Creating and Testing XSQL Pages with Oracle JDeveloper

Setting the CLASSPATH for XSQL Pages

Configuring the XSQL Servlet Container

Setting Up the Connection Definitions

Creating and Testing XSQL Pages with Oracle JDeveloper

The easiest way to use XSQL pages is with Oracle JDeveloper 10g. The IDE supports the following features:

Color-coded syntax highlighting

XML syntax checking

In-context drop-down lists that help you pick valid XSQL tag names and auto-complete tag and attribute names

XSQL page deployment and testing

Debugging tools

Wizards for creating XSQL actions

To create an XSQL page in an Oracle JDeveloper 10g project, do the following steps:

Create or open a project.

Select File and then New.

In the New Gallery dialog box, select the General category and then XML.

In the Item window, select XSQL Page and click OK. JDeveloper loads a tab for the new XSQL page into the central window.

To add XSQL action elements such as <xsql:query> to your XSQL page, place the cursor where you want the new element to go and click an item in the Component Palette. A wizard opens that takes you through the steps of selecting which XSQL action you want to use and which attributes you need to provide.

To check the syntax of an XSQL page, place the cursor in the page and right-click Check XML Syntax. If there are any XML syntax errors, JDeveloper displays them.

To test an XSQL page, select the page in the navigator and right-click Run. JDeveloper automatically starts up a local Web server, properly configured to run XSQL pages, and tests your page by launching your default browser with the appropriate URL to request the page. After you have run the XSQL page, you can continue to make modifications to it in the IDE as well as to any XSLT stylesheets with which it might be associated. After saving the files in the IDE you can immediately refresh the browser to observe the effect of the changes.

You must add the XSQL runtime library to your project library list so that the CLASSPATH is properly set. The IDE adds this entry automatically when you go through the New Gallery dialog to create a new XSQL page, but you can also add it manually to the project as follows:

Right-click the project in the Applications Navigator.

Select Project Properties.

Select Profiles and then Libraries from the navigation tree.

Move XSQL Runtime from the Available Libraries pane to Selected Libraries.

Setting the CLASSPATH for XSQL Pages

Outside of the JDeveloper environment, you should make sure that the XSQL page processor engine is properly configured.

Make sure that the appropriate JAR files are in the CLASSPATH of the JavaVM that processes the XSQL Pages. The complete set of XDK JAR files is described in Table 3-1, "Java Libraries for XDK Components". The JAR files for the XSQL framework include the following:

xml.jar, the XSQL page processor

xmlparserv2.jar, the Oracle XML parser

xsu12.jar, the Oracle XML SQL utility (XSU)

ojdbc5.jar, the Oracle JDBC driver (or ojdbc6.jar)

Note:

The XSQL servlet can connect to any database that has JDBC support. Indicate the appropriate JDBC driver class and connection URL in the XSQL configuration file connection definition. Object-relational functionality only works when using Oracle database with the Oracle JDBC driver.

If you have configured your CLASSPATH as instructed in "Setting Up the Java XDK Environment", then you only need to add the directory where the XSQL pages configuration file resides. In the database installation of the XDK, the directory for XSQLConfig.xml is $ORACLE_HOME/xdk/admin.

On Windows your %CLASSPATH% variable should contain the following entries:

%ORACLE_HOME%\lib\ojdbc5.jar;%ORACLE_HOME%\lib\xmlparserv2.jar;
%ORACLE_HOME%\lib\xsu12.jar;C:\xsql\lib\xml.jar;%ORACLE_HOME%\xdk\admin

On UNIX the $CLASSPATH variable should contain the following entries:

$ORACLE_HOME/lib/ojdbc5.jar:$ORACLE_HOME/lib/xmlparserv2.jar:
$ORACLE_HOME/lib/xsu12.jar:$ORACLE_HOME/lib/xml.jar:$ORACLE_HOME\xdk\admin

Note:

If you are deploying your XSQL pages in a J2EE WAR file, then you can include the XSQL JAR files in the ./WEB-INF/lib directory of the WAR file.

Configuring the XSQL Servlet Container

You can install the XSQL servlet in a variety of different Web servers, including OC4J, Jakarta Tomcat, and so forth. You can find complete instructions for installing the servlet in the Release Notes for the OTN download of the XDK.

Navigate to the setup instructions as follows:

Log on to OTN and navigate to the following URL:

http://www.oracle.com/technology/tech/xml/xdk/doc/production10g/readme.html

Click Getting Started with XDK Java Components.

In the Introduction section, scroll down to XSQL Servlet in the bulleted list and click Release Notes.

In the Contents section, click Downloading and Installing the XSQL Servlet.

Scroll down to the Setting Up Your Servlet Engine to Run XSQL Pages section and look for your Web server.

Setting Up the Connection Definitions

XSQL pages specify database connections by using a short name for a connection that is defined in the XSQL configuration file, which by default is named $ORACLE_HOME/xdk/admin/XSQLConfig.xml.

Note:

If you are deploying your XSQL pages in a J2EE WAR file, then you can place the XSQLConfig.xml file in the ./WEB-INF/classes directory of your WAR file.

The sample XSQL page shown in Example 14-1 contains the following connection information:

<xsql:query connection="hr" xmlns:xsql="urn:oracle-xsql">

Connection names are defined in the <connectiondefs> section of the XSQL configuration file. Example 14-2 shows the relevant section of the sample configuration file included with the database, with the hr connection in bold.

Example 14-2 Connection Definitions Section of XSQLConfig.xml

<connectiondefs>
  ...
  <connection name="hr">
    <username>hr</username>
    <password>hr_password</password>
    <dburl>jdbc:oracle:thin:@localhost:1521:ORCL</dburl>
    <driver>oracle.jdbc.driver.OracleDriver</driver>
    <autocommit>false</autocommit>
  </connection>
  ...
</connectiondefs>

For each database connection, you can specify the following elements:

<username>, the database username

<password>, the database password

<dburl>, the JDBC connection string

<driver>, the fully-qualified class name of the JDBC driver to use

<autocommit>, which optionally forces AUTOCOMMIT to TRUE or FALSE

Specify an <autocommit> child element to control the setting of the JDBC autocommit for any connection. If no <autocommit> child element is set for a <connection>, then the autocommit setting is not set by the XSQL connection manager. In this case, the setting is the default autocommit setting for the JDBC driver.

You can place an arbitrary number of <connection> elements in the XSQL configuration file to define your database connections. An individual XSQL page refers to the connection it wants to use by putting a connection="xxx" attribute on the top-level element in the page (also called the "document element").

Caution:

The XSQLConfig.xml file contains sensitive database username and password information that you want to keep secure on the database server. Refer to "Security Considerations for XSQL Pages" for instructions.

Running the XSQL Pages Demo Programs

Demo programs for the XSQL servlet are included in $ORACLE_HOME/xdk/demo/java/xsql. Table 14-1 lists the demo subdirectories and explains the included demos. The Demo Name column refers to the title of the demo listed on the XSQL Pages & XSQL Servlet home page. "Running the XSQL Demos" explains how to access the home page.

Table 14-1 XSQL Servlet Demos

Directory
Demo Name
Description

home/

XSQL Pages & XSQL Servlet

Contains the pages that display the tabbed home page of the XSQL demos as well as the online XSQL help that you can access from that page. As explained in "Running the XSQL Demos", you can invoke the XSQL home page from the index.html page.

helloworld/

Hello World Page

Illustrates the simplest possible XSQL page.

emp/

Employee Page

XSQL page showing XML data from the hr.employees table, using XSQL page parameters to control what employees are returned and which columns to use for the database sort.

Uses an associated XSLT Stylesheet to format the results as an HTML Form containing the emp.xsql page as the form action so the user can refine the search criteria.

insclaim/

Insurance Claim Page

Demonstrates a number of sample queries over the richly-structured Insurance Claim object view. The insclaim.sql scripts sets up the INSURANCE_CLAIM_VIEW object view and populates it with sample data.

classerr/

Invalid Classes Page

Uses invalidclasses.xsl to format a "live" list of current Java class compilation errors in your schema. The accompanying SQL script sets up the XSQLJavaClassesView object view used by the demo. The master/detail information from the object view is formatted into HTML by the invalidclasses.xsl stylesheet in the server.

doyouxml/

Do You XML? Site

Shows how a simple, data-driven Web site can be built with an XSQL page that makes use of SQL, XSQL substitution variables in the queries, and XSLT for formatting the site.

Demonstrates using substitution parameters in both the body of SQL query statements within <xsql:query> tags, as well as within the attributes to <xsql:query> tags to control behavior such as how many records to display and to skip (for "paging" through query results in a stateless way).

empdept/

Emp/Dept Object Demo

Demonstrates how to use an object view to group master/detail information from two existing flat tables such as scott.emp and scott.dept. The empdeptobjs.sql script creates the object view as well as INSTEAD OF INSERT triggers that enable the master/detail view to be used as an insert target of xsql:insert-request.

The empdept.xsl stylesheet illustrates a form of an XSLT stylesheet that looks just like an HTML page without the extra xsl:stylesheet or xsl:transform at the top. Using a Literal Result Element as Stylesheet is part of the XSLT 1.0 specification. The stylesheet also shows how to generate an HTML page that includes <link rel="stylesheet"> to enable the generated HTML to fully leverage CSS for centralized HTML style information, found in the coolcolors.css file.

airport/

Airport Code Validation

Returns a datagram of information about airports based on their three-letter codes and uses <xsql:no-rows-query> as alternative queries when initial queries return no rows. After attempting to match the airport code passed in, the XSQL page tries a fuzzy match based on the airport description.

The airport.htm page shows how to use the XML results of the airport.xsql page from a Web page with JavaScript to exploit built-in DOM functionality in Internet Explorer.

When you enter the three-letter airport code on the Web page, a JavaScript fetches an XML datagram from XSQL servlet. The datagram corresponds to the code that you entered. If the return indicates no match, then the program collects a "picklist" of possible matches based on information returned in the XML datagram from XSQL servlet

airport/

Airport Code Display

Demonstrates use of the same XSQL page as the Airport Code Validation example but supplies an XSLT stylesheet name in the request. This behavior causes the airport information to be formatted as an HTML form instead of being returned as raw XML.

airport/

Airport Soap Service

Demonstrates returning airport information as a SOAP Service.

adhocsql/

Adhoc Query Visualization

Demonstrates how to pass a SQL query and XSLT stylesheet as parameters to the server.

document/

XML Document Demo

Demonstrates inserting XML documents into relational tables. The docdemo.sql script creates a user-defined type called XMLDOCFRAG containing an attribute of type CLOB.

Try inserting the text of the document in ./xsql/demo/xml99.xml and providing the name xml99.xsl as the stylesheet, as well as ./xsql/demo/JDevRelNotes.xml with the stylesheet relnotes.xsl.

The docstyle.xsql page illustrates an example of the <xsql:include-xsql> action element to include the output of the doc.xsql page into its own page before transforming the final output using a client-supplied stylesheet name.

The demo uses the client-side XML features of Internet Explorer 5.0 to check the document for well-formedness before allowing it to be posted to the server.

insertxml/

XML Insert Request Demo

Demonstrates posting XML from a client to an XSQL page that handles inserting the posted XML data into a database table using the <xsql:insert-request> action element. The demo accepts XML documents in the moreover.com XML-based news format.

In this case, the program doing the posting of the XML is a client-side Web page using Internet Explorer 5.0 and the XMLHttpRequest object from JavaScript. If you look at the source for the insertnewsstory.xsql page, you'll see it's specifying a table name and an XSLT Transform name. The moreover-to-newsstory.xsl stylesheet transforms the incoming XML information into the canonical format that the OracleXMLSave utility knows how to insert.

Try copying and pasting the example <article> element several times within the <moreovernews> element to insert several new articles in one shot.

The newsstory.sql script shows how INSTEAD OF triggers can be used on the database views into which you ask XSQL Pages to insert to the data to customize how incoming data is handled, default primary key values, and so on.

svg/

Scalable Vector Graphics Demo

The deptlist.xsql page displays a simple list of departments with hyperlinks to the SalChart.xsql page. The SalChart.xsql page queries employees for a given department passed in as a parameter and uses the associated SalChart.xsql stylesheet to format the result into a Scalable Vector Graphics drawing, a bar chart comparing salaries of the employees in that department.

fop/

PDF Demo

The emptable.xsql page displays a simple list of employees. The emptable.xsl stylesheet transforms the datapage into the XSL-FO Formatting Objects which, combined with the built-in FOP serializer, render the results in Adobe PDF format.

cursor/

Cursor Demo

Contains an example of using a nested CURSOR expression, which is one of three ways to use the default <xsql:query> element to produce nested elements.

actions/

Contains the source code for two example custom actions.

Setting Up the XSQL Demos

To set up the XSQL demos perform the following steps:

Change into the $ORACLE_HOME/xdk/demo/java/xsql directory (UNIX) or %ORACLE_HOME%\xdk\demo\java\xsql directory (Windows).

Start SQL*Plus and connect to your database as ctxsys — the schema owner for the Oracle Text packages — and issue the following statement:

GRANT EXECUTE ON ctx_ddl TO scott;

Connect to your database as a user with DBA privileges and issue the following statement:

GRANT QUERY REWRITE TO scott;

The preceding query enables scott to create a function-based index that one of the demos requires to perform case-insensitive queries on descriptions of airports.

Connect to your database as scott. You will be prompted for the password.

Run the SQL script install.sql in the current directory. This script runs all SQL scripts for all the demos:

@install.sql

Change to the ./doyouxml subdirectory, and run the following command to import sample data for the "Do You XML?" demo (you will be prompted for the password):

imp scott file=doyouxml.dmp

To run the Scalable Vector Graphics (SVG) demonstration, install an SVG plug-in such as Adobe SVG plug-in into your browser.

Running the XSQL Demos

The XSQL demos are designed to be accessed through a Web browser. If you have set up the XSQL servlet in a Web server as described in "Configuring the XSQL Servlet Container", then you can access the demos through the following URL, substituting appropriate values for yourserver and port:

http://yourserver:port/xsql/index.html

Figure 14-3 shows a section of the XSQL home page in Internet Explorer. Note that you must use browser version 5 or higher.

Figure 14-3 XSQL Home Page

Displays the XSQL home page.
Description of "Figure 14-3 XSQL Home Page"

The demos are designed to be self-explanatory. Click the demo titles—Hello World Page, Employee Page, and so forth—and follow the online instructions.

Using the XSQL Pages Command-Line Utility

Often the content of a dynamic page is based on data that does not frequently change. To optimize performance of your Web publishing, you can use operating system facilities to schedule offline processing of your XSQL pages. This technique enables the processed results to be served statically by your Web server.

The XDK includes a command-line Java interface that runs the XSQL page processor. You can process any XSQL page with the XSQL command-line utility.

The $ORACLE_HOME/xdk/bin/xsql and %ORACLE_HOME%\xdk\bin\xsql.bat shell scripts run the oracle.xml.xsql.XSQLCommandLine class. Before invoking the class make sure that your environment is configured as described in "Setting Up the XSQL Pages Framework". Depending on how you invoke the utility, the syntax is either of the following:

java oracle.xml.xsql.XSQLCommandLine xsqlpage [outfile] [param1=value1 ...]
xsql xsqlpage [outfile] [param1=value1 ...]

If you specify an outfile, then the result of processing xsqlpage is written to it; otherwise the result goes to standard out. You can pass any number of parameters to the XSQL page processor, which are available for reference by the XSQL page processed as part of the request. However, the following parameter names are recognized by the command-line utility and have a pre-defined behavior:

xml-stylesheet=stylesheetURL

Provides the relative or absolute URL for a stylesheet to use for the request. You can also set it to the string none to suppress XSLT stylesheet processing for debugging purposes.

posted-xml=XMLDocumentURL

Provides the relative or absolute URL of an XML resource to treat as if it were posted as part of the request.

useragent=UserAgentString

Simulates a particular HTTP User-Agent string from the command line so that an appropriate stylesheet for that User-Agent type is selected as part of command-line processing of the page.

Generating and Transforming XML with XSQL Servlet

This section describes the most basic tasks that you can perform with your server-side XSQL page templates:

Composing XSQL Pages

Producing Datagrams from SQL Queries

Transforming XML Datagrams into an Alternative XML Format

Transforming XML Datagrams into HTML for Display

Composing XSQL Pages

You can serve database information in XML format over the Web with XSQL pages. For example, suppose your aim is to serve a real-time XML datagram from Oracle of all available flights landing today at JFK airport. Example 14-3 shows a sample XSQL page in a file named AvailableFlightsToday.xsql.

Example 14-3 AvailableFlightsToday.xsql

<?xml version="1.0"?>
<xsql:query connection="demo" bind-params="City" xmlns:xsql="urn:oracle-xsql">
  SELECT    Carrier, FlightNumber, Origin, TO_CHAR(ExpectedTime,'HH24:MI') AS Due
  FROM      FlightSchedule
  WHERE     TRUNC(ExpectedTime) = TRUNC(SYSDATE)
  AND       Arrived = 'N'
  AND       Destination = ?   /* The "?" represents a bind variable bound */
  ORDER BY  ExpectedTime      /* to the value of the City parameter.      */
</xsql:query>

The XSQL page is an XML file that contains any mix of static XML content and XSQL action elements. The file can have any extension, but .xsql is the default extension for XSQL pages. You can modify your servlet engine configuration settings to associate other extensions by using the same technique described in "Configuring the XSQL Servlet Container". Note that the servlet extension mapping is configured inside the ./WEB-INF/web.xml file in a J2EE WAR file.

The XSQL page in Example 14-3 begins with the following declaration:

<?xml version="1.0"?>

The first, outermost element in an XSQL page is the document element. AvailableFlightsToday.xsql contains a single XSQL action element <xsql:query>, but no static XML elements. In this case the <xsql:query> element is the document element. Example 14-3 represents the simplest useful XSQL page: one that contains a single query. The results of the query replace the <xsql:query> section in the XSQL page.

Note:

Chapter 30, "XSQL Pages Reference" describes the complete set of built-in action elements.

The <xsql:query> action element includes an xmlns attribute that declares the xsql namespace prefix as a synonym for the urn:oracle-xsql value, which is the Oracle XSQL namespace identifier:

<xsql:query connection="demo" bind-params="City" xmlns:xsql="urn:oracle-xsql">

The element also contains a connection attribute whose value is the name of one of the pre-defined connections in the XSQL configuration file:

<xsql:query connection="demo" bind-params="City" xmlns:xsql="urn:oracle-xsql">

The details concerning the username, password, database, and JDBC driver that will be used for the demo connection are centralized in the configuration file.

To include more than one query on the page, you can invent an XML element to wrap the other elements. Example 14-4 illustrates this technique.

Example 14-4 Wrapping the <xsql:query> Element

<?xml version="1.0"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query bind-params="City">
    SELECT   Carrier, FlightNumber, Origin, TO_CHAR(ExpectedTime,'HH24:MI') AS Due
    FROM     FlightSchedule
    WHERE    TRUNC(ExpectedTime) = TRUNC(SYSDATE)
    AND      Arrived = 'N'
    AND      Destination = ?   /* The ? is a bind variable bound       */
    ORDER BY ExpectedTime      /* to the value of the City parameter.  */
  </xsql:query>
  <!-- Other xsql:query actions can go here inside <page> and </page> -->
</page>

In Example 14-4, the connection attribute and the xsql namespace declaration always go on the document element, whereas the bind-params is specific to the <xsql:query> action.

Using Bind Parameters

The <xsql:query> element shown in Example 14-3 contains a bind-params attribute that associates the values of parameters in the request to bind variables in the SQL statement included in the <xsql:query> tag. The bind parameters in the SQL statement are represented by question marks.

You can use SQL bind variables to parameterize the results of any of the actions in Table 30-1, "Built-In XSQL Elements and Action Handler Classes" that allow SQL statements. Bind variables enable your XSQL page template to produce results based on the values of parameters passed in the request.

To use a bind variable, include a question mark anywhere in a statement where bind variables are allowed by SQL. Whenever a SQL statement is executed in the page, the XSQL engine binds the parameter values to the variable by specifying the bind-params attribute on the action element.

Example 14-5 illustrates an XSQL page that binds the bind variables to the value of the custid parameter in the page request.

Example 14-5 CustomerPortfolio.xsql

<portfolio connnection="prod" xmlns:xsql="urn:oracle-xsql">
  <xsql:query bind-params="custid">
    SELECT s.ticker as "Symbol", s.last_traded_price as "Price"
    FROM latest_stocks s, customer_portfolio p
    WHERE p.customer_id = ?
    AND s.ticker = p.ticker
  </xsql:query>
</portfolio>

The XML data for a customer with ID of 101 can then be requested by passing the customer id parameter in the request as follows:

http://yourserver.com/fin/CustomerPortfolio.xsql?custid=1001

The value of the bind-params attribute is a space-delimited list of parameter names. The left-to-right order indicates the positional bind variable to which its value will be bound in the statement. Thus, if your SQL statement contains five question marks, then the bind-params attribute needs a space-delimited list of five parameter names. If the same parameter value must be bound to several different occurrences of a bind variable, then repeat the name of the parameters in the value of the bind-params attribute at the appropriate position. Failure to include the same number of parameter names in the bind-params attribute as in the query results in an error when the page is executed.

You can use variables in any action that expects a SQL statement or PL/SQL block. The page shown in Example 14-6 illustrates this technique. The XSQL page contains three action elements:

<xsql:dml> binds useridCookie to an argument in the log_user_hit procedure.

<xsql:query> binds parameter custid to a variable in a WHERE clause.

<xsql:include-owa> binds parameters custid and userCookie to two arguments in the historical_data procedure.

Example 14-6 CustomerPortfolio.xsql

<portfolio connnection="prod" xmlns:xsql="urn:oracle-xsql">
  <xsql:dml commit="yes" bind-params="useridCookie">
     BEGIN log_user_hit(?); END;
  </xsql:dml>
  <current-prices>
    <xsql:query bind-params="custid">
      SELECT s.ticker as "Symbol", s.last_traded_price as "Price"
      FROM latest_stocks s, customer_portfolio p
      WHERE p.customer_id = ?
      AND s.ticker = p.ticker
    </xsql:query>
  </current-prices>
  <analysis>
    <xsql:include-owa bind-params="custid userCookie">
      BEGIN portfolio_analysis.historical_data(?,5 /* years */, ?); END;
    </xsql:include-owa>
  </analysis>
</portfolio>

Using Lexical Substitution Parameters

For any XSQL action element, you can substitute the value of any attribute or the text of any contained SQL statement by means of a lexical substitution parameter. Thus, you can parameterize how actions behave as well as substitute parts of the SQL statements that they perform. Lexical substitution parameters are referenced with the following syntax: {@ParameterName}.

Example 14-7 illustrates how you can use two lexical substitution parameters. One parameter in the <xsql:query> element sets the maximum number of rows to be passed in, whereas the other controls the list of columns to be ordered.

Example 14-7 DevOpenBugs.xsql

<!-- DevOpenBugs.xsql -->
<open-bugs connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query max-rows="{@max}" bind-params="dev prod">
    SELECT bugno, abstract, status
    FROM   bug_table
    WHERE  programmer_assigned = UPPER(?)
    AND    product_id          = ?
    AND    status < 80
    ORDER BY {@orderby}
  </xsql:query>
</open-bugs>

Example 14-7 also contains two bind parameters: dev and prod. Suppose that you want to obtain the open bugs for developer smuench against product 817. You want to retrieve only 10 rows and order them by bug number. You can fetch the XML for the bug list by specifying parameter values as follows:

http://server.com/bug/DevOpenBugs.xsql?dev=smuench&prod=817&max=10&orderby=bugno

You can also use the XSQL command-line utility to make the request as follows:

xsql DevOpenBugs.xsql dev=smuench prod=817 max=10 orderby=bugno

Lexical parameters also enable you to parameterize the XSQL pages connection and the stylesheet used to process the page. Example 14-8 illustrates this technique. You can switch between stylesheets test.xsql and prod.xsl by specifying the name/value pairs sheet=test and sheet=prod.

Example 14-8 DevOpenBugs.xsql

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="{@sheet}.xsl"?>
<!-- DevOpenBugs.xsql -->
<open-bugs connection="{@conn}" xmlns:xsql="urn:oracle-xsql">
  <xsql:query max-rows="{@max}" bind-params="dev prod">
    SELECT bugno, abstract, status
      FROM bug_table
     WHERE programmer_assigned = UPPER(?)
       AND product_id          = ?
       AND status < 80
    ORDER BY {@orderby}
  </xsql:query>
</open-bugs>

Providing Default Values for Bind and Substitution Parameters

You may want to provide a default value for a bind variable or a substitution parameter directly in the page. In this way, the page is parameterized without requiring the requester to explicitly pass in all values in every request.

To include a default value for a parameter, add an XML attribute of the same name as the parameter to the action element or to any ancestor element. If a value for a given parameter is not included in the request, then the XSQL page processor searches for an attribute by the same name on the current action element. If it does not find one, it keeps looking for such an attribute on each ancestor element of the current action element until it gets to the document element of the page.

The page in Example 14-9 defaults the value of the max parameter to 10 for both <xsql:query> actions in the page.

Example 14-9 Setting a Default Value

<example max="10" connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query max-rows="{@max}">SELECT * FROM TABLE1</xsql:query>
  <xsql:query max-rows="{@max}">SELECT * FROM TABLE2</xsql:query>
</example>

This page in Example 14-10 defaults the first query to a max of 5, the second query to a max of 7, and the third query to a max of 10.

Example 14-10 Setting Multiple Default Values

<example max="10" connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query max="5" max-rows="{@max}">SELECT * FROM TABLE1</xsql:query>
  <xsql:query max="7" max-rows="{@max}">SELECT * FROM TABLE2</xsql:query>
  <xsql:query max-rows="{@max}">SELECT * FROM TABLE3</xsql:query>
</example>

All defaults are overridden if a value of max is supplied in the request, as shown in the following example:

http://yourserver.com/example.xsql?max=3

Bind variables respect the same defaulting rules. Example 14-11 illustrates how you can set the val parameter to 10 by default.

Example 14-11 Defaults for Bind Variables

<example val="10" connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query tag-case="lower" bind-params="val val val">
    SELECT ? AS somevalue
    FROM DUAL
    WHERE ? = ?
  </xsql:query>
</example>

If the page in Example 14-11 is requested without any parameters, it returns the following XML datagram:

<example>
  <rowset>
    <row>
      <somevalue>10</somevalue>
    </row>
  </row>
</example>

Alternatively, assume that the page is requested with the following URL:

http://yourserver.com/example.xsql?val=3

The preceding URL returns the following datagram:

<example>
  <rowset>
    <row>
      <somevalue>3</somevalue>
    </row>
  </row>
</example>

You can remove the default value for the val parameter from the page by removing the val attribute. Example 14-12 illustrates this technique.

Example 14-12 Bind Variables with No Defaults

<example connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query tag-case="lower" bind-params="val val val">
    SELECT ? AS somevalue
    FROM DUAL
    WHERE ? = ?
  </xsql:query>
</example>

A URL request for the page that does not supply a name/value pair returns the following datagram:

<example>
  <rowset/>
</example>

A bind variable that is bound to a parameter with neither a default value nor a value supplied in the request is bound to NULL, which causes the WHERE clause in Example 14-12 to return no rows.

How the XSQL Page Processor Handles Different Types of Parameters

XSQL pages can make use of parameters supplied in the request as well as page-private parameters. The names and values of page-private parameters are determined by actions in the page. If an action encounters a reference to a parameter named param in either a bind-params attribute or in a lexical parameter reference, then the value of the param parameter is resolved in the following order:

The value of the page-private parameter named param, if set

The value of the request parameter named param, if supplied

The default value provided by an attribute named param on the current action element or one of its ancestor elements

The value NULL for bind variables and the empty string for lexical parameters

For XSQL pages that are processed by the XSQL servlet over HTTP, you can also set and reference the HTTP-Session-level variables and HTTP Cookies parameters.

For XSQL pages processed through the XSQL servlet, the value of a parameter param is resolved in the following order:

The value of the page-private parameter param, if set

The value of the cookie named param, if set

The value of the session variable named param, if set

The value of the request parameter named param, if supplied

The default value provided by an attribute named param on the current action element or one of its ancestor elements

The value NULL for bind variables and the empty string for lexical parameters

The resolution order means that users cannot supply parameter values in a request to override parameters of the same name set in the HTTP session. Also, users cannot set them as cookies that persist across browser sessions.

Producing Datagrams from SQL Queries

With XSQL servlet properly installed on your Web server, you can access XSQL pages by following these basic steps:

Copy an XSQL file to a directory under the virtual hierarchy of your Web server. Example 14-3 shows the sample page AvailableFlightsToday.xsql.

You can also deploy XSQL pages in a standard J2EE WAR file, which occurs when you use Oracle JDeveloper 10g to develop and deploy your pages to Oracle Application Server.

Load the page in your browser. For example, if the root URL is yourcompany.com, then you can access the AvailableFlightsToday.xsql page through a Web browser by requesting the following URL:

http://yourcompany.com/AvailableFlightsToday.xsql?City=JFK

The XSQL page processor automatically materializes the results of the query in your XSQL page as XML and returns them to the requester. Typically, another server program requests this XML-based datagram for processing, but if you use a browser such as Internet Explorer, then you can directly view the XML result as shown in Figure 14-4.

Figure 14-4 XML Result From XSQL Page (AvailableFlightsToday.xsql) Query

This graphic is described in the following text.
Description of "Figure 14-4 XML Result From XSQL Page (AvailableFlightsToday.xsql) Query"

Transforming XML Datagrams into an Alternative XML Format

If the canonical <ROWSET> and <ROW> XML output from Figure 14-4 is not the XML format you need, then you can associate an XSLT stylesheet with your XSQL page. The stylesheet can transform the XML datagram in the server before returning the data.

When exchanging data with another program, you typically agree on a DTD that describes the XML format for the exchange. Assume that you are given the flight-list.dtd definition and are told to produce your list of arriving flights in a format compliant with the DTD. You can use a visual tool such as XML Authority to browse the structure of the flight-list DTD, as shown in Figure 14-5.

Figure 14-5 Exploring flight-list.dtd with XML Authority

This graphic is described in the following text.
Description of "Figure 14-5 Exploring flight-list.dtd with XML Authority"

Figure 14-5 shows that the standard XML formats for flight lists are as follows:

<flight-list> element, which contains one or more <flight> elements

<flight> elements, which have attributes airline and number, and each of which contains an <arrives> element

<arrives> elements, which contains text

Example 14-13 shows the XSLT stylesheet flight-list.xsl. By associating the stylesheet with the XSQL page, you can change the default <ROWSET> and <ROW> format into the industry-standard <flight-list> and <flight>.

Example 14-13 flight-list.xsl

<!-- XSLT Stylesheet to transform ROWSET/ROW results into flight-list format
 -->
<flight-list xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
               xsl:version="1.0">
  <xsl:for-each select="ROWSET/ROW">
      <flight airline="{CARRIER}" number="{FLIGHTNUMBER}">
        <arrives><xsl:value-of select="DUE"/></arrives>
      </flight>
  </xsl:for-each>
</flight-list>

The XSLT stylesheet is a template that includes the literal elements that you want to produce in the resulting document, such as <flight-list>, <flight>, and <arrives>, interspersed with XSLT actions that enable you to do the following:

Loop over matching elements in the source document with <xsl:for-each>

Plug in the values of source document elements where necessary with <xsl:value-of>

Plug in the values of source document elements into attribute values with the {some_parameter} notation

The following items have been added to the top-level <flight-list> element in the Example 14-13 stylesheet:

xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

This attribute defines the XML Namespace named xsl and identifies the URL string that uniquely identifies the XSLT specification. Although it looks just like a URL, think of the string http://www.w3.org/1999/XSL/Transform as the "global primary key" for the set of elements defined in the XSLT 1.0 specification. When the namespace is defined, you can use the <xsl:XXX> action elements in the stylesheet to loop and plug values in where necessary.

xsl:version="1.0"

This attribute identifies the document as an XSLT 1.0 stylesheet. A version attribute is required on all XSLT stylesheets for them to be valid and recognized by an XSLT processor.

You can associate the flight-list.xsl stylesheet with the AvailableFlightsToday.xsql in Example 14-3 by adding an <?xml-stylesheet?> instruction to the top of the page. Example 14-14 illustrates this technique.

Example 14-14 flight-list.xsl

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="flight-list.xsl"?>
<xsql:query connection="demo" bind-params="City" xmlns:xsql="urn:oracle-xsql">
    SELECT Carrier, FlightNumber, Origin, TO_CHAR(ExpectedTime,'HH24:MI') AS Due
      FROM FlightSchedule
     WHERE TRUNC(ExpectedTime) = TRUNC(SYSDATE) AND Arrived = 'N'
       AND Destination = ?   /* The ? is a bind variable being bound */
      ORDER BY ExpectedTime  /* to the value of the City parameter   */
</xsql:query>

Associating an XSLT stylesheet with the XSQL page causes the requesting program or browser to view the XML in the format as specified by flight-list.dtd you were given. Figure 14-6 illustrates a sample browser display.

Figure 14-6 XSQL Page Results in XML Format

This graphic is described in the preceding text.
Description of "Figure 14-6 XSQL Page Results in XML Format"

Transforming XML Datagrams into HTML for Display

To return the same XML data in HTML instead of an alternative XML format, use a different XSLT stylesheet. For example, rather than producing elements such as <flight-list> and <flight>, you can write a stylesheet that produces HTML elements such as <table>, <tr>, and <td>. The result of the dynamically queried data then looks like the HTML page shown in Figure 14-7. Instead of returning raw XML data, the XSQL page leverages server-side XSLT transformation to format the information as HTML for delivery to the browser.

Figure 14-7 Using an XSLT Stylesheet to Render HTML

This graphic is described in the following text.
Description of "Figure 14-7 Using an XSLT Stylesheet to Render HTML"

Similar to the syntax of the flight-list.xsl stylesheet, the flight-display.xsl stylesheet shown in Example 14-15 looks like a template HTML page. It contains <xsl:for-each>, <xsl:value-of>, and attribute value templates such as {DUE} to plug in the dynamic values from the underlying <ROWSET> and <ROW> structured XML query results.

Example 14-15 flight-display.xsl

<!-- XSLT Stylesheet to transform ROWSET/ROW results into HTML -->
<html xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xsl:version="1.0">
  <head><link rel="stylesheet" type="text/css" href="flights.css" /></head>
  <body>
    <center><table border="0">
      <tr><th>Flight</th><th>Arrives</th></tr>
      <xsl:for-each select="ROWSET/ROW">
        <tr>
          <td>
            <table border="0" cellspacing="0" cellpadding="4">
              <tr>
                <td><img align="absmiddle" src="images/{CARRIER}.gif"/></td>
                <td width="180">
                  <xsl:value-of select="CARRIER"/>
                  <xsl:text> </xsl:text>
                  <xsl:value-of select="FLIGHTNUMBER"/>
                </td>
              </tr>
            </table>
          </td>
          <td align="center"><xsl:value-of select="DUE"/></td>
        </tr>
      </xsl:for-each>
    </table></center>
  </body>
</html>

Note:

The stylesheet produces well-formed HTML. Each opening tag is properly closed (for example, <td>…</td>); empty tags use the XML empty element syntax <br/> instead of just <br>.

You can achieve useful results quickly by combining the power of the following:

Parameterized SQL statements to select information from the Oracle database

Industry-standard XML as a portable, interim data exchange format

XSLT to transform XML-based datagrams into any XML- or HTML-based format

Using XSQL in Java Programs

The oracle.xml.xsql.XSQLRequest class enables you to use the XSQL page processor in your Java programs. To use the XSQL Java API, follow these basic steps:

Construct an instance of XSQLRequest, passing the XSQL page to be processed into the constructor as one of the following:

String containing a URL to the page

URL object for the page

In-memory XMLDocument

Invoke one of the following methods on the object to process the page:

process() to write the result to a PrintWriter or OutputStream

processToXML() to return the result as an XML Document

If you want to use the built-in XSQL connection manager, which implements JDBC connection pooling based on XSQL configuration file definitions, then the XSQL page is all you need to pass to the constructor. Optionally, you can pass in a custom implementation for the XSQLConnectionManagerFactory interface as well.

The ability to pass the XSQL page as an in-memory XMLDocument object means that you can dynamically generate any valid XSQL page for processing. You can then pass the page to the XSQL engine for evaluation.

When processing a page, you may want to perform the following additional tasks as part of the request:

Pass a set of parameters to the request.

You accomplish this aim by passing any object that implements the Dictionary interface to the process() or processToXML() methods. Passing a HashTable containing the parameters is one popular approach.

Set an XML document to be processed by the page as if it were the "posted XML" message body.

You can do this by using the XSQLResquest.setPostedDocument() method.

Example 14-16 shows how you can process a page by using XSQLRequest.

Example 14-16 XSQLRequestSample Class

import oracle.xml.xsql.XSQLRequest;
import java.util.Hashtable;
import java.io.PrintWriter;
import java.net.URL;
public class XSQLRequestSample {
  public static void main( String[] args) throws Exception {
     // Construct the URL of the XSQL Page
   URL pageUrl = new URL("file:///C:/foo/bar.xsql");
   // Construct a new XSQL Page request
   XSQLRequest req = new XSQLRequest(pageUrl);
   // Set up a Hashtable of named parameters to pass to the request
   Hashtable params = new Hashtable(3);
   params.put("param1","value1");
   params.put("param2","value2");
   /* If needed, treat an existing, in-memory XMLDocument as if
   ** it were posted to the XSQL Page as part of the request
   req.setPostedDocument(myXMLDocument);
   **
   */
   // Process the page, passing the parameters and writing the output
   // to standard out.
   req.process(params,new PrintWriter(System.out),
                      new PrintWriter(System.err));
  }
}

See Also:

Chapter 15, "Using the XSQL Pages Publishing Framework: Advanced Topics" to learn more about the XSQL Java API

XSQL Pages Tips and Techniques

This section contains the following topics:

XSQL Pages Limitations

Hints for Using the XSQL Servlet

Resolving Common XSQL Connection Errors

Security Considerations for XSQL Pages

XSQL Pages Limitations

HTTP parameters with multibyte names, for example, a parameter whose name is in Kanji, are properly handled when they are inserted into your XSQL page with the <xsql:include-request-params> element. An attempt to refer to a parameter with a multibyte name inside the query statement of an <xsql:query> tag returns an empty string for the parameter value.

As a workaround use a nonmultibyte parameter name. The parameter can still have a multibyte value that can be handled correctly.

Hints for Using the XSQL Servlet

This section lists the following XSQL Servlet hints:

Specifying a DTD While Transforming XSQL Output to a WML Document

Testing Conditions in XSQL Pages

Passing a Query Result to the WHERE Clause of Another Query

Handling Multi-Valued HTML Form Parameters

Invoking PL/SQL Wrapper Procedures to Generate XML Datagrams

Accessing Contents of Posted XML

Changing Database Connections Dynamically

Retrieving the Name of the Current XSQL Page

Specifying a DTD While Transforming XSQL Output to a WML Document

You can specify a DTD while transforming XSQL output to a WML document for a wireless application. The technique is to use a built-in facility of the XSLT stylesheet called <xsl:output>. The following example illustrates this technique:

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output type="xml" doctype-system="your.dtd"/>
  <xsl:template match="/">
  </xsl:template>
    ...
</xsl:stylesheet>

The preceding stylesheet produces an XML result that includes the following code, where "your.dtd" can be any valid absolute or relative URL.:

<!DOCTYPE xxxx SYSTEM "your.dtd">

Testing Conditions in XSQL Pages

You can include if-then logic in your XSQL pages. Example 14-17 illustrates a technique for executing a query based on a test of a parameter value.

Example 14-17 Conditional Statements in XSQL Pages

<xsql:if-param name="security" equals="admin">
  <xsql:query>
      SELECT ....
  </xsql:query>
</xsq:when>
<xsql:if-param name="security" equals="user">
  <xsql:query>
      SELECT ....
  </xsql:query>
</xsql:if-param>

See Also:

Chapter 30, "XSQL Pages Reference" to learn about the <xsql:if-param> action

Passing a Query Result to the WHERE Clause of Another Query

If you have two queries in an XSQL page, then you can use the value of a select list item of the first query in the second query by using page parameters. Example 14-18 illustrates this technique.

Example 14-18 Passing Values Among SQL Queries

<page xmlns:xsql="urn:oracle-xsql" connection="demo">
  <!-- Value of page param "xxx" will be first column of first row -->
  <xsql:set-page-param name="xxx">
    SELECT one FROM table1 WHERE ...
  </xsl:set-param-param>
  <xsql:query bind-params="xxx">
    SELECT col3,col4 FROM table2
    WHERE col3 = ?
  </xsql:query>
</page>

Handling Multi-Valued HTML Form Parameters

In some situations you may need to process multi-valued HTML <form> parameters that are needed for <input name="choices" type="checkbox">. Use the parameter array notation on your parameter name (for example, choices[]) to refer to the array of values from the selected check boxes.

Assume that you have a multi-valued parameter named guy. You can use the array parameter notation in an XSQL page as shown in Example 14-19.

Example 14-19 Handling Multi-Valued Parameters

<page xmlns:xsql="urn:oracle-xsql">
  <xsql:set-page-param name="guy-list" value="{@guy[]}"
                       treat-list-as-array="yes"/>
  <xsql:set-page-param name="quoted-guys" value="{@guy[]}"
                       treat-list-as-array="yes" quote-array-values="yes"/>
  <xsql:include-param name="guy-list"/>
  <xsql:include-param name="quoted-guys"/>
  <xsql:include-param name="guy[]"/>
</page>

Assume that you request this page is requested with the following URL, which contains multiple parameters of the same name to produce a multi-valued attribute:

http://yourserver.com/page.xsql?guy=Curly&guy=Larry&guy=Moe

The page returned looks like the following:

<page>
  <guy-list>Curly,Larry,Moe</guy-list>
  <quoted-guys>'Curly','Larry','Moe'</quoted-guys>
  <guy>
    <value>Curly</value>
    <value>Larry</value>
    <value>Moe</value>
  </guy>
</page>

You can also use the value of a multi-valued page parameter in a SQL statement WHERE clause by using the code shown in Example 14-20.

Example 14-20 Using Multi-Valued Page Parameters in a SQL Statement

<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:set-page-param name="quoted-guys" value="{@guy[]}"
                       treat-list-as-array="yes"
                       quote-array-values="yes"/>
  <xsql:query>
    SELECT *
    FROM   sometable
    WHERE  name IN ({@quoted-guys})
  </xsql:query>
</page>

Invoking PL/SQL Wrapper Procedures to Generate XML Datagrams

You cannot set parameter values by binding them in the position of OUT variables with <xsql:dml>. Only IN parameters are supported for binding. You can create a wrapper procedure, however, that constructs XML elements with the HTTP package. Your XSQL page can then invoke the wrapper procedure with <xsql:include-owa>.

Example 14-21 shows a PL/SQL procedure that accepts two IN parameters, multiplies them and puts the value in one OUT parameter, then adds them and puts the result in a second OUT parameter.

Example 14-21 addmult PL/SQL Procedure

CREATE OR REPLACE PROCEDURE addmult(arg1        NUMBER, arg2        NUMBER,
                                    sumval  OUT NUMBER, prodval OUT NUMBER)
IS
BEGIN
  sumval := arg1 + arg2;
  prodval := arg1 * arg2;
END;

You can write the PL/SQL procedure in Example 14-22 to wrap the procedure in Example 14-21. The addmultwrapper procedure accepts the IN arguments that the addmult procedure preceding expects, and then encodes the OUT values as an XML datagram that you print to the OWA page buffer.

Example 14-22 addmultwrapper PL/SQL Procedure

CREATE OR REPLACE PROCEDURE addmultwrapper(arg1 NUMBER, arg2 NUMBER)
IS
  sumval  NUMBER;
  prodval NUMBER;
  xml     VARCHAR2(2000);
BEGIN
  -- Call the procedure with OUT values
  addmult(arg1,arg2,sumval,prodval);
  -- Then produce XML that encodes the OUT values
  xml := '<addmult>'||
         '<sum>'||sumval||'</sum>'||
         '<product>'||prodval||'</product>'||
         '</addmult>';
  -- Print the XML result to the OWA page buffer for return
  HTP.P(xml);
END;

The XSQL page shown in Example 14-23 constructs an XML document by including a call to the PL/SQL wrapper procedure.

Example 14-23 addmult.xsql

<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:include-owa bind-params="arg1 arg2">
    BEGIN addmultwrapper(?,?); END;
  </xsql:include-owa>
</page>

Suppose that you invoke addmult.xsql by entering a URL in a browser as follows:

http://yourserver.com/addmult.xsql?arg1=30&arg2=45

The XML datagram returned by the servlet reflects the OUT values as follows:

<page>
  <addmult><sum>75</sum><product>1350</product></addmult>
</page>

Accessing Contents of Posted XML

The XSQL page processor can access the contents of posted XML. Any XML document can be posted and handled by the feature that XSQL supports.

For example, an XSQL page can access the contents of an inbound SOAP message by using the xpath="XpathExpression" attribute in the <xsql:set-page-param> action. Alternatively, custom action handlers can gain direct access to the SOAP message body by calling getPageRequest().getPostedDocument(). To create the SOAP response body to return to the client, use an XSLT stylesheet or a custom serializer implementation to write the XML response in an appropriate SOAP-encoded format.

See Also:

The Airport SOAP demo for an example of using an XSQL page to implement a SOAP-based Web Service

Changing Database Connections Dynamically

Suppose that you want to choose database connections dynamically when invoking an XSQL page. For example, you may want to switch between a test database and a production database.You can achieve this goal by including an XSQL parameter in the connection attribute of the XSQL page. Make sure to define an attribute of the same name to serve as the default value for the connection name.

Assume that in your XSQL configuration file you define connections for database testdb and proddb. You then write an XSQL page with the following <xsql:query> element:

<xsql:query conn="testdb" connection="{@conn}" xmlns:xsql="urn:oracle-xsql">
  ...
</xsql:query>

If you request this page without any parameters, then the value of the conn parameter is testdb, so the page uses the connection named testdb defined in the XSQL configuration file. If you request the page with conn=proddb, then the page uses the connection named proddb instead.

Retrieving the Name of the Current XSQL Page

An XSQL page can access its own name in a generic way at runtime in order to construct links to the current page. You can use a helper method like the one shown in Example 14-24 to retrieve the name of the page inside a custom action handler.

Example 14-24 Obtaining the Name of the Current XSQL Page

private String curPageName(XSQLPageRequest req) {
  String thisPage = req.getSourceDocumentURI();;
  int pos = thisPage.lastIndexOf('/');
  if (pos >=0) thisPage = thisPage.substring(pos+1);
  pos = thisPage.indexOf('?');
  if (pos >=0) thisPage = thisPage.substring(0,pos-1);
  return thisPage;
}

Resolving Common XSQL Connection Errors

This section contains tips for responding to XSQL errors:

Receiving "Unable to Connect" Errors

Receiving "No Posted Document to Process" When Using HTTP POST

Receiving "Unable to Connect" Errors

Suppose that you are unable to connect to a database and errors similar to the following when running the helloworld.xsql sample program:

Oracle XSQL Servlet Page Processor
XSQL-007: Cannot acquire a database connection to process page.
Connection refused(DESCRIPTION=(TMP=)(VSNNUM=135286784)(ERR=12505)
(ERROR_STACK=(ERROR=(CODE=12505)(EMFI=4))))

The preceding errors indicate that the XSQL servlet is attempting the JDBC connection based on the <connectiondef> information for the connection named demo, assuming you did not modify the helloworld.xsql demo page.

By default the XSQLConfig.xml file comes with the entry for the demo connection that looks like the following (use the correct password):

<connection name="demo">
  <username>scott</username>
  <password>password</password>
  <dburl>jdbc:oracle:thin:@localhost:1521:ORCL</dburl>
  <driver>oracle.jdbc.driver.OracleDriver</driver>
</connection>

The error is probably due to one of the following reasons:

Your database is not on the localhost machine.

Your database SID is not ORCL.

Your TNS Listener Port is not 1521.

Receiving "No Posted Document to Process" When Using HTTP POST

When trying to post XML information to an XSQL page for processing, it must be sent by the HTTP POST method. This transfer can be effected by an HTML form or an XML document sent by HTTP POST. If you try to use HTTP GET instead, then there is no posted document, and hence you get the "No posted document to process" error. Use HTTP POST instead to cause the correct behavior.

Security Considerations for XSQL Pages

This section describes best practices for managing security in the XSQL servlet:

Installing Your XSQL Configuration File in a Safe Directory

Disabling Default Client Stylesheet Overrides

Protecting Against the Misuse of Substitution Parameters

Installing Your XSQL Configuration File in a Safe Directory

The XSQLConfig.xml configuration file contains sensitive database username and password information. This file should not reside in any directory that maps to a virtual path of your Web server, nor in any of its subdirectories. The only required permissions for the configuration file are read permission granted to the UNIX account that owns the servlet engine. Failure to follow this recommendation could mean that a user of your site could browse the contents of your configuration file, thereby obtaining the passwords to database accounts.

Disabling Default Client Stylesheet Overrides

By default, the XSQL page processor enables the user to supply a stylesheet in the page request by passing a value for the special xml-stylesheet parameter. If you want the stylesheet referenced by the server-side XSQL page to be the only legal stylesheet, then include the allow-client-style="no" attribute on the document element of your page. You can also globally change the default setting in the XSQLConfig.xml file to disallow client stylesheet overrides. If you take either approach, then the only pages that allow client stylesheet overrides are those that include the allow-client-style="yes" attribute on their document element.

Protecting Against the Misuse of Substitution Parameters

Any product that supports the use of lexical substitution variables in a SQL query can cause a developer problems. Any time you deploy an XSQL page that allows part of all of a SQL statement to be substituted by a lexical parameter, you must make sure that you have taken appropriate precautions against misuse.

For example, one of the demonstrations that comes with XSQL Pages is the Adhoc Query Demo. It illustrates how you can supply the entire SQL statement of an <xsql:query> action handler as a parameter. This technique is a powerful and beneficial tool when in the right hands, but if you deploy a similar page to your production system, then the user can execute any query that the database security privileges for the connection associated with the page allows. For example, the Adhoc Query Demo is set up to use a connection that maps to the scott account, so a user can query any data that scott would be allowed to query from SQL*Plus.

You can use the following techniques to make sure your pages are not abused:

Make sure the database user account associated with the page has only the privileges for reading the tables and views you want your users to see.

Use true bind variables instead of lexical bind variables when substituting single values in a SELECT statement. If you need to parameterize syntactic parts of your SQL statement, then lexical parameters are the only way to proceed. Otherwise, you should use true bind variables so that any attempt to pass an invalid value generates an error instead of producing an unexpected result.

15 Using the XSQL Pages Publishing Framework: Advanced Topics

This chapter discusses the following XSQL pages advanced topics:

Customizing the XSQL Configuration File Name

Controlling How Stylesheets Are Processed

Working with Array-Valued Parameters

Setting Error Parameters on Built-in Actions

Including XMLType Query Results in XSQL Pages

Handling Posted XML Content

Producing PDF Output with the FOP Serializer

Performing XSQL Customizations

Customizing the XSQL Configuration File Name

By default, the XSQL pages framework expects the configuration file to be named XSQLConfig.xml. When moving between development, test, and production environments, you can switch between different versions of an XSQL configuration file. To override the name of the configuration file read by the XSQL page processor, set the Java system property xsql.config.

The simplest technique is to specify a Java VM command-line flag such as -Dxsql.config=MyConfigFile.xml by defining a servlet initialization parameter named xsql.config. Add an <init-param> element to your web.xml file as part of the <servlet> tag that defines the XSQL Servlet as follows:

<servlet>
  <servlet-name>XSQL</servlet-name>
  <servlet-class>oracle.xml.xsql.XSQLServlet</servlet-class>
  <init-param>
    <param-name>xsql.config</param-name>
    <param-value>MyConfigFile.xml</param-value>
    <description>
       Please Use MyConfigFile.xml instead of XSQLConfig.xml
    </description>
  </init-param>
</servlet>

The servlet initialization parameter is only applicable to the servlet-based use of the XSQL engine. When using the XSQLCommandLine or XSQLRequest programmatic interfaces, use the System parameter instead.

Note:

The configuration file is always read from the CLASSPATH. For example, if you specify a custom configuration parameter file named MyConfigFile.xml, then the XSQL processor attempts to read the XML file as a resource from the CLASSPATH. In a J2EE-style servlet environment, you must place your MyConfigFile.xml in the .\WEB-INF\classes directory (or some other top-level directory that will be found on the CLASSPATH). If both the servlet initialization parameter and the System parameter are provided, then the servlet initialization parameter value is used.

Controlling How Stylesheets Are Processed

This section contains the following topics:

Overriding Client Stylesheets

Controlling the Content Type of the Returned Document

Assigning the Stylesheet Dynamically

Processing XSLT Stylesheets in the Client

Providing Multiple Stylesheets

Overriding Client Stylesheets

If the current XSQL page being requested allows it, then you can supply an XSLT stylesheet URL in the request. This technique enables you to either override the default stylesheet or apply a stylesheet where none is applied by default. The client-initiated stylesheet URL is provided by supplying the xml-stylesheet parameter as part of the request. The valid values for this parameter are the following:

Any relative URL interpreted relative to the XSQL page being processed.

Any absolute URL that uses the HTTP protocol scheme, provided it references a trusted host as defined in the XSQL configuration file.

The literal value none. Setting xml-stylesheet=none is useful during development to temporarily "short-circuit" the XSLT stylesheet processing to determine what XML datagram your stylesheet is seeing. Use this technique to determine why a stylesheet is not producing expected results.

You can allow client override of stylesheets for an XSQL page in the following ways:

Setting the allow-client-style configuration parameter to no in the XSQL configuration file

Explicitly including an allow-client-style="no" attribute on the document element of any XSQL page

If client-override of stylesheets has been globally disabled by default in the XSQL configuration file, any page can still enable client-override explicitly by including an allow-client-style="yes" attribute on the document element of that page.

Controlling the Content Type of the Returned Document

Setting the content type of the data that you serve enables the requesting client to correctly interpret the data that you return. If your stylesheet uses an <xsl:output> element, then the XSQL processor infers the media type and encoding of the returned document from the media-type and encoding attributes of <xsl:output>.

The stylesheet in Example 15-1 uses the media-type="application/vnd.ms-excel" attribute on <xsl:output>. This instruction transforms the results of an XSQL page containing a standard query of the hr.employees table into Microsoft Excel format.

Example 15-1 empToExcel.xsl

<?xml version="1.0"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output method="html" media-type="application/vnd.ms-excel"/>
  <xsl:template match="/">
   <html>
     <table>
       <tr><th>Id</th><th>Email</th><th>Salary</th></tr>
       <xsl:for-each select="ROWSET/ROW">
         <tr>
           <td><xsl:value-of select="EMPLOYEE_ID"/></td>
           <td><xsl:value-of select="EMAIL"/></td>
           <td><xsl:value-of select="SALARY"/></td>
         </tr>
       </xsl:for-each>
     </table>
   </html>
  </xsl:template>
</xsl:stylesheet>

The following XSQL page makes use of the stylesheet in Example 15-1:

<?xml version="1.0"?>
<?xml-stylesheet href="empToExcel.xsl" type="text/xsl"?>
<xsql:query connection="hr" xmlns:xsql="urn:oracle-xsql">
  SELECT   employee_id, email, salary
  FROM     employees
  ORDER BY salary DESC
</xsql:query>

Assigning the Stylesheet Dynamically

If you include an <?xml-stylesheet?> instruction at the top of your .xsql file, then the XSQL page processor considers it for use in transforming the resulting XML datagram. Consider the emp_test.xsql page shown in Example 15-2.

Example 15-2 emp_test.xsql

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="emp.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:query>
    SELECT   *
    FROM     employees
    ORDER BY salary DESC
  </xsql:query>
</page>

The page in Example 15-2 uses the emp.xsl stylesheet to transform the results of the employees query in the server tier before returning the response to the requestor. The processor accesses the stylesheet by the URL provided in the href pseudo-attribute on the <?xml-stylesheet?> processing instruction.

Suppose that you want to change XSLT stylesheets dynamically based on arguments passed to the XSQL servlet. You can achieve this goal by using a lexical parameter in the href attribute of your xml-stylesheet processing instruction, as shown in the following sample instruction:

<?xml-stylesheet type="text/xsl" href="{@filename}.xsl"?>

You can then pass the value of the filename parameter as part of the URL request to XSQL servlet.

You can also use the <xsql:set-page-param> element in an XSQL page to set the value of the parameter based on a SQL query. For example, the XSQL page in Example 15-3 selects the name of the stylesheet to use from a table by assigning the value of a page-private parameter.

Example 15-3 emp_test_dynamic.xsql

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="{@sheet}.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:set-page-param bind-params="UserCookie" name="sheet">
    SELECT stylesheet_name
    FROM   user_prefs
    WHERE  username = ?
  </xsql:set-page-param>
  <xsql:query>
    SELECT   *
    FROM     employees
    ORDER BY salary DESC
  </xsql:query>
</page>

Processing XSLT Stylesheets in the Client

Some browsers support processing XSLT stylesheets in the client. These browsers recognize the stylesheet to be processed for an XML document by using an <?xml-stylesheet?> processing instruction. The use of <?xml-stylesheet?> for this purpose is part of the W3C Recommendation from June 29, 1999 entitled "Associating Stylesheets with XML Documents, Version 1.0".

By default, the XSQL pages processor performs XSLT transformations in the server. By adding client="yes" to your <?xml-stylesheet?> processing instruction in your XSQL page, however, you can defer XSLT processing to the client. The processor serves the XML datagram "raw" with the current <?xml-stylesheet?> element at the top of the document.

Providing Multiple Stylesheets

You can include multiple <?xml-stylesheet?> processing instructions at the top of an XSQL page. The instructions can contain an optional media pseudo-attribute. If specified, the processor case-insensitively compares the value of the media pseudo-attribute with the value of the User-Agent string in the HTTP header. If the value of the media pseudo-attribute matches part of the User-Agent string, then the processor selects the current <?xml-stylesheet?> instruction for use. Otherwise, the processor ignores the instruction and continues looking. The processor uses the first matching processing instruction in document order. An instruction without a media pseudo-attribute matches all user agents.

Example 15-4 shows multiple processing instructions at the top of an XSQL file. The processor uses doyouxml-lynx.xsl for Lynx browsers, doyouxml-ie.xsl for Internet Explorer 5.0 or 5.5 browsers, and doyouxml.xsl for all others.

Example 15-4 Multiple <?xml-stylesheet ?> Processing Instructions

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" media="lynx" href="doyouxml-lynx.xsl" ?>
<?xml-stylesheet type="text/xsl" media="msie 5" href="doyouxml-ie.xsl" ?>
<?xml-stylesheet type="text/xsl" href="doyouxml.xsl" ?>
<page xmlns:xsql="urn:oracle-xsql" connection="demo">

Table 15-1 summarizes the supported pseudo-attributes allowed on the <?xml-stylesheet?> processing instruction.

Table 15-1 Pseudo-Attributes for <?xml-stylesheet ?>

Attribute Name
Description

type = "string"

Indicates the MIME type of the associated stylesheet. For XSLT stylesheets, this attribute must be set to the string text/xsl.

This attribute may be present or absent when using the serializer attribute, depending on whether an XSLT stylesheet has to execute before invoking the serializer, or not.

href = "URL"

Indicates the relative or absolute URL to the XSLT stylesheet to be used. If an absolute URL is supplied that uses the http protocol scheme, the IP address of the resource must be a trusted host listed in the XSQL configuration file (by default, named XSQLConfig.xml).

media = "string"

Performs a case-insensitive match on the User-Agent string from the HTTP header sent by the requesting device. This attribute is optional. The current <?xml-stylesheet?> processing instruction is used only if the User-Agent string contains the value of the media attribute; otherwise it is ignored.

client = "boolean"

Defers the processing of the associated XSLT stylesheet to the client if set to yes. The raw XML datagram is sent to the client with the current <?xml-stylesheet?> instruction at the top of the document. The default if not specified is to perform the transformation in the server.

serializer = "string"

By default, the XSQL page processor uses the following:

XML DOM serializer if no XSLT stylesheet is used

XSLT processor serializer if an XSLT stylesheet is used

Specifying this pseudo-attribute indicates that a custom serializer implementation must be used instead.

Valid values are either the name of a custom serializer defined in the <serializerdefs> section of the XSQL configuration file or the string java:fully.qualified.Classname. If both an XSLT stylesheet and the serializer attribute are present, then the processor performs the XSLT transformation first, then invokes the custom serializer to render the final result to the OutputStream or PrintWriter.

Working with Array-Valued Parameters

This section contains the following topics:

Supplying Values for Array-Valued Parameters

Setting Array-Valued Page or Session Parameters from Strings

Binding Array-Valued Parameters in SQL and PL/SQL Statements

Supplying Values for Array-Valued Parameters

Request parameters, session parameters, and page-private parameters can have arrays of strings as values. To treat to the value of a parameter as an array, add two empty square brackets to the end of its name. For example, if an HTML form is posted with four occurrences of a input control named productid, then use the notation productid[] to refer to the array-valued productid parameter. If you refer to an array-valued parameter without using the array-brackets notation, then the XSQL processor uses the value of the first array entry.

Note:

The XSQL processor does not support use of numbers inside the array brackets. That is, you can refer to productid or productid[], but not productid[2].

Suppose that you refer to an array-valued parameter as a lexical substitution parameter inside an action handler attribute value or inside the content of an action handler element. The XSQL page processor converts its value to a comma-delimited list of non-null and non-empty strings in the order that they exist in the array. Example 15-5 shows an XSQL page with an array-valued parameter.

Example 15-5 Using an Array-Valued Parameter in an XSQL Page

<page xmlns:xsql="urn:oracle-xsql">
  <xsql:query>
    SELECT description
    FROM product
    WHERE productid in ( {@productid[]} )  /* Using lexical parameter */
  </xsql:query>
</page>

You can invoke the XSQL command-line utility to supply multiple values for the productid parameter in Page.xsql as follows:

xsql Page.xsql productid=111 productid=222 productid=333 productid=444

The preceding command sets the productid[] array-valued parameter to the value {"111","222","333","444"}. The XSQL page processor replaces the {@productid[]} expression in the query with the string "111,222,333,444".

Note that you can also pass multi-valued parameters programmatically through the XSQLRequest API, which accepts a java.util.Dictionary of named parameters. You can use a Hashtable and call its put(name,value) method to add String-valued parameters to the request. To add multi-valued parameters, put a value of type String[] instead of type String.

Note:

Only request parameters, page-private parameters, and session parameters can use string arrays. The <xsql:set-stylesheet-param> and <xsql:set-cookie> actions only support working with parameters as simple string values. To refer to a multi-valued parameter in your XSLT stylesheet, use <xsql:include-param> to include the multi-valued parameter into your XSQL datapage, then use an XPath expression in the stylesheet to refer to the values from the datapage.

Setting Array-Valued Page or Session Parameters from Strings

You can set the value of a page-private parameter or session parameter to a string-array value by using the array brackets notation on the name as follows:

<!-- param name contains array brackets -->
<xsql:set-page-param name="names[]" value="Tom Jane Joe"/>

You set the value similarly for session parameters, as shown in the following example:

<xsql:set-session-param name="dates[]" value="12-APR-1962 15-JUL-1968"/>

By default, when the name of the parameter uses array brackets, the XSQL processor treats the value as a space-or-comma-delimited list and tokenizes it.

The resulting string array value contains these separate tokens. In the preceding examples, the names[] parameter is the string array {"Tom", "Jane", "Joe"} and the dates[] parameter is the string array {"12-APR-1962", "15-JUL-1968"}.

To handle strings that contain spaces, the tokenization algorithm first checks the string for the presence of commas. If at least one comma is found in the string, then commas are used as the token delimiter. For example, the following action sets the value of the names[] parameter to the string array {"Tom Jones", "Jane York"}:

<!-- param name contains array brackets -->
<xsql:set-page-param name="names[]" value="Tom Jones,Jane York"/>

By default, when you set a parameter whose name does not end with the array-brackets, then the string-tokenization does not occur. Thus, the following action sets the parameter names to the literal string "Tom Jones,Jane York":

<!-- param name does NOT contain array brackets -->
<xsql:set-page-param name="names" value="Tom Jones,Jane York"/>

You can force the string to be tokenized by including the treat-list-as-array="yes" attribute on the <xsql:set-page-param> or <xsql:set-session-param> actions. When this attribute is set, the XSQL processor assigns a comma-delimited string of the tokenized values to the parameter. For example, the following action sets the names parameter to the literal string "Tom,Jane,Joe":

<!-- param name does NOT contain array brackets -->
<xsql:set-page-param name="names" value="Tom Jane Joe"
                     treat-list-as-array="yes"/>

When you are setting the value of a simple string-valued parameter and you are tokenizing the value with treat-list-as-array="yes", you can include the quote-array-values="yes" attribute to surround the comma-delimited values with single-quotes. Thus, the following action assigns the literal string value "'Tom Jones','Jane York','Jimmy'" to the names parameter:

<!--  param name does NOT contain array brackets -->
<xsql:set-page-param name="names" value="Tom Jones,Jane York,Jimmy"
                     treat-list-as-array="yes"
                     quote-array-values="yes"/>

Binding Array-Valued Parameters in SQL and PL/SQL Statements

Where string-valued scalar bind variables are supported in an XSQL page, you can also bind array-valued parameters. Use the array parameter name, for example, myparam[], in the list of parameter names that you supply for the bind-params attribute. This technique enables you to process array-valued parameters in SQL statements and PL/SQL procedures.

The XSQL processor binds array-valued parameters as a nested table object type named XSQL_TABLE_OF_VARCHAR. You must create this type in your current schema with the following DDL statement:

CREATE TYPE xsql_table_of_varchar AS TABLE OF VARCHAR2(2000);

Although the type must have the name xsql_table_of_varchar, you can change the dimension of the VARCHAR2 string if desired. Of course, you have to make it as long as any string value you expect to handle in your array-valued string parameters.

Consider the PL/SQL function shown in Example 15-6.

Example 15-6 testTableFunction

FUNCTION testTableFunction(p_name  XSQL_TABLE_OF_VARCHAR,
                           p_value XSQL_TABLE_OF_VARCHAR)
RETURN VARCHAR2 IS
  lv_ret     VARCHAR2(4000);
  lv_numElts INTEGER;
BEGIN
  IF p_name IS NOT NULL THEN
    lv_numElts := p_name.COUNT;
    FOR j IN 1..lv_numElts LOOP
      IF (j > 1) THEN
        lv_ret := lv_ret||':';
      END IF;
      lv_ret := lv_ret||p_name(j)||'='||p_value(j);
    END LOOP;
  END IF;
  RETURN lv_ret;
END;

The XSQL page in Example 15-7 shows how to bind two array-valued parameters in a SQL statement that uses testTableFunction.

Example 15-7 XSQL Page with Array-Valued Parameters

<page xmlns:xsql="urn:oracle-xsql" connection="demo"
      someNames="aa,bb,cc" someValues="11,22,33">
  <xsql:query bind-params="someNames[] someValues[]">
    SELECT testTableFunction(?,?) AS example
    FROM dual
  </xsql:query>
</page>

Executing the XSQL page in Example 15-7 generates the following datagram:

<page someNames="aa,bb,cc" someValues="11,22,33">
  <ROWSET>
    <ROW num="1">
      <EXAMPLE>aa=11:bb=22:cc=33</EXAMPLE>
    </ROW>
  </ROWSET>
</page>

This technique shows that the XSQL processor bound the array-valued someNames[] and someValues[] parameters as table collection types. It iterated over the values and concatenated them to produce the "aa=11:bb=22:cc=33" string value as the return value of the PL/SQL function.

You can mix any number of regular parameters and array-valued parameters in your bind-params string. Use the array-bracket notation for the parameters that you want to be bound as arrays.

Note:

If you run the page in Example 15-7 but you have not created the XSQL_TABLE_OF_VARCHAR type as illustrated earlier, then you receive an error such as the following:

<page someNames="aa,bb,cc" someValues="11,22,33">
  <xsql-error code="17074" action="xsql:query">
    <statement>
     select testTableFunction(?,?) as example from dual
    </statement>
    <message>
      invalid name pattern: SCOTT.XSQL_TABLE_OF_VARCHAR
    </message>
  </xsql-error>
</page>

Because the XSQL processor binds array parameters as nested table collection types, you can use the TABLE() operator with the CAST() operator in SQL to treat the nested table bind variable value as a table of values. You can then query this table. This technique is especially useful in subqueries. The page in Example 15-8 uses an array-valued parameter containing employee IDs to restrict the rows queried from hr.employees.

Example 15-8 Using an Array-Valued Parameter to Restrict Rows

<page xmlns:xsql="urn:oracle-xsql" connection="hr">
  <xsql:set-page-param name="someEmployees[]" value="196,197"/>
  <xsql:query bind-params="someEmployees[]">
    SELECT first_name||' '||last_name AS name, salary
    FROM employees
    WHERE employee_id IN (
        SELECT * FROM TABLE(CAST( ? AS xsql_table_of_varchar))
     )
   </xsql:query>
</page>

The XSQL page in Example 15-8 generates a datagram such as the following:

<page>
  <ROWSET>
    <ROW num="1">
      <NAME>Alana Walsh</NAME>
      <SALARY>3100</SALARY>
    </ROW>
    <ROW num="2">
      <NAME>Kevin Feeny</NAME>
      <SALARY>3000</SALARY>
    </ROW>
  </ROWSET>
</page>

Example 15-7 and Example 15-8 show how to use bind-params with <xsql:query>, but these techniques work for <xsql:dml>, <xsql:include-owa>, <xsql:ref-cursor-function>, and other actions that accept SQL or PL/SQL statements.

Note that PL/SQL index-by tables work with the OCI JDBC driver but not the JDBC thin driver. By using the nested table collection type XSQL_TABLE_OF_VARCHAR, you can use array-valued parameters with either driver. In this way you avoid losing the programming flexibility of working with array values in PL/SQL.

Setting Error Parameters on Built-in Actions

The XSQL page processor determines whether an action encountered a non-fatal error during its execution. For example, an attempt to insert a row or call a stored procedure can fail with a database exception that will get included in your XSQL data page as an <xsql-error> element.

You can set a page-private parameter in a built-in XSQL action when the action reports a nonfatal error. Use the error-param attribute on the action to enable this feature. For example, to set the parameter "dml-error" when the statement inside the <xsql:dml> action encounters a database error, you can use the technique shown in Example 15-9.

Example 15-9 Setting an Error Parameter

<xsql:dml error-param="dml-error" bind-params="val">
  INSERT INTO yourtable(somecol)
    VALUES(?)
</xsql:dml>

If the execution of the <xsql:dml> action encounters an error, then the XSQL processor sets the page-private parameter dml-error to the string "Error". If the execution is successful, then the XSQL processor does not assign a value to the error parameter. In Example 15-9, if the page-private parameter dml-error already exists, then it retains its current value. If it does not exist, then it continues not to exist.

Using Conditional Logic with Error Parameters

By using the error parameter in combination with <xsql:if-param>, you can achieve conditional behavior in your XSQL page template. For example, assume that your connection definition sets the AUTOCOMMIT flag to false on the connection named demo in the XSQL configuration file. The XSQL page shown in Example 15-10 illustrates how you might roll back the changes made by a previous action if a subsequent action encounters an error.

Example 15-10 Achieving Conditional Behavior with an Error Parameter

<!-- NOTE: Connection "demo" must not set to autocommit! -->
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:dml error-param="dml-error" bind-params="val">
    INSERT INTO yourtable(somecol)
      VALUES(?)
  </xsql:dml>
  <!-- This second statement will commit if it succeeds -->
  <xsql:dml commit="yes" error-param="dml-error" bind-params="val2">
    INSERT INTO anothertable(anothercol)
      VALUES(?)
  </xsql:dml>
  <xsql:if-param name="dml-error" exists="yes">
    <xsql:dml>
      ROLLBACK
    </xsql:dml>
  </xsql:if-param>
</page>

If you have written custom action handlers, and if your custom actions call reportMissingAttribute(), reportError(), or reportErrorIncludingStatement() to report non-fatal action errors, then they automatically pick up this feature as well.

Formatting XSQL Action Handler Errors

Errors raised by the processing of XSQL action elements are reported as XML elements in a uniform way. This fact enables XSLT stylesheets to detect their presence and optionally format them for presentation.

The action element in error is replaced in the page by the following element:

<xsql-error action="xxx">

Depending on the error the <xsql-error> element contains:

A nested <message> element

A <statement> element with the offending SQL statement

Example 15-11 shows an XSLT stylesheet that uses this information to display error information on the screen.

Example 15-11 XSLTStylesheet

<xsl:if test="//xsql-error">
     <table style="background:yellow">
        <xsl:for-each select="//xsql-error">
           <tr>
            <td><b>Action</b></td>
            <td><xsl:value-of select="@action"/></td>
            </tr>
            <tr valign="top">
            <td><b>Message</b></td>
            <td><xsl:value-of select="message"/></td>
           </tr>
          </xsl:for-each>
     </table>
</xsl:if>

Including XMLType Query Results in XSQL Pages

Oracle Database supports XMLType for storing and querying XML-based database content. You can exploit database XML features to produce XML for inclusion in your XSQL pages by using one of the following techniques:

<xsql:query> handles any query including columns of type XMLType, but it handles XML markup in CLOB and VARCHAR2 columns as literal text.

<xsql:include-xml> parses and includes a single CLOB or string-based XML document retrieved from a query.

One difference between the preceding approaches is that <xsql:include-xml> parses the literal XML appearing in a CLOB or string value on the fly to turn it into a tree of elements and attributes. In contrast, <xsql:query> leaves XML markup in CLOB or string-valued columns as literal text.

Another difference is that while <xsql:query> can handle query results of any number of columns and rows, <xsql:include-xml> works on a single column of a single row. Accordingly, when using <xsql:include-xml>, the SELECT statement inside it returns a single row containing a single column. The column can either be a CLOB or a VARCHAR2 value containing a well-formed XML document. The XSQL engine parses the XML document and includes it in your XSQL page.

Example 15-12 uses nested XmlAgg() functions to aggregate the results of a dynamically-constructed XML document containing departments and nested employees. The functions aggregate the document into a single "result" document wrapped in a <DepartmentList> element.

Example 15-12 Aggregating a Dynamically-Constructed XML Document

<xsql:query connection="hr" xmlns:xsql="urn:oracle-xsql">
  SELECT XmlElement("DepartmentList",
           XmlAgg(
             XmlElement("Department",
               XmlAttributes(department_id AS "Id"),
               XmlForest(department_name AS "Name"),
               (SELECT XmlElement("Employees",
                         XmlAgg(
                           XmlElement("Employee",
                             XmlAttributes(employee_id AS "Id"),
                             XmlForest(first_name||' '||last_name AS "Name",
                                       salary   AS "Salary",
                                       job_id   AS "Job")
                           )
                         )
                       )
                FROM employees e
                WHERE e.department_id = d.department_id
               )
             )
           )
         ) AS result
  FROM departments d
  ORDER BY department_name
</xsql:query>

In another example, suppose you have a number of <Movie> XML documents stored in a table of XMLType called movies. Each document might look like the one shown in Example 15-13.

Example 15-13 Movie XML Document

<Movie Title="The Talented Mr.Ripley" RunningTime="139" Rating="R">
  <Director>
    <First>Anthony</First>
    <Last>Minghella</Last>
  </Director>
  <Cast>
    <Actor Role="Tom Ripley">
      <First>Matt</First>
      <Last>Damon</Last>
    </Actor>
    <Actress Role="Marge Sherwood">
      <First>Gwyneth</First>
      <Last>Paltrow</Last>
    </Actress>
    <Actor Role="Dickie Greenleaf">
      <First>Jude</First>
      <Last>Law</Last>
      <Award From="BAFTA" Category="Best Supporting Actor"/>
    </Actor>
  </Cast>
</Movie>

You can use the built-in XPath query features to extract an aggregate list of all cast members who have received Oscar awards from any movie in the database. Example 15-14 shows a sample query.

Example 15-14 Using XPath to Extract an Aggregate List

SELECT XMLELEMENT("AwardedActors",
           XMLAGG(EXTRACT(VALUE(m),
                  '/Movie/Cast/*[Award[@From="Oscar"]]')))
FROM movies m

To include this query result of XMLType in your XSQL page, paste the query inside an <xsql:query> element. Make sure you include an alias for the query expression, as shown in Example 15-15.

Example 15-15 Including an XMLType Query Result

<xsql:query connection="demo" xmlns:xsql="urn:oracle-xsql">
  SELECT XMLELEMENT("AwardedActors",
           XMLAGG(EXTRACT(VALUE(m),
                  '/Movie/Cast/*[Award[@From="Oscar"]]'))) AS result
  FROM movies m
</xsql:query>

You can use the combination of XmlElement() and XmlAgg() to make the database aggregate all of the XML fragments identified by the query into single, well-formed XML document. The functions work together to produce a well-formed result like the following:

<AwardedActors>
  <Actor>...</Actor>
  <Actress>...</Actress>
</AwardedActors>

You can use the standard XSQL bind variable capabilities in the middle of an XPath expression if you concatenate the bind variable into the expression. For example, to parameterize the value Oscar into a parameter named award-from, you can use an XSQL page like the one shown in Example 15-16.

Example 15-16 Using XSQL Bind Variables in an XPath Expression

<xsql:query connection="orcl92" xmlns:xsql="urn:oracle-xsql"
            award-from="Oscar"  bind-params="award-from">
  /* Using a bind variable in an XPath expression */
  SELECT XMLELEMENT("AwardedActors",
           XMLAGG(EXTRACT(VALUE(m),
                  '/Movie/Cast/*[Award[@From="'|| ? ||'"]]'))) AS result
  FROM movies m
</xsql:query>

Handling Posted XML Content

In addition to simplifying the assembly and transformation of XML content, the XSQL pages framework enables you to handle posted XML content. Built-in actions provide the following advantages:

Simplify the handling of posted data from both XML document and HTML forms

Enable data to be posted directly into a database table by using XSU

XSU can perform database inserts, updates, and deletes based on the content of an XML document in canonical form for a target table or view. For a specified table, the canonical XML form of its data is given by one row of XML output from a SELECT * query. When given an XML document in this form, XSU can automate the DML operation.

By combining XSU with XSLT, you can transform XML in any format into the canonical format expected by a given table. XSU can then perform DML on the resulting canonical XML.

The following built-in XSQL actions make it possible for you to exploit this capability from within your XSQL pages:

<xsql:insert-request>

Insert the optionally transformed XML document that was posted in the request into a table.

<xsql:update-request>

Update the optionally transformed XML document that was posted in the request into a table or view.

<xsql:delete-request>

Delete the optionally transformed XML document that was posted in the request from a table or view.

<xsql:insert-param>

Insert the optionally transformed XML document that was posted as the value of a request parameter into a table or view.

If you target a database view with your insert, then you can create INSTEAD OF INSERT triggers on the view to further automate the handling of the posted information. For example, an INSTEAD OF INSERT trigger on a view can use PL/SQL to check for the existence of a record and intelligently choose whether to do an INSERT or an UPDATE depending on the result of this check.

Understanding XML Posting Options

The XSQL pages framework can handle posted data in the following scenarios:

A client program sends an HTTP POST message that targets an XSQL page. The request body contains an XML document; the HTTP header reports a ContentType of "text/xml".

In this case, <xsql:insert-request>, <xsql:update-request>, or <xsql:delete-request> can insert, update, or delete the content of the posted XML in the target table. If you transform the posted XML with XSLT, then the posted document is the source for the transformation.

A client program sends an HTTP GET request for an XSQL page, one of whose parameters contains an XML document.

In this case, you can use the <xsql:insert-param> action to insert the content of the posted XML parameter value in the target table. If you transform the posted XML document with XSLT, then the XML document in the parameter value is the source document for this transformation.

A browser submits an HTML form with method="POST" whose action targets an XSQL page. The request body of the HTTP POST message contains an encoded version of the form fields and values with a ContentType of "application/x-www-form-urlencoded".

In this case, the request does not contain an XML document, but an encoded version of the form parameters. To make all three of these cases uniform, however, the XSQL page processor materializes on demand an XML document from the form parameters, session variables, and cookies contained in the request. The XSLT processor transforms this dynamically-materialized XML document into canonical form for DML by using <xsql:insert>, <xsql:update-request>, or <xsql:delete-request>.

When working with posted HTML forms, the dynamically materialized XML document has the form shown in Example 15-17.

Example 15-17 XML Document Generated from HTML Form

<request>
  <parameters>
    <firstparamname>firstparamvalue</firstparamname>
     ...
    <lastparamname>lastparamvalue</lastparamname>
  </parameters>
  <session>
    <firstparamname>firstsessionparamvalue</firstparamname>
      ...
    <lastparamname>lastsessionparamvalue</lastparamname>
  </session>
  <cookies>
    <firstcookie>firstcookievalue</firstcookiename>
       ...
    <lastcookie>firstcookievalue</lastcookiename>
  </cookies>
</request>

If multiple parameters are posted with the same name, then the XSQL processor automatically creates multiple <row> elements to make subsequent processing easier. Assume that a request posts or includes the following parameters and values:

id = 101

name = Steve

id = 102

name = Sita

operation = update

The XSQL page processor creates a set of parameters as follows:

<request>
  <parameters>
    <row>
      <id>101</id>
      <name>Steve</name>
    </row>
    <row>
      <id>102</id>
      <name>Sita</name>
    </row>
    <operation>update</operation>
  </parameters>
  ...
</request>

You need to provide an XSLT stylesheet that transforms this materialized XML document containing the request parameters into canonical format for your target table. Thus, you can build an XSQL page as follows:

<!--
 | ShowRequestDocument.xsql
 | Show Materialized XML Document for an HTML Form
 +-->
<xsql:include-request-params xmlns:xsql="urn:oracle-xsql"/>

With this page in place, you can temporarily modify your HTML form to post to the ShowRequestDocument.xsql page. In the browser you will see the "raw" XML for the materialized XML request document, which you can save and use to develop the XSL transformation.

Producing PDF Output with the FOP Serializer

Using the XSQL pages framework support for custom serializers, the oracle.xml.xsql.serializers.XSQLFOPSerializer class provides integration with the Apache FOP processor. The FOP processor renders a PDF document from an XML document containing XSL Formatting Objects.

As described in Table 14-1, the demo directory includes the emptablefo.xsl stylesheet and emptable.xsql page as illustrations. If you get an error trying to use the FOP serializer, then probably you do not have all of the required JAR files in the CLASSPATH. The XSQLFOPSerializer class resides in the separate xml.jar file, which must be included in the CLASSPATH to use the FOP integration. You also need to add the following additional Java archives to your CLASSPATH:

fop.jar - from Apache, version 0.20.3 or higher

batik.jar - from the FOP distribution

avalon-framework-4.0.jar - from FOP distribution

logkit-1.0.jar - from FOP distribution

In case you want to customize the implementation, the source code for the FOP serializer provided in this release is shown in Example 15-18.

Example 15-18 Source Code for FOP Serializer

package oracle.xml.xsql.serializers;
import org.w3c.dom.Document;
import org.apache.log.Logger;
import org.apache.log.Hierarchy;
import org.apache.fop.messaging.MessageHandler;
import org.apache.log.LogTarget;
import oracle.xml.xsql.XSQLPageRequest;
import oracle.xml.xsql.XSQLDocumentSerializer;
import org.apache.fop.apps.Driver;
import org.apache.log.output.NullOutputLogTarget;
/**
 * Tested with the FOP 0.20.3RC release from 19-Jan-2002
 */
public class XSQLFOPSerializer implements XSQLDocumentSerializer {
  private static final String PDFMIME = "application/pdf";
  public void serialize(Document doc, XSQLPageRequest env) throws Throwable {
    try {
      // First make sure we can load the driver
      Driver FOPDriver = new Driver();
      // Tell FOP not to spit out any messages by default.
      // You can modify this code to create your own FOP Serializer
      // that logs the output to one of many different logger targets
      // using the Apache LogKit API
      Logger logger=Hierarchy.getDefaultHierarchy().getLoggerFor("XSQLServlet");
      logger.setLogTargets(new LogTarget[]{new NullOutputLogTarget()});
      FOPDriver.setLogger(logger);
      // Some of FOP's messages appear to still use MessageHandler.
      MessageHandler.setOutputMethod(MessageHandler.NONE);
      // Then set the content type before getting the reader
      env.setContentType(PDFMIME);
      FOPDriver.setOutputStream(env.getOutputStream());
      FOPDriver.setRenderer(FOPDriver.RENDER_PDF); FOPDriver.render(doc);
    }
    catch (Exception e) {
      // Cannot write PDF output for the error anyway.
      // So maybe this stack trace will be useful info
      e.printStackTrace(System.err);
    }
  }
}

See Also:

http://xml.apache.org/fop to learn about the Formatting Objects Processor

Performing XSQL Customizations

This section contains the following topics:

Writing Custom XSQL Action Handlers

Implementing Custom XSQL Serializers

Using a Custom XSQL Connection Manager for JDBC Datasources

Writing Custom XSQL Connection Managers

Implementing a Custom XSQLErrorHandler

Providing a Custom XSQL Logger Implementation

Writing Custom XSQL Action Handlers

When a task requires custom processing, and none of the built-in actions listed in Table 30-2, "XSQL Configuration File Settings" does exactly what you need, you can write your own actions.

The XSQL pages engine processes an XSQL page by looking for action elements from the xsql namespace and invoking an appropriate action element handler class to process each action. The processor supports any action that implements the XSQLActionHandler interface. All of the built-in actions implement this interface.

The XSQL engine processes the actions in a page in the following way. For each action in the page, the engine performs the following steps:

Constructs an instance of the action handler class using the default constructor

Initializes the handler instance with the action element object and the page processor context by invoking the method init(Element actionElt,XSQLPageRequest context)

Invokes the method that allows the handler to handle the action handleAction (Node result)

For built-in actions, the engine can map the XSQL action element name to the Java class that implements the handler of the action. Table 30-2, "XSQL Configuration File Settings" lists the built-in actions and their corresponding classes.

For user-defined actions, use the following built-in action, replacing fully.qualified.Classname with the name of your class:

<xsql:action handler="fully.qualified.Classname" ... />

The handler attribute provides the fully-qualified name of the Java class that implements the custom action handler.

Implementing the XSQLActionHandler Interface

To create a custom action handler, provide a class that implements the oracle.xml.xsql.XSQLActionHandler interface. Most custom action handlers extend oracle.xml.xsql.XSQLActionHandlerImpl, which provides a default implementation of the init() method and offers useful helper methods.

When an action handler's handleAction() method is invoked by the XSQL pages processor, a DOM fragment is passed to the action implementation. The action handler appends any dynamically created XML content returned to the page to the root node.

The XSQL processor conceptually replaces the action element in the XSQL page with the content of this document fragment. It is legal for an action handler to append nothing to this fragment if it has no XML content to add to the page.

While writing you custom action handlers, some methods on the XSQLActionHandlerImpl class are helpful. Table 15-2 lists these methods.

Table 15-2 Helpful Methods in the XSQLActionHandlerImpl Class

Method Name
Description

getActionElement

Returns the current action element being handled.

getActionElementContent

Returns the text content of the current action element, with all lexical parameters substituted appropriately.

getPageRequest

Returns the current XSQL pages processor context. Using this object you do the following:

setPageParam()

Set a page parameter value.

getPostedDocument()/setPostedDocument()

Get or set the posted XML document.

translateURL()

Translate a relative URL to an absolute URL.

getRequestObject()/setRequestObject()

Get or set objects in the page request context that can be shared across actions in a single page.

getJDBCConnection()

Gets the JDBC connection in use by this page (possible null if no connection in use).

getRequestType()

Detect whether you are running in the Servlet, Command Line, or Programmatic context. For example, if the request type is Servlet then you can cast the XSQLPageRequest object to the more specific XSQLServletPageRequest to access servlet-specific methods such as getHttpServletRequest, getHttpServletResponse, and getServletContext.

getAttributeAllowingParam

Retrieves the attribute value from an element, resolving any XSQL lexical parameter references that might appear in value of the attribute. Typically this method is applied to the action element itself, but it is also useful for accessing attributes of subelements. To access an attribute value without allowing lexical parameters, use the standard getAttribute() method on the DOM Element interface.

appendSecondaryDocument

Appends the contents of an external XML document to the root of the action handler result content.

addResultElement

Simplifies appending a single element with text content to the root of the action handler result content.

firstColumnOfFirstRow

Returns the first column value of the first row of a SQL statement. Requires the current page to have a connection attribute on its document element, or an error is returned.

getBindVariableCount

Returns the number of tokens in the space-delimited list of bind-params. This number indicates how many bind variables are expected to be bound to parameters.

handleBindVariables

Manages the binding of JDBC bind variables that appear in a prepared statement with the parameter values specified in the bind-params attribute on the current action element. If the statement is already using a number of bind variables prior to call this method, you can pass the number of existing bind variable slots in use as well.

reportErrorIncludingStatement

Reports an error. The error includes the offending (SQL) statement that caused the problem and optionally includes a numeric error code.

reportFatalError

Reports a fatal error.

reportMissingAttribute

Reports an error that a required action handler attribute is missing by using the <xsql-error> element.

reportStatus

Reports action handler status by using the <xsql-status> element.

requiredConnectionProvided

Checks whether a connection is available for this request and outputs an errorgram into the page if no connection is available.

variableValue

Returns the value of a lexical parameter, taking into account all scoping rules that might determine its default value.

Example 15-19 shows a custom action handler named MyIncludeXSQLHandler that leverages one of the built-in action handlers. It uses arbitrary Java code to modify the XML fragment returned by this handler before appending its result to the XSQL page.

Example 15-19 MyIncludeXSQLHandler.java

import oracle.xml.xsql.*;
import oracle.xml.xsql.actions.XSQLIncludeXSQLHandler;
import org.w3c.dom.*;
import java.sql.SQLException;
public class MyIncludeXSQLHandler extends XSQLActionHandlerImpl {
  XSQLActionHandler nestedHandler = null;
  public void init(XSQLPageRequest req, Element action) {
    super.init(req, action);
    // Create an instance of an XSQLIncludeXSQLHandler and init() the handler by
    // passing the current request/action. This assumes the XSQLIncludeXSQLHandler
    // will pick up its href="xxx.xsql" attribute from the current action element.
    nestedHandler = new XSQLIncludeXSQLHandler();
    nestedHandler.init(req,action);
  }
  public void handleAction(Node result) throws SQLException {
    DocumentFragment df=result.getOwnerDocument().createDocumentFragment();
    nestedHandler.handleAction(df);
    // Custom Java code here can work on the returned document fragment
    // before appending the final, modified document to the result node.
    // For example, add an attribute to the first child.
    Element e = (Element)df.getFirstChild();
    if (e != null) {
      e.setAttribute("ExtraAttribute","SomeValue");
    }
    result.appendChild(df);
  }
}

You may need to write custom action handlers that work differently based on whether the page is requested through the XSQL servlet, the XSQL command-line utility, or programmatically through the XSQLRequest class.You can invoke getPageRequest() in your action handler implementation to obtain a reference to the XSQLPageRequest interface for the current page request. By calling getRequestType() on the XSQLPageRequest object, you can determine whether the request is coming from the Servlet, Command Line, or Programmatic routes. If the return value is Servlet, then you can access the HTTP servlet request, response, and servlet context objects as shown in Example 15-20.

Example 15-20 Testing for the Servlet Request

XSQLServletPageRequest xspr = (XSQLServletPageRequest)getPageRequest();
if (xspr.getRequestType().equals("Servlet")) {
  HttpServletRequest     req  = xspr.getHttpServletRequest();
  HttpServletResponse   resp  = xspr.getHttpServletResponse();
  ServletContext        cont  = xspr.getServletContext();
  // Do something here with req, resp, or cont. Note that writing to the response
  // directly from a handler produces unexpected results. All the servlet or your
  // custom Serializer to write to the servlet response output stream at the right
  // moment later when all action elements have been processed.
}

Using Multivalued Parameters in Custom XSQL Actions

XSQLActionHandlerImpl is the base class for custom XSQL actions. It supports the following:

Array-named lexical parameter substitution

Array-named bind variables

Simple-valued parameters

If your custom actions use methods such as getAttributeAllowingParam(), getActionElementContent(), or handleBindVariables() from this base class, you pick up multi-valued parameter functionality for free in your custom actions.

Use the getParameterValues() method on the XSQLPageRequest interface to explicitly get a parameter value as a String[]. The helper method variableValues() in XSQLActionHandlerImpl enables you to use this functionality from within a custom action handler if you need to do so programmatically.

Implementing Custom XSQL Serializers

You can implement a user-defined serializer class to control how the final XSQL datapage is serialized to a text or binary stream. A user-defined serializer must implement the oracle.xml.xsql.XSQLDocumentSerializer interface. The interface contains the following single method:

void serialize(org.w3c.dom.Document doc, XSQLPageRequest env) throws Throwable;

Only DOM-based serializers are supported. A custom serializer class is expected to perform the following tasks in the correct order:

Set the content type of the serialized stream before writing any content to the output PrintWriter (or OutputStream).

Set the type by calling setContentType() on the XSQLPageRequest passed to your serializer. When setting the content type, you can set a MIME type as follows:

env.setContentType("text/html");

Alternatively, you can set a MIME type with an explicit output encoding character set as follows:

env.setContentType("text/html;charset=Shift_JIS");

Call either getWriter() or getOutputStream() (but not both) on the XSQLPageRequest to obtain the appropriate PrintWriter or OutputStream for serializing the content.

The custom serializer in Example 15-21 illustrates a simple implementation that serializes an HTML document containing the name of the document element of the current XSQL data page.

Example 15-21 Custom Serializer

package oracle.xml.xsql.serializers;
import org.w3c.dom.Document;
import java.io.PrintWriter;
import oracle.xml.xsql.*;

public class XSQLSampleSerializer implements XSQLDocumentSerializer {
  public void serialize(Document doc, XSQLPageRequest env) throws Throwable {
    String encoding = env.getPageEncoding();  // Use same encoding as XSQL page
                                              // template. Set to specific
                                              // encoding if necessary
    String mimeType = "text/html"; // Set this to the appropriate content type
    // (1) Set content type using the setContentType on the XSQLPageRequest
    if (encoding != null && !encoding.equals("")) {
      env.setContentType(mimeType+";charset="+encoding);
    }
    else {
      env.setContentType(mimeType);
    }
    // (2) Get the output writer from the XSQLPageRequest
    PrintWriter e = env.getWriter();
    // (3) Serialize the document to the writer
    e.println("<html>Document element is <b>"+
              doc.getDocumentElement().getNodeName()+"</b></html>");
  }
}

Techniques for Using a Custom Serializer

There are two ways to use a custom serializer, depending on whether you need to first perform an XSLT transformation before serializing or not.

To perform an XSLT transformation before using a custom serializer, add the serializer="java:fully.qualified.ClassName" in the <?xml-stylesheet?> processing instruction at the top of your page. The following examples illustrates this technique:

<?xml version="1.0?>
<?xml-stylesheet type="text/xsl" href="mystyle.xsl"
                 serializer="java:my.pkg.MySerializer"?>

If you only need the custom serializer, then leave out the type and href attributes. The following example illustrates this technique:

<?xml version="1.0?>
<?xml-stylesheet serializer="java:my.pkg.MySerializer"?>

Assigning a Short Name to a Custom Serializer

You can also assign a short name to your custom serializers in the <serializerdefs> section of the XSQL configuration file. You can then use the nickname in the serializer attribute instead to save typing. Note that the short name is case sensitive.

Assume that you have the information shown in Example 15-22 in your XSQL configuration file.

Example 15-22 Assigning Short Names to Custom Serializers

<XSQLConfig>
  <!--and so on. -->
  <serializerdefs>
    <serializer>
      <name>Sample</name>
      <class>oracle.xml.xsql.serializers.XSQLSampleSerializer</class>
    </serializer>
    <serializer>
      <name>FOP</name>
      <class>oracle.xml.xsql.serializers.XSQLFOPSerializer</class>
    </serializer>
  </serializerdefs>
</XSQLConfig>

You can use the short names "Sample" or "FOP" in a stylesheet instruction as follows:

<?xml-stylesheet type="text/xsl" href="emp-to-xslfo.xsl" serializer="FOP"?>
<?xml-stylesheet serializer="Sample"?>

The XSQLPageRequest interface supports both a getWriter() and a getOutputStream() method. Custom serializers can call getOutputStream() to return an OutputStream instance into which binary data can be serialized. When you use the XSQL servlet, writing to this output stream results in writing binary information to the servlet output stream.

The serializer shown in Example 15-23 illustrates an example of writing a dynamic GIF image. In this example the GIF image is a static "ok" icon, but it shows the basic technique that a more sophisticated image serializer must use.

Example 15-23 Writing a Dynamic GIF Image

package oracle.xml.xsql.serializers;
import org.w3c.dom.Document;
import java.io.*;
import oracle.xml.xsql.*;

public class XSQLSampleImageSerializer implements XSQLDocumentSerializer {
   // Byte array representing a small "ok" GIF image
   private static byte[] okGif =
     {(byte)0x47,(byte)0x49,(byte)0x46,(byte)0x38,
      (byte)0x39,(byte)0x61,(byte)0xB,(byte)0x0,
      (byte)0x9,(byte)0x0,(byte)0xFFFFFF80,(byte)0x0,
      (byte)0x0,(byte)0x0,(byte)0x0,(byte)0x0,
      (byte)0xFFFFFFFF,(byte)0xFFFFFFFF,(byte)0xFFFFFFFF,(byte)0x2C,
      (byte)0x0,(byte)0x0,(byte)0x0,(byte)0x0,
      (byte)0xB,(byte)0x0,(byte)0x9,(byte)0x0,
      (byte)0x0,(byte)0x2,(byte)0x14,(byte)0xFFFFFF8C,
      (byte)0xF,(byte)0xFFFFFFA7,(byte)0xFFFFFFB8,(byte)0xFFFFFF9B,
      (byte)0xA,(byte)0xFFFFFFA2,(byte)0x79,(byte)0xFFFFFFE9,
      (byte)0xFFFFFF85,(byte)0x7A,(byte)0x27,(byte)0xFFFFFF93,
      (byte)0x5A,(byte)0xFFFFFFE3,(byte)0xFFFFFFEC,(byte)0x75,
      (byte)0x11,(byte)0xFFFFFF85,(byte)0x14,(byte)0x0,
      (byte)0x3B};

  public void serialize(Document doc, XSQLPageRequest env) throws Throwable {
    env.setContentType("image/gif");
    OutputStream os = env.getOutputStream();
    os.write(okGif,0,okGif.length);
    os.flush();
  }
}

Using the XSQL command-line utility, the binary information is written to the target output file. Using the XSQLRequest API, two constructors exist that allow the caller to supply the target OutputStream to use for the results of page processing.

Note that your serializer must either call getWriter() for textual output or getOutputStream() for binary output but not both. Calling both in the same request raises an error.

Using a Custom XSQL Connection Manager for JDBC Datasources

As an alternative to defining your named connections in the XSQL configuration file, you can use one of the two provided XSQLConnectionManager implementations. These implementations enable you to use your servlet container's JDBC Datasource implementation and related connection pooling features.

This XSQL pages framework provides the following alternative connection manager implementations:

oracle.xml.xsql.XSQLDatasourceConnectionManager

Consider using this connection manager if your servlet container's datasource implementation does not use the Oracle JDBC driver. Features of the XSQL pages system such as <xsql:ref-cursor-function> and <xsql:include-owa> are not available when you do not use an Oracle JDBC driver.

oracle.xml.xsql.XSQLOracleDatasourceConnectionManager

Consider using this connection manager when your datasource implementation returns JDBC PreparedStatement and CallableStatement objects that implement the oracle.jdbc.PreparedStatement and oracle.jdbc.CallableStatement interfaces. The Oracle Application Server has a datasource implementation that performs this task.

When using either of the preceding alternative connection manager implementations, the value of the connection attribute in your XSQL page template is the JNDI name used to look up your desired datasource. For example, the value of the connection attribute might look like the following:

jdbc/scottDS

java:comp/env/jdbc/MyDatasource

If you are not using the default XSQL pages connection manager, then needed connection pooling functionality must be provided by the alternative connection manager implementation. In the case of the preceding two options based on JDBC datasources, you must properly configure your servlet container to supply the connection pooling. See your servlet container documentation for instructions on how to properly configure the datasources to offer pooled connections.

Writing Custom XSQL Connection Managers

You can provide a custom connection manager to replace the built-in connection management mechanism. To provide a custom connection manager implementation, you must perform the following steps:

Write a connection manager factory class that implements the oracle.xml.xsql.XSQLConnectionManagerFactory interface.

Write a connection manager class that implements the oracle.xml.xsql.XSQLConnectionManager interface.

Change the name of the XSQLConnectionManagerFactory class in your XSQL configuration file.

The XSQL servlet uses your connection management scheme instead of the XSQL pages default scheme.

You can set your custom connection manager factory as the default connection manager factory by providing the class name in the XSQL configuration file. Set the factory in the following section:

<!--
 | Set the name of the XSQL Connection Manager Factory
 | implementation. The class must implement the
 | oracle.xml.xsql.XSQLConnectionManagerFactory interface.
 | If unset, the default is to use the built-in connection
 | manager implementation in
 | oracle.xml.xsql.XSQLConnectionManagerFactoryImpl
+-->
  <connection-manager>
      <factory>oracle.xml.xsql.XSQLConnectionManagerFactoryImpl</factory>
  </connection-manager>

In addition to specifying the default connection manager factory, you can associate a custom connection factory with a XSQLRequest object by using APIs provided.

The responsibility of the XSQLConnectionManagerFactory is to return an instance of an XSQLConnectionManager for use by the current request. In a multithreaded environment such as a servlet engine, the XSQLConnectionManager object must ensure that a single XSQLConnection instance is not used by two different threads. This aim is realized by marking the connection as in use for the time between the getConnection() and releaseConnection() method calls. The default XSQL connection manager implementation automatically pools named connections and adheres to this thread-safe policy.

If your custom implementation of XSQLConnectionManager implements the optional oracle.xml.xsql.XSQLConnectionManagerCleanup interface, then your connection manager can clean up any resources it has allocated. For example, if your servlet container invokes the destroy() method on the XSQLServlet servlet, which can occur during online administration of the servlet for example, the connection manager has a chance to clean up resources as part of the servlet destruction process.

Accessing Authentication Information in a Custom Connection Manager

To use the HTTP authentication mechanism to get the username and password to connect to the database, write a customized connection manager. You can then invoke a getConnection() method to obtain the needed information.

You can write a Java program that follows these steps:

Pass an instance of the oracle.xml.xsql.XSQLPageRequest interface to the getConnection() method.

Invoke getRequestType() to ensure that the request type is Servlet.

Cast the XSQLPageRequest object to an XSQLServletPageRequest.

Call getHttpServletRequest() on the result of the preceding step.

Obtain the authentication information from the javax.servlet.http.HttpServletResponse object returned by the previous call.

Implementing a Custom XSQLErrorHandler

You may want to control how serious page processor errors such as an unavailable connection are reported to users. You can achieve this task by implementing the oracle.xml.xsql.XSQLErrorHandler interface. The interface contains the following single method signature:

public interface XSQLErrorHandler {
  public void handleError( XSQLError err, XSQLPageRequest env);
}

You can provide a class that implements the XSQLErrorHandler interface to customize how the XSQL pages processor writes error messages. The new XSQLError object encapsulates the error information and provides access to the error code, formatted error message, and so on.

Example 15-24 illustrates a sample implementation of XSQLErrorHandler.

Example 15-24 myErrorHandler class

package example;
import oracle.xml.xsql.*;
import java.io.*;
public class myErrorHandler implements XSQLErrorHandler {
  public void logError( XSQLError err, XSQLPageRequest env) {
    // Must set the content type before writing anything out
    env.setContentType("text/html");
    PrintWriter pw = env.getErrorWriter();
    pw.println("<H1>ERROR</H1><hr>"+err.getMessage());
  }
}

You can control which custom XSQLErrorHandler implementation is used in the following distinct ways:

Define the name of a custom XSQLErrorHandler implementation class in the XSQL configuration file. You must provide the fully-qualified class name of your error handler class as the value of the /XSQLConfig/processor/error-handler/class entry.

If the XSQL processor can load this class, and if it correctly implements the XSQLErrorHandler interface, then it uses this class as a singleton and replaces the default implementation globally wherever page processor errors are reported.

Override the error writer on a per page basis by using the errorHandler (or xsql:errorHandler) attribute on the document element of the page. The attribute value is the fully-qualified class name of a class that implements the XSQLErrorHandler interface. This class reports the errors for this page only. The class is instantiated on each page request by the page engine.

You can use a combination of the preceding approaches if needed.

Providing a Custom XSQL Logger Implementation

You can optionally register custom code to handle the logging of the start and end of each XSQL page request. Your custom logger code must provide an implementation of the oracle.xml.xsql.XSQLLoggerFactory and oracle.xml.xsql.XSQLLogger interfaces.

The XSQLLoggerFactory interface contains the following single method:

public interface XSQLLoggerFactory {
  public XSQLLogger create( XSQLPageRequest env);
}

You can provide a class that implements the XSQLLoggerFactory interface to decide how XSQLLogger objects are created (or reused) for logging. The XSQL processor holds a reference to the XSQLLogger object returned by the factory for the duration of a page request. The processor uses it to log the start and end of each page request by invoking the logRequestStart() and logRequestEnd() methods.

The XSQLLogger interface is as follows:

public interface XSQLLogger {
   public void logRequestStart(XSQLPageRequest env) ;
   public void logRequestEnd(XSQLPageRequest env);
}

The classes in Example 15-25 and Example 15-26 illustrate a trivial implementation of a custom logger. The XSQLLogger implementation in Example 15-25 notes the time the page request started. It then logs the page request end by printing the name of the page request and the elapsed time to System.out.

Example 15-25 SampleCustomLogger Class

package example;
import oracle.xml.xsql.*;
public class SampleCustomLogger implements XSQLLogger  {
  long start = 0;
  public void logRequestStart(XSQLPageRequest env) {
    start = System.currentTimeMillis();
  }
  public void logRequestEnd(XSQLPageRequest env) {
    long secs = System.currentTimeMillis() - start;
    System.out.println("Request for " + env.getSourceDocumentURI()
                        + " took "+ secs + "ms");
  }
}

The factory implementation is shown in Example 15-26.

Example 15-26 SampleCustomLoggerFactory Class

package example;
import oracle.xml.xsql.*;
public class SampleCustomLoggerFactory implements XSQLLoggerFactory {
  public XSQLLogger create(XSQLPageRequest env) {
    return new SampleCustomLogger();
  }
}

To register a custom logger factory, edit the XSQLConfig.xml file and provide the name of your custom logger factory class as the content to the /XSQLConfig/processor/logger/factory element. Example 15-27 illustrates this technique.

Example 15-27 Registering a Custom Logger Factory

<XSQLConfig>
    :
  <processor>
         :
      <logger>
         <factory>example.SampleCustomLoggerFactory</factory>
      </logger>
         :
   </processor>
</XSQLConfig>

By default, <logger> section is commented out. There is no default logger.

Part II

XDK for C

This part contains chapters describing how the Oracle XDK is used for development in C.

This part contains the following chapters:

Chapter 16, "Getting Started with C XDK Components"

Chapter 17, "Using the XSLT and XVM Processors for C"

Chapter 18, "Using the XML Parser for C"

Chapter 19, "Using Binary XML for C"

Chapter 20, "Using the XML Schema Processor for C"

Chapter 21, "Determining XML Differences Using C"

Chapter 22, "Using SOAP with the C XDK"

16 Getting Started with C XDK Components

The XDK C components are the building blocks for reading, manipulating, transforming, and validating XML.

This chapter contains the following topics:

Installing C XDK Components

Configuring the UNIX Environment for C XDK Components

Configuring the Windows Environment for C XDK Components

Overview of the Unified C API

Globalization Support for the C XDK Components

Installing C XDK Components

The C XDK components are included with Oracle Database. This chapter assumes that you have installed XDK with Oracle Database and also installed the demo programs on the Oracle Database Examples media. Refer to "Installing the XDK" for installation instructions and a description of the XDK directory structure.

Example 16-1 shows the UNIX directory structure for the XDK demos and the libraries used by the XDK components. The $ORACLE_HOME/xdk/demo/c subdirectories contain sample programs and data files for the XDK for C components. The chapters in Part II, "XDK for C" explain how to understand and use these programs.

Example 16-1 C XDK Libraries, Header Files, Utilities, and Demos

- Oracle_home_directory
    | - bin/
         schema
         xml
         xmlcg
         xsl
         xvm
    | - lib/
         libcore11.a
         libcoresh11.so
         libnls11.a
         libunls11.a
         libxml11.a
         libxmlsh10.a

    | - xdk/
         | demo/
            | - c/
                 | - dom/
                 | - parser/
                 | - sax/
                 | - schema/
                 | - webdav/
                 | - xslt/
                 | - xsltvm/
         | include/
            oratypes.h
            oraxml.h
            oraxmlcg.h
            oraxsd.h
            xml.h
            xmlerr.h
            xmlotn.h
            xmlproc.h
            xmlsch.h
            xmlxptr.h
            xmlxsl.h
            xmlxvm.h

The subdirectories contain sample programs and data files for the C XDK components. The chapters in Part II, "XDK for C" explain how to use these programs to gain an understanding of the most important C features.

See Also:

"Overview of Oracle XML Developer's Kit (XDK)" for a list of the XDK C components

Configuring the UNIX Environment for C XDK Components

This section contains the following topics:

C XDK Component Dependencies on UNIX

Setting C XDK Environment Variables on UNIX

Testing the C XDK Runtime Environment on UNIX

Setting Up and Testing the C XDK Compile-Time Environment on UNIX

Verifying the C XDK Component Version on UNIX

C XDK Component Dependencies on UNIX

The C libraries described in this section are located in $ORACLE_HOME/lib. The XDK C and C++ components are contained in the following library:

libxml11.a

The following XDK components are contained in the library:

XML parser, which checks an XML document for well-formedness, optionally validates it against a DTD or XML Schema, and supports DOM and SAX interfaces for programmatic access

XSLT processor, which transforms an XML document into another XML document

XSLT compiler, which compiles XSLT stylesheets into byte code for use by the XSLT Virtual Machine

XSLTVM, which is an XSLT transformation engine

XML Schema processor, which validates XML files against an XML schema

Table 16-1 describes the Oracle CORE and Globalization Support libraries on which the XDK C components (UNIX) depend.

Table 16-1 Dependent Libraries of XDK C Components on UNIX

Component
Library
Description

CORE library

libcore11.a

Contains the C runtime functions that enable portability across platforms.

CORE Dynamic linking library

libcoresh11.so

C runtime library that supports dynamic linking on UNIX platforms.

Globalization Support common library

libnls11.a

Supports the UTF-8, UTF-16, and ISO-8859-1 character sets. This library depends on the environment to locate encoding and message files.

Globalization Support library for Unicode

libunls11.a

Supports the character sets described in Oracle Database Globalization Support Guide. This library depends on the environment to locate encoding and message files.

Setting C XDK Environment Variables on UNIX

Table 16-2 describes the UNIX environment variables required for use with the XDK C components.

Table 16-2 UNIX Environment Settings for XDK C Components

Variable
Description
Setting

$ORA_NLS10

Sets the location of the Globalization Support character-encoding definition files. The encoding files represent a subset of character sets available in Oracle Database.

Set to the location of the Globalization Support data files. Set the variable as follows:

setenv ORA_NLS10 $ORACLE_HOME/nls/data

$ORA_XML_MESG

Sets the location of the XML error message files. Files ending in .msb are machine-readable and required at runtime. Files ending in .msg are human-readable and contain cause and action descriptions for each error.

Set to the path of the mesg directory. For example:

setenv ORA_XML_MESG $ORACLE_HOME/xdk/mesg

$PATH

Sets the location of the C XDK executables.

You can set the PATH as follows:

setenv PATH ${PATH}:${ORACLE_HOME}/bin

Testing the C XDK Runtime Environment on UNIX

You can test your UNIX runtime environment by running any of the utilities described in Table 16-3.

Table 16-3 C/C++ XDK Utilities on UNIX

Executable
Directory
Description

schema

$ORACLE_HOME/bin

C XML Schema validator

See Also: "Using the C XML Schema Processor Command-Line Utility"

xml

$ORACLE_HOME/bin

C XML parser

See Also: "Using the C XML Parser Command-Line Utility"

xmlcg

$ORACLE_HOME/bin

C++ class generator

See Also: "Using the XML C++ Class Generator Command-Line Utility"

xsl

$ORACLE_HOME/bin

C XSLT processor

See Also: "Using the C XSLT Processor Command-Line Utility"

xvm

$ORACLE_HOME/bin

C XVM processor

See Also: "Using the XVM Processor Command-Line Utility"

Run these utilities with no options to display the usage help. Run the utilities with the -hh flag for complete usage information.

Setting Up and Testing the C XDK Compile-Time Environment on UNIX

Table 16-4 describes the header files required for compilation of the C components. These files are located in $ORACLE_HOME/xdk/include. Note that your runtime environment must be set up before you can compile your code.

Table 16-4 Header Files in the C XDK Compile-Time Environment

Header File
Description

oratypes.h

Includes the private Oracle C datatypes.

oraxml.h

Includes the Oracle9i XML ORA datatypes and the public ORA APIs included in libxml.a (for backward compatibility only). Use xml.h instead.

oraxmlcg.h

Includes the C APIs for the C++ class generator (for backward compatibility only).

oraxsd.h

Includes the Oracle9i XSD validator datatypes and APIs (for backward compatibility only).

xml.h

Handles the unified DOM APIs transparently, whether you use them through OCI or standalone. It replaces oraxml.h, which is deprecated.

xmlerr.h

Includes the XML errors and their numbers.

xmlotn.h

Includes the other headers depending on whether you compile standalone or use OCI.

xmlproc.h

Includes the Oracle XML datatypes and XML public parser APIs in libxml11.a.

xmlsch.h

Includes the Oracle XSD validator public APIs.

xmlptr.h

Includes the XPointer datatypes and APIs, which are not currently documented or supported.

xmlxsl.h

Includes the XSLT processor datatypes and public APIs.

xmlxvm.h

Includes the XSLT compiler and VM datatypes and public APIs.

Testing the C XDK Compile-Time Environment on UNIX

The simplest way to test your compile-time environment is to run the make utility on the sample programs, which are located on the Examples media rather than on the Oracle Database CD. After you install the demos, they will be located in $ORACLE_HOME/xdk/demo/c. A README in the same directory provides compilation instructions and usage notes.

Build and run the sample programs by executing the following commands at the system prompt:

cd $ORACLE_HOME/xdk/demo/c
make

Verifying the C XDK Component Version on UNIX

To obtain the version of XDK you are working with, change directory into $ORACLE_HOME/lib and run the following command:

strings libxml11.a | grep -i developers

Configuring the Windows Environment for C XDK Components

This section contains the following topics:

C XDK Component Dependencies on Windows

Setting C XDK Environment Variables on Windows

Testing the C XDK Runtime Environment on Windows

Setting Up and Testing the C XDK Compile-Time Environment on Windows

Using the C XDK Components with Visual C/C++ on Windows

C XDK Component Dependencies on Windows

The C libraries described in this section are located in %ORACLE_HOME%\lib. The XDK C components are contained in the following library:

libxml11.dll

The following XDK components are contained in the library:

XML parser

XSLT processor

XSLT compiler

XSLT VM

XML Schema processor

Table 16-5 describes the Oracle CORE and Globalization Support libraries on which the XDK C components (Windows) depend.

Table 16-5 Dependent Libraries of XDK C Components on Windows

Component
Library
Description

CORE library

libcore11.dll

Contains the runtime functions that enable portability across platforms.

Globalization Support common library

libnls11.dll

Supports the UTF-8, UTF-16, and ISO-8859-1 character sets. This library depends on the environment to find encoding and message files.

Globalization Support library for Unicode

libunls11.dll

Supports the character sets described in Oracle Database Globalization Support Guide. This library depends on the environment to find encoding and message files.

Setting C XDK Environment Variables on Windows

Table 16-6 describes the Windows environment variables required for use with the XDK C components.

Table 16-6 Windows Environment Settings for C XDK Components

Variable
Description
Setting

%ORA_NLS10%

Sets the location of the Globalization Support character-encoding definition files. The encoding files represent a subset of character sets available in Oracle Database.

This variable should be set to the location of the Globalization Support data files. Set the variable as follows:

set ORA_NLS10=%ORACLE_HOME%\nls\data

%ORA_XML_MESG%

Sets the location of the XML error message files. Files ending in .msb are machine-readable and required at runtime. Files ending in .msg are human-readable and contain cause and action descriptions for each error.

Set to the path of the mesg directory. For example:

set ORA_XML_MESG=%ORACLE_HOME%\xdk\mesg

%PATH%

Sets the location of the C XDK DLLs and executables.

You can set the PATH as follows:

path %path%;%ORACLE_HOME%\bin

Testing the C XDK Runtime Environment on Windows

You can test your Windows runtime environment by running any of the utilities described in Table 16-7.

Table 16-7 C/C++ XDK Utilities on Windows

Executable
Directory
Description

schema.exe

%ORACLE_HOME%\bin

C XML Schema validator

See Also: "Using the C XML Schema Processor Command-Line Utility"

xml.exe

%ORACLE_HOME%\bin

C XML parser

See Also: "Using the C XML Parser Command-Line Utility"

xmlcg.exe

%ORACLE_HOME%\bin

C++ class generator

See Also: "Using the XML C++ Class Generator Command-Line Utility"

xsl.exe

%ORACLE_HOME%\bin

C XSLT processor

See Also: "Using the C XSLT Processor Command-Line Utility"

xvm.exe

%ORACLE_HOME%\bin

C XVM processor

See Also: "Using the XVM Processor Command-Line Utility"

Run these utilities with no options to display the usage help. Run the utilities with the -hh flag for complete usage information.

Setting Up and Testing the C XDK Compile-Time Environment on Windows

Table 16-4 in the section "Setting Up and Testing the C XDK Compile-Time Environment on UNIX" describes the header files required for compilation of the C components on Windows. The relative filenames are the same on both UNIX and Windows installations.

On Windows the header files are located in %ORACLE_HOME%\xdk\include. Note that you must set up your runtime environment before you can compile your code.

Testing the C XDK Compile-Time Environment on Windows

You can test your compile-time environment by compiling the demo programs, which are located in %ORACLE_HOME%\xdk\demo\c after you install them from the Oracle Database Examples media. A README in the same directory provides compilation instructions and usage notes. Before you compile the demo programs, edit the Make.bat files as described in "Editing the Make.bat Files on Windows".

Editing the Make.bat Files on Windows

Each subfolder of the %ORACLE_HOME%\xdk\demo\c folder contains a Make.bat file. Update the Make.bat file in each folder by adding the path of the libraries and the header files to the compile command. You should not need to edit the paths in the :LINK section because /libpath:%ORACLE_HOME%\lib already points to the C libraries. The section of a Make.bat file in Example 16-2 uses bold text to show the path that you need to include.

Example 16-2 Editing a C XDK Make.bat File on Windows

:COMPILE
set filename=%1
cl -c -Fo%filename%.obj %opt_flg%  /DCRTAPI1=_cdecl /DCRTAPI2=_cdecl /nologo /Zl
/Gy /DWIN32 /D_WIN32 /DWIN_NT /DWIN32COMMON /D_DLL /D_MT /D_X86_=1
/Doratext=OraText -I. -I..\..\..\include -I%ORACLE_HOME%\xdk\include %filename%.c
goto :EOF

:LINK
set filename=%1
link %link_dbg% /out:..\..\..\..\bin\%filename%.exe
/libpath:%ORACLE_HOME%\lib /libpath:..\..\..\..\lib
%filename%.obj oraxml10.lib user32.lib kernel32.lib msvcrt.lib ADVAPI32.lib
oldnames.lib winmm.lib

Setting the C XDK Compiler Path on Windows

The demo make.bat file assumes that you are using the cl.exe compiler, which is freely available with the Microsoft .NET Framework Software Development Kit (SDK).

To set the path for the cl.exe compiler on Windows XP, follow these steps:

In the Start menu, select Settings and then Control Panel.

Double-click System.

In the System Properties dialogue box, select the Advanced tab and click Environment Variables.

In System variables, select Path and click Edit.

Append the path of cl.exe to the %PATH% variable and click OK.

Build and run the sample programs by executing the following commands at the system prompt:

cd $ORACLE_HOME/xdk/demo/c
make

Using the C XDK Components with Visual C/C++ on Windows

You can set up a project in Microsoft Visual C/C++ and use it for the demos included in the XDK.

Setting a Path for a Project in Visual C/C++ on Windows

Follow these steps to set the path for a project:

Open a workspace in Visual C++ and include the *.c files for your project.

Navigate to the Tools menu and select Options.

Select the Directories tab and set your include path to %ORACLE_HOME%\xdk\include as shown in the example in Figure 16-1.

Figure 16-1 Setting the Include Path in Visual C/C++

Description of Figure 16-1 follows
Description of "Figure 16-1 Setting the Include Path in Visual C/C++"

Setting the Library Path in Visual C/C++ on Windows

Follow these steps to set the library path for a project:

Open a workspace in Visual C++ and include the *.c files for your project.

Navigate to the Tools menu and select Options.

Select the Directories tab and set your library path to %ORACLE_HOME%\lib as shown in the example in Figure 16-2.

Figure 16-2 Setting the Static Library Path in Visual C/C++

Description of Figure 16-2 follows
Description of "Figure 16-2 Setting the Static Library Path in Visual C/C++"

After setting the paths for the static libraries in %ORACLE_HOME%\lib, set the library name in the compiling environment of Visual C++. Navigate to the Project menu in the menu bar and select Settings.

Select the Link tab in the Object/Library Modules field and enter the names of XDK C components libraries, as shown in the example in Figure 16-3.

Figure 16-3 Setting the Names of the Libraries in Visual C/C++ Project

Description of Figure 16-3 follows
Description of "Figure 16-3 Setting the Names of the Libraries in Visual C/C++ Project"

Overview of the Unified C API

The unified C API is a programming interface that unifies the functionality required by both the XDK and Oracle XML DB. This API is used primarily by XSLT and XML Schema.

As shown in Table 16-4, the unified C API is declared in the xml.h header file. Table 16-8 summarizes the C XDK APIs. Refer to Oracle XML API Reference for complete documentation.

Table 16-8 Summary of the XDK C APIs

Package
Purpose

Callback APIs

Define macros that declare functions (or function pointers) for XML callbacks.

DOM APIs

Parse and manipulate XML documents with DOM. The API follows the DOM 2.0 standard as closely as possible, although it changes some names when mapping from the objected-oriented DOM specification to the flat C namespace. For example, the overloaded getName() methods become getAttrName().

Range APIs

Create and manipulate Range objects.

SAX APIs

Enable event-based XML parsing with SAX.

Schema APIs

Assemble multiple XML schema documents into a single schema that can be used to validate a specific instance document.

Traversal APIs

Enable document traversal and navigation of DOM trees.

XML APIs

Define an XML processor in terms of how it must read XML data and the information it must provide to the application.

XPath APIs

Process XPath-related types and interfaces.

XPointer APIs

Locate nodes in an XML document.

XSLT APIs

Perform XSL processing.

XSLTVM APIs

Implement a virtual machine that can run compiled XSLT code.

The API accomplishes the unification of the functions by conforming contexts. A top-level XML context (xmlctx) shares common information between cooperating XML components. This context defines information about the following:

Data encoding

Error message language

Low-level allocation callbacks

An application needs this information before it can parse a document and provide programmatic access through DOM or SAX interfaces.

Both XDK and Oracle XML DB require different startup and tear-down functions for the top-level and service contexts. The initialization function takes implementation-specific arguments and returns a conforming context.

The unification is made possible by using conforming contexts. A conforming context means that the returned context must begin with a xmlctx; it may have any additional implementation-specific parts after the standard header.

After an application obtains xmlctx, it uses unified DOM calls, all of which take an xmlctx as the first argument.

Globalization Support for the C XDK Components

The C XDK parser supports over 300 IANA character sets. These character sets include those listed in "Character Sets Supported by the XDK for C". Note the following considerations when working with character sets:

It is recommended that you use IANA character set names for interoperability with other XML parsers.

XML parsers are only required to support UTF-8 and UTF-16, so these character sets are preferable.

The default input encoding ("incoding") is UTF-8. If an input document's encoding is not self-evident (by HTTP character set, Byte Order Mark, XMLDecl, and so on), then the default input encoding is assumed. It is recommended that you set the default encoding explicitly if using only single byte character sets such as US-ASCII or any of the ISO-8859 character sets because single-byte performance is fastest. The flag XML_FLAG_FORCE_INCODING specifies that the default input encoding should always be applied to input documents, ignoring any BOM or XMLDecl. Nevertheless, a protocol declaration such as HTTP character set is always honored.

Choose the data encoding for DOM and SAX ("outcoding") carefully. Single-byte encodings are the fastest, but can represent only a very limited set of characters. Next fastest is Unicode (UTF-16), and slowest are the multibyte encodings such as UTF-8. If input data cannot be converted to the outcoding without loss, then an error occurs. For maximum utility, you should use a Unicode-based outcoding because Unicode can represent any character. If outcoding is not specified, then it defaults to the incoding of the first document parsed.

17 Using the XSLT and XVM Processors for C

This chapter contains these topics:

XVM Processor

XSLT Processor

Using the Demo Files Included with the Software

Note:

Use the new unified C API for new XDK and Oracle XML DB applications. The old C functions are deprecated and supported only for backward compatibility, but will not be enhanced. They will be removed in a future release.

The new C API is described in Chapter 18, "Using the XML Parser for C".

XVM Processor

The Oracle XVM Package implements the XSL Transformation (XSLT) language as specified in the W3C Recommendation of 16 November 1999. The package includes XSLT Compiler and XSLT Virtual Machine (XVM). The implementation by Oracle of the XSLT compiler and the XVM enables compilation of XSLT (Version 1.0) into bytecode format, which is executed by the virtual machine. XSLT Virtual Machine is the software implementation of a "CPU" designed to run compiled XSLT code. The virtual machine assumes a compiler compiling XSLT stylesheets to a sequence of bytecodes or machine instructions for the "XSLT CPU". The bytecode program is a platform-independent sequence of 2-byte units. It can be stored, cached and run on different XVMs. The XVM uses the bytecode programs to transform instance XML documents. This approach clearly separates compile-time from run-time computations and specifies a uniform way of exchanging data between instructions. The benefits of this approach are:

An XSLT stylesheet can be compiled, saved in a file, and re-used often, even on different platforms.

The XVM is significantly faster and uses less memory than other XSLT processors.

The bytecodes are not language-dependent. There is no difference between code generated from a C or C++ XSLT compiler.

XVM Usage Example

A typical scenario of using the package APIs has the following steps:

Create and use an XML meta-context object.

xctx = XmlCreate(&err,...);

Create and use an XSLT compiler object.

comp = XmlXvmCreateComp(xctx);

Compile an XSLT stylesheet or XPath expression and store or cache the resulting bytecode.

code = XmlXvmCompileFile(comp, xslFile, baseuri, flags, &err);

or

code = XmlXvmCompileDom (comp, xslDomdoc, flags, &err);

or

code = XmlXvmCompileXPath (comp, xpathexp,  namespaces, &err);

Create and use an XVM object. The explicit stack size setting is needed when XVM terminates with a "Stack Overflow" message or when smaller memory footprints are required. See XmlXvmCreate().

vm = XmlXvmCreate(xctx, "StringStack", 32, "NodeStack", 24, NULL);

Set the output (optional). Default is a stream.

err = XmlXvmSetOutputDom (vm, NULL);

or

err = XmlXvmSetOutputStream(vm, &xvm_stream);

or

err = XmlXvmSetOutputSax(vm, &xvm_callback, NULL);

Set a stylesheet bytecode to the XVM object. Can be repeated with other bytecode.

len = XmlXvmGetBytecodeLength(code, &err);
err = XmlXvmSetBytecodeBuffer(vm, code, len);

or

err = XmlXvmSetBytecodeFile (vm, xslBytecodeFile);

Transform an instance XML document or evaluate a compiled XPath expression. Can be repeated with the same or other XML documents.

err = XmlXvmTransformFile(vm, xmlFile, baseuri);

or

err = XmlXvmTransformDom (vm, xmlDomdoc);

or

obj  = (xvmobj*)XmlXvmEvaluateXPath (vm, code, 1, 1, node);

Get the output tree fragment (if DOM output is set at step 5).

node = XmlXvmGetOutputDom (vm);

Delete the objects.

XmlXvmDestroy(vm);
XmlXvmDestroyComp(comp);
XmlDestroy(xctx);

Using the XVM Processor Command-Line Utility

The XVM processor is accessed from the command-line this way:

xvm

Usage:

xvm options xslfile xmlfile

xvm options xpath xmlfile

Options:

-c        Compile xslfile. The bytecode is in "xmlfile.xvm".
-ct       Compile xslfile and transform xmlfile.
-t        Transform xmlfile using bytecode from xslfile.
-xc       Compile xpath. The bytecode is in "code.xvm".
-xct      Compile and evaluate xpath with xmlfile.
-xt       Evaluate XPath bytecode from xpath with xmlfile.

Examples:

xvm -ct  db.xsl db.xml
xvm -t   db.xvm db.xml
xvm -xct "doc/employee[15]/family" db.xml

Accessing XVM Processor for C

Oracle XVM Processor for C is part of the standard installation of Oracle Database.

See Also:

Oracle Database XML C API Reference "XSLTVM APIs for C"

http://www.oracle.com/technetwork/database/features/xmldb/overview/xdkhome-092156.html

XSLT Processor

The Oracle XSL/XPath Package implements the XSL Transformation (XSLT) language as specified in the W3C Recommendation of 16 November 1999. The package includes the XSLT processor and XPath Processor. The Oracle implementation of the XSLT processor follows the more common design approach, which melts 'compiler' and 'processor' into one object.

XSLT Processor Usage Example

A typical scenario of using the package APIs has the following steps:

Create and use an XML meta-context object.

xctx = XmlCreate(&err,...);

Parse the XSLT stylesheet.

xslDomdoc = XmlLoadDom(xctx, &err, "file", xslFile, "base_uri", baseuri, NULL);

Create an XSLT processor for the stylesheet

xslproc = XmlXslCreate (xctx, xslDomdoc, baseuri, &err);

Parse the instance XML document.

xmlDomdoc = XmlLoadDom(xctx, &err, "file", xmlFile,  "base_uri", baseuri, NULL);

Set the output (optional). Default is DOM.

err = XmlXslSetOutputStream(xslproc, &stream);

Transform the XML document. This step can be repeated with the same or other XML documents.

err = XmlXslProcess (xslproc, xmlDomdoc, FALSE);

Get the output (if DOM).

node = XmlXslGetOutput(xslproc);

Delete objects.

XmlXslDestroy(xslproc);
XmlDestroy(xctx);

XPath Processor Usage Example

A typical scenario of using the package APIs has the following steps:

Create and use an XML meta-context object.

xctx = XmlCreate(&err,...);

Parse the XML document or get the current node from already existing DOM.

node = XmlLoadDom(xctx, &err, "file", xmlFile,  "base_uri", baseuri, NULL);

Create an XPath processor.

xptproc = XmlXPathCreateCtx(xctx, NULL, node, 0, NULL);

Parse the XPath expression.

exp = XmlXPathParse (xptproc, xpathexpr, &err);

Evaluate the XPath expression.

obj = XmlXPathEval(xptproc, exp, &err);

Delete the objects.

XmlXPathDestroyCtx (xptproc);
XmlDestroy(xctx);

Using the C XSLT Processor Command-Line Utility

You can call the C Oracle XSLT processor as an executable by invoking bin/xsl:

xsl [switches] stylesheet instance
or
xsl -f [switches] [document filespec]

If no style sheet is provided, no output is generated. If there is a style sheet, but no output file, output goes to stdout.

Table 17-1 lists the command line options.

Table 17-1 XSLT Processor for C: Command Line Options

Option
Description

-B BaseUri

Set the Base URI for XSLT processor: BaseUri of http://pqr/xsl.txt resolves pqr.txt to http://pqr/pqr.txt

-e encoding

Specify default input file encoding (-ee to force).

-E encoding

Specify DOM or SAX encoding.

-f

File - interpret as filespec, not URI.

-G xptrexprs

Evaluates XPointer schema examples given in a file.

-h

Help - show this usage. (Use -hh for more options.)

-hh

Show complete options list.

-i n

Number of times to iterate the XSLT processing.

-l language

Language for error reporting.

-o XSLoutfile

Specifies output file of XSLT processor.

-v

Version - display parser version then exit.

-V var value

Test top-level variables in C XSLT.

-w

Whitespace - preserve all whitespace.

-W

Warning - stop parsing after a warning.

Accessing Oracle XSLT processor for C

Oracle XSLT processor for C is part of the standard installation of Oracle Database.

See Also:

Oracle Database XML C API Reference "XSLT APIs for C"

Oracle Database XML C API Reference "XPath APIs for C"

http://www.oracle.com/technetwork/database/features/xmldb/overview/xdkhome-092156.html

Using the Demo Files Included with the Software

$ORACLE_HOME/xdk/demo/c/parser/ directory contains several XML applications to illustrate how to use the XSLT for C.

Table 17-2 lists the files in that directory:

Table 17-2 XSLT for C Demo Files

Sample File Name
Description

XSLSample.c

Source for XSLSample program

XSLSample.std

Expected output from XSLSample

class.xml

XML file that can be used with XSLSample

iden.xsl

Stylesheet that can be used with XSLSample

cleo.xml

XML version of Shakespeare's play

XVMSample.c

Sample usage of XSLT Virtual Machine and compiler. It takes two filenames as input - XML file and XSLT stylesheet file.

XVMXPathSample.c

Sample usage of XSLT Virtual Machine and compiler. It takes XML file name and XPath expression as input. Generates the result of the evaluated XPath expression.

XSLXPathSample.c

Sample usage of XSL/XPath processor. It takes XML file name and XPath expression as input. Generates the result of the evaluated XPath expression.

Building the C Demo Programs for XSLT

Change directories to the demo directory and read the README file. This will explain how to build the sample programs according to your operating system.

Here is the usage of XSLT processor sample XSLSample, which takes two files as input, the XML file and the XSLT stylesheet:

XSLSample xmlfile xslss

18 Using the XML Parser for C

This chapter contains these topics:

Introduction to the XML Parser for C

Using the XML Parser for C

Using the DOM API for C

Using orastream Functions

Using the SAX API for C

Using the XML Pull Parser for C

Using OCI and the XDK C API

Introduction to the XML Parser for C

This section contains the following topics:

Prerequisites

Standards and Specifications

See Also:

"Introduction to the XML Parsing for Java" for a generic introduction to XML parsing with DOM and SAX. Much of the information in the introduction is language-independent and applies equally to C.

Prerequisites

The Oracle XML parser for C reads an XML document and uses DOM or SAX APIs to provide programmatic access to its content and structure. You can use the parser in validating or nonvalidating mode. A pull parser is also available.

This chapter assumes that you are familiar with the following technologies:

Document Object Model (DOM). DOM is an in-memory tree representation of the structure of an XML document.

Simple API for XML (SAX). SAX is a standard for event-based XML parsing.

Using the XML Pull Parser for C. Pull Parser uses XML events.

Document Type Definition (DTD). An XML DTD defines the legal structure of an XML document.

XML Schema. Like a DTD, an XML schema defines the legal structure of an XML document.

XML Namespaces. Namespaces are a mechanism for differentiating element and attribute names.

If you require a general introduction to the preceding technologies, consult the XML resources listed in "Related Documents" of the preface.

Standards and Specifications

XML 1.0 is a W3C Recommendation. The C XDK API provides full support for XML 1.0 (Second Edition). You can find the specification for the Second Edition at the following URL:

http://www.w3.org/TR/2000/REC-xml-20001006

The DOM Level 1, Level 2, and Level 3 specifications are W3C Recommendations. The C XDK API provides full support for DOM Level 1 and 2, but no support for Level 3. You can find links to the specifications for all three levels at the following URL:

http://www.w3.org/DOM/DOMTR

SAX is available in version 1.0, which is deprecated, and 2.0. SAX is not a W3C specification. The C XDK API provides full support for both SAX 1.0 and 2.0. You can find the documentation for SAX at the following URL:

http://www.saxproject.org

XML Namespaces are a W3C Recommendation. You can find the specification at the following URL:

http://www.w3.org/TR/REC-xml-names

See Also:

Chapter 31, "XDK Standards" for a summary of the standards supported by the XDK

Using the XML Parser for C

Oracle XML parser for C checks if an XML document is well-formed, and optionally validates it against a DTD. Your application can access the parsed data through the DOM or SAX APIs.

Overview of the Parser API for C

The core of the XML parsing API are the XML, DOM, and SAX APIs. Table 18-1 describes the interfaces for these APIs. Refer to Oracle XML API Reference for the complete API documentation.

Table 18-1 Interfaces for XML, DOM, and SAX APIs

Package
Interfaces
Function Name Convention

XML

This package implements a single XML interface. The interface defines functions for the following tasks:

Creating and destroying contexts. A top-level XML context (xmlctx) shares common information between cooperating XML components.

Creating and parsing XML documents and DTDs.

Function names begin with the string Xml.

Refer to Oracle Database XML C API Reference for API documentation.

DOM

This package provides programmatic access to parsed XML. The package implements the following interfaces:

Attr defines get and set functions for XML attributes.

CharacterData defines functions for manipulating character data.

Document defines functions for creating XML nodes, obtaining information about an XML document, and setting the DTD for a document.

DocumentType defines get functions for DTDs.

Element defines get and set functions for XML elements.

Entity defines get functions for XML entities.

NamedNodeMap defines get functions for named nodes.

Node defines get and set functions for XML nodes.

NodeList defines functions that free a node list and get a node from a list.

Notation defines functions that get the system and public ID from a node.

ProcessingInstruction defines get and set functions for processing instructions.

Text defines a function that splits a text node into two.

Function names begin with the string XmlDom.

Refer to Oracle Database XML C API Reference for API documentation.

SAX

This package provides programmatic access to parsed XML. The package implements the SAX interface, which defines functions that receive notifications for SAX events.

Function names begin with the string XmlSax.

Refer to Oracle Database XML C API Reference for API documentation.

XML Pull Parser

XML events is a representation of an XML document which is similar to SAX events in that the document is represented as a sequence of events like start tag, end tag, comment, and so on. The difference is that SAX events are driven by the parser (producer) and XML events are driven by the application (consumer).

Function names begin with the string XmlEv.

Refer to Oracle Database XML C API Reference for API documentation.

XML Parser for C Datatypes

Refer to Oracle XML API Reference for the complete list of datatypes for the C XDK. Table 18-2 describes the datatypes used in the XML parser for C.

Table 18-2 Datatypes Used in the XML Parser for C

Datatype
Description

oratext

String pointer

xmlctx

Master XML context

xmlsaxcb

SAX callback structure (SAX only)

ub4

32-bit (or larger) unsigned integer

uword

Native unsigned integer

XML Parser for C Defaults

Note the following defaults for the XML parser for C:

Character set encoding is UTF-8. If all your documents are ASCII, then setting the encoding to US-ASCII increases performance.

The parser prints messages to stderr unless an error handler is provided.

The parser checks inputs documents for well-formedness but not validity. You can set the property "validate" to validate the input.

Note:

It is recommended that you set the default encoding explicitly if using only single byte character sets (such as US-ASCII or any of the ISO-8859 character sets) for faster performance than is possible with multibyte character sets such as UTF-8.

The parser conforms to the XML 1.0 specification when processing whitespace, that is, the parser reports all whitespace to the application but indicates which whitespace can be ignored. However, some applications may prefer to set the property "discard-whitespace," which discards all whitespace between an end-element tag and the following start-element tag.

See Also:

Oracle Database XML C API Reference for the DOM, SAX, pull parser, and callback APIs.

http://www.oracle.com/technetwork/database/features/xmldb/overview/xdkhome-092156.html

XML Parser for C Calling Sequence

Figure 18-1 illustrates the calling sequence for the XML parser for C.

Figure 18-1 XML Parser for C Calling Sequence

Description of Figure 18-1 follows
Description of "Figure 18-1 XML Parser for C Calling Sequence"

Using the XML Parser for C: Basic Process

Perform the following steps in your application:

Initialize the parsing process with the XmlCreate() function. The following sample code fragment is from DOMNamespace.c:

xmlctx     *xctx;
...
xctx = XmlCreate(&ecode, (oratext *) "namespace_xctx", NULL);

Parse the input item, which can be an XML document or string buffer.

If you are parsing with DOM, call the XmlLoadDom() function. The following sample code fragment is from DOMNamespace.c:

xmldocnode *doc;
...
doc = XmlLoadDom(xctx, &ecode, "file", DOCUMENT,
                 "validate", TRUE, "discard_whitespace", TRUE, NULL);

If you are parsing with SAX, call the XmlLoadSax() function. The following sample code fragment is from SAXNamespace.c:

xmlerr      ecode;
...
ecode = XmlLoadSax(xctx, &sax_callback, &sc, "file", DOCUMENT,
                   "validate", TRUE, "discard_whitespace", TRUE, NULL);

If you are using the pull parser, then include the following steps to create the event context and load the document to parse:

evctx = XmlEvCreatePPCtx(xctx, &xerr, NULL);
XmlEvLoadPPDoc(xctx, evctx, "File", input_filenames[i], 0, NULL);

If you are using the DOM interface, then include the following steps:

Use the XmlLoadDom() function to call XmlDomGetDocElem(). This step calls other DOM functions, which are typically node or print functions that output the DOM document, as required. The following sample code fragment is from DOMNamespace.c:

printElements(xctx, XmlDomGetDocElem(xctx, doc));

Invoke the XmlFreeDocument() function to clean up any data structures created during the parse process. The following sample code fragment is from DOMNamespace.c:

XmlFreeDocument(xctx, doc);

If you are using the SAX interface, then include the following steps:

Process the results of the invocation of XmlLoadSax() with a callback function, such as the following

xmlsaxcb saxcb = {
 UserStartDocument,  /* user's own callback functions */
 UserEndDocument,
 /* ... */
};

if (XmlLoadSax(xctx, &saxcb, NULL, "file", "some_file.xml", NULL) != 0)
  /* an error occured */

Register the callback functions. Note that you can set any of the SAX callback functions to NULL if not needed.

If you are using the pull parser, iterate over the events using:

cur_event = XmlEvNext(evctx);

Use the Get APIs to get information about that event.

Use XmlFreeDocument() to clean up the memory and structures used during a parse. The program does not free memory allocated for parameters passed to the SAX callbacks or for nodes and data stored with the DOM parse tree until you call XMLFreeDocument() or XMLDestroy(). The following sample code fragment is from DOMNamespace.c:

XmlFreeDocument(xctx, doc);

Either return to Step 2 or proceed to the next step.

For the pull parser call XmlEvCleanPPCtx() to release memory and structures used during the parse. The application can call XmlEvLoadPPDoc() again to parse another document. Or, it can call XMLEvDestroyPPCtx() after which the pull parser context cannot be used again.

XmlEvCleanPPCtx(xctx, evctx);
...
XmlEvDestroyPPCtx(xctx, evctx);

Terminate the parsing process with XmlDestroy(). The following sample code fragment is from DOMNamespace.c:

(void) XmlDestroy(xctx);

If threads fork off somewhere in the sequence of calls between initialization and termination, the application produces unpredictable behavior and results.

You can use the memory callback functions XML_ALLOC_F and XML_FREE_F for your own memory allocation. If you do, then specify both functions.

See Also:

"Using the XML Pull Parser for C"

Running the XML Parser for C Demo Programs

The $ORACLE_HOME/xdk/demo/c/ (UNIX) and %ORACLE_HOME%\xdk\demo\c (Windows) directories include several XML applications that illustrate how to use the XML parser for C with the DOM and SAX interfaces. Table 18-3 describes the demos.

The make utility compiles the source file fileName.c to produce the demo program fileName and the output file fileName.out . The fileName.std is the expected output.

Table 18-3 C Parser Demos

Directory
Contents
Demos

dom

DOMNamespace.c
DOMSample.c
FullDom.c
FullDom.xml
NSExample.xml
Traverse.c
XPointer.c
class.xml
cleo.xml
pantry.xml

The following demo programs use the DOM API:

The DOMNamespace program uses Namespace extensions to the DOM API. It prints out all elements and attributes of NSExample.xml along with full namespace information.

The DOMSample program uses DOM APIs to display an outline of Cleopatra, that is, the XML elements ACT and SCENE. The cleo.xml document contains the XML version of Shakespeare's The Tragedy of Antony and Cleopatra.

The FullDom program shows sample usage of the full DOM interface. It exercises all the calls. The program accepts FullDom.xml, which shows the use of entities, as input.

The Traverse program illustrates the use of DOM iterators, tree walkers, and ranges. The program accepts the class.xml document, which describes a college Calculus course, as input.

The XPointer program illustrates the use of the XML Pointer Language by locating the children of the <pantry> element in pantry.xml.

sax

NSExample.xml
SAXNamespace.c
SAXSample.c
cleo.xml

The following demo programs use the SAX APIs:

The SAXNamespace program uses namespace extensions to the SAX API. It prints out all elements and attributes of NSExample.xml along with full namespace information.

The SAXSample program uses SAX APIs to show all lines in the play Cleopatra containing a given word. If you do not specify a word, then it uses the word "death." The cleo.xml document contains the XML version of Shakespeare's The Tragedy of Antony and Cleopatra.

You can find documentation that describes how to compile and run the sample programs in the README in the same directory. The basic steps are as follows:

Change into the $ORACLE_HOME/xdk/demo/c directory (UNIX) or %ORACLE_HOME%\xdk\demo\c directory (Windows).

Make sure that your environment variables are set as described in "Setting C XDK Environment Variables on UNIX" and "Setting C XDK Environment Variables on Windows".

Run make (UNIX) or Make.bat (Windows) at the system prompt. The make utility changes into each demo subdirectory and runs make to do the following:

Compiles the C source files with the cc utility. For example, the Makefile in the $ORACLE_HOME/xdk/demo/c/dom directory includes the following line:

$(CC) -o DOMSample $(INCLUDE) $@.c $(LIB)

Runs each demo program and redirects the output to a file. For example, the Makefile in the $ORACLE_HOME/xdk/demo/c/dom directory includes the following line:

./DOMSample > DOMSample.out

Compare the *.std files to the *.out files for each program. The *.std file contains the expected output for each program. For example, DOMSample.std contains the expected output from running DOMSample.

Using the C XML Parser Command-Line Utility

The xml utility, which is located in $ORACLE_HOME/bin (UNIX) or %ORACLE_HOME%\bin (Windows), is a command-line interface that parses XML documents. It checks for both well-formedness and validity.

To use xml ensure that your environment is set up as described in "Setting C XDK Environment Variables on UNIX" and "Setting C XDK Environment Variables on Windows".

Use the following syntax on the command line to invoke xml. Use xml.exe for Windows:

xml [options] [document URI]
xml -f [options] [document filespec]

Table 18-4 describes the command-line options.

Table 18-4 C XML Parser Command-Line Options

Option
Description

-B BaseURI

Sets the base URI for the XSLT processor. The base URI of http://pqr/xsl.txt resolves pqr.txt to http://pqr/pqr.txt.

-c

Checks well-formedness, but performs no validation.

-e encoding

Specifies default input file encoding ("incoding").

-E encoding

Specifies DOM/SAX encoding ("outcoding").

-f file

Interprets the file as filespec, not URI.

-G xptr_exprs

Evaluates XPointer scheme examples given in a file.

-h

Shows usage help and basic list of command-line options.

-hh

Shows complete list command-line options.

-i n

Specifies the number of times to iterate the XSLT processing.

-l language

Specifies the language for error reporting.

-n

Traverses the DOM and reports the number of elements, as shown in the following sample output:

ELEMENT       1
 PCDATA       1
    DOC       1
  TOTAL       3 * 60 = 180

-o XSLoutfile

Specifies the output file of the XSLT processor.

-p

Prints the document/DTD structures after the parse. For example, the root element <greeting>hello</greeting> is printed as:

+---ELEMENT greeting
    +---PCDATA "hello"

-P

Prints the document from the root element. For example, the root element <greeting>hello</greeting> is printed as:

<greeting>hello</greeting>

-PP

Prints from the root node (DOC) and includes the XML declaration.

-PE encoding

Specifies the encoding for -P or -PP output.

-PX

Includes the XML declaration in the output.

-s stylesheet

Specifies the XSLT stylesheet.

-v

Displays the XDK parser version and then exits.

-V var value

Tests top-level variables in CXSLT.

-w

Preserves all whitespace.

-W

Stops parsing after a warning.

-x

Exercises the SAX interface and prints the document, as shown in the following sample output:

StartDocument
XMLDECL version='1.0' encoding=FALSE
<greeting>
    "hello"
</greeting>
EndDocument

Using the XML Parser Command-Line Utility: Example

You can test xml on the various XML files located in $ORACLE_HOME/xdk/demo/c. Example 18-1 displays the contents of NSExample.xml.

Example 18-1 NSExample.xml

<!DOCTYPE doc [
<!ELEMENT doc (child*)>
<!ATTLIST doc xmlns:nsprefix CDATA #IMPLIED>
<!ATTLIST doc xmlns CDATA #IMPLIED>
<!ATTLIST doc nsprefix:a1 CDATA #IMPLIED>
<!ELEMENT child (#PCDATA)>
]>
<doc nsprefix:a1 = "v1" xmlns="http://www.w3c.org"
     xmlns:nsprefix="http://www.oracle.com">
<child>
This element inherits the default Namespace of doc.
</child>
</doc>

You can parse this file, count the number of elements, and display the DOM tree as shown in the following example:

xml -np NSEample.xml > xml.out

The output is shown in the following example:

Example 18-2 xml.out

   ELEMENT       2
    PCDATA       1
       DOC       1
       DTD       1
  ELEMDECL       2
  ATTRDECL       3
     TOTAL      10 * 112 = 1120
+---ELEMENT doc [nsprefix:a1='v1'*, xmlns='http://www.w3c.org'*, xmlns:nsprefix=
'http://www.oracle.com'*]
    +---ELEMENT child
        +---PCDATA "
This element inherits the default Namespace of doc.
"

Using the DOM API for C

This section contains the following topics:

Controlling the Data Encoding of XML Documents for the C API

Using NULL-Terminated and Length-Encoded C API Functions

Handling Errors with the C API

Controlling the Data Encoding of XML Documents for the C API

XML data occurs in many encodings. You can control the XML encoding in the following ways:

Specify a default encoding to assume for files that are not self-describing

Specify the presentation encoding for DOM or SAX

Re-encode when a DOM is serialized

Input XML data is always encoded. Some encodings are entirely self-describing, such as UTF-16, which requires a specific BOM before the start of the actual data. The XMLDecl or MIME header of the document can also specify an encoding. If the application cannot determine the specific encoding, then it applies the default input encoding. If you do not provide a default, then the application assumes UTF-8 on ASCII platforms and UTF-E on EBCDIC platforms.

The API makes a provision for cases when the encoding data of the input document is corrupt. For example, suppose an ASCII document with an XMLDecl of encoding=ascii is blindly converted to EBCDIC. The new EBCDIC document contains (in EBCDIC) an XMLDecl that incorrectly claims the document is ASCII. The correct behavior for a program that is re-encoding XML data is to regenerate but not convert the XMLDecl. The XMLDecl is metadata, not data itself. This rule is often ignored, however, which results in corrupt documents. To work around this problem, the API provides an additional flag that enables you to forcibly set the input encoding, thereby overcoming an incorrect XMLDecl.

The precedence rules for determining input encoding are as follows:

Forced encoding as specified by the user

Caution:

Forced encoding can result in a fatal error if there is a conflict. For example, the input document is UTF-16 and starts with a UTF-16 BOM, but the user specifies a forced UTF-8 encoding. In this case, the parser objects about the conflict.

Protocol specification (HTTP header, and so on)

XMLDecl specification

User's default input encoding

The default, which is UTF-8 on ASCII platforms or UTF-E on EBCDIC platforms

After the application has determined the input encoding, it can parse the document and present the data. You are allowed to choose the presentation encoding; the data is in that encoding regardless of the original input encoding.

When an application writes back a DOM in serialized form, it can choose at that time to re-encode the presentation data. Thus, the you can place the serialized document in any encoding.

Using NULL-Terminated and Length-Encoded C API Functions

The native string representation in C is NULL-terminated. Thus, the primary DOM interface takes and returns NULL-terminated strings. When stored in table form, however, Oracle XML DB data is not NULL-terminated but length-encoded. Consequently, the XDK provides an additional set of length-encoded APIs for the high-frequency cases to improve performance. In particular, the DOM functions in Table 18-5 have dual APIs.

Table 18-5 NULL-Terminated and Length-Encoded C API Functions

NULL-Terminated API
Length-Encoded API

XmlDomGetNodeName()

XmlDomGetNodeNameLen()

XmlDomGetNodeLocal()

XmlDomGetNodeLocalLen()

XmlDomGetNodeURI()

XmlDomGetNodeURILen()

XmlDomGetNodeValue()

XmlDomGetNodeValueLen()

XmlDomGetAttrName()

XmlDomGetAttrNameLen()

XmlDomGetAttrLocal()

XmlDomGetAttrLocalLen()

XmlDomGetAttrURI()

XmlDomGetAttrURILen()

XmlDomGetAttrValue()

XmlDomGetAttrValueLen()

Handling Errors with the C API

The C API functions typically either return a numeric error code (0 for success, nonzero on failure), or pass back an error code through a variable. In all cases, the API stores error codes. Your application can retrieve the most recent error by calling the XmlDomGetLastError() function.

By default, the functions output error messages to stderr. However, you can register an error message callback at initialization time. When an error occurs, the application invokes the registered callback and does not print an error.

Using orastream Functions

The orastream function API is an interface that enables you to stream large chunks of data out of a node instead of getting it all in one piece. Nodes of greater than 64KB are thus accessible.

The orastream API represents a generic input or output stream. This interface is available to XDK users through xml.h and is defined by the orastream data structure and a set of functions that implement the interface. The creator of the stream passes a list of stream function addresses, along with a stream context to OraStreamInit. This function returns an instance of an orastream structure.

A number of stream properties are specified at the time of initialization. If read or write is provided, the stream operates in byte mode using OraStreamRead() and OraStreamWrite(). If "read_char" or "write_char" is provided, the stream operates in character mode using OraStreamReadChar() and OraStreamWriteChar(). In character mode only complete characters are read or written and are never split over buffer boundaries.

A stream context is used to represent the state of the orastream and it persists for the lifetime of a stream.

Just like the input or output streams in Java, a source or a sink for the data is always specified. Output streams store the address of the external stream or object where they need to populate the data. Similarly, input streams store the address of the object that is read.

Here are the orastream functions:

struct orastream;
typedef struct orastream orastream;
typedef ub4 oraerr; /* Error code: zero is success, non-zero is failure */

/* Initialize (Create) & Destroy (Terminate) stream object */

orastream  *OraStreamInit(void *sctx, void *sid, oraerr *err, ...);
oraerr     OraStreamTerm(orastream *stream);

/* Set or Change SID (streamID) for stream (returns old stream ID through osid)*/

oraerr     OraStreamSid(orastream *stream, void *sid, void **osid);

/* Is a stream readable or writable? */

boolean    OraStreamReadable(orastream *stream);
boolean    OraStreamWritable(orastream *stream);

/* Open & Close stream */

oraerr     OraStreamOpen(orastream *stream, ubig_ora *length);
oraerr     OraStreamClose(orastream *stream);

/* Read | Write byte stream */

oraerr     OraStreamRead(orastream *stream, oratext *dest, ubig_ora size,
           oratext **start, ubig_ora *nread, ub1 *eoi);
oraerr     OraStreamWrite(orastream *stream, oratext *src, ubig_ora size,
           ubig_ora *nwrote);

/* Read | Write char stream */

oraerr     OraStreamReadChar(orastream *stream, oratext *dest, ubig_ora size,
           oratext **start, ubig_ora *nread, ub1 *eoi);
oraerr     OraStreamWriteChar(orastream *stream, oratext *src, ubig_ora size,
           ubig_ora *nwrote);

/* Return handles for stream */

orastreamhdl *OraStreamHandle(orastream *stream);

/* Returns status: if the stream object is currently opened or not */

boolean OraStreamIsOpen(orastream *stream);

The stream error codes are:

#define ORASTREAM_ERR_NULL_POINTER      1      /* NULL pointer given */
#define ORASTREAM_ERR_BAD_STREAM        2      /* invalid stream object */
#define ORASTREAM_ERR_WRONG_DECTION     3      /* tried wrong-direction I/O */
#define ORASTREAM_ERR_UNKNOWN_PROPERTY  4      /* unknown creation prop */
#define ORASTREAM_ERR_NO_DIRECTION      5      /* neither read nor write? */
#define ORASTREAM_ERR_BI_DIRECTION      6      /* both read any write? */
#define ORASTREAM_ERR_NOT_OPEN          7      /* stream not open */
#define ORASTREAM_ERR_WRONG_MODE        8      /* wrote byte/char mode */
/* --- Open errors --- */
#define ORASTREAM_ERR_CANT_OPEN         10     /* can't open stream */
/* --- Close errors --- */
#define ORASTREAM_ERR_CANT_CLOSE        20     /* can't close stream */

See Also:

Oracle Database XML C API Reference for reference information such as parameter definitions in the orastream API

Example 18-3 Using orastream Functions

int test_read()
{
   xmlctx *xctx = NULL;
   oratext *barray, *docName = "NSExample.xml";
   orastream* ostream = (orastream *) 0;
   xmlerr ecode = 0;
   ub4 wcount = 0;
   ubig_ora  destsize, nread;
   oraerr oerr = 0;
   ub1 eoi = 0;
   nread = destsize = 1024;
   if (!(xctx = XmlCreateNew(&ecode, (oratext *)"stream_xctx", NULL, wcount,
                             NULL)))
    {
       printf("Failed to create XML context, error %u\n", (unsigned)ecode);
       return -1;
    }

   barray = XmlAlloc(xctx, sizeof(oratext) * destsize);

   /* open function should be specified in order to read correctly. */
   if (!(ostream = OraStreamInit(NULL,docName, (oraerr *)&ecode,
                                 "open", fileopen,
                                 "read", fileread,
                                 NULL)))
   {
      printf("Failed to initialize OrsStream, error %u\n",(unsigned)ecode);
      return -1;
   }

   /* check readable and writable  */
    if (OraStreamReadable(ostream))
       printf("ostream is readable\n");
    else
       printf("ostream is not readable\n");

     if (OraStreamWritable(ostream))
       printf("ostream is writable\n");
    else
       printf("ostream is not writable\n");

    if (oerr = OraStreamRead(ostream, barray, destsize, &barray, &nread, &eoi))
    {
      printf("Failed to read due to orastream was not open, error %u\n", oerr);
    }

   /* open orastream */
   OraStreamOpen(ostream, NULL);

   /* read document */
   OraStreamRead(ostream, barray, destsize, &barray, &nread, &eoi);

   OraStreamTerm(ostream);

   XmlDestroy(xctx);
   return 0;
}
ORASTREAM_OPEN_F(fileopen, sctx, sid, hdl, length)
{
    FILE *fh = NULL;

    printf("Opening orastream %s...\n", (oratext *)sid);

    if (sid && ((fh= fopen(sid, "r")) != NULL))
    {
        printf("Opening orastream %s...\n", (oratext *)sid);
    }
    else
    {
         printf("Failed to open input file.\n");
         return -1;
     }

    /* store file handle generically, NULL means stdout */
    hdl->ptr_orastreamhdl = fh;

    return XMLERR_OK;
}

ORASTREAM_READ_F(fileread, sctx, sid, hdl,
                         dest, size, start, nread, eoi)
{
    FILE *fh = NULL;
    int i =0;
    printf("Reading orastream %s ...\n", (oratext *)sid);

    // read data from file to dest
    if ((fh = (FILE *) hdl->ptr_orastreamhdl) != NULL)
        *nread = fread(dest, 1, size, fh);
    printf("Read %d bytes from orastream...\n", (int) *nread);

    *eoi = (*nread < size);
    if (start)
        *start = dest;

    printf("printing document ...\n");
    for(i =0; i < *nread; i++)
    printf("%c", (char)dest[i]);
    printf("\nend ...\n");
    return ORAERR_OK;
}

Using the SAX API for C

To use SAX, initialize an xmlsaxcb structure with function pointers and pass it to XmlLoadSax(). You can also include a pointer to a user-defined context structure, which you pass to each SAX function.

See Also:

Oracle Database XML C API Reference for the SAX callback structure

Using the XML Pull Parser for C

The XML Pull Parser is an implementation of the XML Events interface.

The XML Pull Parser and the SAX parser are similar, but using the Pull Parser, the application (consumer) drives the events, while in SAX, the parser (producer) drives the events. Both the XML Pull Parser and SAX represent the document as a sequence of events, with start tags, end tags, and comments.XML Pull Parser gives control to the application by exposing a simple set of APIs and an underlying set of events. Methods such as XmlEvNext allow an application to ask for (or pull) the next event, rather than handling the event in a callback, as in SAX. Thus, the application has more procedural control over XML processing. Also, the application can decide to stop further processing, unlike a SAX application, which parses the entire document.

This section contains the following topics:

Using Basic XML Pull Parsing Capabilities

Parsing Multiple XML Documents

ID Callback

Error Handling for the XML Pull Parser

Sample Pull Parser Application

Using Basic XML Pull Parsing Capabilities

To use the XML Pull Parser, your application must do the following, in the order given:

Call XmlCreate to initialize the XML meta-context.

Initialize the Pull Parser context with a call to the XmlEvCreatePPCtx function, which creates and returns the event context.

The XmlEvCreatePPCtx function supports all the properties supported by XmlLoadDom and XmlLoadSax, plus some additional ones.

The XmlEvCreatePPCtx and XmlEvCreatePPCtxVA functions are fully implemented.

Ensure that the event context is passed to all subsequent calls to the Pull Parser.

Terminate the Pull Parser context by calling the XmlEvDestoryPPCtx function, to clean up memory.

Destroy the XML meta-context by calling the XmlDestoryCtx function.

XML Event Context

Example 18-4 shows the structure of the event context.

Example 18-4 XML Event Context

typedef  struct {
   void *ctx_xmlevctx;                   /* implementation specific context */
   xmlevdisp *disp_xmlevctx;             /* dispatch table */
   ub4 checkword_xmlevctx;               /* checkword for integrity check */
   ub4 flags_xmlevctx;                   /* mode; default: expand_entity */
   struct xmlevctx *input_xmlevctx;      /* input xmlevctx; chains the XML Event
                                            context */
} xmlevctx;

About the XML Event Context

Each XML Pull Parser is allowed to create its own context and implement its own API functions.

Dispatch Table

The dispatch table, disp_xmlevctx, contains one pointer for each API function, except for the XmlEvCreatePPCtx, XmlEvCreatePPCtxVA, XmlEvDestoryPPCtx, XmlEvLoadPPDoc, and XmlEvCleanPPCtx functions.

When the event context is created, the pointer disp_xmlevctx is initialized with the address of that static table.

Implementation-Specific Event Context

The field ctx_xmlevctx must be initialized with the address of the context specific to this invocation of the particular implementation. The implementation-specific event context is of type *void, so that it can differ for different applications.

Input Event Context

Each Pull Parser can specify an input event context, xmlevctx. This field enables the parser to chain multiple event producers. As a result, if a dispatch function is specified as NULL in a context, the application uses the next non-null dispatch function in the chain of input event contexts. The base xmlevctx must ensure that all dispatch function pointers are non-null.

Parsing Multiple XML Documents

After creating and initializing the XML Event Context, the application can parse multiple documents with repeated calls to XmlEvLoadPPDoc and XmlEvCleanPPCtx. These functions are fully implemented.

Note that the properties defined by the application during the XML Event Context creation cannot be changed for each call to the XmlLoadPPDoc function. If you want to change the properties, destroy the event context and re-create it.

After XmlEvCleanPPCtx cleans up the internal structure of the current parser, the event context can be re-used to parse another document.

ID Callback

You can provide a callback to convert text-based names to 8-byte IDs.

Callback Function Signature

typedef  sb8 (*xmlev_id_cb_funcp)( void *ctx , ub1 type, ub1 *token, ub4 tok_len,
              sb8 nmspid, boolean isAttribute);

Return Value

sb8: an 8-byte ID.

Arguments

*ctx: The implementation context.

type: The type, which is indicated by the following enumeration:

typedef enum
{
  XML_EVENT_ID_URI,
  XML_EVENT_ID_QNAME,
}xmlevidtype;

*token and tok_len: The actual text to be converted.

nmspid: The namespace ID.

isAttribute: A Boolean value indicating an attribute.

Internally, the XmlEvGetTagId and XmlEvGetAttrID APIs call this callback twice, once to fetch the namespace ID and once to fetch the actual ID of the tag or the attribute Qname.

The XmlEvGetTagUriID and XmlEvGetAttrUriID functions invoke this callback once to get the ID of the corresponding URI.

If a callback is not supplied, an error XML_ERR_EVENT_NOIDCBK is returned when these APIs are used.

Error Handling for the XML Pull Parser

The following sections describe error handling for the XML Pull Parser.

Parser Errors

The XML Pull Parser returns the message XML_EVENT_FATAL_ERROR when it throws an error because the input document is malformed. The XmlEvGetError function is provided to get the error number and message.

Note that during the XmlEvCreatePPCtx operation, any error handler supplied by the application during XmlCreate is overridden. The application must call the XmlErrSetHandler function after the XmlEvDestroyPPCtx operation to restore the original callback.

Programming Errors

To handle programmatic errors. XDK provides a callback that the application can supply when creating an event context. This callback is invoked when the application makes a call to an illegal API. The callback signature is as follows:

typedef  void (* xmlev_err_cb_funcp)(xmlctx *xctx, xmlevctx *evctx,
        xmlevtype cur_event);

An example of an illegal API call is:

XmlEvGetName cannot be called for the XML_EVENT_CHARACTERS event.

Sample Pull Parser Application

This section contains a sample pull parser application, a document to be parsed, and a list of the events that the application generates from the document.

An XML Pull Parser Sample Application

Example 18-5 Sample Pull Parser Application Example

# include "xml.h"
# include "xmlev.h"
...
xmlctx *xctx;
xmlevctx *evtcx;
if (!(xctx = XmlCreate(&xerr, (oratext *) "test")))
{
    printf("Failed to create XML context, error %u\n", (unsigned) xerr);
    return -1;
}
...
if(!(evctx = XmlEvCreatePPCtx(xctx, &xerr, NULL)))
{
   printf("Failed to create EVENT context, error %u\n", (unsigned) xerr);
   return -1;
 }
for(i = 0; i < numDocs; i++)
{
  if (xerr = XmlEvLoadPPDoc(xctx, evctx, "file", input_filenames[i], 0, NULL)
     {
       printf("Failed to load the document, error %u\n", (unsigned) xerr);
       return -1;
     }
...
  for(;;)
  {
    xmlevtype cur_event;
    cur_event = XmlEvNext(evctx);
    switch(cur_event)
         {
               case XML_EVENT_FATAL_ERROR:
                     XmlEvGetError(evctx, (oratext **)&errmsg);
                          printf("Error %s\n", errmsg);
               return;
               case XML_EVENT_START_ELEMENT:
                     printf("<%s>", XmlEvGetName0(evctx));
               break;
               case XML_EVENT_END_DOCUMENT:
                     printf("<%s>", XmlEvGetName0(evctx));
               return;
         }
  }
  XmlEvCleanPPCtx(xctx, evctx);
}
XmlEvDestroyPPCtx(xctx, evctx);
XmlDestroy(xctx);

Sample Document

Example 18-6 Sample Document to Parse

<!DOCTYPE doc [
<!ENTITY ent SYSTEM "file:attendees.txt">
<!ELEMENT doc ANY>
<!ELEMENT meeting (topic, date, publishAttendees)>
<!ELEMENT publishAttendees (#PCDATA)>
<!ELEMENT topic (#PCDATA)>
<!ELEMENT date (#PCDATA)>
]>
<!-- Begin Document -->
<doc>
  <!-- Info about the meeting -->
  <meeting>
    <topic>Group meeting</topic>
    <date>April 25, 2005</date>
    <publishAttendees>&ent;</publishAttendees>
  </meeting>
</doc>
<!-- End Document -->

Events Generated by XML Pull Parser Sample Application

This is the sequence of events generated when the attribute events property is FALSE and expand entities properties is TRUE.

Example 18-7 Events Generated by Parsing a Sample Document

XML_EVENT_START_DOCUMENT
XML_EVENT_START_DTD
XML_EVENT_PE_DECLARATION
XML_EVENT_ELEMENT_DECLARATION
XML_EVENT_ELEMENT_DECLARATION
XML_EVENT_ELEMENT_DECLARATION
XML_EVENT_ELEMENT_DECLARATION
XML_EVENT_ELEMENT_DECLARATION
XML_EVENT_END_DTD
XML_EVENT_COMMENT
XML_EVENT_START_ELEMENT
XML_EVENT_SPACE
XML_EVENT_COMMENT
XML_EVENT_SPACE
XML_EVENT_START_ELEMENT
XML_EVENT_START_ELEMENT
XML_EVENT_CHARACTERS
XML_EVENT_END_ELEMENT
XML_EVENT_START_ELEMENT
XML_EVENT_CHARACTERS
XML_EVENT_END_ELEMENT
XML_EVENT_START_ELEMENT
XML_EVENT_START_ENTITY
XML_EVENT_CHARACTERS
XML_EVENT_END_ENTITY
XML_EVENT_END_ELEMENT
XML_EVENT_END_ELEMENT
XML_EVENT_SPACE
XML_EVENT_END_ELEMENT
XML_EVENT_COMMENT
XML_EVENT_END_DOCUMENT

Using OCI and the XDK C API

This section describes calling the XDK C functions from Oracle Call Interface (OCI).

Using XMLType Functions and Descriptions

You can use the C API for XML for XMLType columns in the database. An OCI program can access XML data stored in a table by initializing the values of OCI handles such as the following:

Environment handle

Service handle

Error handle

Optional parameters

The program can pass these input values to the function OCIXmlDbInitXmlCtx(), which returns an XML context. After the program makes calls to the C API, the function OCIXmlDbFreeXmlCtx() frees the context.

Table 18-6 describes a few of the functions for XML operations.

Table 18-6 XMLType Functions

Function Name
Description

XmlCreateDocument()

Create empty XMLType instance

XmlLoadDom() and so on

Create from a source buffer

XmlXPathEvalexpr() and family

Extract an XPath expression

XmlXslProcess() and family

Transform using an XSLT stylesheet

XmlXPathEvalexpr() and family

Check if an XPath exists

XmlDomIsSchemaBased()

Is document schema-based?

XmlDomGetSchema()

Get schema information

XmlDomGetNodeURI()

Get document namespace

XmlSchemaValidate()

Validate using schema

Cast (void *) to (xmldocnode *)

Obtain DOM from XMLType

Cast (xmldocnode *) to (void *)

Obtain XMLType from DOM

Initializing an XML Context for XML DB

An XML context is a required parameter in all the C DOM API functions. This opaque context encapsulates information pertaining to data encoding, error message language, and so on. The contents of this XML context are different for XDK applications and for Oracle XML DB applications.

Caution:

Do not use an XML context for XDK in an XML DB application, or an XML context for XML DB in an XDK application.

For Oracle XML DB, the two OCI functions that initialize and free an XML context have the following prototypes:

xmlctx *OCIXmlDbInitXmlCtx (OCIEnv *envhp, OCISvcCtx *svchp, OCIError *errhp,
       ocixmldbparam *params, ub4 num_params);

void OCIXmlDbFreeXmlCtx (xmlctx *xctx);

See Also:

Oracle Call Interface Programmer's Guide for reference material on the functions

Oracle Call Interface Programmer's Guide for a discussion about OCI support for XML

Oracle Database XML C API Reference for reference information on the DOM APIs

Creating XMLType Instances on the Client

You can construct new XMLType instances on the client by using the XmlLoadDom() calls. Follow these basic steps:

You first have to initialize the xmlctx, as illustrated in the example in "Using the DOM API for C".

You can construct the XML data itself from the following sources:

User buffer

Local file

URI

The return value from these is an (xmldocnode *), which you can use in the rest of the common C API.

Finally, you can cast the (xmldocnode *) to a (void *) and directly provide it as the bind value if required.

You can construct empty XMLType instances by using the XmlCreateDocument() call. This function would be equivalent to an OCIObjectNew() for other types. You can operate on the (xmldocnode *) returned by the preceding call and finally cast it to a (void *) if it must be provided as a bind value.

Operating on XML Data in the Database Server

You can operate on XML data in Oracle Database by means of OCI statement calls. You can bind and define XMLType values using xmldocnode and use OCI statements to select XML data from the database. You can use this data directly in the C DOM functions. Similarly, you can bind the values directly to SQL statements.

Using OCI and the XDK C API: Examples

Example 18-8 illustrates how to construct a schema-based document with the DOM API and save it to the database. Note that you must include the header files xml.h and ocixmldb.h.

Example 18-8 Constructing a Schema-Based Document with the DOM API

#include <xml.h>
#include <ocixmldb.h>
static oratext tlpxml_test_sch[] = "<TOP xmlns='example1.xsd'\n\
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' \n\
xsi:schemaLocation='example1.xsd example1.xsd'/>";

void example1()
{
    OCIEnv *envhp;
    OCIError *errhp;
    OCISvcCtx *svchp;
    OCIStmt *stmthp;
    OCIDuration dur;
    OCIType *xmltdo;

    xmldocnode  *doc;
    ocixmldbparam params[1];
    xmlnode *quux, *foo, *foo_data;
    xmlerr       err;

    /* Initialize envhp, svchp, errhp, dur, stmthp */
    /* ........ */

    /* Get an xml context */
    params[0].name_ocixmldbparam = XCTXINIT_OCIDUR;
    params[0].value_ocixmldbparam = &dur;
    xctx = OCIXmlDbInitXmlCtx(envhp, svchp, errhp, params, 1);

    /* Start processing */
    printf("Supports XML 1.0: %s\n",
       XmlHasFeature(xctx, (oratext *) "xml", (oratext *) "1.0") ? "YES" : "NO");

    /* Parsing a schema-based document */
    if (!(doc = XmlLoadDom(xctx, &err, "buffer", tlpxml_test_sch,
                          "buffer_length", sizeof(tlpxml_test_sch)-1,
                          "validate", TRUE, NULL)))
    {
       printf("Parse failed, code %d\n");
       return;
    }

    /* Create some elements and add them to the document */
    top = XmlDomGetDocElem(xctx, doc);
    quux = (xmlnode *) XmlDomCreateElem(xctx ,doc, (oratext *) "QUUX");
    foo = (xmlnode *) XmlDomCreateElem(xctx, doc, (oratext *) "FOO");
    foo_data = (xmlnode *) XmlDomCreateText(xctx, doc, (oratext *)"foo's data");
    foo_data = XmlDomAppendChild(xctx, (xmlnode *) foo, (xmlnode *) foo_data);
    foo = XmlDomAppendChild(xctx, quux, foo);
    quux = XmlDomAppendChild(xctx, top, quux);

    XmlSaveDom(xctx, &err, top, "stdio", stdout, NULL);
    XmlSaveDom(xctx, &err, doc, "stdio", stdout, NULL);

    /* Insert the document to my_table */
    ins_stmt = "insert into my_table values (:1)";

    status = OCITypeByName(envhp, errhp, svchp, (const text *) "SYS",
                   (ub4) strlen((char *)"SYS"), (const text *) "XMLTYPE",
                   (ub4) strlen((char *)"XMLTYPE"), (CONST text *) 0,
                   (ub4) 0, dur, OCI_TYPEGET_HEADER,
                   (OCIType **) &xmltdo)) ;

    if (status == OCI_SUCCESS)
    {
       exec_bind_xml(svchp, errhp, stmthp, (void *)doc, xmltdo, ins_stmt));
    }

   /* free xml ctx */
   OCIXmlDbFreeXmlCtx(xctx);
}

/*--------------------------------------------------------*/
/* execute a sql statement which binds xml data */
/*--------------------------------------------------------*/
sword exec_bind_xml(svchp, errhp, stmthp, xml, xmltdo, sqlstmt)
OCISvcCtx *svchp;
OCIError *errhp;
OCIStmt *stmthp;
void *xml;
OCIType *xmltdo;
OraText *sqlstmt;
{
   OCIBind *bndhp1 = (OCIBind *) 0;
   OCIBind *bndhp2 = (OCIBind *) 0;
   sword  status = 0;
   OCIInd ind = OCI_IND_NOTNULL;
   OCIInd *indp = &ind;

   if(status = OCIStmtPrepare(stmthp, errhp, (OraText *)sqlstmt,
                    (ub4)strlen((char *)sqlstmt),
                    (ub4) OCI_NTV_SYNTAX, (ub4) OCI_DEFAULT)) {
     return OCI_ERROR;
   }

   if(status = OCIBindByPos(stmthp, &bndhp1, errhp, (ub4) 1, (dvoid *) 0,
                   (sb4) 0, SQLT_NTY, (dvoid *) 0, (ub2 *)0,
                   (ub2 *)0, (ub4) 0, (ub4 *) 0, (ub4) OCI_DEFAULT)) {
     return OCI_ERROR;
   }

   if(status = OCIBindObject(bndhp1, errhp, (CONST OCIType *) xmltdo,
               (dvoid **) &xml, (ub4 *) 0, (dvoid **) &indp, (ub4 *) 0)) {
     return OCI_ERROR;
   }

   if(status = OCIStmtExecute(svchp, stmthp, errhp, (ub4) 1, (ub4) 0,
                (CONST OCISnapshot*) 0, (OCISnapshot*) 0, (ub4) OCI_DEFAULT)) {
     return OCI_ERROR;
  }

   return OCI_SUCCESS;
}

Example 18-9 illustrates how to get a document from the database and modify it with the DOM API.

Example 18-9 Modifying a Database Document with the DOM API

#include <xml.h>
#include <ocixmldb.h>
sword example2()
{
    OCIEnv *envhp;
    OCIError *errhp;
    OCISvcCtx *svchp;
    OCIStmt *stmthp;
    OCIDuration dur;
    OCIType *xmltdo;

    xmldocnode  *doc;
    xmlnodelist *item_list; ub4 ilist_l;
    ocixmldbparam params[1];
    text *sel_xml_stmt = (text *)"SELECT xml_col FROM my_table";
    ub4    xmlsize = 0;
    sword  status = 0;
    OCIDefine *defnp = (OCIDefine *) 0;

    /* Initialize envhp, svchp, errhp, dur, stmthp */
    /* ... */

    /* Get an xml context */
    params[0].name_ocixmldbparam = XCTXINIT_OCIDUR;
    params[0].value_ocixmldbparam = &dur;
    xctx = OCIXmlDbInitXmlCtx(envhp, svchp, errhp, params, 1);

    /* Start processing */
    if(status = OCITypeByName(envhp, errhp, svchp, (const text *) "SYS",
                   (ub4) strlen((char *)"SYS"), (const text *) "XMLTYPE",
                   (ub4) strlen((char *)"XMLTYPE"), (CONST text *) 0,
                   (ub4) 0, dur, OCI_TYPEGET_HEADER,
                   (OCIType **) xmltdo_p)) {
       return OCI_ERROR;
    }

    if(!(*xmltdo_p)) {
       printf("NULL tdo returned\n");
       return OCI_ERROR;
    }

    if(status = OCIStmtPrepare(stmthp, errhp, (OraText *)selstmt,
                    (ub4)strlen((char *)selstmt),
                    (ub4) OCI_NTV_SYNTAX, (ub4) OCI_DEFAULT)) {
      return OCI_ERROR;
    }

    if(status = OCIDefineByPos(stmthp, &defnp, errhp, (ub4) 1, (dvoid *) 0,
                   (sb4) 0, SQLT_NTY, (dvoid *) 0, (ub2 *)0,
                   (ub2 *)0, (ub4) OCI_DEFAULT)) {
       return OCI_ERROR;
    }

    if(status = OCIDefineObject(defnp, errhp, (OCIType *) *xmltdo_p,
                            (dvoid **) &doc,
                            &xmlsize, (dvoid **) 0, (ub4 *) 0)) {
      return OCI_ERROR;
    }

    if(status = OCIStmtExecute(svchp, stmthp, errhp, (ub4) 1, (ub4) 0,
                 (CONST OCISnapshot*) 0, (OCISnapshot*) 0, (ub4) OCI_DEFAULT)) {
      return OCI_ERROR;
    }

    /* We have the doc. Now we can operate on it */
    printf("Getting Item list...\n");

   item_list = XmlDomGetElemsByTag(xctx,(xmlelemnode *) elem,(oratext *)"Item");
    ilist_l   = XmlDomGetNodeListLength(xctx, item_list);
    printf(" Item list length = %d \n", ilist_l);

    for (i = 0; i < ilist_l; i++)
    {
      elem = XmlDomGetNodeListItem(xctx, item_list, i);
      printf("Elem Name:%s\n", XmlDomGetNodeName(xctx, fragelem));
      XmlDomRemoveChild(xctx, fragelem);
    }

    XmlSaveDom(xctx, &err, doc, "stdio", stdout, NULL);

   /* free xml ctx */
   OCIXmlDbFreeXmlCtx(xctx);

   return OCI_SUCCESS;
}

19 Using Binary XML for C

This chapter contains this topic.

Introduction to Binary XML for C

Introduction to Binary XML for C

Client-side processing of XML data can use either XMLType data stored in the database, including data in binary XML format, or transient data that is not in the database.

Prerequisites

This chapter assumes that you are familiar with the XML Parser for C, the basic concepts of binary XML, and the OCI (Oracle Call Interface). For this release, only the OCI API can be used for programming in C with binary XML. A discussion of how to use OCI support for XML is found in the Oracle Call Interface Programmer's Guide, section "OCI Support for XML."

See Also:

Chapter 18, "Using the XML Parser for C"

Chapter 5, "Using Binary XML for Java"

Oracle XML DB Developer's Guide

Oracle Call Interface Programmer's Guide

Binary XML Storage Format

Binary XML was introduced in 11g Release 1 (11.1). Binary XML is an optimized format for XML It includes encoding and decoding of XML documents, from text to binary and binary to text.

Binary XML is XML Schema-aware encoding of XML data, but binary XML can also be used for XML data that is not based on an XML schema.

A Binary XML processor is a component that processes and transforms binary XML format into text and XML text into binary XML format.

The mid-tier and client tiers can produce, consume, and process XML in binary XML format. The C application fetches data from the XML DB repository, performs updates on the XML using DOM, and stores it back in the database. Or an XML document is created or input on the client and XSLT, XQuery, and other utilities can be used on it. Then the output XML is saved in XML DB. Further details of concepts and reference pages for OCI functions are described in the Oracle Call Interface Programmer's Guide.

20 Using the XML Schema Processor for C

This chapter contains these topics:

Oracle XML Schema Processor for C

Using the C XML Schema Processor Command-Line Utility

XML Schema Processor for C Usage Diagram

How to Run XML Schema for C Sample Programs

What is the Streaming Validator?

Note:

Use the new unified C API for new XDK and Oracle XML DB applications. The old C functions are deprecated and supported only for backward compatibility, but will not be enhanced. They will be removed in a future release.

The new C API is described in "Overview of the Unified C API".

Oracle XML Schema Processor for C

The XML Schema processor for C is a companion component to the XML parser for C that allows support for simple and complex datatypes in XML applications.

The XML Schema processor for C supports the W3C XML Schema Recommendation. This makes writing custom applications that process XML documents straightforward, and means that a standards-compliant XML Schema processor is part of the XDK on every operating system where Oracle is ported.

The XML Schema processor enables validation of XML and retrieval of metadata. It can be called by itself or through the XML Parser for C.

See Also:

Chapter 4, "XML Parsing for Java", for more information about XML Schema and why you would want to use XML Schema.

Oracle XML Schema for C Features

XML Schema processor for C has the following features:

Supports simple and complex types

Built on XML parser for C

Supports the W3C XML Schema Recommendation

See Also:

Oracle Database XML C API Reference "Schema APIs for C"

$ORACLE_HOME/xdk/demo/c/schema/ - sample code

Standards Conformance

The Schema Processor conforms to the following standards:

W3C recommendation for Extensible Markup Language (XML) 1.0

W3C recommendation for Document Object Model Level 1.0

W3C recommendation for Namespaces in XML

W3C recommendation for XML Schema

XML Schema Processor for C: Supplied Software

Table 20-1 lists the supplied files and directories for this release.

Table 20-1 XML Schema Processor for C: Supplied Files in $ORACLE_HOME

Directory and Files
Description

bin

schema processor executable, schema

lib

XML/XSL/Schema & support libraries

nls/data

Globalization Support data files

xdk/demo/c/schema

example usage of the Schema processor

xdk/include

header files

xdk/mesg

error message files

xdk/readme.html

introductory file

Table 20-2 lists the included libraries in directory lib.

Table 20-2 XML Schema Processor for C: Supplied Libraries

Included Library
Description

libxml10.a

XML parser, XSLT processor, XML Schema processor

libcore10.a

CORE functions

libnls10.a

Globalization Support

Using the C XML Schema Processor Command-Line Utility

XML Schema processor for C can be called as an executable by invoking bin/schema in the install area. This takes two arguments:

XML instance document

Optionally, a default schema

The XML Schema processor for C can also be invoked by writing code using the supplied APIs. The code must be compiled using the headers in the include subdirectory and linked against the libraries in the lib subdirectory. See Makefile in the xdk/demo/c/schema subdirectory for details on how to build your program.

Error message files in different languages are provided in the mesg/ subdirectory.

XML Schema Processor for C Usage Diagram

Figure 20-1 describes the calling sequence for the XML Schema processor for C, as follows:

The initialize call is invoked once at the beginning of a session; it returns a schema context which is used throughout the session.

Schema documents to be used in the session are loaded in advance.

The instance document to be validated is first parsed with the XML parser.

The top of the XML element subtree for the instance is then passed to the schema validate function.

If no explicit schema is defined in the instance document, any pre-loaded schemas will be used.

More documents can then be validated using the same schema context.

When the session is over, the Schema tear-down function is called, which releases all memory allocated for the loaded schemas.

Figure 20-1 XML Schema Processor for C Usage Diagram

Description of Figure 20-1 follows
Description of "Figure 20-1 XML Schema Processor for C Usage Diagram"

How to Run XML Schema for C Sample Programs

The directory xdk/demo/c/schema contains sample XML Schema applications that illustrate how to use Oracle XML Schema processor with its API. Table 20-3 lists the provided sample files.

Table 20-3 XML Schema for C Samples Provided

Sample File
Description

Makefile

Makefile to build the sample programs and run them, verifying correct output.

xsdtest.c

Program which invokes the XML Schema for C API

car.{xsd,xml,std}

Sample schema, instance document, and expected output respectively, after running xsdtest on them.

aq.{xsd,xml,std}

Second sample schema, instance document, and expected output respectively, after running xsdtest on them.

pub.{xsd,xml,std}

Third sample schema, instance document, and expected output respectively, after running xsdtest on them.

To build the sample programs, run make.

To build the programs and run them, comparing the actual output to expected output:

make sure

What is the Streaming Validator?

The streaming validator was introduced in 11g Release 1 (11.1). It uses XML Events, which is a representation of an XML document that is similar to SAX Events. XML events has a start tag, end tag, and comment. The producer drives the SAX events and the consumer drives the XML events. The streaming validator shares software with the older schema validator and derives most functionality from it. Memory overhead is less than for the DOM representation used in the older validator. Only one pass is made over the document.

There are two modes of streaming validation:

Transparent mode - events are returned to the application.

Opaque mode - events are not returned to the application but an error indicating success or failure of the document validation process is returned.

Before document validation, the regular validation context must be created, and the relevant schema must be loaded using this context. Then XML event context for pull parser (or for another event producer) must be created. This event context is then given to the streaming validator, so that it is able to request events from the producer.

Passing in a schema DOM to the XmlSchemaLoad API is also supported.

Using Transparent Mode

An application starts with a call to XmlEvCreateSVCtx(). This call creates and returns an event context of type xmlctx, which must be passed on all subsequent calls to the streaming validator. The event context created must be terminated by a call to XmlEvDestroyCtx().

After creation of the event context, the application repeatedly advances validation to the next event by issuing calls to XmlEvNext(), which returns the type of the next event. Additional API interfaces allow the application to retrieve information relevant to the last event.

Error Handling in Transparent Mode

There is no notion of a valid event. Validity is the property of a document and not of the individual items and events of the document. The errors are:

XML_EVENT_FATAL_ERROR - When the producer of XML events reports this error, the streaming validator returns this event back to the application and stops the validation process.

XML_EVENT_ERROR - The streaming validator returns this event to the application when a validation error occurs. The application can then call XmlEvGetError() to get more information about the error.

If the application does not receive any XML_EVENT_ERROR or XML_EVENT_FATAL_ERROR events, the document is valid. Therefore, the application must handle these events and not ignore them.

These errors are not cached and the associated information is not available for later retrieval.

Streaming Validator Example

Here is an example in transparent mode:

Example 20-1 Streaming Validator in Transparent Mode

# include "xmlev.h"
...
xmlevctx *ppevtcx, *svevctx;
xmlctx *xctx
xsdctx *sctx;

if (!(xctx = XmlCreate(&xerr, (oratext *) "test")))
    printf("Failed to create XML context, error %u\n",
                        (unsigned) xerr);
...
if (!(sctx = XmlSchemaCreate(xctx, &xerr, NULL)))
    printf("Failed to create schema context, error %u\n",
                        (unsigned) xerr);

...
If (xerr = XmlSchemaLoad(sctx, "my_schema.xsd", NULL))
    printf("Failed to load schema, error %u\n",
                        (unsigned) xerr);

if(!(ppevctx = XmlEvCreatePPCtx(xctx, &xerr, NULL)))
   printf("Failed to create EVENT context, error %u\n",
                        (unsigned) xerr);

if(xerr = XmlEvLoadPPDoc(xctx, ppevctx, "file", "test.xml", 0, NULL))
   printf("Failed to load Document, error %u\n",
                        (unsigned) xerr);

...
If(!(svevctx = XmlEvCreateSVCtx(xctx, sctx, ppevctx, &xerr)))
   printf("Failed to create SVcontext, error %u\n",
                        (unsigned) xerr);
...
for(;;)
{
   xmlevtype cur_event;
   cur_event = XmlEvNext(svevctx);
   switch(cur_event)
    {
        case XML_EVENT_FATAL_ERROR:
           printf("FATAL ERROR");
           /* error processing goes here */
           return;
        case XML_EVENT_ERROR:
           XmlEvGetError(svevctx, oratext *msg);
           printf("Validation Failed, Error %s\n", msg);
           break;
        case XML_EVENT_START_ELEMENT:
           printf("<%s>", XmlEvGetName(svevctx));
           break;
...
        case XML_EVENT_END_DOCUMENT:
           printf("END DOCUMENT");
           return;
    }
}
...
XmlEvDestroySVCtx(svevctx);
XmlSchemaDestroy(sctx);
XmlEvDestroyCtx(ppevctx);
XmlDestroyCtx(xctx);

Using Opaque Mode

In opaque mode, the streaming validator reads the instance document to be validated as a sequence of events from the producer, but does not pass the events to the application (consumer). It returns XMLERR_OK on success and an error number on failure.

After the schema has been loaded and the XML Events context has been initialized, the application can validate the document in this mode with a call to XmlEvSchemaValidate(). The signature of this function will take a pointer to the events context. The declaration is as follows:

xmlerr XmlEvSchemaValidate(xmlctx *xctx, xsdctx *sctx, xmlevctx *evctx,
       oratext **errmsg);
/* Returns (xmlerr), the error code */

Error Handling in Opaque Mode

When the streaming validator encounters an error, XmlEvSchemaValidate() returns an error number. This could be because of a parse error or a validation error. The application can then use the existing XmlEvGetError APIs to get the error message. The error message is parameterized and typically has all the errors leading up to the point where the streaming validator terminated.

Example of Opaque Mode Application

Here is an example in opaque mode:

Example 20-2 Example of Streaming Validator in Opaque Mode

# include "xmlev.h"
...
xmlevctx *ppevtcx;
xmlctx   *xctx;
xsdctx   *sctx;
oratext  **errmsg;
xmlerr   xerr;

if (!(xctx = XmlCreate(&xerr, (oratext *) "test"))
      printf("Failed to create XML context, error %u\n", (unsigned) xerr);
...
if (!(sctx = XmlSchemaCreate(xctx, &xerr, NULL)))
      printf("Failed to create schema context, error %u\n", (unsigned) xerr);

...
if (xerr = XmlSchemaLoad(sctx, "my_schema.xsd", NULL))
    printf("Failed to load schema, error %u\n", (unsigned) xerr);

if(!(ppevctx = XmlEvCreatePPCtx(xctx, &xerr, NULL)))
     printf("Failed to create EVENT context, error %u\n", (unsigned) xerr);

if(xerr = XmlEvLoadPPDoc(xctx, ppevctx, "file", "test.xml", 0, NULL))
   printf("Failed to load Document, error %u\n", (unsigned) xerr);

if((xerr = XmlEvSchemaValidate(xctx, sctx, ppevctx, errmsg)))
{
  printf("Validation Failed, Error: %s\n", errmsg);
}
...
XmlSchemaDestroy(sctx);
XmlEvDestroyCtx(ppevctx);
XmlDestroyCtx(xctx);

Enhancement of the Existing XmlSchemaLoad() Function

XmlSchemaLoad() was enhanced in 11g Release 1 (11.1) to work with an existing DOM. Previously, this function took two fixed arguments and a set of variable properties. The first argument is the schema context; the second is the URL location of the schema document. A new property was added to the set of variable arguments to provide access to the schema DOM given a URL. The property schema_dom_callback is a callback function provided by the application. If supplied, the schema load function will use this callback to access the DOM for the main schema as well as any included, imported, or redefined schemas. The callback signature is as follows:

typedef  xmldocnode* (*xmlsch_dom_callback) (xmlctx *xctx, oratext *uri,
         xmlerr *xerr);

This callback accepts a URI (the schema load function will pass in the URI of the document desired) and returns the document node. An example follows:

Example 20-3 XmlSchemaLoad() Example

# include "xmlev.h"
...
xmlctx *xctx;
xsdctx *sctx;
xmldocnode *doc;

if (!(xctx = XmlCreate(&xerr, (oratext *) "test"))
    printf("Failed to create XML context, error %u\n", (unsigned) xerr);
...
if (!(sctx = XmlSchemaCreate(xctx, &xerr, NULL)))
    printf("Failed to create schema context, error %u\n", (unsigned) xerr);
...
If (xerr = XmlSchemaLoad(sctx, schema_uri, "schema_dom_callback", func1,  NULL))
    printf("Failed to load schema, error %u\n", (unsigned) xerr);
...
XmlSchemaDestroy(sctx);
XmlDestroyCtx(xctx);

Validation Options

You can supply options to the validation process using XmlSchemaSetValidateOptions(). For example:

XmlSchemaSetValidateOptions(scctx, "ignore_id_constraint", (boolean)TRUE, NULL);

The options are:

ignore_id_constraint (existing before 11.1)

ignore_sch_location (existing before 11.1)

ignore_par_val_rest (existing before 11.1)

ignore_pattern_check: When this property is TRUE, the streaming validator ignores pattern-facet checks. The default is FALSE.

no_events_for_defaults: When this property is TRUE, the streaming validator will not return events for default values added to the instance document. This option can be used in the transparent case only.

Example 20-4 Example of Streaming Validator Using New Options

# include "xmlev.h"
...
xmlevctx *ppevtcx;
xmlctx   *xctx;
xsdctx   *sctx;
xmlerr   xerr;
oratext  **errmsg;

if (!(xctx = XmlCreate(&xerr, (oratext *) "test"))
    printf("Failed to create XML context, error %u\n", (unsigned) xerr);
...
if (!(sctx = XmlSchemaCreate(xctx, &xerr, NULL)))
    printf("Failed to create schema context, error %u\n", (unsigned) xerr);
...
If (xerr = XmlSchemaLoad(sctx, "my_schema.xsd", NULL))
    printf("Failed to load schema, error %u\n", (unsigned) xerr);
if(!(ppevctx = XmlEvCreatePPCtx(xctx, &xerr, "file", "test.xml", NULL)))
   printf("Failed to create EVENT context, error %u\n", (unsigned) xerr);

if(xerr = XmlEvLoadPPDoc(xctx, ppevctx, "file", "test.xml", 0, NULL))
   printf("Failed to load Document, error %u\n", (unsigned) xerr);

XmlSchemaSetValidateOptions(sctx, "ignore_id_constraint", TRUE,
                                  "ignore_pattern_facet", TRUE, NULL);
if((xerr = XmlEvSchemaValidate(xctx,sctx, ppevctx, errmsg)))
{
  printf("Validation Failed, Error: %s\n", errmsg);
}
...
XmlSchemaDestroy(sctx);
XmlEvDestroyCtx(ppevctx);
XmlDestroyCtx(xctx);

21 Determining XML Differences Using C

The Oracle XDK includes components that help you to determine the differences between the contents of two XML documents and then to apply the differences (patch) to one of the XML documents.

This chapter contains these topics:

Overview of XMLDiff in C

Using XmlDiff

Using XmlPatch

Using XmlHash

Overview of XMLDiff in C

You can use Oracle XmlDiff to determine the differences between two similar XML documents. XmlDiff generates an Xdiff instance document that indicates the differences. The Xdiff instance document is an XML document that conforms to an XML schema, the Xdiff schema.

You can then use XmlPatch, which takes the Xdiff instance document and applies the changes to other documents. This can be used to apply the same changes to a large number of XML documents.

XmlDiff only supports the DOM API for input and output.

XmlPatch also supports the DOM for the input and patch documents.

XmlDiff and XmlPatch can be used through a C API or a command line tool, and they are exposed by two SQL functions.

An XmlHash C API is provided to compute the hash value of an XML tree or subtree. If hash values of two trees or subtrees are equal, the trees are identical to a very high probability.

Flow of Process for XMLDiff

The flow of the process is as follows:

The two input documents are compared by XmlDiff.

XmlDiff creates a Xdiff instance document.

The application can pass the Xdiff instance document to XmlPatch, if this is required.

XmlPatch can apply the differences captured from the comparison to other documents as specified by the application.

Using XmlDiff

XmlDiff compares the trees that represent the two input documents to determine differences.

Both input documents must use the same character-set encoding. The Xdiff (output) instance document has the same encoding as the data encoding (DOM encoding) of the input documents.

User Options for Optimization

There are two options for the comparison, known as optimizations:

Global Optimization - Default

The whole document trees are compared.

Local Optimization

Comparison is at the sibling level. Local optimization compares siblings under the corresponding parents from two trees.

Global optimization can take more time and space for large documents but always produces the smallest set of differences (the optimal difference). Local optimization is much faster, but may not produce the optimal difference.

User Option for Hashing

Hashing generally speeds up global optimization with a small possible loss in quality. Hashing improves the quality of the difference output, with local optimization. Using different hash levels may generate both local and global differences.

You can specify the use of hashing for both local and global optimization.

To specify hashing, provide the hashLevel parameter. If hashLevel is greater than 1, then only the DOMHash values are used for comparing all subtrees at depth >= hashLevel of difference. If the hash values are equal, then the subtrees are presumed to be equal.

How XmlDiff Looks at Input Documents

XmlDiff ignores differences in the order of attributes while doing the comparison.

XmlDiff ignores DocType declarations. Files are not validated against the DTD.

XmlDiff ignores any differences in the namespace prefixes as long as the namespace prefixes refer to the same namespace URI. Otherwise, if two nodes have the same local name and content but differ in namespace URI, these differences are indicated.

Note:

XmlDiff operates on its input documents in a nonschema-based way. It does not operate on elements or attributes in a type-aware manner.

Using the XmlDiff Command Line Utility

Table 21-1 describes command line options:

Table 21-1 XmlDiff for Command Line Options for the C Language

Option
Description

-e encoding

Specify default input-file encoding. If no encoding is specified in XML file, this encoding is assumed for input.

-E encoding

Specify output/data encoding. DOMs and the Xdiff instance document are created in this encoding. Default is UTF8.

-h hashLevel

Specify the hash level. 0 means none.

If greater than 1, starting depth to use hashing for subtrees.

-g

Set global optimization (default).

-l

Set local optimization.

-p

Show this usage help.

-u

Disable update operation.

Sample Input Document

Example 21-1 is a sample xml document that can be used to explain updates resulting from using both XmlDiff and XmlPatch. It is followed by some hypothetical changes.

Example 21-1 book1.xml

<?xml version="1.0"?>
<booklist xmlns="http://booklist.oracle.com">
  <book>
    <title>Twelve Red Herrings</title>
    <author>Jeffrey Archer</author>
    <publisher>Harper Collins</publisher>
    <price>7.99</price>
  </book>
  <book>
    <title language="English">The Eleventh Commandment</title>
    <author>Jeffrey Archer</author>
    <publisher>McGraw Hill</publisher>
    <price>3.99</price>
  </book>
  <book>
    <title language="English" country="USA">C++ Primer</title>
    <author>Lippmann</author>
    <publisher>Harper Collins</publisher>
    <price>4.99</price>
  </book>
  <book>
    <title>Emperor's New Mind</title>
    <author>Roger Penrose</author>
    <publisher>Oxford Publishing Company</publisher>
    <price>15.9</price>
  </book>
  <book>
    <title>Evening News</title>
    <author>Arthur Hailey</author>
    <publisher>MacMillan Publishers</publisher>
    <price>9.99</price>
  </book>
</booklist>

Assume that there is another file, book2.xml, that looks just like the Example 21-1, "book1.xml" except that it results in the following:

Deletes "The Eleventh Commandment", a delete-node operation.

Changes the country code for the "C++ Primer" to US from USA, an update-node operation.

Adds a description to "Emperor's New Mind", an append-node operation.

Add the edition to "Evening News", an insert-node-before operation.

Updates the price of "Evening News", an update-node operation.

Sample Xdiff Instance Document

This section shows the Xdiff instance document produced by the comparison of these two XML files described in the previous section. The sections that follow explain the XML processing instructions and the operations on this document.

You can invoke XmlDiff as follows:

> xmldiff book1.xml book2.xml

You can also examine the sample application for arguments and flags.

Example 21-2 Sample Xdiff Instance Document

<?xml version="1.0" encoding="UTF-8"?>
<xd:xdiff xsi:schemaLocation="http://xmlns.oracle.com/xdb/xdiff.xsd
xmlns:xd="http://xmlns.oracle.com/xdb/xdiff.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:oraxdfns_0="http://booklist.oracle.com">
    <?oracle-xmldiff operations-in-docorder="true" output-model="snapshot"
        diff-algorithm="global"?>
    <xd:delete-node xd:node-type="element" xd:xpath="/oraxdfns_0
              :booklist[1]/oraxdfns_0:book[2]"/>
    <xd:update-node xd:node-type="attribute"
         xd:parent-xpath="/oraxdfns_0:booklist[1]/oraxdfns_0:book[3]/oraxdfns_0
              :title[1]" xd:attr-local="country">
                <xd:content>US</xd:content>
    </xd:update-node>
    <xd:append-node xd:node-type="element" xd:parent-xpath="/oraxdfns_0
              :booklist[1]/oraxdfns_0:book[4]">
        <xd:content>
            <oraxdfns_0:description> This is a classic </oraxdfns_0:description>
        </xd:content>
    </xd:append-node>
    <xd:insert-node-before xd:node-type="element" xd:xpath="/oraxdfns_0
              :booklist[1]/oraxdfns_0:book[5]/oraxdfns_0:author[1]">
        <xd:content>
            <oraxdfns_0:edition>Hardcover</oraxdfns_0:edition>
        </xd:content>
    </xd:insert-node-before>
    <xd:update-node xd:node-type="text" xd:xpath="/oraxdfns_0
           :booklist[1]/oraxdfns_0:book[5]/oraxdfns_0:price[1]/text()[1]">
        <xd:content>12.99</xd:content>
    </xd:update-node>
</xd:xdiff>

Output Model and XML Processing Instructions

The Xdiff instance document uses some XML processing instructions (shown in bold in the previous section) that are used to represent certain aspects of the differencing process. See "Xdiff Schema". These instructions and related options are:

operations-in-docorder: Options are true or false:

true - The Xdiff instance document refers to the nodes from the first document in the same order as in the document.

false - The Xdiff instance document does not refer to the nodes from the first document in the same order as in the document.

The output of global optimization meets the operations-in-docorder requirement, but local optimization does not.

output-model: Options are:

snapshot - Xmldiff generates output in snapshot model and follows the UNIX diff model. Each operation uses XPath as if no operations have been applied to the input document. This is the default. XmlPatch can only handle this model if operations-in-docorder is set to true and the XPaths are simple. Simple XPaths require a child axis, no wild cards, and must use positional predicates, such as /root[1]/child[2]/text()[2].

current - Each operation uses XPath as if all operations up to the previous one have been applied to the input document. Even though XmlDiff does not generate differences in the current model, XmlPatch can handle a hand-crafted diff document in the current model

diff-algorithm: Options indicate which optimization generated the differences.

Global optimization

Local optimization

See Also:

"User Options for Optimization"

Xdiff Operations

XmlDiff captures differences using operations indicated by the Xdiff instance document.

Note the following about Xdiff operations:

The parent-xpath attribute or xpath attribute specifies the XPATH location of the parent node of the node to be operated on or XPATH location of node.

The node-type attribute specifies the type of the node to be operated on.

The content child element specifies the new subtree or value appended or inserted.

The Xdiff operations, presented in the Xdiff Instance Document, are as follows:

append-node:

The append-node element specifies that a node of the given type is added as the last child of the given parent.

insert-node-before:

The insert-node-before element specifies that a node of the given type is inserted before the given reference node.

delete-node:

The delete-node element specifies that the node be deleted along with all its children. This can be used to delete elements, comments, and so on.

update-node:

update-node specifies that the value associated with the node with the given XPath expression is updated to the new value, which is specified. Content is the value for a text node. The value of an attribute is the value for an attribute node.

Update for Text Nodes:

Generation of update node operations can be turned off by the user.

The value of an attribute is the value for an attribute node.

update-node is generated for text nodes only by global optimization.

Update for Elements:

XmlDiff does not generate update operations for element nodes.

You can either manually modify the Xdiff instance document to create an update operation that works with XmlPatch, or provide a totally hand-written Xdiff instance document. All children of the element operated on by the update are deleted. Any new subtree specified under the content node is imported.

Format of Xdiff Instance Document

The output of XmlDiff, the Xdiff instance document, is in XML format and conforms to the Xdiff schema shown in the next section.

The output document contains a sequence of operations describing the differences between the two input documents. If you apply the differences from the first document, you get the second document.

Xdiff Schema

Example 21-3 shows the Xdiff schema to which the Xdiff instance document (output) adheres.

Example 21-3 Xdiff Schema: xdiff.xsd

<schema targetNamespace="http://xmlns.oracle.com/xdb/xdiff.xsd"
    xmlns="http://www.w3.org/2001/XMLSchema"
    xmlns:xd="http://xmlns.oracle.com/xdb/xdiff.xsd"
    version="1.0" elementFormDefault="qualified"
    attributeFormDefault="qualified">
    <annotation>
        <documentation xml:lang="en">
         Defines the structure of XML documents that capture the difference
         between two XML documents. Changes that are not supported by Oracle
         XmlDiff may not be expressible in this schema.

       'oracle-xmldiff' PI in Xdiff document:

       We use 'oracle-xmldiff' PI to describe certain aspects of the diff.
       The PI denotes values for 'operations-in-docorder' and 'output-model'.
       The output of XmlDiff has the PI always. If the user hand-codes a diff doc
       then it must also have the PI in it as the first child of top level xdiff
       element, to be able to call XmlPatch.

       operations-in-docorder:
       Can be either 'true' or 'false'.
       If true, the operations in the diff document refer to the
       elements of the input doc in the same order as document order. Output of
       global algorithm meets this requirement while local does not.

       output-model:
       output models for representing the diff. Can be either 'Snapshot' or
       'Current'.

       Snapshot model:
       Each operation uses Xpaths as if no operations
       have been applied to the input document. (like UNIX diff)
       This is the model used in the output of XmlDiff. XmlPatch works with
       this (and the current model too).
       For XmlPatch to handle this model, "operations-in-docorder" must be
       true and the Xpaths must be simple. (see XmlDif C API documentation).

       Current model:
       Each operation uses Xpaths as if all operations till the previous one
       have been applied to the input document. Works with XmlPatch even if
       the 'operations-in-docorder' criterion is not met and the xpaths are
       not simple.
       <!-- Example:
            <?oracle-xmldiff operations-in-docorder="true" output-model=
            "snapshot" diff-algorithm="global"?>
        -->
      </documentation>
    </annotation>
    <!-- Enumerate the supported node types -->
    <simpleType name="xdiff-nodetype">
        <restriction base="string">
            <enumeration value="element"/>
            <enumeration value="attribute"/>
            <enumeration value="text"/>
            <enumeration value="cdata"/>
            <enumeration value="entity-reference"/>
            <enumeration value="entity"/>
            <enumeration value="processing-instruction"/>
            <enumeration value="notation"/>
            <enumeration value="comment"/>
         </restriction>
    </simpleType>

    <element name="xdiff">
        <complexType>
            <choice minOccurs="0" maxOccurs="unbounded">
                <element name="append-node">
                    <complexType>
                        <sequence>
                            <element name="content" type="anyType"/>
                        </sequence>
                        <attribute name="node-type" type="xd:xdiff-nodetype"/>
                        <attribute name="xpath" type="string"/>
                        <attribute name="parent-xpath" type="string"/>
                        <attribute name="attr-local" type="string"/>
                        <attribute name="attr-nsuri" type="string"/>
                    </complexType>
                </element>

                <element name="insert-node-before">
                    <complexType>
                        <sequence>
                            <element name="content" type="anyType"/>
                        </sequence>
                        <attribute name="xpath" type="string"/>
                        <attribute name="node-type" type="xd:xdiff-nodetype"/>

                    </complexType>
                </element>

                <element name="delete-node">
                    <complexType>
                        <attribute name="node-type" type="xd:xdiff-nodetype"/>
                        <attribute name="xpath" type="string"/>
                        <attribute name="parent-xpath" type="string"/>
                        <attribute name="attr-local" type="string"/>
                        <attribute name="attr-nsuri" type="string"/>
                    </complexType>
                </element>
                 <element name="update-node">
                    <complexType>
                        <sequence>
                            <element name="content" type="anyType"/>
                        </sequence>
                        <attribute name="node-type" type="xd:xdiff-nodetype"/>
                        <attribute name="parent-xpath" type="string"/>
                        <attribute name="xpath" type="string"/>
                        <attribute name="attr-local" type="string"/>
                        <attribute name="attr-nsuri" type="string"/>
                    </complexType>
                </element>
                <element name="rename-node">
                    <complexType>
                        <sequence>
                            <element name="content" type="anyType"/>
                        </sequence>
                        <attribute name="xpath" type="string"/>
                        <attribute name="node-type" type="xd:xdiff-nodetype"/>
                    </complexType>
                </element>
            </choice>
         <attribute name="xdiff-version" type="string"/>
        </complexType>
    </element>
</schema>

Using XMLDiff in an Application

In an application, XmlDiff takes the source types and locations of the input documents as arguments. The source type can be a URL, file, orastream and stream context pointers, buffer, and buffer_length pointers or the pointer to a DOM document element (docelement).

XmlDiff returns the document node for the DOM for the Xdiff instance document.

XmlDiff builds the DOM for the two documents, if they are not already provided as DOM, before performing a comparison.

See Also:

Oracle Database XML C API Reference, for the C API for the flags that control the behavior of XmlDiff

Example 21-4 XMLDiff Application

# include <xmldf.h>
...
xmlctx     *xctx;
xmldocnode *doc1, *doc2, *doc3;
uword       hash_level;
oratext    *s, *inp1 = "book1.xml", *inp2="book2.xml";
xmlerr      err;
ub4         flags;

flags = 0; /* defaults : global algorithm */
hash_level = 0; /* no hashing */
/* create XML meta context */
if (!(xctx = XmlCreate(&err, (oratext *) "XmlDiff", NULL)))
{
   printf("Failed to create XML context, error %u\n",
(unsigned) err);
err_exit("Exiting");
}
/* Load the two input files */
if (!(doc1 = XmlLoadDom(xctx, &err, "file", inp1, "discard_whitespace", TRUE,
 NULL)))
{
   printf("Parsing first file failed, error %u\n", (unsigned)err);
   err_exit((oratext *)"Exiting.");
}
if (!(doc2 = XmlLoadDom(xctx, &err, "file", inp2, "discard_whitespace", TRUE,
    NULL)))
{
   printf("Parsing second file failed, error %u\n", (unsigned)err);
   err_exit((oratext *)"Exiting.");
}

/* run XmlDiff on the DOM trees. */

doc3 = XmlDiff(xctx, &err, flags, XMLDF_SRCT_DOM, doc1, NULL, XMLDF_SRCT_DOM,
               doc2, NULL,hash_level, NULL);

if(!doc3)
   printf("XmlDiff Failed, error %u\n", (unsigned)err);
else
{
if(err != XMLERR_OK)
printf("XmlDiff returned error %u\n", (unsigned)err);
/* Now we have the DOM tree in doc3 which represent the Diff */
...
}

XmlFreeDocument(xctx, doc1);
XmlFreeDocument(xctx, doc2);
XmlFreeDocument(xctx, doc3);
XmlDestroy(xctx);

Customized Output

A customized output builder stores differences in any format suitable to the application. You can create your own customized output builder, rather than using the default Xdiff instance document, generated by XmlDiff and which conforms to the Xdiff schema.

To do this, you must provide a callback that can be called after XmlDiff determines the differences. The differences are passed to the callback as an array of xmdlfop. The callback may be called multiple times as the differences are being generated.

Using a customized output builder may perform better than using the default, because it does not have to maintain the internal state necessary for XPath generation.

By default, XmlDiff captures the differences in XML conforming to Xdiff schema. If necessary, plug in your own output builder. The differences are represented as an array xmldfop. You must write an output builder callback function. The function signature is:

xmlerr(*xdfobcb)(void *uctx, xmldfop *escript, ub4 escript_siz);

uctx is the user specific context.

escript is the array of size escript_siz:

diff[escript_siz]

mctx is the memory context.

Supply this memory context through properties to XmlDiff(). Use this memory context to allocate escript. You must later free escript.

Invoke the output builder callback after the differences have been found which happens even before the call to XmlDiff() returns. The output builder callback can be called multiple times.

Example 21-5 Customized XMLDiff Output

 /* Sample useage:  */
 ...
 #include <orastruc.h> / * for 'oraprop' * /
 ...
 static oraprop diff_props[] = {
    ORAPROP(XMLDF_PROPN_CUSTOM_OB, XMLDF_PROPI_CUSTOM_OB, POINTER),
    ORAPROP(XMLDF_PROPN_CUSTOM_OBMCX, XMLDF_PROPI_CUSTOM_OBMCX, POINTER),
    ORAPROP(XMLDF_PROPN_CUSTOM_OBUCX, XMLDF_PROPI_CUSTOM_OBUCX, POINTER),
        { NULL }
  };
  ...
  oramemctx *mymemctx;
  ...
  xmlerr myob(void *uctx,  xmldfop *escript, ub4 escript_siz)
  {
     /* process diff which is available in escript * /

     /* free escript - the caller has to do this * /
     OraMemFree(mymemctx, escript);
  }

  main()
  {
   ...
      myctxt  *myctx;

      diff_props[0].value_oraprop.p_oraprop_v = myob;
      diff_props[1].value_oraprop.p_oraprop_v = mymemctx;
      diff_props[2].value_oraprop.p_oraprop_v = myctx;
      XmlDiff(xctx, &err, 0, doc1, NULL, 0, doc2, NULL, 0, diff_props);
 ...
  }

Using XmlPatch

XmlPatch takes the Xdiff instance document, either as generated by XmlDiff or created by another mechanism, and follows the instructions in the Xdiff instance document to modify other XML documents as specified.

Using the XmlPatch Command Line Utility

Using XmlPatch in an Application

Using the XmlPatch Command Line Utility

Table 21-2 describes the XmlPatch command line options:

Table 21-2 XmlPatch for C Command Line Options

Option
Description

-e encoding

Specify default input-file encoding. If no encoding is specified in XML file, this encoding is assumed for input.

-E encoding

Specify output/data encoding. DOMs and patched document are created in this encoding. Default is UTF8.

-i

Interpret file names as URLs.

-h

Show this usage help.

Using XmlPatch in an Application

XmlPatch takes the source types and locations of the input document and the diff document as arguments. The source type can be a URL, file, orastream and stream context pointers, buffer and buffer_length pointers, or the pointer to a DOM document element (docelement).

See Also:

Oracle Database XML C API Reference, for the C API for the flags that control the behavior of XmlPatch

The modes that were set by the Xdiff schema affect how XmlPatch works.

If the output-model is Snapshot, XmlPatch only works if operations-in-docorder is TRUE.

If the output-model is Current, it is not necessary that operations-in-docorder be set to TRUE.

Example 21-6 Sample Application for XmlPatch

...
#include <xmldf.h>
...
xmlctx     *xctx;
xmldocnode *doc1, *doc2;
oratext    *s;
oratext    *inp1 = "book1.xml"; /* input document */
oratext    *inp2 = "diff.xml", /* diff document */
xmlerr      err;

/* create XML meta context */
if (!(xctx = XmlCreate(&err, (oratext *) "XmlPatch", NULL)))
{
   printf("Failed to create XML context, error %u\n",
(unsigned) err);
err_exit("Exiting");
}
/* Load the two input files */
if (!(doc1 = XmlLoadDom(xctx, &err, "file", inp1, "discard_whitespace", TRUE,
    NULL)))
{
   printf("Parsing first file failed, error %u\n", (unsigned)err);
   err_exit((oratext *)"Exiting.");
}
if (!(doc2 = XmlLoadDom(xctx, &err, "file", inp2, "discard_whitespace", TRUE,
    NULL)))
{
   printf("Parsing second file failed, error %u\n", (unsigned)err);
   err_exit((oratext *)"Exiting.");
}

/* call XmlPatch */
if(!XmlPatch(xctx, &err, 0, XMLDF_SRCT_DOM, doc1, NULL, XMLDF_SRCT_DOM,
           doc2, NULL, NULL));

   printf("XmlPatch Failed, error %u\n", (unsigned)err);
else
{
if(err != XMLERR_OK)
printf("XmlPatch returned error %u\n", (unsigned)err);
/* Now we have the patched document in doc1 */
...
}

XmlFreeDocument(xctx, doc1);
XmlFreeDocument(xctx, doc2);
XmlDestroy(xctx);

Using XmlHash

Oracle XDK provides XmlHash, which computes a hash value for an XML tree or subtree. If the hash values of two subtrees are equal, it is highly probable that they are the same XML. This can be used to do a quick comparison, for example, if you want to see if the XML tree is already in the database.

You can run XmlDiff again, if necessary, on any matches, to be absolutely certain there is a match. You can compute the hash value of the new document and query the database for it.

Example 21-7 shows a sample program that uses XmlHash.

Example 21-7 XmlHash Program

sword main(sword argc, char *argv[])
{
   xmlctx     *xctx;
   xmldfsrct   srct;
   oratext    *data_encoding, *input_encoding, *s, *inp1;
   ub1         flags;
   xmlerr      err;
   ub4         num_args;
   xmlhasht    digest;
   flags = 0; /* defaults */
   srct = XMLDF_SRCT_FILE;
   inp1 = "somexml.xml";
   xctx = XmlCreate(&err, (oratext *) "XmlHash", NULL);

   if (!xctx)
   {
      /* handle error with creating xml context and exit */
      ...
   }

   /* run XmlHash */
   err = XmlHash(xctx, &digest, 0, srct, inp1, NULL, NULL);
   if(err)
      printf("XmlHash returned error:%d \n", err);
   else
      txdfha_pd(digest);

   XmlDestroy(xctx);

   return (sword )err;
}

/* print bytes in xml hash */
static void txdfha_pd(xmlhasht digest)
{
   ub4  i;

   for(i = 0; i < digest.l_xmlhasht; i++)
      printf("%x ", digest.d_xmlhasht[i]);

   printf("\n");
}

Calling XmlDiff and XmlPatch

XmlDiff and XmlPatch can be called as command line tools and from the C language. They are also available as SQL functions.

See Also:

Oracle Database SQL Language Reference, XMLDiff

Oracle Database SQL Language Reference, XMLPatch

22 Using SOAP with the C XDK

This chapter contains these topics:

Introduction to SOAP for C

SOAP C Functions

SOAP Example 1: Sending an XML Document

SOAP Example 2: A Response Asking for Clarification

SOAP Example 3: Using POST

See Also:

Oracle XML DB Developer's Guide

Introduction to SOAP for C

The Simple Object Access Protocol (SOAP) is an XML protocol for exchanging structured and typed information between peers using HTTP and HTTPS in a distributed environment. Only HTTP 1.0 is supported in the XDK for 10g release 2. SOAP has three parts:

The SOAP envelope which defines how to present what is in the message, who must process the message, and whether that processing is optional or mandatory.

A set of serialization and deserialization rules for converting application data types to and from XML.

A SOAP remote procedure call (RPC) that defines calls and responses.

Note:

RPC and serialization/deserialization are not supported in this release.

SOAP is operating system and language-independent because it is XML-based. This chapter presents the C implementation of the functions that read and write the SOAP message.

SOAP Version 1.2 is the definition of an XML-based message which is specified as an XML Infoset (an abstract data set, it could be XML 1.0) that gives a description of the message contents. Version 1.1 is also supported.

See Also:

W3C SOAP 1.2 specifications at:

http://www.w3.org/TR/soap12-part0/ for Primer

http://www.w3.org/TR/soap12-part1/ for Messaging Framework

http://www.w3.org/TR/soap12-part2/ for Adjuncts

SOAP Messaging Overview

The Simple Object Access Protocol (SOAP) is a lightweight protocol for sending and receiving requests and responses across the Internet. Because it is based on XML and transport protocols such as HTTP, it is not blocked by most firewalls. SOAP is independent of operating system, implementation language, and object model.

The power of SOAP is its ability to act as the glue between heterogeneous software components. For example, Visual Basic clients can invoke CORBA services running on UNIX computers; Macintosh clients can invoke Perl objects running on Linux.

SOAP messages are divided into the following parts:

An envelope that contains the message, defines how to process the message and who should process it, and whether processing is optional or mandatory. The Envelope element is required.

A set of encoding rules that describe the datatypes for the application. These rules define a serialization mechanism that converts the application datatypes to and from XML.

A remote procedure call (RPC) request and response convention. This required element is called a body element. The Body element contains a first subelement whose name is the name of a method. This method request element contains elements for each input and output parameter. The element names are the parameter names. RPC is not currently supported in this release.

SOAP is independent of any transport protocol. Nevertheless, SOAP used over HTTP for remote service invocation has emerged as a standard for delivering programmatic content over the Internet.

Besides being independent of transfer protocol, SOAP is also independent of operating system. In other words, SOAP enables programs to communicate even when they are written in different languages and run on different operating systems.

SOAP Message Format

SOAP messages are of the following types:

Requests for a service, including input parameters

Responses from the requested service, including return value and output parameters

Optional fault elements containing error codes and information

In a SOAP message, the payload contains the XML-encoded data. The payload contains no processing information. In contrast, the message header may contain processing information.

SOAP Requests

In SOAP requests, the XML payload contains several elements that include the following:

Root element

Method element

Header elements (optional)

Example 22-1 shows the format of a sample SOAP message request. A GetLastTradePrice SOAP request is sent to a StockQuote service. The request accepts a string parameter representing the company stock symbol and returns a float representing the stock price in the SOAP response.

Example 22-1 SOAP Request Message

POST /StockQuote HTTP/1.0
Host: www.stockquoteserver.com
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn
SOAPAction: "Some-URI"

<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
            SOAP-ENV:encodingStyle="http://www.w3.org/2003/05/soap-encoding/">
  <SOAP-ENV:Body>
    <m:GetLastTradePrice xmlns:m="Some-URI">
      <symbol>ORCL</symbol>
    <m:GetLastTradePrice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

In Example 22-1, the XML document is the SOAP message. The <SOAP-ENV:Envelope> element is the top-level element of the XML document. The payload is represented by the method element <m:GetLastTradePrice>. Note that XML namespaces distinguish SOAP identifiers from application-specific identifiers.

The first line of the header specifies that the request uses HTTP as the transport protocol:

POST /StockQuote HTTP/1.1

Because SOAP is independent of transport protocol, the rules governing XML payload format are independent of the use of HTTP for transport of the payload. This HTTP request points to the URI /StockQuote. Because the SOAP specification is silent on the issue of component activation, the code behind this URI determines how to activate the component and invoke the GetLastTradePrice method.

Example of a SOAP Response

Example 22-2 shows the format of the response to the request in Example 22-1. The <Price> element contains the stock price for ORCL requested by the first message.

Example 22-2 SOAP Response Message

HTTP/1.0 200 OK
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

<SOAP-ENV:Envelope  xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
 SOAP-ENV:encodingStyle="http://www.w3.org/2003/05/soap-encoding/">
  <SOAP-ENV:Body>
    <m:GetLastTradePriceResponse xmlns:m="Some-URI">
      <Price>13.5</Price>
    </m:GetLastTradePriceResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The messages shown in Example 22-1 and Example 22-2 illustrate two-way SOAP messaging, that is, a SOAP request that is answered by a SOAP response. A one-way SOAP message does not require a SOAP message in response.

Using SOAP Clients

SOAP clients are user-written applications that generate XML documents. The documents make a request for a SOAP service and handle the SOAP response. The SOAP implementation in the XDK processes requests from any client that sends a valid SOAP request.

Note the following useful features of the SOAP client API:

Supports a synchronous invocation model for requests and responses

Facilitates the writing of client applications to make SOAP requests

Encapsulates the creation of the SOAP request and the details of sending the request over the underlying transport protocol

Supports a pluggable transport, allowing the client to easily change the transport (available transports include HTTP and HTTPS, but only HTTP 1.0 is supported in this release)

The SOAP client must perform the following steps to make a request and receive a response:

Gather all parameters that are needed to invoke a service.

Create a SOAP service request message, which is an XML message that is built according to the SOAP protocol. It contains all the values of all input parameters encoded in XML. This process is called serialization.

Submit the request to a SOAP server using a transport protocol that is supported by the SOAP server.

Receive a SOAP response message.

Determine the success or failure of the request by handling the SOAP Fault element.

Convert the returned parameter from XML to native datatype. This process is called deserialization.

Use the result as needed.

Using SOAP Servers

A SOAP server performs the following steps when executing a SOAP service request:

The SOAP server receives the service request.

The server parses the XML request and then decides whether to execute or reject the message.

If the message is executed, then the server determines whether the requested service exists.

The server converts all input parameters from XML into datatypes that the service understands.

The server invokes the service.

The server converts the return parameter to XML and generates a SOAP response message.

The server sends the response message back to the caller.

SOAP C Functions

The SOAP C implementation uses the xml.h header. A context of type xmlctx must be created before a SOAP context can be created.

HTTP aspects of SOAP are hidden from the user. SOAP endpoints are specified as a couple (binding, endpoint) where binding is of type xmlsoapbind and the endpoint is a (void *) depending on the binding. Currently, only one binding is supported, XMLSOAP_BIND_HTTP. For HTTP binding, the endpoint is an (OraText *) URL.

The SOAP layer creates and transports SOAP messages between endpoints, and decomposes received SOAP messages.

The C functions are declared in xmlsoap.h. Here is the beginning of that header file:

Example 22-3 SOAP C Functions Defined in xmlsoap.h

   FILE NAME
        xmlsoap.h - XML SOAP APIs

   FILE DESCRIPTION
        XML SOAP Public APIs

   PUBLIC FUNCTIONS
        XmlSoapCreateCtx         - Create and return a SOAP context
        XmlSoapDestroyCtx        - Destroy a SOAP context

        XmlSoapCreateConnection  - Create a SOAP connection object
        XmlSoapDestroyConnection - Destroy a SOAP connection object

        XmlSoapCall              - Send a SOAP message & wait for reply

        XmlSoapCreateMsg         - Create and return an empty SOAP message
        XmlSoapDestroyMsg        - Destroy a SOAP message created
                                      w/XmlSoapCreateMsg

        XmlSoapGetEnvelope       - Return a SOAP message's envelope
        XmlSoapGetHeader         - Return a SOAP message's envelope header
        XmlSoapGetBody           - Return a SOAP message's envelope body

        XmlSoapAddHeaderElement  - Adds an element to a SOAP header
        XmlSoapGetHeaderElement  - Gets an element from a SOAP header

        XmlSoapAddBodyElement    - Adds an element to a SOAP message body
        XmlSoapGetBodyElement    - Gets an element from a SOAP message body

        XmlSoapSetMustUnderstand - Set mustUnderstand attr for SOAP hdr elem
        XmlSoapGetMustUnderstand - Get mustUnderstand attr from SOAP hdr elem

        XmlSoapSetRole           - Set role for SOAP header element
        XmlSoapGetRole           - Get role from SOAP header element

        XmlSoapSetRelay          - Set relay Header element property
        XmlSoapGetRelay          - Get relay Header element property

        XmlSoapSetFault          - Set Fault in SOAP message
        XmlSoapHasFault          - Does SOAP message have a Fault?
        XmlSoapGetFault          - Return Fault code, reason, and details

        XmlSoapAddFaultReason    - Add additional Reason to Fault
        XmlSoapAddFaultSubDetail - Add additional child to Fault Detail
        XmlSoapGetReasonNum      - Get number of Reasons in Fault element
        XmlSoapGetReasonLang     - Get a lang of a reasons with a
                                       particular iindex.

        XmlSoapError             - Get error message(s)

*/

#ifndef XMLSOAP_ORACLE
# define XMLSOAP_ORACLE

# ifndef XML_ORACLE
#  include <xml.h>
# endif

/*---------------------------------------------------------------------------
                Package SOAP - Simple Object Access Protocol APIs

     W3C: "SOAP is a lightweight protocol for exchange of information
     in a decentralized, distributed environment.  It is an XML based
     protocol that consists of three parts: an envelope that defines a
     framework for describing what is in a message and how to process
     it, a set of encoding rules for expressing instances of
     application-defined datatypes, and a convention for representing
     remote procedure calls and responses."
     Atachments are only allowed in Soap 1.1
     In Soap 1.2 body may not have other elements if Fault is present.

     Structure of a SOAP message:

     [SOAP message (XML document)
        [SOAP envelope
             [SOAP header?
                 element*
             ]
             [SOAP body
                 (element* | Fault)?
             ]
        ]
     ]
---------------------------------------------------------------------------*/
...

See Also:

Oracle Database XML C API Reference for the C SOAP APIs

SOAP Example 1: Sending an XML Document

Here is an XML document that illustrates a request to a travel company for a reservation on a plane flight from New York to Los Angeles for John Smith:

Example 22-4 Example 1 SOAP Message

<?xml version='1.0' ?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
 <env:Header>
  <m:reservation xmlns:m="http://travelcompany.example.org/reservation"
          env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true">
   <m:reference>uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d</m:reference>
   <m:dateAndTime>2001-11-29T13:20:00.000-05:00</m:dateAndTime>
  </m:reservation>
  <n:passenger xmlns:n="http://mycompany.example.com/employees"
          env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true">
   <n:name>John Smith</n:name>
  </n:passenger>
 </env:Header>
 <env:Body>
  <p:itinerary
    xmlns:p="http://travelcompany.example.org/reservation/travel">
   <p:departure>
     <p:departing>New York</p:departing>
     <p:arriving>Los Angeles</p:arriving>
     <p:departureDate>2001-12-14</p:departureDate>
     <p:departureTime>late afternoon</p:departureTime>
     <p:seatPreference>aisle</p:seatPreference>
   </p:departure>
   <p:return>
     <p:departing>Los Angeles</p:departing>
     <p:arriving>New York</p:arriving>
     <p:departureDate>2001-12-20</p:departureDate>
     <p:departureTime>mid-morning</p:departureTime>
     <p:seatPreference/>
   </p:return>
  </p:itinerary>
  <q:lodging
   xmlns:q="http://travelcompany.example.org/reservation/hotels">
   <q:preference>none</q:preference>
  </q:lodging>
 </env:Body>
</env:Envelope>

The example used to create the XML document, send it, and receive and decompose a reply is simplified. There is some minimal error checking. The DEBUG option is shown for correcting anomalies. The program may not work on all operating systems. To send this XML document, the first client C program follows these steps:

After declaring variables in main(), an XML context, xctx, is created using XmlCreate() and the context is then used to create a SOAP context, ctx, using XmlSoapCreateCtx().

To construct the message, XmlSoapCreateMsg() is called and returns an empty SOAP message.

The header is constructed using XmlSoapAddHeaderElement(), XmlSoapSetRole(), XmlSoapSetMustUnderstand(), and XmlDomAddTextElem() to fill in the envelope with text.

The body elements are created by XmlSoapAddBodyElement(), XmlDomCreateElemNS(), and a series of calls to XmlDomAddTextElem(). Then XmlDomAppendChild() completes the section of the body specifying the New York to Los Angeles flight.

The return flight is built in an analogous way. The lodging is added with another XmlSoapAddBodyElement() call.

The connection must be created next with XmlSoapCreateConnection(), specifying HTTP binding (the only binding available now) and an endpoint URL.

The function XmlSoapCall() sends the message over the defined connection by means of the SOAP server, and then waits for the reply.

The message reply is returned in the form of another SOAP message. This is done with XmlSaveDom() and XmlSoapHasFault() used with XmlSoapGetFault() to check for a fault and analyze the fault. The fault is parsed into its parts, which is output in this example.

If there was no fault returned, this is followed by XmlSoapGetBody() to return the envelope body. XmlSaveDom() completes the analysis of the returned message.

To clean up, use XmlSoapDestroyMsg() on the message and on the reply, XmlDestroyCtx() to destroy the SOAP context, and XmlDestroy() to destroy the XML context.

The C client program for Example 1 is:

Example 22-5 Example 1 SOAP C Client

#ifndef S_ORACLE
# include <s.h>
#endif

#ifndef XML_ORACLE
# include <xml.h>
#endif

#ifndef XMLSOAP_ORACLE
# include <xmlsoap.h>
#endif

#define MY_URL "http://my_url.com"

/* static function declaration */
static xmlerr add_ns_decl(xmlsoapctx  *ctx, xmlctx *xctx, xmlelemnode *elem,
                        oratext *pfx, oratext *uri);

sb4 main( sword argc, char *argv[])
{
    xmlctx      *xctx;
    xmlerr       xerr;
    xmlsoapctx  *ctx;
    oratext     *url;
    xmlsoapcon  *con;

    xmldocnode  *msg1, *reply, *msg2, *msg3;
    xmlelemnode *res, *pas, *pref, *itin, *departure, *ret, *lodging;
    xmlelemnode *departing, *arriving, *trans, *text, *charge, *card, *name;
    xmlelemnode *body, *header;
    boolean      has_fault;
    oratext     *code, *reason, *lang, *node, *role;
    xmlelemnode *detail;
    oratext *comp_uri   = "http://travelcompany.example.org/";
    oratext *mres_uri   = "http://travelcompany.example.org/reservation";
    oratext *trav_uri   = "http://travelcompany.example.org/reservation/travel";
    oratext *hotel_uri  = "http://travelcompany.example.org/reservation/hotels";
    oratext *npas_uri   = "http://mycompany.example.com/employees";

    oratext *tparty_uri = "http://thirdparty.example.org/transaction";
    oratext *estyle_uri = "http://example.com/encoding";
    oratext *soap_style_uri = "http://www.w3.org/2003/05/soap-encoding";
    oratext *estyle     = "env:encodingStyle";
    oratext *finance_uri = "http://mycompany.example.com/financial";

    if (!(xctx = XmlCreate(&xerr, (oratext *)"SOAP_test",NULL)))
    {
        printf("Failed to create XML context, error %u\n", (unsigned) xerr);
        return EX_FAIL;
    }
    /* Create SOAP context */
    if (!(ctx = XmlSoapCreateCtx(xctx, &xerr, (oratext *) "example", NULL)))
       {
         printf("Failed to create SOAP context, error %u\n", (unsigned) xerr);
         return EX_FAIL;
       }

    /* EXAMPLE 1 */
    /* construct message */
    if (!(msg1 = XmlSoapCreateMsg(ctx, &xerr)))
    {
      printf("Failed to create SOAP message, error %u\n", (unsigned) xerr);
      return xerr;
    }
    res = XmlSoapAddHeaderElement(ctx, msg1, "m:reservation", mres_uri, &xerr);
    xerr = XmlSoapSetRole(ctx, res, XMLSOAP_ROLE_NEXT);
    xerr = XmlSoapSetMustUnderstand(ctx, res, TRUE);
    (void) XmlDomAddTextElem(xctx, res, mres_uri, "m:reference",
                 "uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d");
    (void) XmlDomAddTextElem(xctx, res, mres_uri, "m:dateAndTime",
                               "2001-11-29T13:20:00.000-05:00");
    pas = XmlSoapAddHeaderElement(ctx, msg1, "n:passenger", npas_uri, &xerr);
    xerr = XmlSoapSetRole(ctx, pas, XMLSOAP_ROLE_NEXT);
    xerr = XmlSoapSetMustUnderstand(ctx, pas, TRUE);
    (void) XmlDomAddTextElem(xctx, pas, npas_uri, "n:name",
                              "John Smith");
    /* Fill body */
    /* Itinerary */
    itin = XmlSoapAddBodyElement(ctx, msg1, "p:itinerary", trav_uri, &xerr);
    /* Departure */
    departure = XmlDomCreateElemNS(xctx, msg1,  trav_uri, "p:departure");
    (void) XmlDomAddTextElem(xctx, departure, trav_uri,
                              "p:departing","New York");
    (void) XmlDomAddTextElem(xctx, departure, trav_uri,
                              "p:arriving", "Los Angeles");
    (void) XmlDomAddTextElem(xctx, departure, trav_uri,
                              "p:departureDate", "2001-12-14");
    (void) XmlDomAddTextElem(xctx, departure, trav_uri,
                              "p:departureTime", "late afternoon");
    (void) XmlDomAddTextElem(xctx, departure, trav_uri,
                              "p:seatPreference", "aisle");
    XmlDomAppendChild(xctx, itin, departure);

    /* Return */
    ret = XmlDomCreateElemNS(xctx, msg1,  trav_uri, "p:return");
    (void) XmlDomAddTextElem(xctx, ret, trav_uri,
                              "p:departing", "Los Angeles");
    (void) XmlDomAddTextElem(xctx, ret, trav_uri,
                              "p:arriving", "New York");
    (void) XmlDomAddTextElem(xctx, ret, trav_uri,
                              "p:departureDate", "2001-12-20");
    (void) XmlDomAddTextElem(xctx, ret, trav_uri,
                              "p:departureTime", "mid-morning");
    pref = XmlDomCreateElemNS(xctx, msg1, trav_uri, "p:seatPreference");
    (void) XmlDomAppendChild(xctx, ret, pref);
    XmlDomAppendChild(xctx, itin, ret);

    /* Lodging */
    lodging = XmlSoapAddBodyElement(ctx, msg1, "q:lodging", hotel_uri, &xerr);
    (void) XmlDomAddTextElem(xctx, lodging, hotel_uri,
                              "q:preference", "none");

#ifdef DEBUG
    /* dump the message in debug mode */
    printf("Message:\n");
    XmlSaveDom(xctx, &xerr, msg1, "stdio", stdout, "indent_step", 1, NULL);
#endif

/* END OF EXAMPLE 1 */

    /* create connection */
    url = MY_URL;
    if (!(con = XmlSoapCreateConnection(ctx, &xerr, XMLSOAP_BIND_HTTP,
          url, NULL, 0, NULL, 0,
          "XTest: baz", NULL)))
      {
        printf("Failed to create SOAP connection, error %u\n", (unsigned) xerr);
        return xerr;
    }

    reply = XmlSoapCall(ctx, con, msg1, &xerr);
    XmlSoapDestroyConnection(ctx, con);

    if (!reply)
    {
      printf("Call failed, no message returned.\n");
      return xerr;
    }

#ifdef DEBUG
    printf("Reply:\n");
    XmlSaveDom(xctx, &xerr, reply, "stdio", stdout, NULL);
#endif

     printf("\n==== Header:\n ");
    header = XmlSoapGetHeader(ctx, reply, &xerr);
    if (!header)
    {
        printf("NULL\n");
    }
    else
        XmlSaveDom(xctx, &xerr, header, "stdio", stdout, NULL);

   /* check for fault */
    has_fault = XmlSoapHasFault(ctx, reply, &xerr);
    if(has_fault)
    {
        lang = NULL;
        xerr = XmlSoapGetFault(ctx, reply, &code, &reason, &lang,
                               &node, &role, &detail);
        if (xerr)
        {
            printf("error getting Fault %d\n", xerr);
            return EX_FAIL;
        }
         if(code)
            printf("   Code -- %s\n", code);
        else
            printf("   NO Code\n");
        if(reason)
            printf("   Reason -- %s\n", reason);
        else
            printf("   NO Reason\n");
        if(lang)
            printf("   Lang -- %s\n", lang);
        else
            printf("   NO Lang\n");
        if(node)
            printf("   Node -- %s\n", node);
        else
            printf("   NO Node\n");
        if(role)
            printf("   Role -- %s\n", role);
        else
            printf("   NO Role\n");
        if(detail)
        {
            printf("   Detail\n");
            XmlSaveDom(xctx, &xerr, detail, "stdio", stdout, NULL);
            printf("\n");
        }
        else
            printf("   NO Detail\n");

    }
    else
    {
        body = XmlSoapGetBody(ctx, reply, &xerr);
        printf("==== Body:\n ");
        if (!body)
        {
            printf("NULL\n");
            return EX_FAIL;
        }
        XmlSaveDom(xctx, &xerr, body, "stdio", stdout, NULL);
    }
    (void) XmlSoapDestroyMsg(ctx, reply);
    (void) XmlSoapDestroyMsg(ctx, msg1);
    (void) XmlSoapDestroyCtx(ctx);
    XmlDestroy(xctx);
}

SOAP Example 2: A Response Asking for Clarification

The travel company wants to know which airport in New York the traveller, John Smith, will depart from. The choices are JFK for Kennedy, EWR for Newark, or LGA for LaGuardia. So the following reply is sent:

Example 22-6 Example 2 SOAP Message

<?xml version='1.0' ?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
 <env:Header>
  <m:reservation xmlns:m="http://travelcompany.example.org/reservation"
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true">
   <m:reference>uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d</m:reference>
   <m:dateAndTime>2001-11-29T13:35:00.000-05:00</m:dateAndTime>
  </m:reservation>
  <n:passenger xmlns:n="http://mycompany.example.com/employees"
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true">
   <n:name>John Smith</n:name>
  </n:passenger>
 </env:Header>
 <env:Body>
  <p:itineraryClarification
    xmlns:p="http://travelcompany.example.org/reservation/travel">
   <p:departure>
     <p:departing>
       <p:airportChoices>
          JFK LGA EWR
       </p:airportChoices>
     </p:departing>
   </p:departure>
   <p:return>
     <p:arriving>
       <p:airportChoices>
         JFK LGA EWR
       </p:airportChoices>
     </p:arriving>
   </p:return>
  </p:itineraryClarification>
 </env:Body>
</env:Envelope>

To send this XML document as a SOAP message, substitute the following code block for the lines beginning with /* EXAMPLE 1 */ and ending with /* END OF EXAMPLE 1 */ in Example 22-5, "Example 1 SOAP C Client":

Example 22-7 Example 2 SOAP C Client

#define XMLSOAP_MAX_NAME        1024

/* we need this function for examples 2 and 3 */
static xmlerr add_ns_decl(xmlsoapctx  *ctx, xmlctx *xctx, xmlelemnode *elem,
                          oratext *pfx, oratext *uri)
{
    oratext     *aq, aqbuf[XMLSOAP_MAX_NAME];
    xmldocnode  *doc;
    oratext     *xmlns = "xmlns:";

    /* if no room for "xmlns:usersprefix\0" then fail now */
    if ((strlen((char *)pfx) + strlen((char *)xmlns)) >
        sizeof(aqbuf))
        return EX_FAIL;
    (void) strcpy((char *)aqbuf, (char *)xmlns);
    strcat((char *)aqbuf, (char *)pfx);
    doc = XmlDomGetOwnerDocument(xctx, elem);
    aq = XmlDomSaveString(xctx, doc, aqbuf);
    XmlDomSetAttrNS(xctx, elem, uri, aq, uri);
    return XMLERR_OK;
}

    /* EXAMPLE 2 */
    /* construct message */
    if (!(msg2 = XmlSoapCreateMsg(ctx, &xerr)))
    {
         printf("Failed to create SOAP message, error %u\n", (unsigned) xerr);
         return xerr;
    }
    res = XmlSoapAddHeaderElement(ctx, msg2, "m:reservation", mres_uri, &xerr);
    xerr = XmlSoapSetRole(ctx, res, XMLSOAP_ROLE_NEXT);
    xerr = XmlSoapSetMustUnderstand(ctx, res, TRUE);
    (void) XmlDomAddTextElem(xctx, res, mres_uri, "m:reference",
                 "uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d");
    (void) XmlDomAddTextElem(xctx, res, mres_uri, "m:dateAndTime",
                               "2001-11-29T13:35:00.000-05:00");
    pas = XmlSoapAddHeaderElement(ctx, msg2, "n:passenger", npas_uri, &xerr);
    xerr = XmlSoapSetRole(ctx, pas, XMLSOAP_ROLE_NEXT);
    xerr = XmlSoapSetMustUnderstand(ctx, pas, TRUE);
    (void) XmlDomAddTextElem(xctx, pas, npas_uri, "n:name",
                              "John Smith");
    /* Fill body */
    /* Itinerary */
    itin = XmlSoapAddBodyElement(ctx, msg2, "p:itineraryClarification",
                                 trav_uri, &xerr);
    /* Departure */
    departure = XmlDomCreateElemNS(xctx, msg2,  trav_uri, "p:departure");
    departing = XmlDomCreateElem(xctx, msg2,  "p:departing");
    (void) XmlDomAddTextElem(xctx, departing, trav_uri,
                              "p:airportChoices", "JFK LGA EWR");
    (void) XmlDomAppendChild(xctx, departure, departing);
    XmlDomAppendChild(xctx, itin, departure);

    /* Return */
    ret = XmlDomCreateElemNS(xctx, msg2,  trav_uri, "p:return");
    arriving = XmlDomCreateElemNS(xctx, msg2,  trav_uri, "p:arriving");
    (void) XmlDomAddTextElem(xctx, arriving, trav_uri,
                              "p:airportChoices", "JFK LGA EWR");
    XmlDomAppendChild(xctx, ret, arriving);
    XmlDomAppendChild(xctx, itin, ret);

#ifdef DEBUG
    XmlSaveDom(xctx, &xerr, msg2, "stdio", stdout, "indent_step", 1, NULL);
#endif

SOAP Example 3: Using POST

Credit card information for John Smith is sent in the final XML document using the POST method. The XmlSoapCall() writes the HTTP header that precedes the XML message in the following example:

Example 22-8 Example 3 SOAP Message

POST /Reservations HTTP/1.0
Host: travelcompany.example.org
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

<?xml version='1.0' ?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" >
 <env:Header>
   <t:transaction
           xmlns:t="http://thirdparty.example.org/transaction"
           env:encodingStyle="http://example.com/encoding"
           env:mustUnderstand="true" >5</t:transaction>
 </env:Header>
 <env:Body>
  <m:chargeReservation
      env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
         xmlns:m="http://travelcompany.example.org/">
   <m:reservation xmlns:m="http://travelcompany.example.org/reservation">
    <m:code>FT35ZBQ</m:code>
   </m:reservation>
   <o:creditCard xmlns:o="http://mycompany.example.com/financial">
    <n:name xmlns:n="http://mycompany.example.com/employees">
           John Smith
    </n:name>
    <o:number>123456789099999</o:number>
    <o:expiration>2005-02</o:expiration>
   </o:creditCard>
  </m:chargeReservation>
 </env:Body>
</env:Envelope>

The C Client includes the following code block which is substituted like the second example in Example 22-5, "Example 1 SOAP C Client":

Example 22-9 Example 3 SOAP C Client

#define XMLSOAP_MAX_NAME        1024

/* we need this function for examples 2 and 3 */
static xmlerr add_ns_decl(xmlsoapctx  *ctx, xmlctx *xctx, xmlelemnode *elem,
                          oratext *pfx, oratext *uri)
{
    oratext     *aq, aqbuf[XMLSOAP_MAX_NAME];
    xmldocnode  *doc;
    oratext     *xmlns = "xmlns:";

    /* if no room for "xmlns:usersprefix\0" then fail now */
    if ((strlen((char *)pfx) + strlen((char *)xmlns)) >
        sizeof(aqbuf))
        return EX_FAIL;
    (void) strcpy((char *)aqbuf, (char *)xmlns);
    strcat((char *)aqbuf, (char *)pfx);
    doc = XmlDomGetOwnerDocument(xctx, elem);
    aq = XmlDomSaveString(xctx, doc, aqbuf);
    XmlDomSetAttrNS(xctx, elem, uri, aq, uri);
    return XMLERR_OK;
}

    /* EXAMPLE 3 */
    if (!(msg3 = XmlSoapCreateMsg(ctx, &xerr)))
    {
        printf("Failed to create SOAP message, error %u\n", (unsigned) xerr);
        return xerr;
    }
    trans = XmlSoapAddHeaderElement(ctx,msg3, "t:transaction", tparty_uri, &xerr);
    xerr = XmlSoapSetMustUnderstand(ctx, trans, TRUE);
    XmlDomSetAttr(xctx, trans, estyle, estyle_uri);
    text = XmlDomCreateText(xctx, msg3, "5");
    XmlDomAppendChild(xctx, trans, text);

    /* Fill body */
    /* Charge Reservation */
    charge = XmlSoapAddBodyElement(ctx,msg3,"m:chargeReservation",comp_uri,&xerr);
    XmlDomSetAttr(xctx, charge, estyle, soap_style_uri);
    res = XmlDomCreateElemNS(xctx, msg3, mres_uri,  "m:reservation");
    if (add_ns_decl(ctx, xctx, res, "m", mres_uri))
        return EX_FAIL;
    (void) XmlDomAddTextElem(xctx, res, mres_uri,
                              "m:code", "FT35ZBQ");
    (void) XmlDomAppendChild(xctx, charge, res);

    /* create card elem with  namespace */
    card = XmlDomCreateElemNS(xctx, msg3, finance_uri, "o:creditCard");
    if (add_ns_decl(ctx, xctx, card, "o", finance_uri))
        return EX_FAIL;
    name =  XmlDomAddTextElem(xctx, card, npas_uri,
                              "n:name", "John Smith");
    /* add namespace */
    if (add_ns_decl(ctx, xctx, name, "n", npas_uri))
        return EX_FAIL;
    (void)  XmlDomAddTextElem(xctx, card, finance_uri,
                              "o:number", "123456789099999");
    (void) XmlDomAddTextElem(xctx, card, finance_uri,
                              "o:expiration", "2005-02");
    (void) XmlDomAppendChild(xctx, charge, card);

#ifdef DEBUG
    XmlSaveDom(xctx, &xerr, msg3, "stdio", stdout, "indent_step", 1, NULL);
#endif

Part III

Oracle XDK for C++

This part contains chapters that describe how the Oracle XDK is used for developing applications in C++.

This part contains the following chapters:

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

Chapter 24, "Overview of the Unified C++ Interfaces"

Chapter 25, "Using the XML Parser for C++"

Chapter 26, "Using the XSLT Processor for C++"

Chapter 27, "Using the XML Schema Processor for C++"

Chapter 28, "Using the XPath Processor for C++"

Chapter 29, "Using the XML Class Generator for C++"

23 Getting Started with C++ XDK Components

This chapter describes the Oracle Database installation of the XDK. Note that the C++ demo programs are located on the Examples media.

This chapter contains these topic:

Installing the C++ XDK Components

Configuring the UNIX Environment for C++ XDK Components

Configuring the Windows Environment for C++ XDK Components

Installing the C++ XDK Components

The C++ XDK components are included with Oracle Database and Oracle Application Server.

Refer to "Installing the XDK" for installation instructions.

See Also:

"Overview of Oracle XML Developer's Kit (XDK)" for a list of the C++ XDK components

Configuring the UNIX Environment for C++ XDK Components

This section contains the following topics:

C++ XDK Component Dependencies on UNIX

Setting C++ XDK Environment Variables on UNIX

Testing the C++ XDK Runtime Environment on UNIX

Setting Up and Testing the C++ XDK Compile-Time Environment on UNIX

Verifying the C++ XDK Component Version on UNIX

C++ XDK Component Dependencies on UNIX

The C++ libraries described in this section are located in $ORACLE_HOME/lib. The C and C++ XDK components are contained in the library:

libxml11.a

In addition to the C XDK components described in "C XDK Component Dependencies on UNIX", the library includes the XML class generator, which creates C++ source files based on an input DTD or XML Schema.

Table 16-1 in "C XDK Component Dependencies on UNIX" describes the Oracle CORE and Globalization Support libraries on which the C XDK components (UNIX) depend. The library dependencies are the same for C and C++.

Setting C++ XDK Environment Variables on UNIX

Table 16-2 in "Setting C XDK Environment Variables on UNIX" describes the UNIX environment variables required for use with the C XDK components. The environment variables are the same for C and C++.

Testing the C++ XDK Runtime Environment on UNIX

You can test your environment by running any of the utilities described in Table 16-3 in "Testing the C XDK Runtime Environment on UNIX". These utilities are C utilities that do not have C++ versions.

Setting Up and Testing the C++ XDK Compile-Time Environment on UNIX

Both the C and C++ header files are located in $ORACLE_HOME/xdk/include. Table 23-1 describes the C++ header files. Table 16-4 in "Setting Up and Testing the C XDK Compile-Time Environment on UNIX" describes the C header files. Your runtime environment must be set up before you can compile your C++ code.

Table 23-1 Header Files in the C++ XDK Compile-Time Environment

Header File
Description

oraxml.hpp

Includes the Oracle9i XML ORA datatypes and the public ORA APIs included in libxml.a (for backward compatibility only).

oraxmlcg.h

Includes the C APIs for the C++ class generator (for backward compatibility only).

oraxsd.hpp

Includes the Oracle9i XSD validator datatypes and APIs (for backward compatibility only)

xml.hpp

Handles the Unified DOM APIs transparently, whether you use them through OCI or standalone

xmlotn.hpp

Includes the common APIs, whether you compile standalone or use OCI and the Unified DOM

xmlctx.hpp

Includes the initialization and exception-handling public APIs

Testing the C++ XDK Compile-Time Environment on UNIX

The simplest way to test your compile-time environment is to run the make utility on the sample programs. The demo programs are located on the Examples media rather than the Oracle Database CD. After you install these programs, they will be located in $ORACLE_HOME/xdk/demo/cpp.

Build and run the sample programs by executing the following commands at the system prompt:

cd $ORACLE_HOME/xdk/demo/cpp
make

Verifying the C++ XDK Component Version on UNIX

To obtain the version of XDK you are using, change into $ORACLE_HOME/lib and run the following command as the system prompt:

strings libxml10.a | grep -i developers

Configuring the Windows Environment for C++ XDK Components

This section contains the following topics:

C++ XDK Component Dependencies on Windows

Setting C++ XDK Environment Variables on Windows

Testing the C++ XDK Runtime Environment on Windows

Setting Up and Testing the C++ XDK Compile-Time Environment on Windows

Using the C++ XDK Components with Visual C/C++

C++ XDK Component Dependencies on Windows

The C++ libraries described in this section are located in %ORACLE_HOME%\lib. The XDK C and C++ components are contained in the following Windows library:

libxml10.dll

Table 16-5 in "C XDK Component Dependencies on Windows" describes the Oracle CORE and Globalization Support libraries on which the C components for Windows depend. The library dependencies are the same for C and C++.

Setting C++ XDK Environment Variables on Windows

Table 16-6 in "Setting C XDK Environment Variables on Windows" describes the Windows environment variables required for use with the XDK C components. The environment variables are the same for C and C++.

Testing the C++ XDK Runtime Environment on Windows

You can test your environment by running any of the utilities described in Table 16-7 in "Testing the C XDK Runtime Environment on Windows". These utilities are C utilities that do not have C++ versions.

Setting Up and Testing the C++ XDK Compile-Time Environment on Windows

Table 23-1 in the section "Setting Up and Testing the C++ XDK Compile-Time Environment on UNIX" describes the header files required for compilation of the C components on Windows. The relative filenames are the same on both UNIX and Windows installations.

On Windows the header files are located in %ORACLE_HOME%\xdk\include. Note that your runtime environment must be set up before you can compile your code.

Testing the C++ XDK Compile-Time Environment on Windows

You can test your compile-time environment by compiling the demo programs, which are located in %ORACLE_HOME%\xdk\demo\cpp if you have installed the Oracle Database Examples media.

The procedure for setting the C++ compiler path is identical to the procedure described in "Setting the C XDK Compiler Path on Windows". The procedure for editing the Make.bat files is identical to the procedure described in "Editing the Make.bat Files on Windows".

Using the C++ XDK Components with Visual C/C++

You can set up a project in Microsoft Visual C/C++ and use it for the demos included in the XDK. Refer to "Using the C XDK Components with Visual C/C++ on Windows" for instructions.

24 Overview of the Unified C++ Interfaces

This chapter contains these topics:

What is the Unified C++ API?

Accessing the C++ Interface

OracleXML Namespace

Ctx Namespace

IO Namespace

Tools Package

Error Message Files

What is the Unified C++ API?

Unified C++ APIs for XML tools represent a set of C++ interfaces for Oracle XML tools. This unified approach provides a generic, interface-based framework that allows XML tools to be improved, updated, replaced, or added without affecting any interface-based user code, and minimally affecting application drivers and, possibly, application configuration. All three kinds of C++ interfaces: abstract classes, templates, and implicit interfaces represented by generic template parameters, are used by the unified framework.

Note:

Use the new unified C++ API in xml.hpp for new XDK applications. The old C++ API in oraxml.hpp is deprecated and supported only for backward compatibility, but will not be enhanced. It will be removed in a future release.

These C++ APIs support the W3C specification as closely as possible; however, Oracle cannot guarantee that the specification is fully supported by our implementation because the W3C specification does not cover C++ implementations.

Accessing the C++ Interface

The C++ interface is provided with Oracle Database. Sample files are located in $ORACLE_HOME/xdk/demo/cpp.

readme.html in the root directory of the software archive contains release specific information including bug fixes and API additions.

OracleXML Namespace

OracleXml is the C++ namespace for all XML C++ interfaces. It contains common interfaces and namespaces for different XDK packages. The following namespaces are included:

Ctx - namespace for TCtx related declarations

Dom - namespace for DOM related declarations

Parser - namespace for parser and schema validator declarations

IO - namespace for input and output source declarations

Xsl - namespace for XSLT related declarations

XPath - namespace for XPath related declarations

Tools - namespace for Tools::Factory related declarations

OracleXml is fully defined in the file xml.hpp. Another namespace, XmlCtxNS, visible to users, is defined in xmlctx.hpp. That namespace contains C++ definitions of data structures corresponding to C level definitions of the xmlctx context and related data structures. While there is no need for users to know details of that namespace, xmlctx.hpp must be included in most application main modules.

Multiple encodings are currently supported on the base of the oratext type that is currently supposed to be used by all implementations. All strings are represented as oratext*.

OracleXML Interfaces

XMLException Interface - This is the root interface for all XML exceptions.

Ctx Namespace

The Ctx namespace contains data types and interfaces related to the TCtx interface.

OracleXML Datatypes

DATATYPE encoding - a particular supported encoding. The following kinds of encodings (or encoding names) are supported:

data_encoding

default_input_encoding

input_encoding - overwrites the previous one

error_language - gets overwritten by the language of the error handler, if specified

DATATYPE encodings - array of encodings.

Ctx Interfaces

ErrorHandler Interface - This is the root error handler class. It deals with local processing of errors, mainly from the underlying C implementation. It may throw XmlException in some implementations. But this is not specified in its signature in order to accommodate needs of all implementations. However, it can create exception objects. The error handler is passed to the TCtx constructor when TCtx is initialized. Implementations of this interface are provided by the user.

MemAllocator Interface - This is a simple root interface to make the TCtx interface reasonably generic so that different allocator approaches can be used in the future. It is passed to the TCtx constructor when TCtx is initialized. It is a low level allocator that does not know the type of an object being allocated. The allocators with this interface can also be used directly. In this case the user is responsible for the explicit deallocation of objects (with dealloc).

If the MemAllocator interface is passed as a parameter to the TCtx constructor, then, in many cases, it makes sense to overwrite the operator new. In this case all memory allocations in both C and C++ can be done by the same allocator.

Tctx Interface - This is an implicit interface to XML context implementations. It is primarily used for memory allocation, error (not exception) handling, and different encodings handling. The context interface is an implicit interface that is supposed to be used as type parameter. The name TCtx will be used as a corresponding type parameter name. Its actual substitutions are instantiations of implementations parameterized (templatized) by real context implementations. In the case of errors XmlException might be thrown.All constructors create and initialize context implementations. In a multithreaded environment a separate context implementation has to be initialized for each thread.

IO Namespace

The IO namespace specifies interfaces for the different input and output options for all XML tools.

IO Datatypes

Datatype InputSourceType specifies different kinds of input sources supported currently. They include:

ISRC_URI - Input is to be read from the specified URI.

ISRC_FILE - Input is to be read from a file.

ISRC_BUFFER - Input is to be read from a buffer.

ISRC_DOM - Input is a DOM tree.

ISRC_CSTREAM - Input is a C level stream.

IO Interfaces

URISource - This is an interface to inputs from specified URIs.

FileSource - This is an interface to inputs from a file.

BufferSource - This is an interface to inputs from a buffer.

DOMSource - This is an interface to inputs from a DOM tree.

CStreamSource - This is an interface to inputs from a C level stream.

Tools Package

Tools is the package (sub-space of OracleXml) for types and interfaces related to the creation and instantiation of Oracle XML tools.

Tools Interfaces

FactoryException - Specifies tool's factory exceptions. It is derived from XMLExceptions.

Factory - XML tools factory. Hides implementations of all XML tools and provides methods to create objects representing these tools based on their ID values.

Error Message Files

Error message files are provided in the mesg subdirectory. The messages files also exist in the $ORACLE_HOME/xdk/mesg directory. You can set the environment variable ORA_XML_MESG to point to the absolute path of the mesg subdirectory, although this not required.

See Also:

Oracle Database XML C++ API Reference package Ctx APIs for C++

25 Using the XML Parser for C++

This chapter contains these topics:

Introduction to Parser for C++

DOM Namespace

DOM Interfaces

Parser Namespace

Thread Safety

XML Parser for C++ Usage

XML Parser for C++ Default Behavior

C++ Sample Files

Note:

Use the new unified C++ API in xml.hpp for new XDK applications. The old C++ API in oraxml.hpp is deprecated and supported only for backward compatibility.

Introduction to Parser for C++

Oracle XML parser for C++ determines whether an XML document is well-formed and optionally validates it against a DTD or XML schema. The parser constructs an object tree which can be accessed through one of the following two XML APIs:

DOM: Tree-based APIs. A tree-based API compiles an XML document into an internal tree structure, then allows an application to navigate that tree using the Document Object Model (DOM), a standard tree-based API for XML and HTML documents.

SAX: Event-based APIs. An event-based API, on the other hand, reports parsing events (such as the start and end of elements) directly to the application through a user defined SAX even handler, and does not usually build an internal tree. The application implements handlers to deal with the different events, much like handling events in a graphical user interface.

Tree-based APIs are useful for a wide range of applications, but they often put a great strain on system resources, especially if the document is large (under very controlled circumstances, it is possible to construct the tree in a lazy fashion to avoid some of this problem). Furthermore, some applications need to build their own, different data trees, and it is very inefficient to build a tree of parse nodes, only to map it onto a new tree.

DOM Namespace

This is the namespace for DOM-related types and interfaces.

DOM interfaces are represented as generic references to different implementations of the DOM specification. They are parameterized by Node that supports various specializations and instantiations. Of them, the most important is xmlnode which corresponds to the current C implementation

These generic references do not have a NULL-like value. Any implementation must never create a reference with no state (like NULL). If there is a need to signal that something has no state, an exception should be thrown.

Many methods might throw the SYNTAX_ERR exception, if the DOM tree is incorrectly formed, or throw UNDEFINED_ERR, in the case of wrong parameters or unexpected NULL pointers. If these are the only errors that a particular method might throw, it is not reflected in the method signature.

Actual DOM trees do not depend on the context, TCtx. However, manipulations on DOM trees in the current, xmlctx-based implementation require access to the current context, TCtx. This is accomplished by passing the context pointer to the constructor of DOMImplRef. In multithreaded environment DOMImplRef is always created in the thread context and, so, has the pointer to the right context.

DOMImplRef provides a way to create DOM trees. DomImplRef is a reference to the actual DOMImplementation object that is created when a regular, non-copy constructor of DomImplRef is invoked. This works well in a multithreaded environment where DOM trees need to be shared, and each thread has a separate TCtx associated with it. This works equally well in a single threaded environment.DOMString is only one of the encodings supported by Oracle implementations. The support of other encodings is an Oracle extension. The oratext* data type is used for all encodings.Interfaces represent DOM level 2 Core interfaces according to http://www.w3.org/TR/DOM-Level-2-Core/core.html. These C++ interfaces support the DOM specification as closely as possible. However, Oracle cannot guarantee that the specification is fully supported by our implementation because the W3C specification does not cover C++ binding.

DOM Datatypes

DATATYPE DomNodeType - Defines types of DOM nodes.

DATATYPE DomExceptionCode - Defines exception codes returned by the DOM API.

DOM Interfaces

DOMException Interface - See exception DOMException in the W3C DOM documentation. DOM operations only raise exceptions in "exceptional" circumstances: when an operation is impossible to perform (either for logical reasons, because data is lost, or because the implementation has become unstable). The functionality of XMLException can be used for a wider range of exceptions.

NodeRef Interface - See interface Node in the W3C documentation.

DocumentRef Interface - See interface Document in the W3C documentation.

DocumentFragmentRef Interface - See interface DocumentFragment in the W3C documentation.

ElementRef Interface - See interface Element in the W3C documentation.

AttrRef Interface - See interface Attr in the W3C documentation.

CharacterDataRef Interface - See interface CharacterData in the W3C documentation.

TextRef Interface - See Text nodes in the W3C documentation.

CDATASectionRef Interface - See CDATASection nodes in the W3C documentation.

CommentRef Interface - See Comment nodes in the W3C documentation.

ProcessingInstructionRef Interface - See PI nodes in the W3C documentation.

EntityRef Interface - See Entity nodes in the W3C documentation.

EntityReferenceRef Interface - See EntityReference nodes in the W3C documentation.

NotationRef Interface - See Notation nodes in the W3C documentation.

DocumentTypeRef Interface - See DTD nodes in the W3C documentation.

DOMImplRef Interface - See interface DOMImplementation in the W3C DOM documentation. DOMImplementation is fundamental for manipulating DOM trees. Every DOM tree is attached to a particular DOM implementation object. Several DOM trees can be attached to the same DOM implementation object. Each DOM tree can be deleted and deallocated by deleting the document object. All DOM trees attached to a particular DOM implementation object are deleted when this object is deleted. DOMImplementation object is not visible to the user directly. It is visible through class DOMImplRef. This is needed because of requirements in the case of multithreaded environments

NodeListRef Interface - Abstract implementation of node list. See interface NodeList in the W3C documentation.

NamedNodeMapRef Interface - Abstract implementation of a node map. See interface NamedNodeMap in the W3C documentation.

DOM Traversal and Range Datatypes

DATATYPE AcceptNodeCode defines values returned by node filters provided by the user and passed to iterators and tree walkers.

DATATYPE WhatToShowCode specifies codes to filter certain types of nodes.

DATATYPE RangeExceptionCode specifies Exception kinds that can be thrown by the Range interface.

DATATYPE CompareHowCode specifies kinds of comparisons that can be done on two ranges.

DOM Traversal and Range Interfaces

NodeFilter Interface - DOM 2 Node Filter.

NodeIterator Interface - DOM 2 Node Iterator.

TreeWalker Interface - DOM 2 TreeWalker.

DocumentTraversal Interface - DOM 2 interface.

RangeException Interface - Exceptions for DOM 2 Range operations.

Range Interface - DOM 2 Range.

DocumentRange Interface - DOM 2 interface.

Parser Namespace

DOMParser Interface - DOM parser root class.

GParser Interface - Root class for XML parsers.

ParserException Interface - Exception class for parser and validator.

SAXHandler Interface - Root class for current SAX handler implementations.

SAXHandlerRoot Interface - Root class for all SAX handlers.

SAXParser Interface - Root class for all SAX parsers.

SchemaValidator Interface - XML schema-aware validator.

GParser Interface

GParser Interface - Root class for all XML parser interfaces and implementations. It is not an abstract class, that is, it is not an interface. It is a real class that allows users to set and check parser parameters.

DOMParser Interface

DOMParser Interface - DOM parser root abstract class or interface. In addition to parsing and checking that a document is well formed, DOMParser provides means to validate the document against DTD or XML schema.

SAXParser Interface

SAXParser Interface - Root abstract class for all SAX parsers.

SAX Event Handlers

To use SAX, a SAX event handler class should be provided by the user and passed to the SAXParser in a call to parse() or set before such call.

SAXHandlerRoot Interface - root class for all SAX handlers.

SAXHandler Interface - root class for current SAX handler implementations.

Thread Safety

If threads are forked off somewhere in the midst of the init-parse-term sequence of calls, you will get unpredictable behavior and results.

XML Parser for C++ Usage

A call to Tools::Factory to create a parser initializes the parsing process.

The XML input can be any of the InputSource kinds (see IO namespace).

DOMParser invocation results in the DOM tree.

SAXParser invocation results in SAX events.

A call to parser destructor terminates the process.

XML Parser for C++ Default Behavior

The following is the XML parser for C++ default behavior:

Character set encoding is UTF-8. If all your documents are ASCII, you are encouraged to set the encoding to US-ASCII for better performance.

Messages are printed to stderr unless msghdlr is specified.

XML parser for C++ determines whether an XML document is well-formed and optionally validates it against a DTD. The parser constructs an object tree that can be accessed through a DOM interface or operates serially through a SAX interface.

A parse tree which can be accessed by DOM APIs is built unless saxcb is set to use the SAX callback APIs. Note that any of the SAX callback functions can be set to NULL if not needed.

The default behavior for the parser is to check that the input is well-formed but not to check whether it is valid. The flag XML_FLAG_VALIDATE can be set to validate the input. The default behavior for whitespace processing is to be fully conformant to the XML 1.0 spec, that is, all whitespace is reported back to the application but it is indicated which whitespace is ignorable. However, some applications may prefer to set the XML_FLAG_DISCARD_WHITESPACE which will discard all whitespace between an end-element tag and the following start-element tag.

Note:

It is recommended that you set the default encoding explicitly if using only single byte character sets (such as US-ASCII or any of the ISO-8859 character sets) for performance up to 25% faster than with multibyte character sets, such as UTF-8.

In both of these cases, an event-based API provides a simpler, lower-level access to an XML document: you can parse documents much larger than your available system memory, and you can construct your own data structures using your callback event handlers.

C++ Sample Files

xdk/demo/cpp/parser/ directory contains several XML applications to illustrate how to use the XML parser for C++ with the DOM and SAX interfaces.

Change directories to the sample directory ($ORACLE_HOME/xdk/demo/cpp on Solaris, for example) and read the README file. This will explain how to build the sample programs.

Table 25-1 lists the sample files in the directory. Each file *Main.cpp has a corresponding *Gen.cpp and *Gen.hpp.

Table 25-1 XML Parser for C++ Sample Files

Sample File Name
Description

DOMSampleMain.cpp

Sample usage of C++ interfaces of XML parser and DOM.

FullDOMSampleMain.cpp

Manually build DOM and then exercise.

SAXSampleMain.cpp

Source for SAXSample program.

See Also:

Oracle Database XML C++ API Reference for parser package APIs for C++

26 Using the XSLT Processor for C++

This chapter contains these topics:

Accessing XSLT for C++

Xsl Namespace

XSLT for C++ DOM Interface Usage

Invoking XSLT for C++

Using the Sample Files Included with the Software

Note:

Use the new unified C++ API in xml.hpp for new XDK applications. The old C++ API in oraxml.hpp is deprecated and supported only for backward compatibility, but will not be enhanced. It will be removed in a future release.

Accessing XSLT for C++

XSLT for C++ is provided with Oracle Database. Sample files are located at xdk/demo/cpp/new.

readme.html in the root directory of the software archive contains release specific information including bug fixes and API additions.

See Also:

"XVM Processor"

Xsl Namespace

This is the namespace for XSLT compilers and transformers.

Xsl Interfaces

XslException Interface - Root interface for all XSLT-related exceptions.

Transformer Interface -Basic XSLT processor. This interface can be used to invoke all XSLT processors.

CompTransformer Interface - Extended XSLT processor. This interface can be used only with processors that create intermediate binary bytecode (currently XVM-based processor only).

Compiler Interface - XSLT compiler. It is used for compilers that compile XSLT into binary bytecode.

See Also:

Oracle Database XML C++ API Reference package XSL APIs for C++

XSLT for C++ DOM Interface Usage

There are two inputs to XMLParser.xmlparse():

The XML document

The stylesheet to be applied to the XML document

Any XSLT processor is initiated by calling the tools factory to create a particular XSLT transformer or compiler.

The stylesheet is supplied to any transformer by calling setXSL() member functions.

The XML instance document is supplied as a parameter to the transform member functions.

The resultant document (XML, HTML, VML, and so on) is typically sent to an application for further processing. The document is sent as a DOM tree or as a sequence of SAX events. SAX events are produced if a SAX event handler is provided by the user.

The application terminates the XSLT processors by invoking their destructors.

Invoking XSLT for C++

XSLT for C++ can be invoked in two ways:

By invoking the executable on the command line

By writing C++ code and using the supplied APIs

Command Line Usage

XSLT for C++ can be called as an executable by invoking bin/xml.

See Also:

Table 18-4, "C XML Parser Command-Line Options"

Writing C++ Code to Use Supplied APIs

XSLT for C++ can also be invoked by writing code to use the supplied APIs. The code must be compiled using the headers in the public subdirectory and linked against the libraries in the lib subdirectory. Please see the Makefile or make.bat in xdk/demo/cpp/new for full details of how to build your program.

Using the Sample Files Included with the Software

The $ORACLE_HOME/xdk/demo/cpp/parser/ directory contains several XML applications to illustrate how to use the XSLT for C++.

Table 26-1 lists the sample files.

Table 26-1 XSLT for C++ Sample Files

Sample File Name
Description

XSLSampleMain.cpp
XSLSampleGen.cpp
XSLSampleGen.hpp

Sources for sample XSLT usage program. XSLSample takes two arguments, the XSLT stylesheet and the XML file. If you redirect stdout of this program to a file, you may have some output missing, depending on your environment.

XVMSampleMain.cpp
XVMSampleGen.cpp
XVMSampleGen.hpp

Sources for the sample XVM usage program.

27 Using the XML Schema Processor for C++

This chapter contains these topics:

Oracle XML Schema Processor for C++

XML Schema Processor API

Running the Provided XML Schema for C++ Sample Programs

Note:

Use the new unified C++ API in xml.hpp for new XDK applications. The old C++ API in oraxml.hpp is deprecated and supported only for backward compatibility, but will not be enhanced. It will be removed in a future release.

Oracle XML Schema Processor for C++

The XML Schema processor for C++ is a companion component to the XML parser for C++ that allows support to simple and complex datatypes into XML applications.

The XML Schema processor for C++ supports the W3C XML Schema Recommendation. This makes writing custom applications that process XML documents straightforward, and means that a standards-compliant XML Schema processor is part of the XDK on each operating system where Oracle is ported.

Oracle XML Schema for C++ Features

XML Schema processor for C++ has the following features:

Supports simple and complex types

Built upon the XML parser for C++

Supports the W3C XML Schema Recommendation

The XML Schema processor for C++ class is OracleXml::Parser::SchemaValidator.

See Also:

Oracle Database XML C++ API Reference schema validator interface

Online Documentation

Documentation for Oracle XML Schema processor for C++ is located in /xdk/doc/cpp/schema directory in your install area.

Standards Conformance

The XML Schema processor for C++ conforms to the following standards:

W3C recommendation for Extensible Markup Language (XML) 1.0

W3C recommendation for Document Object Model Level 1.0

W3C recommendation for Namespaces in XML 1.0

W3C recommendation for XML Schema 1.0

XML Schema Processor API

Interface SchemaValidator is an abstract template class to handle XML schema-based validation of XML documents.

Invoking XML Schema Processor for C++

The XML Schema processor for C++ can be called as an executable by invoking bin/schema in the install area. This takes the arguments:

XML instance document

Optionally, a default schema

Optionally, the working directory

Table 27-1 lists the options (can be listed if the option is invalid or -h is the option):

Table 27-1 XML Schema Processor for C++ Command Line Options

Option
Description

-0

Always exit with code 0 (success).

-e encoding

Specify default input file encoding.

-E encoding

Specify output/data/presentation encoding.

-h

Help. Prints these choices.

-i

Ignore provided schema.

-o num

Validation option.

-p

Print document instance to stdout on success.

-u

Force the Unicode path.

-v

Version - display version, then exit.

The XML Schema processor for C++ can also be invoked by writing code using the supplied APIs. The code must be compiled using the headers in the include subdirectory and linked against the libraries in the lib subdirectory. See Makefile or Make.bat in the xdk/demo/cpp/schema directory for details on how to build your program.

Error message files in different languages are provided in the mesg subdirectory.

Running the Provided XML Schema for C++ Sample Programs

The directory xdk/demo/cpp/schema contains a sample application that illustrates how to use Oracle XML Schema processor for C++ with its API. Table 27-2 lists the sample files provided.

Table 27-2 XML Schema Processor for C++ Samples Provided

Sample File
Description

Makefile

Makefile to build the sample programs and run them, verifying correct output.

xsdtest.cpp

Trivial program which invokes the XML Schema for C++ API

car.{xsd,xml,std}

Sample schema, instance document, expected output respectively, after running xsdtest on them.

aq.{xsd,xml,std}

Second sample schema's, instance document, expected output respectively, after running xsdtest on them.

pub.{xsd,xml,std}

Third sample schema's, instance document, expected output respectively, after running xsdtest on them.

To build the sample programs, run make.

To build the programs and run them, comparing the actual output to expected output:

make sure

28 Using the XPath Processor for C++

This chapter contains these topics:

XPath Interfaces

Sample Programs

Note:

Use the new unified C++ API in xml.hpp for new XDK applications. The old C++ API in oraxml.hpp is deprecated and supported only for backward compatibility, but will not be enhanced. It will be removed in a future release.

XPath Interfaces

Processor Interface - basic XPath processor interface that any XPath processor is supposed to conform to.

CompProcessor Interface - extended XPath processor that adds an ability to use XPath expressions pre-compiled into an internal binary representation. In this release this interface represents Oracle virtual machine interface.

Compiler Interface - XPath compiler into binary representation.

NodeSetRef Interface - defines references to node sets when they are returned by the XPath expression evaluation.

XPathException Interface - exceptions for XPath compilers and processors.

XPathObject Interface - interface for XPath 1.0 objects.

Sample Programs

Sample programs are located in xdk/demo/cpp/new.

The programs XslXPathSample and XvmXPathSample have sources:

XslXPathSampleGen.hpp, XslXPathSampleGen.cpp, XslXPathSampleMain.cpp, XslXPathSampleForce.cpp;

and XvmXPathSampleGen.hpp, XvmXPathSampleGen.cpp, XvmXPathSampleMain.cpp, XvmXPathSampleForce.cpp.

See Also:

Oracle Database XML C++ API Reference package XPATH APIs for C++

29 Using the XML Class Generator for C++

This chapter contains these topics:

Accessing XML C++ Class Generator

Using XML C++ Class Generator

Using the XML C++ Class Generator Command-Line Utility

Using the XML C++ Class Generator Examples

Accessing XML C++ Class Generator

The XML C++ class generator is provided with Oracle Database.

Using XML C++ Class Generator

The XML C++ class generator creates source files from an XML DTD or XML Schema. The class generator takes the Document Type Definition (DTD) or the XML Schema, and generates classes for each defined element. Those classes are then used in a C++ program to construct XML documents conforming to the DTD.

This is useful when an application wants to send an XML message to another application based on an agreed-upon DTD or XML Schema, or as the back end of a Web form to construct an XML document. Using these classes, C++ applications can construct, validate, and print XML documents that comply with the input.

The class generator works in conjunction with the Oracle XML parser for C++, which parses the input and passes the parsed document to the class generator.

External DTD Parsing

The XML C++ class generator can also parse an external DTD directly without requiring a complete (dummy) document by using the Oracle XML parser for C++ routine xmlparsedtd().

The provided command-line program xmlcg has a '-d' option that is used to parse external DTDs.

Error Message Files

Error message files are provided in the mesg/ subdirectory. The messages files also exist in the $ORACLE_HOME/xdk/mesg directory. You may set the environment variable ORA_XML_MESG to point to the absolute path of the mesg subdirectory although this not required.

Using the XML C++ Class Generator Command-Line Utility

The standalone class generator can be called as an executable by invoking bin/xmlcg.

You can run the C++ class generator from the command line as follows:

xmlcg [options] input_file

Table 29-1 describes the options for the utility.

Table 29-1 C++ Class Generator Options

Option
Meaning

-d name

Input is an external DTD or a DTD file. Generates name.cpp and name.h.

-o directory

Output directory for generated files (the default is the current directory).

-e encoding

Default input file encoding.

-h

Show this usage help.

-v

Show the class generator version validator options.

-s name

Input is an XML Schema file with the given name. Generates name.cpp and name.h.

input_file name is the name of the parsed XML document with <!DOCTYPE> definitions, or parsed DTD, or an XML Schema document. The XML document must have an associated DTD.

The DTD input to the XML C++ class generator is an XML document containing a DTD, or an external DTD. The document body itself is ignored; only the DTD is relevant, though the document must conform to the DTD.

If invalid options, or no input is provided, a usage message with the preceding information is output.

Two source files are output, a name.h header file and a C++ file, name.cpp. These are named after the DTD file.

The output files are typically used to generate XML documents.

Constructors are provided for each class (element) that allow an object to be created in the following two ways:

Initially empty, then adding the children or data after the initial creation

Created with the initial full set of children or initial data

A method is provided for #PCDATA (and Mixed) elements to set the data and, when appropriate, set an element's attributes.

Input to the XML C++ Class Generator

The input is an XML document containing a DTD. The document body itself is ignored; only the DTD is relevant, though the dummy document must conform to the DTD. The underlying XML parser only accepts file names for the document and associated external entities.

Using the XML C++ Class Generator Examples

Table 29-2 lists the demo XML C++ class generator files:

Table 29-2 XML C++ Class Generator Files

File Name
Description

CG.cpp

Sample program

CG.xml

XML file contains DTD and dummy document

CG.dtd

DTD file referenced by CG.xml

Make.bat on Windows

Makefile on UNIX

Batch file (on Windows) or Make file (on UNIX) to generate classes and build the sample programs.

README

A readme file with these instructions

The make.bat batch file (on Windows) or Makefile (on UNIX) do the following:

Generate classes based on CG.xml into Sample.h and Sample.cpp

Compile the program CG.cpp (using Sample.h), and link this with the Sample object into an executable named CG.exe in the...\bin (or .../bin) directory.

XML C++ Class Generator Example 1: XML — Input File to Class Generator, CG.xml

This XML file, CG.xml, inputs XML C++ class generator. It references the DTD file, CG.dtd.

<?xml version="1.0"?>
<!DOCTYPE Sample SYSTEM "CG.dtd">
  <Sample>
    <B>Be!</B>
    <D attr="value"></D>
    <E>
      <F>Formula1</F>
      <F>Formula2</F>
    </E>
  </Sample>

XML C++ Class Generator Example 2: DTD — Input File to Class Generator, CG.dtd

This DTD file, CG.dtd is referenced by the XML file CG.xml. CG.xml inputs XML C++ class generator.

<!ELEMENT Sample (A | (B, (C | (D, E))) | F)>
<!ELEMENT A (#PCDATA)>
<!ELEMENT B (#PCDATA | F)*>
<!ELEMENT C (#PCDATA)>
<!ELEMENT D (#PCDATA)>
<!ATTLIST D attr CDATA #REQUIRED>
<!ELEMENT E (F, F)>
<!ELEMENT F (#PCDATA)>

XML C++ Class Generator Example 3: CG Sample Program

The CG sample program, CG.cpp, does the following:

Initializes the XML parser.

Loads the DTD (by parsing the DTD-containing file-- the dummy document part is ignored).

Creates some objects using the generated classes.

Invokes the validation function which verifies that the constructed classes match the DTD.

Writes the constructed document to Sample.xml.

//////////////////////////////////////////////////////////////////////////////
// NAME        CG.cpp
// DESCRIPTION Demonstration program for C++ class generator usage
//////////////////////////////////////////////////////////////////////////////

#ifndef ORAXMLDOM_ORACLE
# include <oraxmldom.h>
#endif

#include <fstream.h>

#include "Sample.h"

#define DTD_DOCUMENT "CG.xml"
#define OUT_DOCUMENT Sample.xml"

int main()
{
    XMLParser parser;
    Document *doc;
    Sample   *samp;
    B        *b;
    D        *d;
    E        *e;
    F        *f1, *f2;
    fstream  *out;
    ub4       flags = XML_FLAG_VALIDATE;
    uword     ecode;

    // Initialize XML parser
    cout << "Initializing XML parser...\n";
    if (ecode = parser.xmlinit())
    {
        cout << "Failed to initialize parser, code " << ecode << "\n";
        return 1;
    }

    // Parse the document containing a DTD; parsing just a DTD is not
    // possible yet, so the file must contain a valid document (which
    // is parsed but we're ignoring).
    cout << "Loading DTD from " << DTD_DOCUMENT << "...\n";
    if (ecode = parser.xmlparse((oratext *) DTD_DOCUMENT, (oratext *)0, flags))
    {
        cout << "Failed to parse DTD document " << DTD_DOCUMENT <<
        ", code " << ecode << "\n";
        return 2;
    }

    // Fetch dummy document
    cout << "Fetching dummy document...\n";
    doc = parser.getDocument();

    // Create the constituent parts of a Sample
    cout << "Creating components...\n";
    b = new B(doc, (String) "Be there or be square");
    d = new D(doc, (String) "Dit dah");
    d->setattr((String) "attribute value");
    f1 = new F(doc, (String) "Formula1");
    f2 = new F(doc, (String) "Formula2");
    e = new E(doc, f1, f2);

    // Create the Sample
    cout << "Creating top-level element...\n";
    samp = new Sample(doc, b, d, e);

    // Validate the construct
    cout << "Validating...\n";
    if (ecode = parser.validate(samp))
    {
     cout << "Validation failed, code " << ecode << "\n";
     return 3;
    }

    // Write out doc
    cout << "Writing document to " << OUT_DOCUMENT << "\n";
    if (!(out = new fstream(OUT_DOCUMENT, ios::out)))
    {
      cout << "Failed to open output stream\n";
      return 4;
    }
    samp->print(out, 0);
    out->close();

    // Everything's OK
    cout << "Success.\n";

    // Shut down
    parser.xmlterm();
    return 0;
}

// end of CG.cpp

Part IV

Oracle XDK Reference

This part contains the following reference chapters for the XDK:

Chapter 30, "XSQL Pages Reference"

Chapter 31, "XDK Standards"

Appendix A, "Oracle XDK for Java XML Error Messages"

Appendix B, "Oracle XDK for Java TXU Error Messages"

Appendix C, "Oracle XDK for Java XSU Error Messages"

30 XSQL Pages Reference

This chapter contains reference information for the XSQL pages framework. "XSQL Configuration File Parameters" describes settings in the XSQL configuration file. Table 30-1 lists the legal built-in actions for XSQL pages.

Table 30-1 Built-In XSQL Elements and Action Handler Classes

XSQL Action Element
Handler Class in oracle.xml.xsql.actions
Purpose

<xsql:action>

XSQLExtensionActionHandler

Invoke a user-defined action handler, implemented in Java, for executing custom logic and including custom XML data in your XSQL page.

<xsql:delete-request>

XSQLDeleteRequestHandler

Delete an existing row in the database based on the posted XML document supplied in the request.

<xsql:dml>

XSQLDMLHandler

Execute a SQL DML statement or a PL/SQL anonymous block.

<xsql:if-param>

XSQLIfParamHandler

Conditionally include XML content or other XSQL actions.

<xsql:include-owa>

XSQLIncludeOWAHandler

Include the results of a stored procedure that uses the Oracle Web Agent (OWA) packages in the database to generate XML.

<xsql:include-param>

XSQLGetParameterHandler

Include a parameter and its value as an element in the XSQL page.

<xsql:include-posted-xml>

XSQLIncludePostedXMLHandler

Include the XML document that has been posted in the request into the XSQL page.

<xsql:include-request-params>

XSQLIncludeRequestHandler

Include all request parameters as XML elements in the XSQL page.

<xsql:include-xml>

XSQLIncludeXMLHandler

Include arbitrary XML resources at any point in your page by relative or absolute URL.

<xsql:include-xsql>

XSQLIncludeXSQLHandler

Include the results of one XSQL page at any point inside another.

<xsql:insert-param>

XSQLInsertParameterHandler

Insert the XML document contained in the value of a single parameter.

<xsql:insert-request>

XSQLInsertRequestHandler

Insert the XML document or HTML form posted in the request into a table or view.

<xsql:query>

XSQLQueryHandler

Execute an arbitrary SQL statement and include its result in canonical XML format.

<xsql:ref-cursor-function>

XSQLRefCursorFunctionHandler

Include the canonical XML representation of the result set of a cursor returned by a PL/SQL stored function.

<xsql:set-cookie>

XSQLSetCookieHandler

Set an HTTP Cookie.

<xsql:set-page-param>

XSQLSetPageParamHandler

Set an HTTP-Session level parameter. Set a page-level (local) parameter that can be referred to in subsequent SQL statements in the page.

<xsql:set-session-param>

XSQLSetSessionParamHandler

Set an HTTP-Session level parameter.

<xsql:set-stylesheet-param>

XSQLStylesheetParameterHandler

Set the value of a top-level XSLT stylesheet parameter.

<xsql:update-request>

XSQLUpdateRequestHandler

Update an existing row in the database based on the posted XML document supplied in the request.

XSQL Configuration File Parameters

You can use the XSQL configuration file to tune your XSQL pages environment. Table 30-2 defines the legal parameters.

Table 30-2 XSQL Configuration File Settings

Configuration Setting Name
Description

XSQLConfig/servlet/output-buffer-size

Sets the size in bytes of the buffered output stream. If the servlet engine already buffers I/O to the servlet output stream, you can set to 0 (the default) to avoid additional buffering. Any non-negative integer is valid.

XSQLConfig/servlet/suppress-mime-charset/media-type

The XSQL servlet sets the HTTP ContentType header to indicate the MIME type of the resource returned to the request. By default, the servlet includes the optional character set data in the MIME type. For a particular MIME type, you can suppress the inclusion of the character set data by including a <media-type> element, with the desired MIME type as its contents. You can list any number of <media-type> elements. Valid value is any string.

XSQLConfig/processor/character-set-conversion/
default-charset

NOTE: Setting name is a single line. It is displayed on two lines due to space constraints.

Performs character set conversion by default on the value of HTTP parameters to compensate for the default character set used by most servlet engines. The default base character set used for conversion is the Java 8859_1, which corresponds to the IANA ISO-8859-1 set. If your servlet engine uses a different character set as its base, then you can specify this value here.

To suppress character set conversion, specify the empty element <none/> as the content of the <default-charset> element instead of a character set name. This technique is useful if you are working with parameter values that are correctly representable with your servlet default character set. It eliminates overhead associated with performing the character set conversion.

Valid values are any Java character set name or <none/>.

XSQLConfig/processor/reload-connections-on-error

Connection definitions are cached when the XSQL pages processor is initialized. Set to yes (default) to cause the processor to reread the XSQLConfig.xml file to reload connection definitions if an attempt is made to request a connection name that is not in the cached connection list. The yes setting is useful for adding new <connection> definitions to the file while the servlet is running. Set to no to avoid reloading the connection definition file when a connection name is not found in the in-memory cache. Valid values are yes and no.

XSQLConfig/processor/default-fetch-size

Sets the default value of the row fetch size for retrieving information from SQL queries. It only takes effect when you use the Oracle JDBC driver; otherwise the setting is ignored. This technique reduces network round trips to the database from the servlet engine running in a different tier.

Default is 50. Valid value is any nonzero positive integer.

XSQLConfig/processor/page-cache-size

Sets the size of the cache for XSQL page templates and so determines the maximum number of XSQL pages that are cached. Least recently used pages move out of the cache if you go above this number. Default is 25. Any nonzero positive integer is valid.

XSQLConfig/processor/stylesheet-cache-size

Sets the size of the cache for XSLT stylesheets and so determines the maximum number of XSQL pages that are cached. Least recently used pages move out of the cache if you go above this number. Default is 25. Any nonzero positive integer is valid.

XSQLConfig/processor/stylesheet-pool/initial

Each cached stylesheet is a pool of cached stylesheet instances to improve throughput. Sets the initial number of stylesheets to be allocated in each stylesheet pool.

Default is 1. Valid value is any nonzero positive integer.

XSQLConfig/processor/stylesheet-pool/increment

Sets the number of stylesheets allocated when the stylesheet pool must grow due to increased load on the server.

Default is 1. Valid value is any nonzero positive integer.

XSQLConfig/processor/stylesheet-pool/timeout-seconds

Sets the number of seconds of inactivity before a stylesheet instance in the pool is removed to free resources as the pool tries to shrink back to its initial size.

Default is 60. Valid value is any nonzero positive integer.

XSQLConfig/processor/connection-pool/initial

Controls the initial number of JDBC connections allocated in each connection pool. The XSQL pages processor's default connection manager implements connection pooling to improve throughput.

Default is 2. Valid value is any nonzero positive integer.

XSQLConfig/processor/connection-pool/increment

Sets the number of connections allocated when the connection pool must grow due to increased load on the server.

Default is 1. Valid value is any nonzero positive integer.

XSQLConfig/processor/connection-pool/timeout-seconds

Sets the number of seconds of inactivity before a JDBC connection in the pool is removed to free resources as the pool tries to shrink back to its initial size.

Default is 60. Valid value is any nonzero positive integer.

XSQLConfig/processor/connection-pool/dump-allowed

Determines whether a diagnostic report of connection pool activity can be requested by passing the dump-pool=y parameter in the page request.

Default is no. Valid value is yes or no.

XSQLConfig/processor/connection-manager/factory

Specifies the fully-qualified Java class name of the XSQL connection manager factory implementation. If not specified, default is XSQLConnectionManagerFactoryImpl.

Valid value is any class name that implements the XSQLConnectionManagerFactory interface.

XSQLConfig/processor/owa/fetch-style

Sets the default OWA Page Buffer fetch style used by the <xsql:include-owa> action. Valid values are CLOB (default) or TABLE.

If set to CLOB, then the processor uses a temporary CLOB to retrieve the OWA page buffer. If set to TABLE, then the processor uses a more efficient approach that requires the Oracle database user-defined type named XSQL_OWA_ARRAY. Create this type with the following DDL statement:

CREATE TYPE xsql_owa_array AS TABLE OF VARCHAR2(32767)

XSQLConfig/processor/timing/page

Determines whether the XSQL page processor adds an xsql-timing attribute to the document element of the page whose value reports the elapsed number of milliseconds required to process the page.

Valid values are yes or no (default).

XSQLConfig/processor/timing/action

Determines whether a the XSQL page processor adds comment to the page just before the action element whose contents reports the elapsed number of milliseconds required to process the action.

Valid values are yes or no (default).

XSQLConfig/processor/logger/factory

Specifies the fully-qualified Java class name of a custom XSQL logger factory implementation. If not set, then no logger is used.

Valid value is any class name that implements the XSQLLoggerFactory interface.

XSQLConfig/processor/error-handler/class

Specifies the fully-qualified Java class name of a custom XSQL error handler. The specified handler is the default error handler implementation. If not set, then the default error handler is used.

Valid value is any class name that implements the XSQLErrorHandler interface.

XSQLConfig/processor/xml-parsing/preserve-whitespace

Determines whether the XSQL pages processor preserves whitespace when parsing XSQL pages and XSLT stylesheets.

Valid values are true (default) or false. Changing the default to false can slightly speed up processing of XSQL pages and stylesheets because ignoring whitespace while parsing is faster than preserving it.

XSQLConfig/processor/security/stylesheet/defaults/
allow-client-style

NOTE: Setting name is a single line. It is displayed on two lines due to space constraints.

Prevents client overriding of the stylesheet. Valid values are yes and no.

During development it is sometimes useful to use the XSQL stylesheet override feature by providing a value for the xml-stylesheet parameter in the request. You can use the xml-stylesheet=none combination to temporarily disable the application of the stylesheet for debugging purposes.

You can add the allow-client-style="no" attribute to the document element of each XSQL page to prohibit client overriding of the stylesheet in production applications. This setting can globally change the default behavior for allow-client-style in a single place.

This setting only specifies default behavior. If the attribute value is explicitly specified on the document element for a given XSQL page, its value takes precedence over this global default.

XSQLConfig/processor/security/stylesheet/
trusted-hosts/host

NOTE: Setting name is a single line. It is displayed on two lines due to space constraints.

Specifies that any absolute URL to an XSLT stylesheet must be from a trusted host whose name is listed in the configuration file. List any number of <host> elements inside the <trusted-hosts> element. The name of the local machine, localhost, and 127.0.0.1 are trusted hosts by default. Valid values are any hostname or IP address.

The XSLT processor supports Java extension functions. Typically, XSQL pages refer to XSLT stylesheets with relative URLs.

XSQLConfig/http/proxyhost

Sets the name of the HTTP proxy server to use when processing URLs with the HTTP protocol.

Valid value is any hostname or IP address.

XSQLConfig/http/proxyport

Sets the port number of the HTTP proxy server to use when processing URLs with the HTTP protocol.

Valid value is any nonzero integer.

XSQLConfig/connectiondefs/connection

Defines a short name and the JDBC details for a named connection used by the XSQL pages processor.

You may supply any number of <connection> element children of <connectiondefs>. Each connection definition must supply a name attribute and may supply children elements <username>, <password>, <driver>, <dburl>, and <autocommit>.

XSQLConfig/connectiondefs/connection/username

Defines the username for the current connection.

XSQLConfig/connectiondefs/connection/password

Defines the password for the current connection.

XSQLConfig/connectiondefs/connection/dburl

Defines the JDBC connection URL for the current connection.

XSQLConfig/connectiondefs/connection/driver

Specifies the fully-qualified Java class name of the JDBC driver used for the current connection. If not specified, defaults to oracle.jdbc.driver.OracleDriver.

XSQLConfig/connectiondefs/connection/autocommit

Explicitly sets the Auto Commit flag for the current connection. If not specified, the connection uses the JDBC driver default setting for Auto Commit.

XSQLConfig/serializerdefs/serializer

Defines a named custom serializer implementation. You can supply any number of <serializer> element children of <serializerdefs>. Each must specify both a <name> and a <class> child element.

XSQLConfig/serializerdefs/serializer/name

Defines the name of the current custom serializer definition.

XSQLConfig/connectiondefs/connection/class

Specifies the fully-qualified Java class name of the current custom serializer. The class must implement the XSQLDocumentSerializer interface.

<xsql:action>

Purpose

Invokes a user-defined action handler, implemented in Java, for executing custom logic and including custom XML data in a XSQL page. The Java class invoked with this action must implement the oracle.xml.xsql.XSQLActionHandler interface.

Use <xsql:action> to perform tasks that are not handled by the built-in action handlers. Custom actions can supply arbitrary XML content to the data page and perform arbitrary processing.

Usage Notes

The XSQL page processor processes the actions in a page in the following way:

Constructs an instance of the action handler class with the default constructor.

Initializes the handler instance with the action element object and the page processor context by invoking the method init(Element actionElt, XSQLPageRequest context).

Invokes the method that allows the handler to handle the action handleAction(Node result).

Syntax

The syntax for this action is as follows, where handler is a single, required attribute named whose value is the fully-qualified Java class name of the invoked action, yourpackage is the Java package, and YourCustomHandler is the Java class:

<xsql:action handler="yourpackage.YourCustomHandler"/>

Some action handlers expect text content or element content to appear inside the <xsql:action> element. In this case, use syntax such as the following:

<xsql:action handler="yourpackage.YourCustomHandler">
  Some_text
</xsql:action>

You can also use the following syntax:

<xsql:action handler="yourpackage.YourCustomHandler">
  <some>
    <other/>
    <elements/>
    <here/>
  </some>
</xsql:action>

Attributes

The only required attribute is handler, but you can supply additional attributes to the handler. For example, if yourpackage.YourCustomHandler is expecting attributes named param1 and param2, then use the following syntax:

<xsql:action handler="yourpackage.YourCustomHandler" param1="xxx" param2="yyy">

Examples

Example 30-1 shows an XSQL page that invokes the myactions.StockQuotes Java class. It includes stock quotes from Google for any symbols passed in with the symbol parameter. If this parameter is not supplied, it supplies a default list.

Example 30-1 Retrieving Stock Quotes

<?xml version="1.0"?>
<page xmlns:xsql="urn:oracle-xsql">
  <xsql:action handler="myactions.StockQuotes"
               symbols="{@symbol}"
               symbol="ORCL,SAP,MSFT,IBM"/>
</page>

<xsql:delete-request>

Purpose

Accepts data posted from an XML document or HTML form and uses the XML SQL Utility (XSU) to delete the content of an XML document in canonical form from a target table or view.

By combining XSU with XSLT, you can transform XML into the canonical format expected by a given table. Afterward, you can use XSU to delete the resulting canonical XML. For a specified database table, the canonical XML form is given by one row of XML output from a SELECT * query against the table.

Syntax

The syntax for this action is as follows, where table_name is the name of a table and key is a list of one or more columns to use as the unique key:

<xsql:delete-request table="table_name" key-columns="key"/>

Attributes

Table 30-3 lists the optional attributes that you can use on the <xsql:delete-request> action. Required attributes are in bold

Table 30-3 Attributes for <xsql:delete-request>

Attribute Name
Description

table = "string"

Name of the table, view, or synonym to use for deleting the XML data.

key-columns = "string string ..."

Space-delimited or comma-delimited list of one or more column names. The processor uses the values of these names in the posted XML document to identify the existing rows to delete.

transform = "URL"

Relative or absolute URL of the XSLT transformation to use to transform the document to be deleted into canonical ROWSET/ROW format.

columns = "string"

Relative or absolute URL of the XSLT transformation to use to transform the document to be deleted into canonical ROWSET/ROW format.

commit = "boolean"

If set to yes (default), calls COMMIT on the current connection after a successful execution of the deletion. Valid values are yes and no.

commit-batch-size = "integer"

If a positive, nonzero integer is specified, then after each batch of integer deleted records, the processor issues a COMMIT. The default batch size is zero (0) if not specified, which means that the processor does not commit interim batches.

date-format = "string"

Date format mask to use for interpreting date field values in XML being deleted. Valid values are those documented for the java.text.SimpleDateFormat class.

error-param = "string"

Name of a page-private parameter that must be set to the string Error if a non-fatal error occurs while processing this action. Valid value is any parameter name.

Examples

Example 30-2 specifies that the posted XML document should be transformed with the style.xsl stylesheet and then deleted from the departments table. The departments.department_id column is the primary key for the deletion.

Example 30-2 Deleting Rows

<?xml version="1.0"?>
<xsql:delete-request table="departments"       transform="style.xsl"
 connection="demo" key-columns="department_id" xmlns:xsql="urn:oracle-xsql"/>

<xsql:dml>

Purpose

Executes a DML or DDL statement or a PL/SQL block. Typically, you use this tag to include statements that would be executed or rolled back together.

This action requires a database connection provided as a connection="connname" attribute on the document element of the XSQL page in which it appears.

Usage Notes

You cannot set parameter values by binding them in the position of OUT variables with <xsql:dml>. Only IN parameters are supported for binding.

Syntax

The syntax for the action is as follows, where DML_DDL_or_PLSQL is a placeholder for a legal DML statement, DDL statement, or PL/SQL block:

<xsql:dml>
  DML_DDL_or_PLSQL
</xsql:dml>

Attributes

Table 30-4 lists the optional attributes that you can use on the <xsql:dml> action.

Table 30-4 Attributes for <xsql:dml>

Attribute Name
Description

commit = "boolean"

If set to yes, calls commit on the current connection after a successful execution of the DML statement. Valid values are yes and no (default).

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. The values of these parameters are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

error-param = "string"

Name of a page-private parameter that must be set to the string 'Error' if a nonfatal error occurs while processing this action. Valid value is any parameter name.

error-statement = "boolean"

If set to no, suppresses the inclusion of the offending SQL statement in any <xsql-error> element generated. Valid values are yes (default) and no.

Examples

Example 30-3 inserts the username stored in the webuser cookie into a request_log table. Using bind variables guards against SQL injection attacks.

Example 30-3 Inserting a Username into a Table

 <xsql:dml connection="demo" bind-params="webuser"
           xmlns:xsql="urn:oracle-xsql">
   BEGIN
     INSERT INTO request_log(page,userid)
       VALUES( 'somepage.xsql', ? );
     COMMIT;
   END;
 </xsql:dml>

<xsql:if-param>

Purpose

Enables you to include elements and actions nested inside if a specified condition is true. If the condition is true, then all nested XML content and actions are included in the page. If the condition is false, then none of the nested XML content or actions is included (and thus none of the nested actions is executed).

Specify which parameter value is evaluated by supplying the required name attribute. Both simple parameter names as well as array-parameter names are supported.

Note:

If the parameter being tested does not exist, the test evaluates to false.

Syntax

The syntax for the action is the following, where some_name is the value of the name attribute and test_condition is exactly one of the conditions listed in Table 30-5:

<xsql:if-param name="some_name" test_condition>
   element_or_action
</xsql:if-param>

Any XML content or XSQL action elements can be nested inside an <xsql:if-param>, including other <xsql:if-param> elements.

Attributes

In addition to the required name attribute, you must pick exactly one of the attributes listed in Table 30-5 to indicate how the parameter value (or values, in the array case) is tested. As with other XSQL actions, the attributes of the <xsql:if-param> action can contain lexical substitution parameter expressions such as {@paramName}.

Table 30-5 Attributes for <xsql:if-param>

Attribute Name
Description

exists="yes_or_no"

If set to exists="yes", then this condition tests whether the named parameter exists and has a non-empty value. For an array-valued parameter, it tests whether the array-parameter exists and has at least one non-empty element.

If set to exists="no", then this condition evaluates to true if the parameter does not exist, of if it exists but has an empty value. For an array-valued parameter, it evaluates to true if the parameter does not exist, or if all of the array elements are empty.

equals="stringValue"

This condition tests whether the named parameter equals the string value provided. By default the comparison is an exact string match. For a case-insensitive match, supply the additional ignore-case="yes" attribute as well.

For an array-valued parameter, the condition tests whether any element in the array has the indicated value.

not-equals="stringValue"

This condition tests whether the named parameter does not equal the string value provided. By default the comparison is an exact string match. For an array-valued parameter, the condition evaluates to true if none of the elements in the array has the indicated value.

in-list = "comma-or-space-separated-list"

This condition tests whether the named parameter matches any of the strings in the provided list. By default the comparison is an exact string match. For a case-insensitive match, supply the additional ignore-case="yes" attribute as well.

The value of the in-list parameter is tokenized into an array with commas as the delimiter if commas are detected in the string. Otherwise, it uses a space as the delimiter. For an array-valued parameter, the condition tests whether any element in the array matches an element in the list.

not-in-list = "comma-or-space-separated-list"

This tests whether the named parameter does not match any of the strings in the provided list. By default the comparison is an exact string match. For a case-insensitive match, supply the additional ignore-case="yes" attribute as well.

The value of the not-in-list parameter is tokenized into an array with commas as the delimiter if commas are in the string. Otherwise, the processor uses a space as the delimiter. For an array-valued parameter, the condition tests whether none of the elements in the array matches an element in the list.

Examples

To test whether two different conditions are true, you can use nested <xsql:if-param> elements as shown in Example 30-4.

Example 30-4 Testing Conditions

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
<!--
| Set page parameter 'some_param' to value "some_value" if parameter 'a'
| exists, and if parameter 'b' has a value equal to "X"
+-->
  <xsql:if-param name="a" exists="yes">
    <xsql:if-param name="b" equals="X">
      <xsql:set-page-param name="some_param" value="some_value"/>
    </xsql:if-param>
  </xsql:if-param>
  <!-- ... -->
</page>

<xsql:include-owa>

Purpose

Includes XML content generated by a database stored procedure. This action requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

The stored procedure uses the standard Oracle Web Agent (OWA) packages (HTP and HTF) to "print" the XML tags into the server-side page buffer. Afterwards, the XSQL pages processor fetches, parses, and includes the dynamically-produced XML content in the data page. The stored procedure must generate a well-formed XML page or an appropriate error is displayed.

Usage Notes

You can create a wrapper procedure that constructs XML elements with the HTP package. Your XSQL page can invoke the wrapper procedure by using <xsql:include-owa>.

Syntax

The syntax for the action is as follows, where PL/SQL_block is a PL/SQL Block invoking a procedure that uses the HTP or HTF packages:

<xsql:include-owa>
   PL/SQL_block
</xsql:include-owa>

Attributes

Table 30-6 lists the optional attributes supported by this action.

Table 30-6 Attributes for <xsql:include-owa>

Attribute Name
Description

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. The values of these parameters are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

error-param = "string"

Name of a page-private parameter that must be set to the string 'Error' if a non-fatal error occurs while processing this action. Valid value is any parameter name.

error-statement = "boolean"

If set to no, suppresses the inclusion of the offending SQL statement in any <xsql-error> element generated. Valid values are yes (default) and no.

Examples

Assume that you write a PL/SQL procedure called UpdateStatus that updates the status of a project. The procedure uses HTP to print an <UpdateStatus> datagram that contains the element <Success/> if no errors occur or one or more <Error> elements if errors occur.

Example 30-5 shows how you can call UpdateStatus from an XSQL page. The example uses SQL bind variable instead of lexical substitution to prevent the possibility of SQL injection attacks.

Example 30-5 Including XML Content Created by a Stored Procedure

<xsql:include-owa connection="demo"
                  bind-params="project status"
                  xmlns:xsql="urn:oracle-xsql">
  UpdateStatus( ?,? );
</xsql:include-owa>

Assume that a user enters an invalid status number for a project into a Web-based form. The form posts the input parameters to an XSQL page as shown in Example 30-5. The XSQL processor returns the following datagram, which an XSLT stylesheet could transform into an HTML error page:

<UpdateStatus>
  <Error Field="status">Status must be 1, 2, 3, or 4</Error>
</UpdateStatus>

<xsql:include-param>

Purpose

Includes an XML representation of the name and value of a single parameter. This technique is useful if an associated XSLT stylesheet must refer to parameter values with XPath expressions.

Syntax

The syntax of the action is as follows, where paramname is the name of a parameter:

<xsql:include-param name="paramname" />

The required name attribute supplies the name of the parameter whose value you want to include.

Attributes

The name attribute is required; there are no optional attributes.

Examples

Example 30-6 uses XPATH to obtain the value of a parameter and represent it in XML.

Example 30-6 Including an XML Representation of a Parameter Value

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql"
                        xmlns:p="http://www.companysite.com/products">
  <xsql:set-page-param name="productid"
                       xpath="/p:Products/productid"/>
  <xsql:include-param name="productid"/>
</page>

The XML fragment included in the datagram will be as follows:

<productid>12345</productid>

Suppose that you use an array parameter name to indicate that you want to treat the value as an array, as in the following example:

<xsql:include-param name="productid[]"/>

The XML fragment reflects all of the array values, as shown in the following example:

<productid>
  <value>12345<value>
  <value>33455</value>
  <value>88199</value>
</productid>

In this array-parameter name scenario, if productid happens to be a single-valued parameter, then the fragment looks identical to a one-element array, as illustrated in the following example:

<productid>
  <value>12345<value>
</productid>

<xsql:include-posted-xml>

Purpose

Includes the posted XML document in the XSQL page. If the user posts an HTML form instead of an XML document, then the XML included is similar to that included by the <xsql:include-request-params> action.

Syntax

The syntax of the action is as follows:

<xsql:include-posted-xml/>

Attributes

None.

Examples

Example 30-7 shows a sample XSQL page that includes a posted XML document.

Example 30-7 Including Posted XML

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsql" href="somepage.xsql"?>
<page connection="demo"
      xmlns:xsql="urn:oracle-xsql">
  <xsql:include-posted-xml/>
</page>

<xsql:include-request-params>

Purpose

Includes an XML representation of all parameters in the request in the datagram. The action element is replaced in the page at page-request time with a tree of XML elements that represents the parameters available to the request.

This technique is useful if an associated XSLT stylesheet must refer to request parameter values with XPath expressions.

Usage Notes

When processing pages through the XSQL servlet, the XML included takes the form shown in Example 30-8.

Example 30-8 Including Request Parameters

<request>
  <parameters>
    <paramname>value1</paramname>
    <ParamName2>value2</ParamName2>
     ...
  </parameters>
  <session>
    <sessVarName>value1</sessVarName>
     ...
  </session>
  <cookies>
    <cookieName>value1</cookieName>
     ...
  </cookies>
</request>

When you use the XSQL command-line utility or the XSQLRequest class, the XML takes the form shown in Example 30-11.

Example 30-9 Including Request Parameters

<request>
  <parameters>
    <paramname>value1</paramname>
    <ParamName2>value2</ParamName2>
     ...
  </parameters>
</request>

The technique enables you to distinguish request parameters from session parameters or cookies because its value is a child element of <parameters>, <session>, or <cookies>.

Syntax

The syntax of the action is as follows:

<xsql:include-request-params/>

Attributes

None.

Examples

Example 30-10 shows a sample XSQL page that includes all request parameters in the data page.

Example 30-10 Including Request Parameters

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsql" href="cookie_condition.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:include-request-params/>
</page>

The cookie_condition.xsl stylesheet chooses an output format based on whether the siteuser cookie is present. Example 30-11 shows a fragment of the stylesheet.

Example 30-11 Testing for Conditions in a Stylesheet

<xsl:choose>
  <xsl:when test="/page/request/cookies/siteuser">
  ...
  </xsl:when>
  <xsl:otherwise>
  ...
  </xsl:otherwise>
</xsl:choose>

<xsql:include-xml>

Purpose

Includes the XML contents of a local, remote, or database-driven XML resource in your datagram. You can specify the resource by URL or SQL statement. The server can deliver a resource that is a static XML file or dynamically created XML from a programmatic resource such as a servlet or CGI program.

Syntax

The syntax for this action is as follows, where URL is a relative URL or an absolute, HTTP-based URL to retrieve XML from another Web site:

<xsql:include-xml href="URL"/>

Alternatively, you can use the following syntax, where SQL_statement is a SQL SELECT statement selecting a single row containing a single CLOB or VARCHAR2 column value:

<xsql:include-xml>
  SQL_statement
</xsql:include-xml>

The href attribute and SQL statement are mutually exclusive. If you provide one, then the other is not allowed.

Attributes

Table 30-7 lists the attributes supported by this action. Required attributes are in bold.

Table 30-7 Attributes for <xsql:include-xml>

Attribute Name
Description

href="URL"

The absolute, relative, or parameterized URL of the XML resource to be included. The resource can be a static file dynamic source.

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. The values for these name will be used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

error-param = "string"

Name of a page-private parameter that must be set to the string 'Error' if a non-fatal error occurs while processing this action. Valid value is any parameter name.

Examples

Example 30-12 includes an XML document retrieved by a database query. The XML content is a CLOB-valued member field of a user-defined type. The XML included must come from a VARCHAR2 or CLOB column, not an XMLType.

Example 30-12 Including an XML Document

<?xml version="1.0"?>
<xsql:include-xml bind-params="id" connection="demo"
                   xmlns:xsql="urn:oracle-xsql">
  SELECT x.document.contents doc FROM xmldoc x
  WHERE x.docid = ?
</xsql:include-xml>

<xsql:include-xsql>

Purpose

Includes the XML output of one XSQL page in another page. You can create a page that assembles the contents—optionally transformed—from other XSQL pages.

Usage Notes

If the aggregated page contains an <?xml-stylesheet?> processing instruction, then this stylesheet is applied before the result is aggregated. Thus, you can use <xsql:include-xsql> to chain XSLT stylesheets.

When one XSQL page aggregates another page by using <xsql:include-xsql>, all request-level parameters are visible to the nested page. For pages processed by the XSQL Servlet, the visible data includes session-level parameters and cookies. None of the aggregating page's page-private parameters are visible to the nested page.

Syntax

The syntax for this action is as follows, where XSQL_page is a relative or absolute URL of an XSQL page to be included:

<xsql:include-xsql href="XSQL_page"/>

Attributes

Table 30-8 lists the attributes supported by this action. Required attributes are in bold; all others are optional.

Table 30-8 Attributes for <xsql:include-xsql>

Attribute Name
Description

href="string"

Relative or absolute URL of XSQL page to be included.

error-param = "string"

Name of a page-private parameter that must be set to the string Error if a non-fatal error occurs while processing this action. Valid value is any parameter name.

reparse = "boolean"

Indicates whether output of the included XSQL page must be reparsed before it is included. Valid values are no (default) and yes.

This attribute is useful if the included XSQL page selects the text of an XML document fragment that the including page wants to treat as elements.

Examples

Example 30-13 displays an XSQL page that lists discussion forum categories.

Example 30-13 Categories.xsql

<?xml version="1.0"?>
<xsql:query connection="demo" xmlns:xsql="urn:oracle-xsql">
  SELECT name
  FROM categories
  ORDER BY name
</xsql:query>

Example 30-14 shows how you can include the results of the page in Example 30-13 into a page that lists the ten most recent topics in the current forum.

Example 30-14 TopTenTopics.xsql

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<top-ten-topics connection="demo" xmlns:xsql="urn:oracle-xsql">
  <topics>
    <xsql:query max-rows="10">
      SELECT subject
      FROM topics
      ORDER BY last_modified DESC
    </xsql:query>
  </topics>
  <categories>
    <xsql:include-xsql href="Categories.xsql"/>
  </categories>
</top-ten-topics>

You can also use <xsql:include-xsql> to apply an XSLT stylesheet to an included page. Assume that you write the following XSLT stylesheets:

cats-as-html.xsl, which renders the topics in HTML

cats-as-wml.xsl, which renders the topics in WML

One approach for catering to two different types of devices is to create different XSQL pages for each device. Example 30-15 shows an XSQL page that aggregates Categories.xsql and applies the cats-as-html.xsl stylesheet.

Example 30-15 HTMLCategories.xsql

<?xml version="1.0"?>
<!-- HTMLCategories.xsql -->
<?xml-stylesheet type="text/xsl" href="cats-as-html.xsl"?>
<xsql:include-xsql href="Categories.xsql" xmlns:xsql="urn:oracle-xsql"/>

Example 30-16 shows an XSQL page that aggregates Categories.xsql and applies the cats-as-html.xsl stylesheet for delivering to wireless devices.

Example 30-16 WMLCategories.xsql

<?xml version="1.0"?>
<!-- WMLCategories.xsql -->
<?xml-stylesheet type="text/xsl" href="cats-as-wml.xsl"?>
<xsql:include-xsql href="Categories.xsql" xmlns:xsql="urn:oracle-xsql"/>

<xsql:insert-param>

Purpose

Inserts the value of a parameter into a table or view. Use this tag when the client is posting a well-formed XML document as text in an HTTP parameter or individual HTML form field.

By combining the XML SQL Utility (XSU) with XSLT, you can transform XML into the canonical format expected by a given table. Afterward, you can use XSU to insert the resulting canonical XML. For a specified database table, the canonical XML form is given by one row of XML output from a SELECT * query against the table.

Syntax

The syntax for this action is as follows, where table_or_view_name is a relative or absolute URL of an XSQL page to be included:

<xsql:insert-param table="table_or_view_name" name="string"/>

Attributes

Table 30-9 lists the optional attributes that you can use on the <xsql:insert-param> action.

Table 30-9 Attributes for <xsql:insert-param>

Attribute Name
Description

name="string"

Name of the parameter whose value contains XML to be inserted.

table="string"

Name of the table, view, or synonym to use for inserting the XML data.

transform = "URL"

Relative or absolute URL of the XSLT transformation to use to transform the document to be inserted into canonical ROWSET/ROW format.

columns = "string"

Space-delimited or comma-delimited list of one or more column names whose values will be inserted. If supplied, then only these columns will be inserted. If not supplied, all columns will be inserted, with NULL values for columns whose values do not appear in the XML document.

commit = "boolean"

If set to yes, calls commit on the current connection after a successful execution of the insert. Valid values are yes (default) and no.

commit-batch-size = "integer"

If a positive, nonzero number integer is specified, then after each batch of integer inserted records, the XSQL processor issues a COMMIT. Default batch size is zero (0), which instructs the processor not to commit interim batches.

date-format = "string"

Date format mask to use for interpreting date field values in XML being inserted. Valid values are those for the java.text.SimpleDateFormat class.

error-param = "string"

Name of a page-private parameter that must be set to Error if a non-fatal error occurs while processing this action. Valid value is any parameter name.

Examples

Example 30-17 parses and transforms the contents of the HTML form parameter xmlfield for database insert.

Example 30-17 Inserting XML Contained in an HTML Form Parameter

<?xml version="1.0"?>
<xsql:insert-param name="xmlfield" table="image_metadata_table"
transform="field-to-rowset.xsl" connection="demo" xmlns:xsql="urn:oracle-xsql"/>

<xsql:insert-request>

Purpose

Accepts data posted from an XML document or HTML form and uses the XML SQL Utility (XSU) to insert the content of an XML document in canonical form into a target table or view.

If an HTML Form has been posted, then the posted XML document is materialized from HTTP request parameters, cookies, and session variables. The XML document has the following form:

<request>
<parameters>
  <param1>value1</param1>
    :
  </paramN>valueN</paramN>
</parameters>
  :
</request>

By combining XSU with XSLT, you can transform XML into the canonical format expected by a given table. The XSQL engine uses XSU to insert the resulting canonical XML. For a specified database table, the canonical XML form is given by one row of XML output from a SELECT * query against the table.

Usage Notes

If you target a database view with an INSERT, then you can create INSTEAD OF INSERT triggers on the view to further automate the handling of the posted data. For example, an INSTEAD OF INSERT trigger on a view can use PL/SQL to check for the existence of a record and intelligently choose whether to do an INSERT or an UPDATE depending on the result.

Syntax

The syntax for this action is as follows:

<xsql:insert-request table="table"/>

Attributes

Table 30-10 lists the optional attributes that you can use on the <xsql:insert-request> action.

Table 30-10 Attributes for <xsql:insert-request>

Attribute Name
Description

table = "string"

Name of the table, view, or synonym to use for inserting the XML data.

transform = "URL"

Relative or absolute URL of the XSLT transformation to use to transform the document to be inserted into canonical ROWSET/ROW format.

columns = "string"

Relative or absolute URL of the XSLT transformation to use to transform the document to be inserted into canonical ROWSET/ROW format.

commit = "boolean"

If set to yes (default), calls COMMIT on the current connection after a successful execution of the insert. Valid values are yes and no.

commit-batch-size = "integer"

If a positive, nonzero number integer is specified, then after each batch of integer inserted records, the processor issues a COMMIT. The default batch size is zero (0) if not specified, which means that the processor does not commit interim batches.

date-format = "string"

Date format mask to use for interpreting date field values in XML being inserted. Valid values are those documented for the java.text.SimpleDateFormat class.

error-param = "string"

Name of a page-private parameter that must be set to the string Error if a non-fatal error occurs while processing this action. Valid value is any parameter name.

Examples

Example 30-18 parses and transforms the contents of the posted XML document or HTML Form for insert.

Example 30-18 Inserting XML Received in a Parameter

<?xml version="1.0"?>
<xsql:insert-request
  table="purchase_order"
  transform="purchseorder-to-rowset.xsl"
  connection="demo"
  xmlns:xsql="urn:oracle-xsql"/>

<xsql:query>

Purpose

Executes a SQL select statement and includes a canonical XML representation of the query result set in the data page. This action requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

Syntax

The syntax for the action is the following:

<xsql:query>
   SELECT_Statement
</xsql:query>

Any legal SQL select statement is permissible as a substitution for the SELECT_Statement placeholder. If the select statement produces no rows, then you can provide a fallback query by including a nested <xsql:no-rows-query> element as follows:

<xsql:query>
  SELECT_Statement
  <xsql:no-rows-query>
    Fallback_SELECT_Statement
  </xsql:no-rows-query>
</xsql:query>

An <xsql:no-rows-query> element can itself contain nested <xsql:no-rows-query> elements to any level of nesting. The options available on the <xsql:no-rows-query> are identical to those legal on the <xsql:query> action element.

Attributes

The optional attributes listed in Table 30-11 can be supplied to control various aspects of the data retrieved and the XML produced by the <xsql:query> action.

Table 30-11 Attributes for <xsql:query>

Attribute Name
Description

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. The values of these parameters are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

date-format = "string"

Date format mask to use for formatted date column and attribute values in the XML that is queried. Valid values are the same values legal for the java.text.SimpleDateFormat class.

error-param = "string"

Name of a page-private parameter that must be set to the string 'Error' if a nonfatal error occurs while processing this action. Valid value is any parameter name.

error-statement = "boolean"

If set to no, suppresses the inclusion of the offending SQL statement in any <xsql-error> element generated. Valid values are yes (default) and no.

fetch-size = "integer"

Number of records to fetch in each round trip to the database. If not set, the default value is used as specified by the /XSQLConfig/processor/default-fetch-size configuration setting in XSQLConfig.xml.

id-attribute = "string"

XML attribute name to use instead of the default num for uniquely identifying each row in the result set. If the value is the empty string, then the row id attribute is suppressed.

id-attribute-column = "string"

Case-sensitive name of the column in the result set whose value must be used in each row as the value of the row id attribute. The default is to use the row count as the value of the row id attribute.

include-schema = "boolean"

If set to yes, includes an inline XML schema that describes the structure of the result set. Valid values are yes and no (default).

max-rows = "integer"

Maximum number of rows to fetch after optionally skipping the number of rows set by the skip-rows attribute. If not specified, the default is to fetch all rows.

null-indicator = "boolean"

Indicates whether to signal that a column's value is NULL by including the NULL="Y" attribute on the element for the column. By default, columns with NULL values are omitted from the output. Valid values are yes and no (default).

row-element = "string"

XML element name to use instead of the default <ROW> for the rowset of query results. Set to the empty string to suppress generating a containing <ROW> element for each row in the result set.

rowset-element = "string"

XML element name to use instead of the default <ROWSET> for the rowset of query results. Set to the empty string to suppress generating a containing <ROWSET> element.

skip-rows = "integer"

Number of rows to skip before fetching rows from the result set. Can be combined with max-rows for stateless paging through query results.

tag-case = "string"

Valid values are lower and upper. If not specified, the default is to use the case of column names as specified in the query as corresponding XML element names.

Examples

Example 30-20 shows a simple XSQL page.

Example 30-19 Hello World

<?xml version="1.0"?>
<xsql:query connection="xmlbook" xmlns:xsql="urn:oracle-xsql">
   SELECT 'Hello, World!' AS text     FROM DUAL</xsql:query>

If you save Example 30-20 as hello.xsql and execute it in a browser, the XSQL page processor returns the following XML:

<?xml version = '1.0'?>
<ROWSET>
   <ROW num="1">
      <TEXT>Hello, World!</TEXT>
   </ROW>
</ROWSET>

By default, the XML produced by a query reflects the column structure of its result set, with element names matching the names of the columns. Columns in the result with the following nested structure produce nested elements that reflect this structure:

Object types

Collection types

CURSOR expressions

The result of a typical query containing different types of columns and returning one row might look like Example 30-20.

Example 30-20 Nested Structure Example

<ROWSET>
  <ROW id="1">
    <VARCHARCOL>Value</VARCHARCOL>
    <NUMBERCOL>12345</NUMBERCOL>
    <DATECOL>12/10/2001 10:13:22</DATECOL>
    <OBJECTCOL>
       <ATTR1>Value</ATTR1>
       <ATTR2>Value</ATTR2>
    </OBJECTCOL>
    <COLLECTIONCOL>
       <COLLECTIONCOL_ITEM>
         <ATTR1>Value</ATTR1>
         <ATTR2>Value</ATTR2>
       </COLLECTIONCOL_ITEM>
       <COLLECTIONCOL_ITEM>
         <ATTR1>Value</ATTR1>
         <ATTR2>Value</ATTR2>
       </COLLECTIONCOL_ITEM>
    </COLLECTIONCOL>
    <CURSORCOL>
      <CURSORCOL_ROW>
        <COL1>Value1</COL1>
        <COL2>Value2</COL2>
      </CURSORCOR_ROW>
    </CURSORCOL>
  </ROW>
</ROWSET>

A <ROW> element repeats for each row in the result set. Your query can use standard SQL column aliasing to rename the columns in the result, which effectively renames the XML elements that are produced. Column aliasing is required for columns whose names otherwise are illegal names for an XML element.

For example, an <xsql:query> action as shown in Example 30-21 produces an error because the default column name for the calculated expression is an illegal XML element name.

Example 30-21 Query with Error

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<xsql:query connection="demo" xmlns:xsql="urn:oracle-xsql">
  SELECT TO_CHAR(hire_date,'DD-MON')
  FROM   employees
</xsql:query>

You can fix the problem by using column aliasing as shown in Example 30-22.

Example 30-22 Query with Column Aliasing

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<xsql:query connection="demo" xmlns:xsql="urn:oracle-xsql">
  SELECT TO_CHAR(hire_date,'DD-MON') AS hiredate FROM   employees
</xsql:query>

<xsql:ref-cursor-function>

Purpose

Executes an arbitrary stored function returning a REF CURSOR and includes the query result set in canonical XML format. This action requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

Use this tag to invoke a stored procedure that determines what the query is and returns a cursor to the query. Used in this way, this tag also provides a weak level of security because it can hide the query from direct inspection.

Syntax

The syntax of the action is as follows, where SCHEMA_NAME represents an optional database schema name, PACKAGE_NAME represents an optional PL/SQL package name, and FUNCTION_NAME (required) specifies the name of a PL/SQL function:

<xsql:ref-cursor-function>
  [SCHEMA_NAME.][PACKAGE_NAME.]FUNCTION_NAME(args);
</xsql:ref-cursor-function>

Attributes

The optional attributes are the same as for the <xsql:query> action listed in Table 30-11 except that fetch-size is not available for <xsql:ref-cursor-function>.

Examples

By exploiting dynamic SQL in PL/SQL, a function can conditionally construct a dynamic query before a cursor handle to its result set is returned to the XSQL page processor. The return value of the function must be of type REF CURSOR. Consider the PL/SQL package shown in Example 30-23.

Example 30-23 DynCursor PL/SQL Package

CREATE OR REPLACE PACKAGE DynCursor IS
  TYPE ref_cursor IS REF CURSOR;
  FUNCTION DynamicQuery(id NUMBER) RETURN ref_cursor;
END;
CREATE OR REPLACE PACKAGE BODY DynCursor IS
  FUNCTION DynamicQuery(id NUMBER) RETURN ref_cursor IS
    the_cursor ref_cursor;
  BEGIN
    IF id = 1 THEN -- Conditionally return a dynamic query as a REF CURSOR
      OPEN the_cursor  -- An employees Query
       FOR 'SELECT employee_id, email FROM employees';
    ELSE
      OPEN the_cursor  -- A departments Query
        FOR 'SELECT department_name, department_id FROM departments';
   END IF;
   RETURN the_cursor;
  END;
END;

An <xsql:ref-cursor-function> can include the dynamic results of the REF CURSOR returned by this function as shown in Example 30-24.

Example 30-24 Executing a REF CURSOR Function

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<xsql:ref-cursor-function connection="demo" xmlns:xsql="urn:oracle-xsql">
  DynCursor.DynamicQuery(1);
</xsql:ref-cursor-function>

<xsql:set-cookie>

Purpose

Sets an HTTP cookie to a value. By default, the value remains for the lifetime of the current browser, but you can change its lifetime by supplying the optional max-age attribute. The value to be assigned to the cookie can be supplied by a combination of static text and other parameter values, or from the result of a SQL SELECT statement.

Because this feature is specific to the HTTP protocol, this action is only effective if the XSQL page in which it appears is processed by the XSQL servlet. If this action is encountered in an XSQL page processed by the XSQL command-line utility or the XSQLRequest programmatic API, then it does nothing.

Usage Notes

If you use the SQL statement option, then a single row is fetched from the result set and the parameter is assigned the value of the first column. This use requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

If you need to set several cookie values based on the results of a single SQL statement, then do not use the name attribute. Instead, you can use the names attribute and supply a space-or-comma-delimited list of one or more cookie names.

Syntax

The syntax for this action is as follows, where paramname is the name of a parameter:

<xsql:set-cookie name="paramname" value="value"/>

Alternatively, you can use the following syntax, where SQL_statement is a SQL SELECT statement and paramname is the name of a parameter:

<xsql:set-cookie name="paramname">
  SQL_statement
</xsql:set-cookie>

Either the name or the names attribute is required. The value attribute and the contained SQL statement are mutually exclusive. The number of columns in the select list must match the number of cookies being set or an error message results.

Attributes

Table 30-12 lists the attributes supported by this action. Attributes in bold are required; all others are optional.

Table 30-12 Attributes for <xsql:set-cookie>

Attribute Name
Description

name = "string"

Name of the cookie whose value you want to set. You must use name or names but not both.

names = "string string ..."

Space-or-comma-delimited list of the cookie names whose values you want to set. You must use name or names but not both.

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. Values are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

domain = "string"

Domain in which cookie value is valid and readable. If domain is not set explicitly, it defaults to the fully-qualified host name (for example, server.biz.com) of the document creating the cookie.

error-param = "string"

Name of a page-private parameter that is set to the string 'Error' if a non-fatal error occurs while processing this action. Valid value is any parameter name.

ignore-empty-value = "boolean"

Indicates whether the cookie assignment is ignored if the value to which it is being assigned is an empty string.Valid values are yes and no (default).

immediate = "boolean"

Indicates whether the cookie assignment is immediately visible to the current page. Typically, cookies set in the current request are not visible until the browser sends them back to the server in a subsequent request.Valid values are yes and no (default).

max-age = "integer"

Sets the maximum age of the cookie in seconds. Default is to set the cookie to expire when users current browser session terminates.

only-if-unset = "boolean"

Indicates whether the cookie assignment only occurs when the cookie currently does not exists.Valid values are yes and no (default).

path = "string"

Relative URL path within domain in which cookie value is valid and readable. If path is not set explicitly, then it defaults to the URL path of the document creating the cookie.

value = "string"

Sets the value to assign to the cookie.

Examples

Example 30-25 sets the HTTP cookie to the value of the parameter named choice.

Example 30-25 Setting a Cookie to a Parameter Value

<?xml version="1.0"?>
<xsql:set-cookie name="last_selection"
                 value="{@choice}" xmlns:xsql="urn:oracle-xsql"/>

Example 30-3 sets the HTTP cookie to a value selected from the database.

Example 30-26 Setting a Cookie to a Database-Generated Value

<?xml version="1.0"?>
<xsql:set-cookie name="shopping_cart_id" bind-params="user"
                 connection="demo"       xmlns:xsql="urn:oracle-xsql">
 SELECT cartmgr.new_cart_id(UPPER(?)) FROM DUAL
</xsql:set-cookie>

Example 30-4 sets three cookies based on the result of a single SELECT statement.

Example 30-27 Setting Three Cookies

<?xml version="1.0"?>
<xsql:set-cookie names="paramname1 paramname2 paramname3"
                 connection="demo" xmlns:xsql="urn:oracle-xsql">
  SELECT expression_or_column1, expression_or_column2, expression_or_column3
  FROM table
  WHERE clause_identifying_a_single_row
</xsql:set-cookie>

<xsql:set-page-param>

Purpose

Sets a page-private parameter to a value. The value can be supplied by a combination of static text and other parameter values, or alternatively from the result of a SQL SELECT statement.

Usage Notes

If you use the SQL statement option, then the program fetches a single row from the result set and assigns the parameter the value of the first column. This usage requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

As an alternative to providing the value attribute, or a SQL statement, you can supply the xpath attribute to set the page-level parameter to the value of an XPath expression. The XPath expression is evaluated against an XML document or HTML form that has been posted to the XSQL pages processor. The value of the xpath attribute can be any valid XPath expression, optionally built using XSQL parameters as part of the attribute value like any other XSQL action element.

After a page-private parameter is set, subsequent action handlers can use this value as a lexical parameter, for example {@po_id}. Alternatively, action handlers can use this value as a SQL bind parameter value; they can reference its name in the bind-params attribute of any action handler that supports SQL operations.

If you need to set multiple session parameter values based on the results of a single SQL statement, instead of using the name attribute, then you can use the names attribute. You can supply a list, delimited by spaces or commas, of one or more session parameter names.

Syntax

The syntax for this action is as follows, where paramname is the name of a parameter and value is a value:

<xsql:set-page-param name="paramname" value="value"/>

Alternatively, you can use the following syntax, where SQL_statement is a SQL SELECT statement and paramname is the name of a parameter:

<xsql:set-page-param nname="paramname">
  SQL_statement
</xsql:set-page-param>

Alternatively, you can use the following syntax, where paramname is the name of a parameter and where expression is an XPath expression:

<xsql:set-page-param name="paramname" xpath="expression"/>

Either the name or the names attribute is required. The value attribute and the contained SQL statement are mutually exclusive.

Attributes

Table 30-13 lists the attributes supported by this action. Attributes in bold are required; all others are optional.

Table 30-13 Attributes for <xsql:set-page-param>

Attribute Name
Description

name = "string"

Name of the page-private parameter whose value you want to set.

names = "string string ..."

Space-or-comma-delimited list of the page parameter names whose values you want to set. Either use the name or the names attribute, but not both.

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. The values of these parameters are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

error-param = "string"

Name of a page-private parameter that must be set to the string 'Error' if a non-fatal error occurs while processing this action. Valid value is any parameter name.

ignore-empty-value = "boolean"

Indicates whether the page-level parameter assignment is ignored if the value to which it is being assigned is an empty string.Valid values are yes and no (default).

quote-array-values = "boolean"

If the parameter name is a simple-valued parameter name (for example, myparam) and if treat-list-as-array="yes" is specified, then specifying quote-array-values="yes" will surround each string token with single quotes before separating the values with commas. Valid values are yes and no (default).

treat-list-as-array = "boolean"

Indicates whether the string-value assigned to the parameter is tokenized into an array of separate values before assignment. If any comma is present in the string, then the comma is used for separating tokens. Otherwise, spaces are used.Valid values are yes and no. The default value is yes if the parameter name being set is an array parameter name (for example, myparam[]), and default is no if the parameter name being set is a simple-valued parameter name like myparam.

value = "string"

Sets the value to assign to the parameter.

xpath = "XPathExpression"

Sets the value of the parameter to an XPath expression evaluated against an XML document or HTML form that has been posted to the XSQL pages processor.

Examples

Example 30-28 sets multiple parameter values based on the results of a single SQL statement.

Example 30-28 Setting Multiple Page Parameters

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<xsql:set-page-param names="paramname1 paramname2 paramname3"
                     connection="demo" xmlns:xsql="urn:oracle-xsql>
  SELECT expression_or_column1, expression_or_column2, expression_or_column3
  FROM table
  WHERE clause_identifying_a_single_row
</xsql:set-page-param>

Example 30-29 sets the page-level parameter to a value selected from database and then uses it as the value of an xsql:query attribute.

Example 30-29 Setting a Parameter to a Database-Generated Value

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:set-page-param name="max-rows-pref">
     SELECT max_rows
     FROM user_profile
     WHERE userid = {@userid}
  </xsql:set-page-param>
  <xsql:query max-rows="{@max-rows-pref}">
    SELECT title, url
    FROM newsstory
    ORDER BY date_entered DESC
  </xsql:query>
</page>

<xsql:set-session-param>

Purpose

Sets an HTTP session-level parameter to a value. The value of the session-level parameter remains for the lifetime HTTP session of the current browser user. The session is controlled by the Web server. The value can be supplied by a combination of static text and other parameter values or from the result of a SQL SELECT statement.

Because this feature is specific to Java servlets, this action is only effective if the XSQL page in which it appears is processed by the XSQL servlet. If this action occurs in an XSQL page processed by the XSQL command-line utility or the XSQLRequest programmatic API, then it does nothing.

Usage Notes

If you use the SQL statement option, the XSQL processor fetches a single row from the result set and assigns the parameter the value of the first column. This use requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

To set several session parameter values based on the results of a single SQL statement, do not use the name attribute. Instead, use the names attribute and supply a space-or-comma-delimited list of one or more session parameter names.

Syntax

The syntax for this action is as follows, where paramname is the name of a parameter and where value is a value:

<xsql:set-session-param name="paramname" value="value"/>

Alternatively, you can use the following syntax, where SQL_statement is a SQL SELECT statement and paramname is the name of a parameter:

<xsql:set-session-param name="paramname">
  SQL_statement
</xsql:set-session-param>

Either the name or the names attribute is required. The value attribute and the contained SQL statement are mutually exclusive.

Attributes

Table 30-14 lists the optional attributes supported by this action. Attributes in bold are required; all others are optional.

Table 30-14 Attributes for <xsql:set-session-param>

Attribute Name
Description

name = "string"

Name of the session-level variable whose value you want to set. Either use the name or the names attribute, but not both.

names = "string string ..."

Space-or-comma-delimited list of the session parameter names whose values you want to set. Either use the name or the names attribute, but not both.

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. The parameter values are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

error-param = "string"

Name of a page-private parameter that is set to the string 'Error' if a non-fatal error occurs while processing this action. Valid value is any parameter name.

ignore-empty-value = "boolean"

Indicates whether the session-level parameter assignment is ignored if the value to which it is being assigned is an empty string. Valid values are yes and no (default).

only-if-unset = "boolean"

Indicates whether the session variable assignment only occurs when the session variable currently does not exists.Valid values are yes and no (default).

quote-array-values = "boolean"

If the parameter name is a simple-valued parameter name (for example, myparam) and if treat-list-as-array="yes" is specified, then specifying quote-array-values="yes" surrounds each string token with single quotes before separating the values with commas. Valid values are yes and no (default).

treat-list-as-array = "boolean"

Indicates whether the string-value assigned to the parameter is tokenized into an array of separate values before assignment. If any comma is present in the string, then the comma is used for separating tokens. Otherwise, spaces are used.Valid values are yes and no. The default value is yes if the parameter name being set is an array parameter name (for example, myparam[]), and default is no if the parameter name being set is a simple-valued parameter name like myparam.

value = "string"

Sets the value to assign to the parameter.

Examples

Example 30-30 sets multiple session parameter values based on the results of a single SELECT statement.

Example 30-30 Setting Session Parameters

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<page connection="demo" xmlns:xsql="urn:oracle-xsql">
  <xsql:set-session-param names="paramname1 paramname2 paramname3">
    SELECT expression_or_column1, expression_or_column2, expression_or_column3
    FROM   table
    WHERE  clause_identifying_a_single_row
  </xsql:set-session-param>
  <!-- ... -->
</page>

<xsql:set-stylesheet-param>

Purpose

Sets a top-level XSLT stylesheet parameter to a value. The value can be supplied by a combination of static text and other parameter values, or from the result of a SQL SELECT statement. The stylesheet parameter will be set on any stylesheet used during the processing of the current page.

Usage Notes

If you use the SQL statement option, then a single row is fetched from the result set and the parameter is assigned the value of the first column. This use requires a database connection to be provided by supplying a connection="connname" attribute on the document element of the XSQL page in which it appears.

To set several stylesheet parameter values based on the results of a single SQL statement, do not use the name attribute. You can use the names attribute and supply a space-or-comma-delimited list of one or more stylesheet parameter names.

Syntax

The syntax for this action is as follows, where paramname is the name of a parameter and where value is a value:

<xsql:set-stylesheet-param name="paramname" value="value"/>

Alternatively, you can use the following syntax, where SQL_statement is a SQL SELECT statement and paramname is the name of a parameter:

<xsql:set-stylesheet-param name="paramname">
  SQL_statement
</xsql:set-stylesheet-param>

Either the name or the names attribute is required. The value attribute and the contained SQL statement are mutually exclusive.

Attributes

Table 30-15 lists the optional attributes supported by this action. Attributes in bold are required; all others are optional.

Table 30-15 Attributes for <xsql:set-stylesheet-param>

Attribute Name
Description

name = "string"

Name of the top-level stylesheet parameter whose value you want to set.

names = "string string ..."

Space-or-comma-delimited list of the top-level stylesheet parameter names whose values you want to set. Use the name or the names attribute, but not both.

bind-params = "string"

Ordered, space-delimited list of one or more XSQL parameter names. Parameter values are used to bind to the JDBC bind variable in the appropriate sequential position in the SQL statement.

error-param = "string"

Name of a page-private parameter that has to be set to the string 'Error' if a non-fatal error occurs while processing this action. Valid value is any parameter name.

ignore-empty-value = "boolean"

Indicates whether the stylesheet parameter assignment is to be ignored if the value to which it is being assigned is an empty string. Valid values are yes and no (default).

value = "string"

Sets the value to assign to the parameter.

Examples

Example 30-31 associate a stylesheet and uses the <xsql:set-stylesheet-param> action element to assign the value of the XSQL page parameter named p_table to the XSLT top-level stylesheet parameter named table.

Example 30-31 Setting a Stylesheet Parameter

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<page connname="xmlbook" connection="{@p_connname}">
  <xsql:query null-indicator="yes" xmlns:xsql="urn:oracle-xsql">
  <![CDATA[
    SELECT *
    FROM {@p_table}
    WHERE rownum < 2
  ]]>
  </xsql:query>
  <xsql:set-stylesheet-param name="table" value="{@p_table}"
                             xmlns:xsql="urn:oracle-xsql" />
</page>

<xsql:update-request>

Purpose

Accepts data posted from an XML document or HTML form and uses the XML SQL Utility (XSU) to update the content of an XML document in canonical form from a target table or view.

By combining XSU with XSLT, you can transform XML into the canonical format expected by a given table. Afterward, you can use XSU to update the resulting canonical XML. For a specified database table, the canonical XML form is given by one row of XML output from a SELECT * query against the table.

Syntax

The syntax for this action is as follows:

<xsql:update-request table="table_name"/>

Attributes

Table 30-3 lists the attributes that you can use on the <xsql:update-request> action. Required attributes are in bold.

Table 30-16 Attributes for <xsql:update-request>

Attribute Name
Description

table = "string"

Name of the table, view, or synonym to use for updating the XML data.

key_columns = "string string ..."

Space-delimited or comma-delimited list of one or more column names. The processor uses the values of these names in the posted XML document to identify the existing rows to update.

transform = "URL"

Relative or absolute URL of the XSLT transformation to use to transform the document to be updated into canonical ROWSET/ROW format.

columns = "string"

Relative or absolute URL of the XSLT transformation to use to transform the document to be updated into canonical ROWSET/ROW format.

commit = "boolean"

If set to yes (default), calls COMMIT on the current connection after a successful execution of the update. Valid values are yes and no.

commit-batch-size = "integer"

If a positive, nonzero integer is specified, then after each batch of integer updated records, the processor issues a COMMIT. The default batch size is zero (0) if not specified, which means that the processor does not commit interim batches.

date-format = "string"

Date format mask to use for interpreting date field values in XML being updated. Valid values are those for the java.text.SimpleDateFormat class.

error-param = "string"

Name of a page-private parameter that must be set to Error if a nonfatal error occurs while processing this action. Valid value is any parameter name.

Examples

Example 30-32 parses and transforms the contents of the posted XML document or HTML Form for update.

Example 30-32 Updating XML Received in a Parameter

<?xml version="1.0"?>
<xsql:update-request table="purchase_order"   key-columns="department_id"
                     connection="demo"        transform="doc-to-departments.xsl"
 xmlns:xsql="urn:oracle-xsql/>

31 XDK Standards

This appendix contains the following topics:

XML Standards Supported by the XDK

Character Sets Supported by the XDK

XML Standards Supported by the XDK

This section contains the following topics:

Summary of XML Standards Supported by the XDK

XML Standards for the XDK for Java

Summary of XML Standards Supported by the XDK

Table 31-1 summarizes the standards supported by the XDK Components.

Table 31-1 Summary of XML Standards Supported by the XDK

Standard
Java
C
C++
Specification URL

DOM 1.0

Full

Full

Full

http://www.w3.org/TR/DOM-Level-1

DOM 2.0 Core

Full

Full

Full

http://www.w3.org/TR/DOM-Level-2-Core

DOM 2.0 Events

Full

Full

Full

http://www.w3.org/TR/DOM-Level-2-Events

DOM 2.0 Transversal and Range

Full

Full

Full

http://www.w3.org/TR/DOM-Level-2-Traversal-Range

DOM 3.0 Load and Save

PartialFoot 1 

None

None

http://www.w3.org/TR/2003/CR-DOM-Level-3-LS-20031107

DOM 3.0 Validation

FullFoot 2 

None

None

http://www.w3.org/TR/2003/CR-DOM-Level-3-Val-20030730

JAXP 1.1 (JSR Standard)

Full

N/A

N/A

http://java.sun.com/xml/downloads/jaxp.html

JAXP 1.2 (JSR Standard)

Full

N/A

N/A

http://java.sun.com/xml/downloads/jaxp.html

SAX 1.0

Full

Full

Full

http://www.saxproject.org

SAX 2.0 Core

Full

Full

Full

http://www.saxproject.org

SAX 2.0 Extension

Full

Full

Full

http://www.saxproject.org

XML 1.0 (Second Edition)

Full

Full

Full

http://www.w3.org/TR/REC-xml

XML Base

Only in XSLT

None

None

http://www.w3.org/TR/xmlbase

XML Namespaces 1.0

Full

Full

Full

http://www.w3.org/TR/REC-xml-names

XML Pipeline Definition Language 1.0 (Note)

PartialFoot 3 

None

None

http://www.w3.org/TR/xml-pipeline

XML Schema language 1.0

Full

FullFoot 4 

FullFootref 4

http://www.w3.org/TR/xmlschema-0

XPath 1.0

Full

Full

Full

http://www.w3.org/TR/xpath

XPath 2.0 Language (working draft dated 04 April 2005)

Full

None

None

http://www.w3.org/TR/2005/WD-xpath20-20050404

XPath 2.0 Data Model (working draft dated 04 April 2005)

Full

None

None

http://www.w3.org/TR/2005/WD-xpath-datamodel-20050404/

XQuery 1.0 and XPath 2.0 Functions and Operators (working draft dated 04 April 2005)

Full

None

None

http://www.w3.org/TR/2005/WD-xpath-functions-20050404

XSLT 1.0

Full

Full

Full

http://www.w3.org/TR/xslt

XSLT 2.0 (working draft dated 04 April 2005)

PartialFoot 5 

None

None

http://www.w3.org/TR/2005/WD-xslt20-20050404/

Footnote 1 "DOM Level 3 Load and Save" describes the relationship between DOM 3.0 Core and Load and Save.

Footnote 2 "DOM 3.0 Validation" describes the relationship between DOM 3.0 Core and Validation.

Footnote 3 "Pipeline Definition Language Standard for the XDK for Java" describes the parts of the standard that are not supported.

Footnote 4 The Schema processor fully supports the functionality stated in the specification plus "XML Schema 1.0 Specification Errata" as published on http://www.w3.org/2001/05/xmlschema-errata.

Footnote 5 "XSLT Standard for the XDK for Java" describes the parts of the XSLT standard that are not supported.

XML Standards for the XDK for Java

This section contains the following topics:

DOM Standard for the XDK for Java

XSLT Standard for the XDK for Java

JAXB Standard for the XDK for Java

Pipeline Definition Language Standard for the XDK for Java

DOM Standard for the XDK for Java

Note:

In Oracle Database 10g Release 2, the Java XDK implements the candidate recommendation versions of DOM Level 3.0 Load and Save and Validation specifications. Oracle plans to produce a release or patch set that will include an implementation of DOM Level 3.0 Load and Save and Validation recommendations. In order to conform to the recommendations, Oracle may be forced to make changes that are not backward compatible. During this period Oracle does not guarantee backward compatibility with respect to our DOM Load and Save, and Validation implementation. After the Java XDK is updated to conform to the recommendations, standard Oracle policies with respect to backwards compatibility will apply to the Oracle DOM Load and Save, and Validation implementation.

The DOM APIs include support for candidate recommendations of DOM Level 3 Validation and DOM Level 3 Load and Save.

DOM Level 3 Load and Save

The DOM Level 3 Load and Save module enables software developers to load and save XML content inside conforming products. The DOM 3.0 Core interface DOMConfiguration is referred by DOM 3 Load and Save. Although DOM 3.0 Core is not supported, a limited implementation of this interface is available.

The charset-overrides-xml-encoding configuration parameter is not supported by LSParser. Optional settings of the following configuration parameters are not supported by LSParser:

disallow-doctype (true)

ignore-unknown-character-denormalizations (false)

namespaces (false)

supported-media-types-only (true)

The discard-default-content configuration parameter is not supported by LSSerializer. Optional settings of the following configuration parameters are not supported by LSSerializer:

canonical-form (true)

format-pretty-print (true)

ignore-unknown-character-denormalizations (false)

normalize-characters (true)

DOM 3.0 Validation

DOM 3.0 validation allows users to retrieve the metadata definitions from XML schemas, query the validity of DOM operations and validate the DOM documents or sub-trees against the XML schema.

Some DOM 3 Core functions referred by Validation are implemented, but Core itself is not supported. Specifically, NameList and DOMStringList in DOM Core are supported for validation purposes. Because validation is based on an XML schema, you need to convert a DTD to an XML schema before using these functions.

XSLT Standard for the XDK for Java

The XSLT processor adds support for the current working drafts of XSLT 2.0, XPath 2.0, and the shared XPath/XQuery data model.

Note:

At the time of release of Oracle Database 10g Release 2 the W3C XSLT and XPath working group had not yet published the XSLT 2.0 and XPath 2.0 recommendations. Oracle will continue to track the evolution of the XSLT 2.0 and XPath 2.0 specifications, until such time as they become recommendations. During this period, in order to follow the evolution of the XSLT 2.0 and XPath 2.0 specifications, Oracle may be forced to release updates to the XSLT 2.0 and XPath 2.0 implementation which are not backwards compatible with previous releases or patch sets. During this period Oracle does not guarantee any backward compatibility between database releases or patch sets with respect to our XSLT 2.0 and XPath 2.0 implementation. After the XSLT 2.0 and XPath 2.0 specifications become recommendations, Oracle will produce a release or patch set that includes an implementation of the XSLT 2.0 and XPath 2.0 recommendations. From that point on, standard Oracle policies with respect to backwards compatibility will apply to the Oracle XSLT 2.0 and XPath 2.0 implementation. See http://www.w3.org for the latest information on the status of XSLT 2.0 and XPath 2.0 specifications.

Some features of these specifications are not supported in the current release:

The Schema Import and Static Typing features are not supported, but we do support XML Schema built-in types specified by the XPath 2.0 Datamodel.

The schema-element and schema-attribute nodetests are not supported.

The XSLT instruction xsl:number uses XSLT 1.0 semantics and syntax.

The use-when standard attribute is not supported.

The processor does not honor the attribute of required on xsl:param.

Tunnel parameters are not supported.

Regular expression instructions are not supported in XSLT.

The XPath 2.0 functions fn:tokenize, fn:matches, and fn:replace are not supported.

format-dateTime, format-date, and format-time functions are not supported.

The content model for xsl:attribute, xsl:comment, xsl:message and the way to compute key values of xsl:key and xsl:sort are still 1.0 behavior.

attribute [xsl:]inherit-namespaces for xsl:copy, xsl:element, and literal result elements is not supported.

Updates to the W3C specifications for XPath 2.0 and XSLT 2.0 resulted in certain differences in behavior from 10g Release 1. For 10g Release 1 compatible behavior set the system property oracle.xdkjava.compatibility.version=10.1.0.

XPath 2.0 - Differences between 10g Release 1 and 10g Release 2

1. RangeExpr, behavior for (m to n), where m > n changed. Earlier we treated it as (n to m), reverse sequence. As described in the April 2005 draft, we return an empty sequence.

2. isnot operator was removed as per the Apr 2005 draft.

3. getEffectiveBooleanValue definition (fn:boolean) updated as described in the April 2005 draft. Empty string value will result in exception (FORG006) instead of returning false. All cases not handled by getEffectiveBooleanValue will result in an exception (FORG006). XPath 1.0 behavior for fn:boolean will remain the same.

XSLT 2.0 - Difference between 10g Release 1 and 10g Release 2

normalize-unicode has been changed to normalization-form, the allowed attribute values have been changed from "yes" | "no" to "NFC" | "NFD" | "NKFC" | "NKFD" | \x{2026}\x{2026} as described in the Nov. 2004 draft.

JAXB Standard for the XDK for Java

The Oracle Database XDK implementation of the JAXB specification does not support the following features:

Javadoc generation

XML Schema component "any" and substitution groups

Pipeline Definition Language Standard for the XDK for Java

The XML Pipeline processor differs from the W3C Note as follows:

The parser processes DOMParserProcess and SAXParserProcess are included in the XML pipeline (Section 1).

Only the final target output is checked to see if it is up-to-date with respect to the available pipeline inputs. The XML Pipeline processor does not determine whether the intermediate outputs of every process are up-to-date (Section 2.2).

For the select attribute, anything in between double-quotes ("...") is considered to be a string literal.

The XML Pipeline processor throws an error if more that one process produces the same infoset (Section 2.4.2.3).

The <document> element is not supported (Section 2.4.2.8).

Character Sets Supported by the XDK

This section contains the following topics:

Character Sets Supported by the XDK for Java

Character Sets Supported by the XDK for C

Character Sets Supported by the XDK for Java

XML Schema processor for Java supports documents in the following encodings:

BIG

EBCDIC-CP-*

EUC-JP

EUC-KR

GB2312

ISO-2022-JP

ISO-2022-KR

ISO-8859-1to -9

ISO-10646-UCS-2

ISO-10646-UCS-4

KOI8-R

Shift_JIS

US-ASCII

UTF-8

UTF-16

Character Sets Supported by the XDK for C

The XDK parser for C supports over 300 IANA character sets. These character sets include the following:

UTF-8

UTF-16

UTF16-BE

UTF16-LE

US-ASCII

ISO-10646-UCS-2

ISO-8859-{1-9, 13-15}

EUC-JP

SHIFT_JIS

BIG5

GB2312

GB_2312-80

HZ-GB-2312

KOI8-R

KSC5601

EUC-KR

ISO-2022-CN

ISO-2022-JP

ISO-2022-KR

WINDOWS-{1250-1258}

EBCDIC-CP-{US,CA,NL,WT,DK,NO,FI,SE,IT,ES,GB,FR,HE,BE,CH,ROECE,YU,IS,AR}

IBM{037, 273, 277, 278, 280, 284, 285, 297, 420, 424, 437, 500, 775, 850, 852, 855, 857, 858, 860, 861, 863, 865, 866, 869, 870, 871, 1026, 01140, 01141, 01142, 01143, 01144, 01145, 01146, 01147,01148}

You can use any alias of the preceding character sets. In addition, you can use any character set specified in Appendix A, Character Sets, of the Oracle Database Globalization Support Guide with the exception of IW7IS960.

A Oracle XDK for Java XML Error Messages

This appendix lists XML error messages that may be encountered in applications that use Oracle XDK for Java.

See Also:

http://www.w3.org/TR/xquery/#id-errors for the XQuery error messages

XML Error Messages

These error messages may occur during the execution of XML interfaces.

XML Parser Error Messages

DOM Error Messages

XSL Transformation Error Messages

XPath Error Messages

XML Schema Validation Error Messages

Schema Representation Constraint Error Messages

Schema Component Constraint Error Messages

XSQL Server Pages Error Messages

XML Pipeline Error Messages

Java API for XML Binding (JAXB) Error Messages

XML Parser Error Messages

These error messages are in the range XML-20000 through XML-20999.

XML-20003: missing token string at line string, column string

An expected token was not found in the input data.

Action: Check/update the input data to fix the syntax error.

XML-20004: missing keyword string at line string, column string

Cause: An expected keyword was not found in the input data.

Action: Check/update the input data to the correct keyword.

XML-20005: missing keyword string or string at line string, column string

Cause: An expected keyword was not found in the input data.

Action: Check/update the input data to the correct keyword.

XML-20006: unexpected text at line string, column string; expected EOF

Cause: More text was found after the end-tag of the root element.

Action: The end-tag of the root element can be followed only by comments, PI, or white space. Remove the extra text after the end-tag.

XML-20007: missing content model in element declaration at line string, column string

Cause: The element declaration was missing the required content model spec See Production [45] in XML 1.0 2nd Edition.

Action: Add the required content spec to the element declaration.

XML-20008: missing element name in content model at line string, column string

Cause: The content model in the element declaration was invalid, the content particle requires an element name. See Production [48] in XML 1.0 2nd Edition.

Action: Add the element name to fix the content spec syntactically.

XML-20009: target name string of processing instruction at line string, column string is reserved

Cause: The target names "XML: xml", and so on are reserved for standardization in future versions of XML specification. See Production [17] in XML 1.0 2nd Edition.

Action: If the PI is meant to be XML declaration, make sure the declaration occurs at the very beginning of the file. Otherwise, change to name of the PI.

XML-20010: missing notation name in unparsed entity declaration at line string, column string

Cause: The notation name used in the unparsed entity declaration did not match the name in a declared notation. See Production [76] in XML 1.0 2nd Edition.

Action: Add the notation declaration to the DTD.

XML-20011: missing attribute type in attribute-list declaration at line string, column string

Cause: The attribute type was missing the attribute-list declaration. One of the following types CDATA, ID, IDREF, IDREFS, ENTITY, ENTITIES, NMTOKEN, or NMTOKENS must be added. See Production [52], [53] in XML 1.0 2nd Edition.

Action: Check and correct attribute declaration.

XML-20012: missing white space at line string, column string

Cause: The required white space was missing.

Action: Add white space to fix the syntax error.

XML-20013: invalid character string in entity value at line string, column string

Cause: An invalid character was used in the entity value, the characters'&', '%' and (" or ' based on the value delimiters) are invalidSee Production [9] in XML 1.0 2nd Edition.

Action: Use entity or character references instead of the characters For example, &amp; or &#38; can be used instead of '&'

XML-20014: -- not allowed in comment at line string, column string

Cause: A syntax error in comment due to the use of "--"See Production [15] in XML 1.0 2nd Edition.

Action: Fix the comment, and use "--" only as part of end of comment "-->"

XML-20015: ]]> not allowed in text at line string, column string

Cause: "]]>" is not allowed in text, it is used only as end marker forCDATA Section. See Production [14] in XML 1.0 2nd Edition.

Action: Fix the text content by using &gt; or char ref for '>'

XML-20016: white space not allowed before occurrence indicator at line string, column string

Cause: White space is not allowed in the contentspec before the occurrenceindicator. For example, <!ELEMENT x (a,b) *> is not valid. See Production [47], [48] in XML 1.0 2nd Edition.

Action: Fix the contentspec by removing the extra space

XML-20017: occurrence indicator string not allowed in mixed-content at line string, column string

Cause: Occurrence is not allowed in mixed content declaration.For example, <!ELEMENT x (#PCDATA)?> is not valid. See Production [51] in XML 1.0 2nd Edition.

Action: Fix the syntax to remove the occurrence indicator.

XML-20018: content list not allowed inside mixed-content at line string, column string

Cause: Content list is not allowed in mixed-content declaration. For example, <!ELEMENT x (#PCDATA | (a,b))> is not valid.See Production [51] in XML 1.0 2nd Edition.

Action: Fix the syntax to remove the content list.

XML-20019: duplicate element string in mixed-content declaration at line string, column string

Cause: Duplicate element name was found in mixed-content declaration. For example, <!ELEMENT x (#PCDATA | a | a)> is not valid. See Production [51] in XML 1.0 2nd Edition.

Action: Remove the duplicate element name.

XML-20020: root element string does not match the DOCTYPE name string at line string, column string

Cause: failed: The Name in the document type declaration must match the element type of the root element. For example: <?xml version="1.0"?> <!DOCTYPE greeting [ <!ELEMENT greeting (#PCDATA)> ]> <salutation>Hello!</salutation> The document's root element, salutation, does not match the root element declared in the DTD (greeting).

Action: Correct the document.

XML-20021: duplicate element declaration string at line string, column string

Cause: Element was declared twice in the DTD.

Action: Remove the duplicate declaration.

XML-20022: element string has multiple ID attributes at line string, column string

Cause: failed: No element type may have more than one ID attribute specified.

Action: Correct the document, by removing the duplicate ID attribute decl

XML-20023: ID attribute string in element string must be #IMPLIED or #REQUIRED at line string, column string

Cause: failed: An ID attribute must have a declared default of #IMPLIED or #REQUIRED.

Action: Fix the attribute declaration.

XML-20024: missing required attribute string in element string at line string, column string

Cause: failed: If the default declaration is the keyword #REQUIRED, then the attribute must be specified for all elements of the type in the attribute-list declaration.

Action: Fix the input document by specifying the required attribute.

XML-20025: duplicate ID value: string

Cause: Values of type ID must match the Name production. A name must not appear more than once in an XML document as a value of this type; i.e., ID values must uniquely identify the elements which bear them.

Action: Fix the input document by removing the duplicate ID value.

XML-20026: undefined ID value string in IDREF

Cause: failed "Values of type IDREF must match value of some ID attribute.

Action: Fix the document by adding an ID corresponding the to the IDREF, or removing the IDREF

XML-20027: attribute string in element string has invalid enumeration value string at line string, column string

Cause: failed: Values of this type must match one of the Nmtoken tokens in the declaration.

Action: Fix the attribute value to match one of the enumerated values.

XML-20028: attribute string in element string has invalid value string, must be string at line string, column {5}

Cause: failed: If an attribute has a default value declared with the #FIXED keyword, instances of that attribute must match the default value.

Action: Update the attribute value to match the fixed default value.

XML-20029: attribute default must be REQUIRED, IMPLIED, or FIXED at line string, column string

Cause: The declared default value must meet the lexical constraints o the declared attribute type.

Action: Use one of REQUIRED, IMPLIED, or FIXED for attribute default decl.

XML-20030: invalid text in content of element string at line string, column string

Cause: The element does not allow text in content. An element is valid if there is a declaration matching element decl where the Name matches the element type, and one of the following holds:

The declaration matches children and the sequence of child elements belongs to the language generated by the regular expression in the content model, with optional white space (characters matching the nonterminal S) between the start-tag and the first child element, between child elements, or between the last child element and the end-tag. Note that a CDATA section containing only white space does not match the nonterminal S, and hence cannot appear in these positions.

Action: Fix the content by removing unexpected text.

XML-20031: invalid element string in content of element string at line string, column string

Cause: The element has invalid content. An element is valid if there is a declaration matching element decl where the Name matches the element type, and one of the following holds:

1. The declaration matches children and the sequence of child elements belongs to the language generated by the regular expression in the content model, with optional white space (characters matching the nonterminal S) between the start-tag and the first child element, between child elements, or between the last child element and the end-tag. Note that a CDATA section containing only white space does not match the non-terminal S, and hence cannot appear in these positions.

2. The declaration matches Mixed and the content consists of character data and child elements whose types match names in the content model.

Action: Fix the content by removing unexpected elements.

XML-20032: incomplete content in element string at line string, column string

Cause: The element has invalid content. An element is valid if there is a declaration matching elementdecl where the Name matches the element type, and one of the following holds:

1. The declaration matches children and the sequence of child elements belongs to the language generated by the regular expression in the content model, with optional white space (characters matching the non-terminal S) between the start-tag and the first child element, between child elements, or between the last child element and the end-tag. Note that a CDATA section containing only white space does not match the nonterminal S, and hence cannot appear in these positions.

2. The declaration matches Mixed and the content consists of character data and child elements whose types match names in the content model.

Action: Fix the content by removing unexpected elements.

XML-20033: invalid replacement-text for entity string at line string, column string

Cause: Parameter-entity replacement text must be properly nested with markup declarations. That is to say, if either the first character or the last character of a markup declaration (markup decl above) is contained in the replacement text for a parameter-entity reference, both must be contained in the same replacement text.

Action: Fix the entity value.

XML-20034: end-element tag string does not match start-element tag string at line string, column string

Cause: The Name in an element's end-tag must match the element type in the start-tag.

Action: Fix the end-tag or start-tag to match the other.

XML-20035: duplicate attribute string in element string at line string, column string

Cause: No attribute name may appear more than once in the same start-tag o rempty-element tag.

Action: Remove the duplicate attribute.

XML-20036: invalid character string in attribute value at line string, column string

Cause: An invalid character was used in the attribute value, the characters'&', '<' and (" or ' based on the value delimiters) are invalid. See Production [10] in XML 1.0 2nd Edition.

Action: Use entity or character references instead of the characters For example, &amp; or &#38; can be used instead of '&'

XML-20037: invalid reference to external entity string in attribute string at line string, column string

Cause: Attribute values cannot contain direct or indirect entity references to external entities.

Action: Fix document to remove reference to external entity in attribute.

XML-20038: invalid reference to unparsed entity string in element string at line string, column string

Cause: An entity reference must not contain the name of an unparsed entity.Unparsed entities may be referred to only in attribute values declared to be of type ENTITY or ENTITIES.

Action: Fix document to remove reference to unparsed entity in content.

XML-20039: invalid attribute type string in attribute-list declaration at line string, column string

Cause: Invalid attribute type was used in the attribute-list declaration. One of the following types CDATA, ID, IDREF, IDREFS, ENTITY, ENTITIES, NMTOKEN, or NMTOKENS must be added. See Production [52], [53] in XML 1.0 2nd Edition.

Action: Check and correct attribute declaration.

XML-20040: invalid character string in element content at line string, column string

Cause: Characters referred to using character references must match the production for Char.

Action: Fix the document by removing the invalid character or char-ref.

XML-20041: entity reference string refers to itself at line string, column string

Cause: A parsed entity must not contain a recursive reference to itself, either directly or indirectly.

Action: Fix the document.

XML-20042: invalid Nmtoken: string

Cause: Values of this type must match one of the Nmtoken tokens in the declaration, and must be valid Nmtoken"

Action: Fix the attribute value.

XML-20043: invalid character string in public identifier at line string, column string

Cause: Invalid character used in public identifier. See Production [12], [13] in XML 1.0 2nd Edition.

Action: Fix the public identifier.

XML-20044: undeclared namespace prefix string used at line string, column string

Cause: The prefix was not defined in any namespace declaration in scope.

Action: Add a namespace declaration to define the prefix.

XML-20045: attribute string in element string must be an unparsed entity at line string, column string

Cause: Values of type ENTITY must match the Name production, values of type ENTITIES must match Names; each Name must match the name of an unparsed entity declared in the DTD.

Action: Fix the attribute value to refer to an unparsed entity.

XML-20046: undeclared notation string used in unparsed entity string at line string, column string

Cause: Values of this type must match one of the notation names included in the declaration; all notation names in the declaration must be declared.

Action: Fix the notation name in the unparsed entity declaration.

XML-20047: missing element declaration string

Cause: The element declaration referred to by an attribute declaration was not found in the DTD.

Action: Fix the DTD by adding the element declaration.

XML-20048: duplicate entity declaration string at line string, column string

Cause: Warning regarding duplicate entity declaration.

Action: No action required.

XML-20049: invalid use of NDATA in parameter entity declaration at line string, column string

Cause: NDATA declaration was found in parameter entity declaration. It is allowed only in general unparsed entity declaration. See Production [72], [74] in XML 1.0 2nd Edition.

Action: Fix the entity declaration.

XML-20050: duplicate attribute declaration string at line string, column string

Cause: Warning regarding duplicate attribute declaration.

Action: No action required.

XML-20051: duplicate notation declaration string at line string, column string

Cause: Only one notation declaration can declare a given Name.

Action: Fix the document by removing the duplicate notation.

XML-20052: undeclared attribute string used at line string, column string

Cause: The attribute declaration was not found in the DTD.

Action: Fix the DTD by adding the attribute declaration.

XML-20053: undeclared element string used at line string, column string

Cause: The element declaration was not found in the DTD.

Action: Fix the DTD by adding the element declaration.

XML-20054: undeclared entity string used at line string, column string

Cause: The entity declaration was not found in the DTD.

Action: Fix the DTD by adding the element declaration.

XML-20055: invalid document returned by NodeFactory's createDocument

Cause: The document returned by createDocument function of NodeFactory was invalid, either it was null or instance of an unsupported class.

Action: Fix NodeFactory implementation to return an instance of XMLDocument or its subclass.

XML-20056: invalid SAX feature string

Cause: The SAX feature supplied was not a valid feature name.

Action: Refer to documentation for a valid list of features.

XML-20057: invalid value string passed for SAX feature string

Cause: The value supplied for the SAX feature was not valid.

Action: Refer to documentation for a valid list of features and their corresponding values.

XML-20058: invalid SAX property string

Cause: The SAX property supplied was not a valid property name.

Action: Refer to documentation for a valid list of properties.

XML-20059: invalid value passed for SAX property string

Cause: The value supplied for the SAX property was not valid.

Action: Refer to documentation for a valid list of properties and their corresponding values.

XML-20060: Error occurred while opening URL string

Cause: An error occurred while opening the supplied URL.

Action: Verify the URL, and take appropriate action to allow data to be read.

XML-20061: invalid byte stream string in UTF8 encoded data

Cause: The input data contained bytes that are not valid w.r.t to UTF8encoding scheme.

Action: Fix the input data.

XML-20062: 5-byte UTF8 encoding not supported

Cause: The XML Parser does not support 5-byte UTF8 encoding scheme. It is also possible that invalid UTF8 characters were misinterpreted as5-byte UTF8 encoding.

Action: If the data contains invalid UTF8 bytes, fix the input, otherwise if 5-byte UTF8 supported is required, please contact Oracle Support.

XML-20063: 6-byte UTF8 encoding not supported

Cause: The XML Parser does not support 6-byte UTF8 encoding scheme. It is also possible that invalid UTF8 characters were misinterpreted as6-byte UTF8 encoding.

Action: If the data contains invalid UTF8 bytes, fix the input, otherwise if 6-byte UTF8 supported is required, please contact Oracle Support.

XML-20064: invalid XML character string

Cause: Invalid XML character was found in the input data.

Action: Fix the input data.

XML-20065: encoding string doesn't match encoding string in XML declaration

Cause: The encoding of the data (either by auto-detection or user supplied)didn't match the encoding specified in the XML declaration.

Action: Fix the XML declaration to match the encoding of the data.

XML-20066: encoding string not supported

Cause: The XML Parser does not support the specified encoding.

Action: If the support for the encoding is required, please contact Oracle Support.

XML-20067: invalid InputSource returned by EntityResolver's resolveEntity

Cause: An invalid instance of InputSource was returned by the EntityResolverAn InputSource can be invalid if the none of Reader, InputStream, andSystemId were initialized or if the SystemId was invalid.

Action: Fix the EntityResolver class to return a valid instance of InputSource

XML-20100: Expected string.

XML-20101: Expected string or string.

XML-20102: Expected string, string, or string.

XML-20103: Illegal token in content model.

XML-20104: Could not find element with ID string.

XML-20105: ENTITY type Attribute value string does not match any unparsed Entity.

XML-20106: Could not find Notation string.

XML-20107: Could not find declaration for element string.

XML-20108: Start of root element expected.

XML-20109: PI with the name 'xml' can occur only in the beginning of the document.

XML-20110: #PCDATA expected in mixed-content declaration.

XML-20111: Element string repeated in mixed-content declaration.

XML-20112: Error opening external DTD string.

XML-20113: Unable to open input source (string).

XML-20114: Bad conditional section start syntax, expected '['.

XML-20115: Expected ']]>' to end conditional section.

XML-20116: Entity string already defined, using the first definition.

XML-20117: NDATA not allowed in parameter entity declaration.

XML-20118: NDATA value required.

XML-20119: Entity Value should start with quote.

XML-20120: Entity value not well-formed.

XML-20121: End tag does not match start tag string.

XML-20122: '=' missing in attribute.

XML-20123: '>' Missing from end tag.

XML-20124: An attribute cannot appear more than once in the same start tag.

XML-20125: Attribute value should start with quote.

XML-20126: '<' cannot appear in attribute value.

XML-20127: Reference to an external entity not allowed in attribute value.

XML-20128: Reference to unparsed entity not allowed in element content.

XML-20129: Namespace prefix string used but not declared.

XML-20130: Root element name must match the DOCTYPE name.

XML-20131: Element string already declared.

XML-20132: Element cannot have more than one ID attribute.

XML-20133: Attr type missing.

XML-20134: ID attribute must be declared #IMPLIED or #REQUIRED.

XML-20135: Attribute string already defined, using the first definition.

XML-20136: Notation string already declared.

XML-20137: Attribute string used but not declared.

XML-20138: REQUIRED attribute string is not specified.

XML-20139: ID value string is not unique.

XML-20140: IDREF value string does not match any ID attribute value.

XML-20141: Attribute value string should be one of the declared enumerated values.

XML-20142: Unknown attribute type.

XML-20143: Unrecognized text at end of attribute value.

XML-20144: FIXED type Attribute value not equal to the default value string.

XML-20145: Unexpected text in content of Element string.

XML-20146: Unexpected text in content of Element string, expected elements string.

XML-20147: Invalid element string in content of string, expected closing tag.

XML-20148: Invalid element string in content of string, expected elements string.

XML-20149: Element string used but not declared.

XML-20150: Element string not complete, expected elements string.

XML-20151: Entity string used but not declared.

XML-20170: Invalid UTF8 encoding.

XML-20171: Invalid XML character(string).

XML-20172: 5-byte UTF8 encoding not supported.

XML-20173: 6-byte UTF8 encoding not supported.

XML-20180: User Supplied NodeFactory returned a Null Pointer.

XML-20190: Whitespace required.

XML-20191: '>' required to end DTD.

XML-20192: Unexpected text in DTD.

XML-20193: Unexpected EOF.

XML-20194: Unable to write to output stream.

XML-20195: Encoding not supported in PrintWriter.

XML-20200: Expected string instead of string.

XML-20201: Expected string instead of string.

XML-20202: Expected string to be string.

XML-20205: Expected string.

XML-20206: Expected string or string.

XML-20210: Unexpected string.

XML-20211: string is not allowed in string.

XML-20220: Invalid InputSource.

XML-20221: Invalid char in text.

XML-20230: Illegal change of encoding: from string to string.

XML-20231: Encoding string is not currently supported.

XML-20240: Unable to open InputSource.

XML-20241: Unable to open entity string.

XML-20242: Error opening external DTD string.

XML-20250: Missing entity string.

XML-20251: Cyclic Entity Reference in entity string.

XML-20280: Bad character (string).

XML-20281: NMToken must contain atleast one NMChar.

XML-20282: string not allowed in a PubIdLiteral.

XML-20284: Illegal white space before optional character in content model.

XML-20285: Illegal mixed content model.

XML-20286: Content list not allowed inside mixed content model.

XML-20287: Content particles not allowed inside mixed content model.

XML-20288: Invalid default declaration in attribute declaration.

XML-20500: SAX feature string not recognized.

XML-20501: SAX feature string not supported.

XML-20502: SAX property string not recognized.

XML-20503: SAX property string not supported.

DOM Error Messages

These error messages are in the range XML-21000 through XML-21999.

XML-21000: invalid size string specified

Cause: An invalid size or count was passed to a DOM function.

Action: Correct the argument passed to a valid value.

XML-21001: invalid index string specified; must be between 0 and string

Cause: An invalid index was passed to a DOM function.

Action: Correct the argument passed to a valid value specified by the bounds in the error message.

XML-21002: cannot add an ancestor as a child node

Cause: The DOM operation was trying to a add an ancestor node as a child. This can lead to inconsistencies in the tree, so it is not allowed.

Action: Check the application to fix the usage.

XML-21003: node of type string cannot be added to node of type string

Cause: The DOM specification does not allow the parent-child combinationused in the DOM operation.

Action: Refer to DOM specification to fix the usage.

XML-21004: document node can have only one string node as child

Cause: The XML well-formedness requires that the document node have onlyone element node as its child. The application tried adding addinga second element node.

Action: Fix usage in the application.

XML-21005: node of type string cannot be added to attribute list

Cause: The attribute list (instance of NamedNodeMap) can contain onlyattribute nodes.

Action: Fix usage of NamedNodeMap.

XML-21006: cannot add a node belonging to a different document

Cause: The node being added was created by a different document. The DOMspecification does not allow use of nodes across documents.

Action: Use importNode or adoptNode to move a node from one document to another, before adding it.

XML-21007: invalid character string in name

Cause: The qualified or local name passed was invalid.

Action: Fix the name to contain only valid

XML-21008: cannot set value for node of type string

Cause: The node of the specified type cannot have value.

Action: Fix usage of DOM functions.

XML-21009: cannot modify descendants of entity or entity reference nodes

Cause: The descendants of entity or entity reference nodes are read-onlynodes, and modification is not allowed.

Action: Fix usage of DOM functions.

XML-21010: cannot modify DTD's content

Cause: DTD and all its content is read-only and cannot be modified.

Action: Fix usage of DOM functions.

XML-21011: cannot remove attribute; not found in the current element

Cause: An attempt was made to remove an attribute that does not belong thecurrent element.

Action: Fix usage in application.

XML-21012: cannot remove or replace node; it is not a child of the current node

Cause: An attempt was made to remove an node that does not belong thecurrent node as a child.

Action: Fix usage in application.

XML-21013: parameter string not recognized

Cause: The DOM parameter was not recognized.

Action: See documentation for a valid list of parameters.

XML-21014: value string of parameter string is not supported

Cause: The DOM parameter was not recognized.

Action: See documentation for a valid list of parameters.

XML-21015: cannot add attribute belonging to another element

Cause: An attempt was made to add an attribute that belonged theanother element.

Action: Fix usage in application.

XML-21016: invalid namespace string for prefix string

Cause: The namespace for xml, and xmlns prefixes is fixed, and usage mustmatch these.

Action: Correct the namespace for the prefixes, namespaces are xml = http://www.w3.org/XML/1998/namespace xmlns = http://www.w3.org/2000/xmlns/

XML-21017: invalid qualified name: string

Cause: The qualified name passed to a DOM function was invalid.

Action: Fix the qualified name.

XML-21018: conflicting namespace declarations string and string for prefix string

Cause: The DOM tree has conflicting namespace declarations for the sameprefix. Such a DOM tree cannot be serialized.

Action: Fix the DOM tree, before printing it.

XML-21019: string object is detached

Cause: The object was detached, no operations are supported ona detached object. The object can be a Range or iterator object

Action: Fix the usage in application.

XML-21020: bad boundary specified; cannot partially select a node of type string

Cause: The boundary specified in the range was invalid. The selectioncan be partial only for text nodes.

Action: Fix the usage in the application.

XML-21021: node of type string does not support range operation string

Cause: The range operation is not supported on the node type specified.

Action: Refer to DOM documentation for restrictions of node types for each range operation.

XML-21022: invalid event type: string

Cause: The event type passed was invalid.

Action: Fix usage in the application.

XML-21023: prefix not allowed on nodes of type string

Cause: The application tried to set prefix on a node on which prefix is notallowed

Action: Fix usage in the application.

XML-21024: import not allowed on nodes of type string

Cause: The application tried to import a node of type DOCUMENT orDOCUMENT FRAGMENT.

Action: Fix usage in the application.

XML-21025: rename not allowed on nodes of type string

Cause: The application tried to import a node of type other than ELEMENT orATTRIBUTE.

Action: Fix usage in the application.

XML-21026: Unrepresentable character in node: string

Cause: A node contains an invalid character, eg. CDATA section contain a termination character.

Action: Set appropriate DOMConfiguration parameter.

XML-21027: Namespace normalization error in node: string

Cause: Namespace fixup cannot be performed on this node.

Action: Set namespace normalization to false.

XML-21997: function not supported on THICK DOM

Cause: A function on THICK (for example, XDB based) DOM which is not supported was called.

Action: Refer to the XDK documentation for possible alternatives for functions not supported on THICK DOM.

XML-21998: system error occurred: string

Cause: Non-dom related system errors occurred.

Action: Check with ORA error(s) embedded in the message and consult with developers for possible causes.

XSL Transformation Error Messages

These error messages are in the range XML-22000 through XML-22999.

XML-22000: Error while parsing XSL file (string).

XML-22001: XSL Stylesheet does not belong to XSLT namespace.

XML-22002: Error while processing include XSL file (string).

XML-22003: Unable to write to output stream (string).

XML-22004: Error while parsing input XML document (string).

XML-22005: Error while reading input XML stream (string).

XML-22006: Error while reading input XML URL (string).

XML-22007: Error while reading input XML reader (string).

XML-22008: Namespace prefix string used but not declared.

XML-22009: Attribute string not found in string.

XML-22010: Element string not found in string.

XML-22011: Cannot construct XML PI with content: string.

XML-22012: Cannot construct XML comment with content: string.

XML-22013: Error in expression: string.

XML-22014: Expecting node-set before relative location path.

XML-22015: Function string not found.

XML-22016: Extension function namespace should start with string.

XML-22017: Literal expected in string function. Found string.

XML-22018: Parse Error in string function.

XML-22019: Expected string instead of string.

XML-22020: Error in extension function arguments.

XML-22021: Error parsing external document: string.

XML-22022: Error while testing predicates. Not a nodeset type.

XML-22023: Literal Mismatch.

XML-22024: Unknown multiply operator.

XML-22025: Expression error: Empty string.

XML-22026: Unknown expression at EOF: string.

XML-22027: Closing } not found in Attribute Value template.

XML-22028: Expression value type string not recognized by string.

XML-22029: Cannot transform child string in string.

XML-22030: Attribute value string not expected for string.

XML-22031: Variable not defined: string.

XML-22032: Found a single } outside expression in Attribute value template.

XML-22033: Token not recognized:!.

XML-22034: Namespace definition not found for prefix string.

XML-22035: Axis string not found

XML-22036: Cannot convert string to string.

XML-22037: Unsupported feature: string.

XML-22038: Expected Node-set in Path Expression.

XML-22039: Extension function error: Error invoking constructor for string

XML-22040: Extension function error: Overloaded constructors for string

XML-22041: Extension function error: Constructor not found for string

XML-22042: Extension function error: Overloaded method string

XML-22043: Extension function error: Method not found string

XML-22044: Extension function error: Error invoking string:string

XML-22045: Extension function error: Class not found string

XML-22046: Apply import cannot be called when current template is null.

XML-22047: Invalid instantiation of string in string context.

XML-22048: The string element children must precede all other element children of an string element.

XML-22049: Template string invoked but not defined.

XML-22050: Duplicate variable string definition.

XML-22051: only a literal or a reference to a variable or parameter is allowed in id() function when used as a pattern

XML-22052: no sort key named as: string was defined

XML-22053: cannot detect encoding in unparsed-text(), please specify

XML-22054: no such xsl:function with namespace: string and local name: string was defined

XML-22055: range expression can only accept xs:integer data type, but not string

XML-22056: exactly one of four group attributes must be present in xsl:for-each-group

XML-22057: string can only have string as children

XML-22058: wrong child of xsl:function

XML-22059: wrong child order of xsl:function

XML-22060: TERMINATE PROCESSING

XML-22061: teminate attribute in <xsl:message> can only be yes or no

XML-22062: string must have at least one string child

XML-22063: no definition for character-map with qname string

XML-22064: cannot define character-map with the same name string and the same import precedence

Cause: A required child was not found.

Action: After error mesgfreeze is over, throws an error (without the required child element, it can do nothing).

XML-22065: at least one string must be defined under string

Cause: a required child is missing.

Action: without the required child, it can do nothing, so throws an error.

XML-22066: if select attribute is present, string instructions sequence-constructor must be empty

Cause: the "select" attribute and sequence constructor should be mutually exclusive for this instruction.

Action: None. Throw an error.

XML-22067: if use attribute is present, string instructions sequence-constructor must be empty

Cause: the "use" attribute and sequence constructor should be mutually exclusive for this instruction.

Action: None. Throw an error.

XML-22068: only primary sort key is allowed to have the stable attribute.

Cause: the secondary sort key has a stable attribute.

Action: None. Throw an error.

XML-22069: only string or string is allowed.

Cause: user's typo.

Action: None. Throw an error.

XML-22101: DOMSource node as this type not supported.

XML-22103: DOMResult can not be this kind of node.

XML-22106: Invalid StreamSource - InputStream, Reader, and SystemId are null.

XML-22107: Invalid SAXSource - InputSource is null.

XML-22108: Invalid Source - URL format is incorrect.

XML-22109: Internal error while reporting SAX events.

XML-22110: Invalid StreamResult set in TransformerHandler.

XML-22111: Invalid Result set in TransformerHandler.

XML-22112: Namespace URI missing }.

XML-22113: Namespace URI should start with {.

XML-22117: URL format has problems (null or bad format or missing 'href' or missing '=').

XML-22121: Could not get associated stylesheet.

XML-22122: Invalid StreamResult - OutputStream, Writer, and SystemId are null.

XML-22900: An internal error condition occurred.

XPath Error Messages

These error messages are in the range XML-23000 through XML-23999.

XML-23002: internal xpath error

Cause: This was an error returned by the XPath/XQuery datamodel or XPathF&O.

Action: Check the XPath expression.

XML-23003: XPath 2.0 feature schema-element/schema-attribute not supported

Cause: This error was caused by using the kindtest schema-element or schema-attribute. These are not supported for this release.

Action: Remove usage of schema-element or schema-attribute kindtest

XML-23006: value does not match required type

Cause: During the evaluation phase, there was a type error as thevalue did not match a required type specified by the matchingrules in XPath 2.0 SequenceType Matching.

Action: Modify the stylesheet to reflect the correct type.

XML-23007: FOAR0001: division by zero

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23008: FOAR0002: numeric operation overflow/unflow

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23009: FOCA0001: Error in casting to decimal

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23010: FOCA0002: invalid lexical value

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23011: FOCA0003: input value too large for integer

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23012: FOCA0004: Error in casting to integer

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23013: FOCA0005: NaN supplied as float/double value

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23014: FOCH0001: invalid codepoint

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23015: FOCH0002: unsupported collation

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23016: FOCH0003: unsupported normalization form

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23017: FOCH0004: collation does not support collation units

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23018: FODC0001: no context document

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23019: FODC0002: Error retrieving resource

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23020: FODC0003: Error parsing contents of resource

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23021: FODC0004: invalid argument to fn:collection()

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23022: FODT0001: overflow in date/time arithmetic

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23023: FODT0002: overflow in duration arithmetic

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23024: FONC0001: undefined context item

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23025: FONS0002: default namespace is defined

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23026: FONS0003: no prefix defined for namespace

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23027: FONS0004: no namespace found for prefix

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23028: FONS0005: base URI not defined in the static context

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23029: FORG0001: invalid value for cast/constructor

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23030: FORG0002: invalid argument to fn:resolve-uri()

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23031: FORG0003: zero-or-one called with sequence containing more than one item

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23032: FORG0004: fn:one-or-more called with sequence containing no items

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23033: FORG0005: exactly-one called with sequence containing zero or more than one item

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23034: FORG0006: invalid argument type

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23035: FORG0007: invalid argument to aggregate function

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23036: FORG0008: both arguments to fn:dateTime have a specified timezone

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23037: FORG0009: base uri argument to fn:resolve-uri is not an absolute URI

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23038: FORX0001: invalid regular expression flags

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23039: FORX0002: invalid regular expression

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23040: FORX0003: regular expression matches zero-length string

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23041: FORX0004: invalid replacement string

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23042: FOTY0001: type error

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23043: FOTY0011: context item is not a node

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23044: FOTY0012: items not comparable

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23045: FOTY0013: type does not have equality defined

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23046: FOTY0014: type exception

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23047: FORT0001: invalid number of parameters

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23048: FOTY0002: type definition not found

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23049: FOTY0021: invalid node type

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23050: FOER0000: unidentified error

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23051: FODC0005: invalid argument to fn:doc

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML-23052: FODT0003: invalid timezone value

Cause: This was an XPath 2.0 F&O specification error.

Action: Check the XPath expression.

XML Schema Validation Error Messages

These error messages are in the range XML-24000 through XML-24099.

XML-24000: internal error

Cause: An unexpected error occoured during processing

Action: Report the error

XML-24001: attribute string not expected at line string, column string

Cause: [cvc-assess-attr.1] The attribute were not expected for owner element

Action: Add the attribute declaration to the type of the owner element

XML-24002: can not find element declaration string.

Cause: [cvc-assess-elt.1.1.1.1]The element declaration required by processorfor validation was absent.

Action: Add the element declaration to schema, or change the instance document to comply to schema.

XML-24003: context-determined element declaration string absent.

Cause: [cvc-assess-elt.1.1.1.2] The element declaration required by context was missing in schema

Action: Add the element declaration to schema

XML-24004: declaration for element string absent.

Cause: [cvc-assess-elt.1.1.1.3] The context-determined declaration was not skip and the declaration that matches the element could not be foundin schema

Action: Add the element declaration to schema or change the context-determined declaration to skip

XML-24005: element string not assessed

Cause:[cvc-assess-elt.2]

XML-24006: element string laxly assessed

Cause: [cvc-assess-elt.2]

XML-24007: missing attribute declaration stringin element string

Cause: [cvc-attribute.1] Attribute declaration was absent from element declaration

Action: Add the attribute declaration to schema.

XML-24008: type absent for attribute string

Cause: [cvc-attribute.2] Missing type definition for the attribute declaration

Action: Specify a data type for the attribute declaration.

XML-24009: invalid attribute value string

Cause: [cvc-attribute.3] Invalid attribute value with respect to its type

Action: Correct the attribute value in instance.

XML-24010: attribute value string and fixed value string not match

Cause: [cvc-au] Attribute's normalized value was not the same as the fixedvalue declared.

Action: Change attribute value to the required value.

XML-24011: type of element string is abstract.

Cause: [cvc-complex-type.1] The type of this element was specified as abstract.

Action: Remove the abstract attribute from the type definition.

XML-24012: no children allowed for element string with empty content type

Cause: [cvc-complex-type.2.1] The content type was specified empty while the actual content was not.

Action: Make the content empty or modify the content type of this element.

XML-24013: element child string not allowed for simple content

Cause: [cvc-complex-type.2.2] Element was declared with simple content, but instance had element children.

Action: Use only character content for this element.

XML-24014: characters string not allowed for element-only content

Cause: [cvc-complex-type.2.3] Characters appeared in the content of element with element-only content.

Action: Use only element children for this element.

XML-24015: multiple ID attributes in element string at line string, column string

Cause:[cvc-complex-type.2.5] More than one attributes with type ID or its derivation matched attribute wildcard.

Action: Do not use more than one attriubtes with ID or ID derived type.

XML-24016: invalid string value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid with respect to string type.

Action: Correct the value to satisfy the declared type

XML-24017: invalid boolean value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid with respect to boolean type.

Action: Correct the value to satisfy boolean type, valid values are "0: 1", "true", and"false".

XML-24018: invalid decimal value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters could not be parsed into a decimal value.

Action: Correct the data value to satisfy decimal type.

XML-24019: invalid float value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters could not be parsed into a float value.

Action: Correct the value to satisfy string type

XML-24020: invalid double value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid double format as specified in IEEE 754-1985.

Action: Correct the value to satisfy double format.

XML-24021: invalid duration string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in correct extended date time format defined in ISO 8601.

Action: Correct the value to satisfy format PnYnMnDTnHnMnS.

XML-24022: invalid date value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid calendar date format specified in ISO 8601.

Action: Correct the value to satisfy CCYY-MM-DD format.

Comments: cvc-datatype-valid.1.2.2

XML-24023: invalid dateTime value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid combined data time format as specified in ISO 8601

Action: Correct the value to satisfy format CCYY-MM-DDThh:mm:ss with optional timezoon.

XML-24024: invalid time value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid time format as specified in ISO 8601.

Action: Correct the value to satisfy foramt DDThh:mm:ss with optional timezone.

XML-24025: invalid gYearMonth value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid right-truncated date format, as specified in ISO 8601.

Action: Correct the value to satisfy format CCYY-MM.

XML-24026: invalid gYear value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid right-truncateddate format, as specified in ISO 8601.

Action: Correct the value to satisfy format CCYY.

XML-24027: invalid gMonthDay value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid left-truncateddate format, as specified in ISO 8601.

Action: Correct the value to required foramt --MM-DD.

XML-24028: invalid gDay value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid left-truncated date format, as specified in ISO 8601.

Action: Correct the value to required format ---DD.

XML-24029: invalid gMonth value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid left-and-right-truncated date format, as specified in ISO 8601.

Action: Correct the value to required format --MM--.

XML-24030: invalid hexBinary value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid hex encoded binary.

Action: Correct the value to satisfy hexBinary type

XML-24031: invalid base64Binary value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid with respect to base64 encoding.

Action: Correct the value to satisfy base64 binary encoding.

XML-24032: invalid anyURI value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid format as specified in RFC 2396 and RFC 2732.

Action: Correct the value to satisfy anyURI type

XML-24033: invalid QName value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not in valid QName format.

Action: Correct the value to satisfy QName type

XML-24034: invalid NOTATION value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for NOTATION type.

Action: Correct the value to satisfy NOTATION type

XML-24035: invalid normalizedString value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid normalizedStringvalue.

Action: Correct the value to satisfy normalizedString type

XML-24036: invalid token value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for token type.

Action: Correct the value to satisfy token type

XML-24037: invalid language value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for language type.

Action: Correct the value to satisfy language type

XML-24038: invalid NMTOKEN value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for NMTOKEN type.

Action: Correct the value to satisfy NMTOKEN type

XML-24039: invalid NMTOKENS value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid list of NMTOKEN type.

Action: Correct the value to satisfy NMTOKENS type.

XML-24040: invalid Name value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for Name type.

Action: Correct the value to satisfy Name type

XML-24041: invalid NCName value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for NCName type.

Action: Correct the value to satisfy NCName type

XML-24042: invalid ID value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for ID type.

Action: Correct the value to satisfy ID type

XML-24043: invalid IDREF value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for IDREF type.

Action: Correct the value to satisfy IDREF type

XML-24044: invalid ENTITY value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for ENTITY type

Action: Correct the value to satisfy ENTITY type

XML-24045: invalid ENTITIES value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid list ofENTITY value.

Action: Correct the value to satisfy ENTITIES type

XML-24046: invalid integer value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for integertype.

Action: Correct the value to satisfy integer type

XML-24047: invalid nonPositiveInteger value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for nonPositiveInteger type.

Action: Correct the value to satisfy nonPositiveInteger type

XML-24048: invalid negativeInteger value string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for negativeInteger type.

Action: Correct the value to satisfy negativeInteger type

XML-24049: invalid long value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for long type.

Action: Correct the value to satisfy long type

XML-24050: invalid int value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for int type.

Action: Correct the value to satisfy int type

XML-24051: invalid short value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for short type.

Action: Correct the value to satisfy short type

XML-24052: invalid byte value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for byte type.

Action: Correct the value to satisfy byte type

XML-24053: invalid nonNegativeInteger value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for nonNegativeInteger type.

Action: Correct the value to satisfy nonNegativeInteger type

XML-24054: invalid unsignedLong value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for unsignedlong type.

Action: Correct the value to satisfy unsignedlong type

XML-24055: invalid unsignedInt value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value of unsignedInt.

Action: Correct the value to satisfy unsignedInt type

XML-24056: invalid unsignedShort value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for unsignedShort type.

Action: Correct the value to satisfy unsignedShort type

XML-24057: invalid unsignedByte value string at line string, column string

Cause: [cvc-datatype-valid.1.2.2] Characters were not valid value for unsignedByte type.

Action: Correct the value to satisfy unsignedByte type

XML-24058: value string must be valid with respect to one member type

Cause: [cvc-datatype-valid.1.2.3] Characters were invalid with respect to any member type of union.

Action: Correct data value to satisfy at least one member type

XML-24059: element string not expected at line string, column string

Cause: [cvc-elt.1]

XML-24060: element string abstract

Cause:[cvc-elt.2] Element declared abstract was used in instance document.

Action: Do not declare the element as abstract.

XML-24061: element string not nillable

Cause: [cvc-elt.3.1] There was an attriube xsi:nil, which was not allowed because the element declaration was not nillable.

Action: Remove xsi:nil attribute from the the element

XML-24062: no character or element children allowed for nil content string

Cause: [cvc-elt.3.2.1] Element was specified nil but had character or element children.

Action: Remove any element content or remove nil attribute.

XML-24063: nil element does not satisfy fixed value constraint

Cause: [cvc-elt.3.2.2] Element had an fixed value while the content in instance was empty.

Action: Remove nil attribute from element.

XML-24064: xsi:type not a QName at line string, column string

Cause: [cvc-elt.4.1] The value of xsi:type attribute was not a QName.

Action: Change the value to a valid QName that references to a type.

XML-24065: xsi:type string not resolved to a type definition

Cause: [cvc-elt.4.2] The referenced type specified by xsi:type was absent.

Action: Correct the value of xsi:type so it points to a valide type definition.

XML-24066: local type string not validly derived from the type of element string

Cause: [cvc-elt.4.3] The type referenced by xsi:type was not derived from original type.

Action: Modify the reference type defintion so it satisfy the constraint, or use another type that is derived from original type.

XML-24067: value string not in enumeration

Cause: [cvc-enumeration-valid] The value was not one in the enumeration constraint.

Action: Use valid value specified in enumeration.

XML-24068: invalid facet string for type string

Cause: [cvc-facet-valid] The given data value violates the constraining facet.

Action: Correct the data value.

XML-24069: too many fraction digits in value string at line string, column string

Cause: [cvc-fractionDigits-valid] The given number violated the fractionDigits constraining facet.

Action: Use fewer fraction digits.

XML-24070: missing ID definition for ID reference string at line string, column string

Cause: [cvc-id.1] There is no ID binding in the ID/IDREF table for validation root

Action: Define the ID for the ID reference

XML-24071: duplicate ID string at line string, column string

Cause: [cvc-id.2] Same ID was defined more than once.

Action: Eliminate duplicate ID attributes.

XML-24072: duplicate key sequence string

Cause: [cvc-identity-constraint] The document contained duplicate key sequence thatviolated uniqueness constraint.

Action: Correct the document to make key sequence unique, or modify xpath to avoid it.

XML-24073: target node set not equals to qualified node set for key string

Cause: [cvc-identity-constraint.4.2.1] There were empty key sequences in key constraint.

Action: Make sure every element in target node set has a non-empty key sequence.

XML-24074: element member string in key sequence is nillable

Cause: [cvc-identity-constraint.4.2.3] The element selected as a member in a key sequence was nillable, which is not allowed.

Action: Modify the schema to make corrsponding element declaration not nillable.

XML-24075: missing key sequence for key reference string

Cause: [cvc-identity-constraint.4.3] A keyref referenced to empty key sequence.

Action: Make sure every key sequence for keyref is has a corresponding key sequence for referenced key.

XML-24076: incorrect length of value string

Cause: [cvc-length-valid] The length of the value was not the same as specified in length facet.

Action: Use data value with correct length.

XML-24077: value string greater than or equal to maxExclusive

Cause: [cvc-maxExclusive-valid] The data value was out of boundary specified in maxExclusive facet.

Action: Correct the data value.

XML-24078: value string greater than the maxInclusive

Cause: [cvc-maxInclusive-valid] The data value was out of boundary specified in maxInclusive facet.

Action: Correct the data value.

XML-24079: value length of string greater than maxLength

Cause: [cvc-maxLength-valid] The length of the data value was greater than maxLength.

Action: Make the data value's length smaller than maxLength.

XML-24080: value string smaller or equals to minExclusive

Cause: [cvc-minExclusive-valid] The data value was out of lower boundary of value range.

Action: Use data valude that is greater to minExclusive.

XML-24081: value string smaller than minInclusive

Cause: [cvc-minInclusive-valid] The data value was too small.

Action: Use data value not smaller than the value of minInclusive.

XML-24082: value string shorter than minLength

Cause: [cvc-minLength-valid] The length of value was smaller than that specified in minLength.

Action: Use data value with length greater than or equals to minLength.

XML-24083: wildcard particle in the content of element string not done

Cause: [cvc-particle.1.1] The wildcard particle's minOccurs had not been met.

Action: Have more elements in the content that match the wildcard.

XML-24084: element particle string not done

Cause: [cvc-particle.1.2] The element particle's minOccurs had not been met.

Action: Have more elements that match the element declaration or members in its substitution group.

XML-24085: model group string in the content of element string not done

Cause: [cvc-particle.1.3] The model group particle's minOccurs had not been met.

Action: Have more elements in the content that match the model group.

XML-24086: invlid literal string with respect to pattern facet string

Cause: [cvc-pattern-valid] The literal did not match the pattern constraining facet.

Action: Correct the lexical data to match pattern facet.

XML-24087: undefined type string

Cause: [cvc-resolve-instance.1] Could not resolve the type reference to a type definition

Action: Add the type definition to schema

XML-24088: undeclared attribute string

Cause: [cvc-resolve-instance.2] Could not resolve attributre reference to an attribute declaraton.

Action: Add the attribute declaration to schema.

XML-24089: undeclared element string

Cause: [cvc-resolve-instance.3] Could not resolve element reference to an element declaraton

Action: Add the element declaration to schema

XML-24090: undefined attribute group string

Cause: [cvc-resolve-instance.4] Could not resolve the attribute group reference to an attribute group definition.

Action: Define the attribute group definition in schema

XML-24091: undefined model group string

Cause: [cvc-resolve-instance.5] Could not resolve the model group reference to a model group definition

Action: Define the model group in schema

XML-24092: undeclared notation string

Cause: [cvc-resolve-instance.6] Could not resolve the notation reference to a notation declaration

Action: Add the notation declaration to schema

XML-24093: too many digits in value string at line string, column string

Cause: [cvc-totalDigits-valid] The number of digits in numeric value was greater than the value oftotalDigits facet.

Action: Use smaller numbers.

Schema Representation Constraint Error Messages

These error messages are in the range XML-24100 through XML-24199.

XML-24100: element string must belong to XML Schema namespace

Cause: Element in XML Schema document did not have Schema namespace.

Action: Specify XML Schema namespace http://www.w3.org/2001/XMLSchema

XML-24101: can not build schema from location string

Cause: [schema_reference.2] Processor could not find schema from given schema location

Action: Fix the schema location

XML-24102: can not resolve schema by target namespace string

Cause: [schema_reference.3] Processor was unable to retrieve schema based on given namespace.

Action: Fix the schema namespace

XML-24103: invalid annotation representation at line string, column string

Cause:[src-annotation]

XML-24104: multiple annotations at line string, column string

Cause: [src-annotation] More than one annotation elements appeared in component.

Action: Remove extra annotation.

XML-24105: annotation must be the first element at line string, column string

Cause: [src-annotation] Annotation was not the first element in component.

Action: Move annotation to the begining of component content.

XML-24106: attribute wildcard before attribute declaration at line string, column string

Cause: The attribute wildcard appeared before attribute declarations.

Action: Move attribute wildcard to the end of declaration.

XML-24107: multiple attribute wildcard

Cause: [src-attribute.1] More than one anyAttributes were declared.

Action: Remove extra attribute wildcards.

XML-24108: default string and fixed string both present

Cause: [src-attribute.1] Both default and fixed attriubtes were present in attriubte declaration.

Action: Remove either default or fixed attribute.

XML-24109: default value string conflicts with attribute use stringXML-24109: default value string conflicts with attribute use string

Cause: [src-attribute.2] Both default and use were present, and value for use is not optional.

Action: Remove either default or use value.

XML-24110: missing name or ref attribute

Cause: [src-attribute.3.1] Neither name nor ref attribute was present in declaration.

Action: Add name or ref to the declaration.

XML-24111: both name and ref presented in attribute declaration

Cause: [src-attribute.3.1] Name and ref attribute were both present in attribute declaration.

Action: Add name or ref to the declaration.

XML-24112: ref conflicits with form, type, or simpleType child

Cause: [src-attribute.3.2] The attribute was a reference, and form, type or simpleType child were specified.

Action: Either change ref to name, or remove form, type and/or childrens.

XML-24113: type attribute conflicts with simpleType child

Cause: [src-attribute.4] Both type attribute and simpleType child were present.

Action: Remove either type reference or type definition.

XML-24114: intersecton of attribute wildcard is not expressible

Cause: [src-attribute_group.2] Attriubes wildcards defined were not expressible with a wildcard.

Action: Remove inexpressible attribute wildcards.

XML-24115: circular attribute group reference string

Cause: [src-attribute_group.3] Attriubte group were circularly referenced outside redefine

Action: Remove circular reference

XML-24116: circular group reference string

Cause: group were circularly referenced outside redefine.

Action: Remove circular reference

XML-24117: base type string for complexContent is not complex type

Cause: [src-ct.1] Derived a complexType with complex content from simple type

Action: Change base type to complex type

XML-24118: simple content required in base type string

Cause: [src-ct.2] A complexType with simpleContent was derived from a complexType with complex content

Action: Change base type to simple type (if derivation is extension) or simpleContent complex type.

XML-24119: properties specified with element reference string

Cause: [src-element.2.2] Element reference also had complexType, simpleType, key, keyrefunique children or nillable, form, default, block, or type attribute.

Action: Remove conflict attributes or children.

XML-24120: simpleType and complexType can not both present in element declaration string

Cause: [src-element.3] Element declaration had both complexType, simpleType children.

Action: Remove either simpleType or complexType child.

XML-24121: imported namespace string must different from namespace string

Cause: [src-import.1.1] The namespce of import was the same as the target namespace of importing schema

Action: Change import to inclusion.

XML-24122: target namespace string required

Cause: [src-import.1.2] Imported namespace was specified but absent imported schema.

Action: Remove namespace attribute in element import, or add target namespac to the imported schema.

XML-24123: namespace stringis different from expedted targetNamespace string

Cause: [src-import.3.1] Specified namespace was different from actual targetNamespace impported.

Action: Correct the namespace attribute in import element.

XML-24124: targetNamespace string not expected in schema

Cause: [src-import.3.2] Specified a no-namespace schema, but actual schema had targetNamespace.

Action: Remove the imported schema's targetNamespace attribute

XML-24125: can not include schema fromstring

Cause: [src-include.1] Processor was unable to include a schema from given location.

Action: Check correctness of URL and URL resolver

XML-24126: included targetNamespace string must the same as string

Cause: [src-include.2.1] Tried to include a achema with different targetNamespace.

Action: Use import instead of include.

XML-24127: no-namespace schema can not include schema with target namespace string

Cause: [src-include.2.2] A schema without targetNamespace tried to include a schema with targetNamespace.

Action: Use import instead of include

XML-24128: itemType attribute conflicits with simpleType child

Cause: [src-list-itemType-or-simpleType] Both itemType attribute and simpleType child were present in list simple type declaration.

Action: Remove either itemType attribute or simpleType child.

XML-24129: prefix of qname string can not be resolved

Cause: [src-qname] Prefix of a qname was present, but did not map to any in-scope namespace.

Action: Declare a namespace corresponding to the prefix.

XML-24130: redefined schema has different namespace. line string column string

Cause: Redefined schema's targetNamespace was not the same as the targetNamespace of redefining schema.

Action: Correct the targetNamespace in redefined schema.

Comments: src-redefine.3.1

XML-24131: no-namespace schema can only redefine schema without targetNamespace

Cause: [src-redefine.3.2] A no-namespace schema tried to redefine a schema with namespace

Action: Remove the targetNamespace attribute from redefined schema.

XML-24132: type derivation string must be restriction

Cause: [src-redefine.5] A simpleType or complexType was present in redefine, but the derivation was not restriction.

Action: Change the type redefinition, make it a restriction.

XML-24132: type string must redefine itself at line string, column string

Cause: [src-redefine.5] A simpleType or complexType was present in redefine, but its base type was not itself.

Action: Change the base type to redefine itself.

XML-24133: group string can have only one self reference in redefinition

Cause: [src-redefine.6.1.1] A group was present in redefine and it had more than onereferences to itself in its content.

Action: Remove extra self references in the group redefinition.

XML-24134: self reference of group string must not have minOccurs or maxOccurs other than 1 in redefinition

Cause: [src-redefine.6.1.2] A minOccurs or maxOccurs with value other than 1 was specified in a group self reference in redefine.

Action: Remove the minOccurs or maxOccurs attribute.

XML-24135: redefined group stringis not a restriction of its orginal group

Cause: [src-redefine.6.2.2] A group presented in redefine, without self reference but was nota valid restriction of its original group.

Action: Modify the content of the group, make it a valid restriction of its original.

XML-24236: attribute group string can have only one self reference in redefinition

Cause: [src-redefine.7.1] An attributeGroup was present in redefine and it had more than oneself references in its content.

Action: Remove extra self references.

XML-24136: redefined attribute group string must be a restriction of its orginal group

Cause: [src-redefine.7.2.2] An attributeGroup presented in redefine, without self reference but was not a valid restriction of its original.

Action: Modify the content of the attribute group, make it valid restriction of its original.

XML-24137: restriction must not have both base and simpleType child

Cause:[src-restriction-base-or-simpleType]

XML-24138: simple type restriction must have either base attribute or simpleType child

Cause: [src-simple-type.2] Both base and simpleType were absent in simple type restriction

Action: Add either base attribute or simpleType child.

XML-24139: neitehr itemType or simpleType child present for list

Cause: [src-simple-type.3] Missing itemType attribute or simpleType child in list definition.

Action: Add either itemType or simpleType child

XML-24140: itemType and simpleType child can not both be present in list type.

Cause: [src-simple-type.3] Both itemType attribute and simpleType child were present inlist definition

Action: Remove either itemType or simpleType child.

XML-24141: circular union type is disallowed

Cause: [src-simple-type.4] Some member types in union type made references to the union type

Action: Remove the circular references

XML-24142: facet string can not be specified more than once

Cause: [src-single-facet-value] Same facet other than enumeration and pattern had been specified more than once, which is not allowed.

Action: Remove extra facets.

XML-24143: memberTypes and simpleType child can not both be absent in union

Cause: [src-union-memberTypes-or-simpleTypes] Both memberTypes and simpleType were absent for a union type.

Action: Either specify memberTypes or add simpleType children.

XML-24144: facets can only used for restriction

Cause: [st-restrict-facets] Derivation was not restriction while facet children were present.

Action: Remove facet children.

Schema Component Constraint Error Messages

These error messages are in the range XML-24200 through XML-24399.

XML-24201: duplicate attribute string declaration

Cause: [ag-props-correct.1] There were more than one attribute declarations with same namespace and name in attribute group definition.

Action: Remove duplicate attribute declarations.

XML-24202: more than one attributes with ID type not allowed

Cause: [ag-props-correct.2] There were more than one attribute declarations with type ID.

Action: Change to other types for such attriubte declarations

XML-24203: invalid value constraint string

Cause: [a-props-correct.2] The fixed value or default value did not satisfy the attribute's type

Action: Use type valid default for fixed value.

XML-24204: value constraint string not allowed for ID type

Cause: [a-props-correct.3] Attribute with ID type had either fixed or default value constraint.

Action: Remove value constraint.

XML-24205: fixed value string does not match string in attribute declaration

Cause: [au-props-correct.2] Attriubte reference specified a fixed value which is not the same as that in referenced declaration.

Action: Correct the fixed value to the same as specified in attribute declaration

XML-24206: value constraint must be fixed to match that in attribute declaration

Cause: [au-props-correct.2] Attriubte reference specified a default value, while the referenced declaration had a fixed value.

Action: Remove default value form attribute reference.

XML-24207: invalid xpath expression string

Cause: [c-fields-xpaths.1] The value of xpath was not valid xpath expression as specified in XPath 1.0.

Action: Use correct xpath

XML-24208: invalid field xpath string

Cause: [c-fields-xpaths.2] The value of xpath did not satisfied field's restricted xpath syntax.

Action: Correct the xpath expression

XML-24209: maxOccurs in element string of All group must be 0 or 1

Cause: [cos-all-limited] Some elements in a All group had maxOccurs greater than one.

XML-24210: All group has to form a content type.

Cause: All group was contained in another model group

Action: Make all group at the top of a content type

Comments: cos-all-limited

XML-24211: All group has to form a content type.

Cause: [cos-applicable-facets] All group was contained in another model group

Action: Make all group at the top of a content type

XML-24212: type string does not allow facet string

Cause: [cos-applicable-facets] A facet not applicable to the simple type was used.

Action: Remove the facet.

XML-24213: wildcard intersection is not exprssible

Cause: [cos-aw-intersect] Two wilcards in an attribtue group had different negative namespaces

Action: Use only one wildcard with negative namespace

XML-24214: base type not allow string derivation

Cause: [cos-ct-derived-ok.1] Base type's final prevented the derivation.

Action: Remove the derivation method from the value of final in base type

XML-24215: complex type string is not a derivation of type string

Cause: [cos-ct-derived-ok.2] There was no derivation chain from base type to derived type.

Action: Fix the derivation chaining.

XML-24216: must specify a particle in extened content type

Cause: [cos-ct-extends.1.4.2.1] The content type of an extension of a complex type was empty

Action: Add particle to the content type of extension.

XML-24217: content type string conflicts with base type's content type string

Cause: [cos-ct-extends.1.4.2.2.2] Base type's content type was not empty and was not the same as the content type specified.

Action: Match the specified content type with that in base type.

XML-24218: inconsistent local element declarations string

Cause: More than one elements in the content had same name and namespace, butdid not refer to same type.

Action: Make type references the same for all elements equal in name and namespace

Comments: cos-element-consistent

XML-24219: element string is not valid substitutable for element string

Cause:[cos-equiv-derived-ok-rec]

XML-24220: itemType string can not be list

Cause: [cos-list-of-atomic] The itemType of a list type was itself a list.

Action: Use atomic or union type as the itemType of list.

XML-24221: cricular union string not allowed

Cause: [cos-no-circular-union] Union's name and namespace matched one of its memberType.

Action: Remove any circular references

XML-24222: ambiguous particles string

Cause: [cos-nanambig] particles in a content type violated UPA (Unique Particle Attrition)constraint.

Action: Make content type particle unambiguous.

XML-24223: invalid particle extension

Cause:[cos-particle-extend]

XML-24224: invalid particle restriction

Cause:[cos-particle-restrict]

XML-24225: simple type string does not allowed restriction

Cause: [cos-st-derived-ok] Derivation was restriction but restriction was in base type's final.

Action: Remove restriction from base type's final.

XML-24226: invalid derivation from base type string

Cause: [cos-st-derived-ok] The derivation violated the "type derivaton OK (simple)" constraint.

Action: Make the derivation satisfy the constraint.

XML-24227: atomic type can not restrict list string

Cause: [cos-st-restricts.1.1] base type is list,

XML-24228: base type can not be ur-type in restriction

Cause: [cos-st-restricts.1.1] Tried to directly restrict anySimipleType.

XML-24229: base type of list must be list or ur-type

Cause: [cos-st-restricts.2.3]

XML-24230: base type of union must be union or ur-type

Cause: [cos-st-restricts.3.3]

XML-24231: element default stringrequires mixed content to be emptiable

Cause: [cos-valide-default] Element had default constraint but its mixed content type was not emtiable.

Action: Remove default value constraint.

XML-24232: element default string requires mixed content or simple content

Cause: [cos-valide-default] Element had default value constraint but its content type was element only or empty.

Action: Remove default value constraint.

XML-24233: element default string must be valid to its content type

Cause: [cos-valide-default] Element's default value constraint was invalid to its type.

Action: Correct the default value or remove it.

XML-24234: wrong field cardinality for keyref string

Cause: [c-props-correct] Number of fields were different between keyref and referenced key.

Action: Ensure that keyref and referenced key have same number of fields.

XML-24235: complex type can only extend simple type string

Cause: [ct-props-correct] Complex type was derived from simple type, but derivation was not extension.

Action: Change restriction to extension.

XML-24236: cricular type definition string

Cause: [ct-props-correct] Type was in its own derivation chain.

Action: Remove recursive derivation.

XML-24237: base type string must be complex type

Cause: [derivation-ok-restriction.1] Complex type was restricted from a simple type.

Action: Change the restriction from a complex type.

XML-24238: attribute string not allowed in base type

Cause: [derivation-ok-restriction.2] The attribute in restriction was not allowed for base type.

Action: Correct the restriction of attribute use.

XML-24239: required attribute string not in restriction

Cause: [derivation-ok-restriction.3] Restriction's attribute uses was not a subset of basetype's attribute uses.

Action: Correct the restriction of attribute uses.

XML-24240: no correspoonding attribue wildcard in bas type string

Cause: [derivation-ok-restriction.4] Restriction had an attribute wildard that did not corrspond to any attribute wildcard in base type.

Action: Correct the derivation.

XML-24241: base type string must have simple content or emptiable

Cause: [derivation-ok-restriction.5.1] Content type was simple, but the base type has complex content that is not mixed or not emptiable.

Action: Change the content type from simple to element only.

XML-24242: base type string must have empty content or emptiable

Cause: [derivation-ok-restriction.5.2] Content type was empty, but the base type had simple content or not emptiable complex content.

Action: Change the content type from simple to element only.

XML-24243: enumeration facet required for NOTATION

Cause: [enumeration-required-notation] NOTATION type was used without enumeration facet.

Action: Specify enumeration facet for NOTATION.

XML-24244: invalid value string in enumeration

Cause: [enumeration-valid-restriction] Some value in enumeration was not valid in respect to the type.

Action: Correct invalid values.

XML-24245: default value stringis element type invalid

Cause: [e-props-correct.2] Default value was invalid in respect to the type of element.

Action: Correct the default value.

XML-24246: invalid substitutionGroup string, type invalid

Cause: [e-props-correc.3] The type of the element was not a validly derivation from the type ofelement's substitutionGroup.

Action: Correct the type or remove substitutionGroup.

XML-24247: ID type does not allow value constraint string

Cause: [e-props-correct.4] Type was ID or its derivation whild there was a value constraint.

Action: Remove value constraint.

XML-24248: fractionDigits stringgreater than totalDigits string

Cause: [fractionDigits-totalDigits] The value for fractionDigits was greater than totalDigits.

Action: Make fractionDigits smaller or equal to totalDigits.

XML-24249: length facet can not be specified with minLength or maxLength

Cause: [length-minLength-maxLength] Both length and either minLength or maxLength were specified.

Action: Remove length facet.

XML-24250: length string not the same as length in base type's

Cause: [length-valid-restriction] Specified a length that was not the same as the length in base type.

Action: Remove length facet.

XML-24251: maxExclusive greater than its original

Cause: [maxExclusive-valid-restriction] Restricted maxExclusive was greater thant its original in base type.

XML-24252: minInclusive greater than or equal to maxExclusive

Cause: [maxInclusive-maxExclusive] Specified a minInclusive that was greater or equal to maxExclusive.

Action: Make minInclusive smaller than maxExclusive.

XML-24253: maxLength is greater than that in base type

Cause: [maxLength-valid-restriction] Specified a maxLength greater than orginal in base type.

Action: Sepcify a smaller maxLength to make it valid restriction.

XML-24254: circular group stringdisallowed

Cause: [mg-props-correct] Circular model group references.

Action: Remove circular references in model group definition.

XML-24256: minExclusive must be less than or equal to maxExclusive

Cause: [minExclusive-less-than-equals-to-maxExclusive] minExclusive was bigger than maxExclusive.

Action: Use smaller value for minExclusive.

XML-24257: minExclusive stringmust be less than maxInclusive

Cause: [minExclusive-less-than-maxInclusive] inExclusive specified was greater than or equal to maxInclusive.

Action: Specify smaller minExclusive.

XML-24258: invalid minExclusive string

Cause: [minExclusive-valid-restriction] Restriction's minExclusive was less than base type's minExclusive

Action: Specify greater value for minExclusive.

XML-24259: invalid minExclusive string

Cause: [minExclusive-valid-restriction] Restriction's minExclusive was less than base type's minInclusive

Action: Specify greater value for minExclusive

XML-24260: invalid minExclusive string

Cause: [minExclusive-valid-restriction] Restriction's minExlcusive was greater than base type's maxInclusive

Action: Specify smaller value for minExclusive

XML-24261: invalid minExclusive string

Cause: [minExclusive-valid-restriction] Restriction's minExclusive was greater than or equals to base type's maxExclusive

Action: Specify smaller value for minExclusive.

XML-24262: minInclusive string must not be greater than maxInclusive

Cause: [minInclusive-less-than-equal-to-maxInclusive] Specified a minInclusive that was greater than maxInclusive

Action: Specify smaller value for minInclusive.

XML-24263: Can not specify both minInclusive and minExclusive

Cause: [minInclusive-minExclusive]] Restriction specified both minInclusive and minExclusive.

Action: Remove either minInclusive or minExclusive.

XML-24264: invalid minInclusive string

Cause: [minInclusive-valid-restriction] Restriction's minInclusive was less than or equal to minInclusive in base type.

Action: Use minInclusive larger than that of base type.

XML-24265: invalid minInclusive string

Cause: [minInclusive-valid-restriction] Restriction's minInclusive was less than minExclusivein base type.

Action: Use minInclusive larger than or equal to the minExclusive of base type.

XML-24267: invalid minInclusive string

Cause: [minInclusive-valid-restriction] Restriction's minInclusive was greater than maxInclusive in base type.

Action: Use minInclusive smaller than or equal to the maxInclusive of base type.

XML-24268: invalid minInclusive string

Cause: Restriction's minInclusive was greater than or equal to maxEnclusive in base type.

Action: Use minInclusive smaller than the maxEnclusive of base type.

Comments: minInclusive-valid-restriction

XML-24269: invalid minLength string

Cause: [minLength-less-than-equal-to-maxLength] minLength in restriction is greater than base type's maxLength.

Action: Make minLength within the length range of base type.

XML-24270: invalid minLength string

Cause: [minLength-valid-restriction] Value of minLength is smaller than that of base type in restriction.

Action: Use bigger value for minLength.

XML-24271: can not declare xmlns attribute

Cause: [no-xmlns] Declared an attribute with name xmlns.

Action: Remove such declaraton.

XML-24272: no xsi for targetNamespace

Cause: [no-xsi] The schema's target namespace matched http://www.w3.org/2001/XMLSchema-instance

Action: Use other target namespace.

XML-24272: minOccurs is greater than maxOccurs

Cause: [n-props-correct] The minOccurs of particle was greater than the maxOccurs.

Action: Use smaller value for minOccurs.

XML-24281: maxOccurs must greater than or equal to 1

Cause: [ p-props-correct] The maxOccurs of particle was less than 1.

Action: Use greater value for maxOccurs.

XML-24282: incorrect Notation properties

Cause: [n-props-correct] The Notation declaration had incorrect properties.

Action: Fix Noation declaration.

XML-24283: particle's range is not valid restriction

Cause: [range-ok] Range of restriction was not within the range of parent particle.

XML-24284: sequence group is not valid derivation of choice group

Cause: Restriction did not satisfy constraint: Particle Derivation OK (Sequence:Choice -- MapAndSum)

Comments: rcase-MapAndSum

XML-24285: element string is not valid restriction of element string

Cause: [rcase-NameAndTypeOK] Restriction did not satisfy constraint: Particle Restriction OK

XML-24286: element string is not valid restriction of wildcard

Cause: [rcase-NSCompat] Restriction did not satisfy constraint: Particle Restriction OK

XML-24287: group is not valid restriction of wildcard

Cause: [rcase-NSRecurseCheckCardinality] Restriction did not satisfy constraint: Particle Restriction OK

XML-24288: group any is not valid restriction

Cause: [rcase-NSSubset] Restriction did not satisfy constraint: Particle Restriction OK(Any:Any -- NSSubset)

XML-24289: invalid restriction of all or sequence group

Cause: [ rcase-Recurse] Restriction did not satisfy constraint: Particle Restriction OK(All:All, Seqiemce"Sequence:-- Recurse)

XML-24290: wildcard is not valid restriction

Cause: [rcase-RecurseLax] The wildcard was not validly restricted from another wildcard.

XML-24291: sequence is not a valid restriction of all

Cause: Restriction violated constraint: Particle Derivation OK (Sequence:All--RecurseUnordered)

Action: Fix the restriction.

Comments: rcase-RecurseUnordered

XML-24292: duplicate component definitions string

Cause: [sch-props-correct] There were two schema components with same name and namespace.

Action: Remove duplicate definitions.

XML-24293: Incorrect simple type definition properties

Cause: [st-props-correct]

XML-24294: wildcard is not a subset of its super

Cause: [w-props-correct] The namespace constraint was not a restriction of its super

Action: Correct namespace constraint.

XML-24295: totalDigits stringis greater than string in base type

Cause: [totalDigits-valid-restriction] Restriction specified a totalDigits with value greater than that in base type.

Action: Use smaller value for totalDigits.

XML-24296: whiteSpace string can not restrict base type's string

Cause: [whiteSpace-valid-restriction] Restriction's whiteSpace was replace or preserve, and base had whiteSpace collapse, or restriction had replace while base had preserve.

Action: Eliminate conflicit whiteSpace values.

XML-24297: circular substitution group string

Cause: Substitution group was circular.

Action: Remove the circular substitution group

XSQL Server Pages Error Messages

These error messages are in the range XML-25000 through XML-25999.

XML-25001: Cannot locate requested XSQL file. Check the name.

XML-25002: Cannot acquire database connection from pool: string

XML-25003: Failed to find config file string in CLASSPATH.

XML-25004: Could not acquire a database connection named: string

XML-25005: XSQL page is not well-formed.

XML-25006: XSLT stylesheet is not well-formed: string

XML-25007: Cannot acquire a database connection to process page.

XML-25008: Cannot find XSLT Stylesheet: string

XML-25009: Missing arguments on command line

XML-25010: Error creating: string\nUsing standard output.

XML-25011: Error processing XSLT stylesheet: string

XML-25012: Cannot Read XSQL Page

XML-25013: XSQL Page URI is null; check exact case of file name.

XML-25014: Resulting page is an empty document or had multiple document elements.

XML-25015: Error inserting XML Document

XML-25016: Error parsing posted XML Document

XML-25017: Unexpected Error Occurred

XML-25018: Unexpected Error Occurred processing stylesheet string

XML-25019: Unexpected Error Occurred reading stylesheet string

XML-25020: Config file string is not well-formed.

XML-25021: Serializer string is not defined in XSQL configuration file

XML-25022: Cannot load serializer class string

XML-25023: Class string is not an XSQL Serializer

XML-25024: Attempted to get response Writer after getting OutputStream

XML-25025: Attempted to get response OutputStream after getting Writer

XML-25026: Stylesheet URL references an untrusted server.

XML-25027: Failed to load string class for built-in xsql:string action.

XML-25028: Error reading string. Check case of the name.

XML-25029: Cannot load error handler class string

XML-25030: Class string is not an XSQL ErrorHandler

XML-25100: You must supply a string attribute.

XML-25101: Fatal error in Stylesheet Pool

XML-25102: Error instantiating class string

XML-25103: Unable to load class string

XML-25104: Class string is not an XSQLActionHandler

XML-25105: XML returned from PLSQL agent was not well-formed

XML-25106: Invalid URL string

XML-25107: Error loading URL string

XML-25108: XML Document string is not well-formed

XML-25109: XML Document returned from database is not well-formed

XML-25110: XML Document in parameter string is not well-formed

XML-25111: Problem including string

XML-25112: Error reading parameter value

XML-25113: Error loading XSL transform string

XML-25114: Parameter string has a null value

XML-25115: No posted document to process

XML-25116: No query statement supplied

XML-25117: No PL/SQL function name supplied

XML-25118: Stylesheet URL references an untrusted server.

XML-25119: You must supply either the string or string attribute.

XML-25120: You selected fewer than the expected string values.

XML-25121: Cannot use 'xpath' to set multiple parameters.

XML-25122: Query must be supplied to set multiple parameters

XML-25123: Error reading string. Check case of the name.

XML-25124: Error printing additional error information.

XML-25125: Only one of (string) attributes is allowed.

XML-25126: One of (string) attributes must be supplied.

XML Pipeline Error Messages

These error messages are in the range XML-30000 through XML-30999.

XML-30000: Error ignored in string: string

Cause: Error occurred while processes execution is ignored

Action: None required

XML-30001: Error occurred in execution of Process

Cause: Component being wrapped by pipeline process is causing error

Action: Might need to fix input xml content

XML-30002: Only XML type(s) string allowed.

Comments: Should not occur normally

XML-30003: Error creating/writing to output string

Cause: Output url provided might be invalid

XML-30004: Error creating base url string

Cause: URL provided as base url is invalid

Action: Fix base url provided

XML-30005: Error reading input string

Cause: Input url provided might be invalid

XML-30006: Error in processing pipedoc Error element

XML-30007: Error converting output to xml type required by dependent process

XML-30008: A valid parameter target is required

Cause: Param with name target is missing or invalid

Action: Please add param target pointing to the target output label

XML-30009: Error piping output to input

XML-30010: Process definition element string needs to be defined

Cause: Element procdef is missing

Action: Please add process definition to pipedoc

XML-30011: ContentHandler not available

Cause: The dependent process does not provide a valid ContentHandler

Action: Please implement the getContentHandler API in your Process.

XML-30012: Pipeline components are not compatible

Cause: Component output and input don't match in terms of document/docfrag

Action: Fix the pipedoc to use components which are compatible

XML-30013: Process with output label string not found

Cause: Process whose output label matched target label is not available

Action: Create a process in the pipedoc, where the output label matches the label of the target param

XML-30014: Pipeline is not complete, missing output/outparam label called string

Cause: A dependent process output label has not been named correctly, or a dependent process is missing

Action: Please make sure every dependent input has a corresponding output

XML-30016: Unable to instantiate class

Cause: A process could not be create as there is an error in the process definition element associated with it

Action: Correctly specify the class for a process definition

XML-30017: Target is up-to-date, pipeline not executed

Cause: Either the target does not exist, or the pipeline inputs are more recent than the target

Action: Use the 'force' option to execute pipeline regardless of whether the target is up-to-date

Java API for XML Binding (JAXB) Error Messages

These error messages are in the range XML-32000 through XML32999.

XML-32202: a problem was encountered because multiple <schemaBindings> were defined.

Cause: There was more than one instance of <schemaBindings> declaration in the annotation element of the <schema> element.

Action: Update the annotation to remove duplicate <schemaBinding> declaration.

XML-32203: a problem was encountered because multiple <class> name annotations were defined on node string.

Cause: There was more than one instance of <class> declaration in the annotation element of the node.

Action: Update the annotation to remove duplicate <class> declaration.

XML-32204: a problem was encountered because the name in <class> declaration contained a package name prefix string which was not allowed.

Cause: A failure occurred because the name attribute in the <class> declaration contained a package prefix.

Action: Update the className in <class> declaration.

Comments: The package prefix is inherited from the current value of package.

XML-32205: a problem was encountered because the property customization was not specified correctly on node string.

Cause: A failure occurred because the property customization was not specified correctly.

Action: Update the <property> customization.

XML-32206: a problem was encountered because the javaType customization was not specified correctly on node string.

Cause: A failure occurred because the property customization was notspecified correctly.

Action: Update the <javaType> customization.

XML-32207: a problem was encountered in declaring the baseType customization on the node string.

Cause: A failure occurred because the baseType customization was not specified correctly.

Action: Update the <baseType> customization.

XML-32208: a problem was encountered because multiple baseType customizations were declared on the node string.

Cause: A failure occurred because multiple "baseType" customizations were declared.

Action: Remove one of the <baseType> customization declaration.

XML-32209: a problem was encountered because multiple javaType customizations were declared on the node string.

Cause: A failure occurred because multiple "javaType" customizations were declared.

Action: Remove one of the <javaType> customization declaration.

XML-32210: a problem was encountered because invalid value was specified on customization of string.

Cause: A failure occurred because an invalid value was specified onthe globalBindings customization declaration.

Action: Check and correct the globalBindings customization value.

XML-32211: a problem was encountered because incorrect <schemaBindings> customization was specified.

Cause: A failure occurred because an invalid value was specified on the schemaBindings cusotmization.

Action: Check and correct the schemaBindings customization value.

XML-32212: the <class> customization did not support specifiying the implementation class using implClass declaration. The implClass declaration specified on node string was ignored.

Cause: A warning occurred because the implClass customization declaration was not supported.

XML-32213: the <globalBindings> customization did not support specifiying user specific class that implements java.util.List. The collectionType declaration was ignored.

Cause: A warning occurred because the user specific implementation class for java.util.List was not supported.

B Oracle XDK for Java TXU Error Messages

This appendix lists TXU error messages that may be encountered in applications that use Oracle XDK for Java.

See Also:

http://www.w3.org/TR/xquery/#id-errors for the XQuery error messages

TXU Error Messages

These error messages may occur during the execution of TXU interfaces.

General TXU Error Messages

DLF Error Messages

TransX Informational Messages

TransX Error Messages

Assertion Messages

Usage Description Messages

General TXU Error Messages

These error messages are in the range TXU-0001 through TXU-0099.

TXU-0001: Fatal Error

TXU-0002: Error

TXU-0003: Warning

DLF Error Messages

These error messages are in the range TXU-0100 through TXU-0199.

TXU-0100: parameter string in query string not found

Cause: There is not a placeholder for the parameter in the query

Action: Supply a parameter whose id can be found as an associated placeholder in the associated query

TXU-0101: incompatible attributes col and constant coexist at string in query string

Cause: Attributes 'col' and 'constant' cannot coexist

Action: Remove either 'col' or 'constant' attribute

TXU-0102: node string not found

Cause: The document lacks an expected node

Action: Supply the missing node

TXU-0103: element string lacks content

Cause: The element has no data

Action: Supply content

TXU-0104: element string with SQL string lacks col or constant attribute

Cause: The element lacks a required attribute of 'col' or 'constant'

Action: Supply either 'col' or 'constant' attribute

TXU-0105: SQL exception string while processing SQL string

Cause: An error occurred during the SQL execution

Action: Resolve the error in the SQL statement

TXU-0106: no data for column string selected by SQL string

Cause: The SQL query returned no data

Action: Supply data or modify your query

TXU-0107: datatype string not supported

Cause: An attempt to process an unsupported datatype was made

Action: Change the datatype to a supported one

TXU-0108: missing maxsize attribute for column string

Cause: The size-unit attribute is specified but maxsize is not.

Action: Supply the maxsize attribute, too

TXU-0109: a text length of string for string exceeds the allowed maximum of string

Cause: The length of the text data is too long

Action: Shorten the data so it fits in the limit, or enlarge the maxsize attribute and ensure the database column is large enough

TXU-0110: undeclared column string in row string

Cause: A column in the data section is not declared in the columns section

Action: Modify the column name to a declared one

TXU-0111: lacking column data for string in row string

Cause: A column is declared but the data is missing.

Action: Supply the col element whose name attribute matches the column name

TXU-0112: undeclared query parameter string for column string

Cause: The query parameter refers to an undeclared column

Action: Specify a declared column

TXU-0113: incompatible attribute string with a query on column string

Cause: A column with a query cannot have the specified attribute

Action: Remove either the attribute or query

TXU-0114: DLF parse error (string) on line string, character string in string

Cause: The format is in error as reported

Action: Correct the erroneous part

TXU-0115: The specified date string string has an invalid format

Cause: The specified date string does not match the specified formatstring.

Action: Make sure the date string is in an appropriate date format

TransX Informational Messages

These error messages are in the range TXU-0200 throughTXU-0299.

TXU-0200: duplicate row at string

Cause: A duplicate row exists in the database

Action: This message appears on the DuplicateRowException to inform applications of existance of one or more duplicate rows already stored in the database

TransX Error Messages

These error messages are in the range TXU-0300 through TXU-0399.

TXU-0300: document string not found

Cause: The document could not be located

Action: Modify the document location or supply the document at the location

TXU-0301: file string could not be read

Cause: An I/O error happened when reading the file

Action: Resolve the I/O problem

TXU-0302: archive string not found

Cause: The archive file could not be located

Action: Ensure that the CLASSPATH includes TransX correctly and only once

TXU-0303: schema string not found in string

Cause: The schema definition of DLF could not be located

Action: Obtain an unbroken copy of a TransX archive

TXU-0304: archive path for string not found

Cause: The path for the archive could not be determined

Action: Ensure that the CLASSPATH includes TransX correctly and only once

TXU-0305: no database connection on string call for string

Cause: The operation was attempted without a database connection

Action: Open a connection first

TXU-0306: null tablename given; access denied

Cause: The table name is not provided

Action: Specify a table name

TXU-0307: lookup-keys could not be determined string

Cause: The data dictionary is corrupted

Action: Restore the data dictionary

TXU-0308: binary file string not found

Cause: The file name is invalid

Action: Supply a good file name

TXU-0309: a file size of string exceeds the allowed maximum of 2,000 bytes

Cause: The file is too large

Action: Reduce the file size

Assertion Messages

These error messages are in the range TXU-0400 through TXU-0499.

TXU-0400: missing SQL statement element on string

Cause: An internal assertion was not successful

Action: Contact Oracle customer support

TXU-0401: missing node string

Cause: An internal assertion was not successful

Action: Contact Oracle customer support

TXU-0402: invalid flag string

Cause: An internal assertion was not successful

Action: Contact Oracle customer support

TXU-0403: internal error string

Cause: An internal assertion was not successful

Action: Contact Oracle customer support

TXU-0404: unexpected Exception string

Cause: An internal assertion was not successful

Action: Contact Oracle customer support

Usage Description Messages

These error messages are in the range TXU-0500 through TXU-0599.

TXU-0500: XML data transfer utility

TXU-0501: Parameters are as follows:

TXU-0502: JDBC connect string

TXU-0503: You can omit the connect string information through the '@' symbol.

TXU-0504: Then jdbc:oracle:thin:@ will be supplied.

TXU-0505: database username

TXU-0506: database password

TXU-0507: data file name or URL

TXU-0508: Options:

TXU-0509: update existing rows

TXU-0510: raise exception if a row is already existing

TXU-0511: print data in the predefined format

TXU-0512: save data in the predefined format

TXU-0513: print the XML to load

TXU-0514: print the tree for update

TXU-0515: omit validation

TXU-0516: validate the data format and exit without loading

TXU-0517: preserve whitespace

TXU-0518: Examples:

C Oracle XDK for Java XSU Error Messages

This appendix lists XSU error messages that may be encountered in applications that use Oracle XDK for Java.

See Also:

http://www.w3.org/TR/xquery/#id-errors for the XQuery error messages

XSU Error Messages

These error messages may occur during the execution of the XSU interfaces.

Keywords and Syntax for Error Messages

Generic Error Messages

Query Error Messages

DML Error Messages

Pieces of Error Messages

Keywords and Syntax for Error Messages

These error messages are in the range XSUK-0001 through XSUK-0099.

XSUK-0001: DOCUMENT

XSUK-0002: ROWSET

XSUK-0003: ROW

XSUK-0004: ERROR

XSUK-0005: num

XSUK-0006: item

Generic Error Messages

These error messages are in the range XSUE-0000 through XSUE-0099.

XSUE-0000: Internal Error -- Exception Caught string

XSUE-0001: Internal Error -- string

XSUE-0002: string is not a scalar column. The row id attribute can only get values from scalar columns.

XSUE-0003: string is not a valid column name.

XSUE-0004: This object has been closed. If you would like the object not to be closed implicitly between calls, see the string method.

XSUE-0005: The row-set enclosing tag and the row enclosing tag are both omitted; consequently, the result can consist of at most one row which contains exactly one column which is not marked to be an XML attribute.

XSUE-0006: The row enclosing tag or the row-set enclosing tag is ommitted; consequently to get a well formed XML document, the result can only consist of a single row with multiple columns or multiple rows with exactly one column which is not marked to be an XML attribute.

XSUE-0007: Parsing of the sqlname failed -- invalid arguments.

XSUE-0008: Character string is not allowed in an XML tag name.

XSUE-0009: this method is not supported by string class. Please use string instead.

XSUE-0010: The number of bind names does not equal the number of bind values.

XSUE-0011: The number of bind values does not match the number of binds in the SQL statement.

XSUE-0012: Bind name identifier string does not exist in the sql query.

XSUE-0013: The bind identifier has to be of non-zero length.

XSUE-0014: Root node supplied is null.

XSUE-0015: Invalid LOB locator specified.

XSUE-0016: File string does not exit.

XSUE-0017: Can not create oracle.sql.STRUCT object of a type other than oracle.sql.STRUCT (i.e. ADT).

XSUE-0018: Null is not a valid DocumentHandler.

XSUE-0019: Null and empty string are not valid namespace aliases.

XSUE-0020: to use this method you will have to override it in your subclass.

XSUE-0021: You are using an old version of the gss library; thus, sql-xml name escaping is not supported.

XSUE-0022: cannot create XMLType object from opaque base type: string

Query Error Messages

These error messages are in the range XSUE-0100 through XSUE-0199.

XSUE-0100: Invalid context handle specified.

XSUE-0101: In the FIRST row of the resultset there is a nested cursor whose parent cursor is empty; when this condition occurs we are unable to generate a dtd.

XSUE-0102: string is not a valid IANA encoding.

XSUE-0103: The resultset is a "TYPE_FORWARD_ONLY" (non-scrollable); consequently, xsu can not reposition the read point. Furthermore, since the result set has been passed to the xsu by the caller, the xsu can not recreate the resultset.

XSUE-0104: input character is invalid for well-formed XML: string

DML Error Messages

These error messages are in the range XSUE-0200 through XSUE-0299.

XSUE-0200: The XML element tag string does not match the name of any of the columns/attributes of the target database object.

XSUE-0201: NULL is an invalid column name.

XSUE-0202: Column string, specified to be a key column, does not not exits in table string.

XSUE-0203: Column string, specified as column to be updated, does not exist in the table string.

XSUE-0204: Invalid REF element - string - attribute string missing.

XSUE-0206: Must specify key values before calling update routine. Use the string function.

XSUE-0207: UpdateXML: No columns to update. The XML document must contain some non-key columns to update.

XSUE-0208: The key column array must be non empty.

XSUE-0209: The key column array must be non empty.

XSUE-0210: No rows to modify -- the row enclosing tag missing. Specify the correct row enclosing tag.

XSUE-0211: string encountered during processing ROW element string in the XML document.

XSUE-0212: string XML rows were successfully processed.

XSUE-0213: All prior XML row changes were rolled back.

Pieces of Error Messages

These error messages are in the range XSUE-0300 through XSUE-0400.

XSUE-0300: Note

XSUE-0301: Exception string caught: string

XSUE-0302: column

XSUE-0303: name

XSUE-0303: invalid

XSUE-0304: xml document

XSUE-0305: template

Glossary

access control entry (ACE)

An entry in the access control list that grants or denies access to a given principal.

access control list (ACL)

A list of access control entries that determines which principals have access to a given resource or resources.

ACE

Access Control Entry. See access control entry.

ACL

Access Control List. See access control list.

application server

A server designed to host applications and their environments, permitting server applications to run. A typical example is Oracle Application Server, which is able to host Java, C, C++, and PL/SQL applications in cases where a remote client controls the interface.

attribute

A property of an element that consists of a name and a value separated by an equals sign and contained within the start-tags after the element name. In this example, <Price units='USD'>5</Price>, units is the attribute and USD is its value, which must be in single or double quotes. Attributes may reside in the document or DTD. Elements may have many attributes but their retrieval order is not defined.

Binary XML

An XML representation using the compact schema-aware format.

BLOB

See binary large object.

Business-to-Business (B2B)

A term describing the communication between businesses in the selling of goods and services to each other. The software infrastructure to enable this is referred to as an exchange.

Business-to-Consumer (B2C)

A term describing the communication between businesses and consumers in the selling of goods and services.

callback

A programmatic technique in which one process starts another and then continues. The second process then calls the first as a result of an action, value, or other event. This technique is used in most programs that have a user interface to allow continuous interaction.

cartridge

A stored program in Java or PL/SQL that adds the necessary functionality for the database to understand and manipulate a new datatype. Cartridges interface through the Extensibility Framework within Oracle Database version 8 or later. Oracle Text is such a cartridge, adding support for reading, writing, and searching text documents stored within the database.

Cascading Style Sheets

A simple mechanism for adding style (fonts, colors, spacing, and so on) to Web documents.

CDATA

See character data.

character data (CDATA)

Text in a document that should not be parsed is put within a CDATA section. This allows for the inclusion of characters that would otherwise have special functions, such as &, <, >, and so on. CDATA sections can be used in the content of an element or in attributes.

child element

An element that is wholly contained within another, which is referred to as its parent element. For example <Parent><Child></Child></Parent> illustrates a child element nested within its parent element.

Class Generator

A utility that accepts an input file and creates a set of output classes that have corresponding functionality. In the case of the XML class generator, the input file is a DTD and the output is a series of classes that can be used to create XML documents conforming with the DTD.

CLASSPATH

The operating system environmental variable that the JVM uses to find the classes it needs to run applications.

Common Object Request Broker API (CORBA)

An Object Management Group standard for communicating between distributed objects across a network. These self-contained software modules can be used by applications running on different platforms or operating systems. CORBA objects and their data formats and functions are defined in the Interface Definition Language (IDL), which can be compiled in a variety of languages including Java, C, C++, Smalltalk and COBOL.

Common Oracle Runtime Environment (CORE)

The library of functions written in C that provides developers the ability to create code that can be easily ported to virtually any platform and operating system.

CORBA

See Common Object Request Broker API.

CSS

See Cascading Style Sheets.

Database Access Descriptor (DAD)

A DAD is a named set of configuration values used for database access. A DAD specifies information such as the database name or the Oracle Net service name, the ORACLE_HOME directory, and Globalization Support configuration information such as language, sort type, and date language.

datagram

A text fragment, which may be in XML format, that is returned to the requester embedded in an HTML page from a SQL query processed by the XSQL Servlet.

DBUriType

The datatype used for storing instances of the datatype that permits XPath-based navigation of database schemas.

DOCTYPE

The term used as the tag name designating the DTD or its reference within an XML document. For example, <!DOCTYPE person SYSTEM "person.dtd"> declares the root element name as person and an external DTD as person.dtd in the file system. Internal DTDs are declared within the DOCTYPE declaration.

Document Location Hint

Oracle XML DB uses the Document Location Hint to determine which XML schemas are relevant to processing the instance document. It assumes that the Document Location Hint will map directly to the URL used when registering the XML schema with the database. When the XML schema includes elements defined in multiple namespaces, an entry must occur in the schemaLocation attribute for each of the XML schemas. Each entry consists of the namespace declaration and the Document Location Hint. The entries are separated from each other by one or more whitespace characters. If the primary XML schema does not declare a target namespace, then the instance document also must include a noNamespaceSchemaLocation attribute that provides the Document Location Hint for the primary XML schema.

Document Object Model (DOM)

An in-memory tree-based object representation of an XML document that enables programmatic access to its elements and attributes. The DOM object and its interface is a W3C recommendation. It specifies the Document Object Model of an XML Document including the APIs for programmatic access. DOM views the parsed document as a tree of objects.

Document Type Definition (DTD)

A set of rules that define the legal structure of an XML document. DTDs are text files that derive their format from SGML and can either be included in an XML document by using the DOCTYPE element or by using an external file through a DOCTYPE reference.

DOM

See Document Object Model.

DOM fidelity

To assure the integrity and accuracy of this data, for example, when regenerating XML documents stored in Oracle XML DB, Oracle XML DB uses a data integrity mechanism, called DOM fidelity. DOM fidelity refers to when the returned XML documents are identical to the original XML document, particularly for purposes of DOM traversals. Oracle XML DB assures DOM fidelity by using a binary attribute, SYS_XDBPD$.

DTD

See Document Type Definition.

EDI

Electronic Data Interchange.

element

The basic logical unit of an XML document that can serve as a container for other elements such as children, data, and attributes and their values. Elements are identified by start-tags, such as <name>, and end-tags, such as </name>, or in the case of empty elements, <name/>.

empty element

An element without text content or child elements. It can only contain attributes and their values. Empty elements are of the form <name/> or <name></name>, where there is no space between the tags.

Enterprise JavaBean (EJB)

An independent program module that runs within a JVM on the server. CORBA provides the infrastructure for EJBs, and a container layer provides security, transaction support, and other common functions on any supported server.

entity

A string of characters that may represent either another string of characters or special characters that are not part of the document character set. Entities and the text that is substituted for them by the parser are declared in the DTD.

eXtensible Markup Language (XML)

An open standard for describing data developed by the World Wide Web Consortium (W3C) using a subset of the SGML syntax and designed for Internet use.

eXtensible Stylesheet Language (XSL)

The language used within stylesheets to transform or render XML documents. There are two W3C recommendations covering XSL stylesheets—XSL Transformations (XSLT) and XSL Formatting Objects (XSLFO).

XSL consists of two W3C recommendations: XSL Transformations for transforming one XML document into another and XSL Formatting Objects for specifying the presentation of an XML document. XSL is a language for expressing stylesheets. It consists of two parts:

A language for transforming XML documents (XSLT), and

An XML vocabulary for specifying formatting semantics (XSLFO).

An XSL stylesheet specifies the presentation of a class of XML documents by describing how an instance of the class is transformed into an XML document that uses the formatting vocabulary.

eXtensible Stylesheet Language Formatting Object (XSLFO)

The W3C standard specification that defines an XML vocabulary for specifying formatting semantics. See FOP.

eXtensible Stylesheet Language Transformation (XSLT)

Also written as XSL-T. The XSL W3C standard specification that defines a transformation language to convert one XML document into another.

FOP

Print formatter driven by XSL formatting objects. It is a Java application that reads a formatting object tree and then renders the resulting pages to a specified output. Output formats currently supported are PDF, PCL, PS, SVG, XML (area tree representation), Print, AWT, MIF and TXT. The primary output target is PDF.

HASPATH

The SQL operator that is part of Oracle Text and used for querying XMLType datatypes for the existence of a specific XPath.

hierarchical indexing

The data relating a folder to its children is managed by the Oracle XML DB hierarchical index, which provides a fast mechanism for evaluating path names similar to the directory mechanisms used by operating system filesystems. Any path name-based access will normally use the Oracle XML DB hierarchical index.

HTTP

See Hypertext Transport Protocol.

HTTPS

See Hypertext Transport Protocol, Secure.

HTTPUriType

The datatype used for storing instances of the datatype that permits XPath-based navigation of database schemas in remote databases.

IDE

See Integrated Development Environment.

infoset

XML Information Set, an abstract data set consisting of a number of information items. It has at least one information item: the document node, but the infoset is not necessarily valid XML. The W3C Recommendation is at http://www.w3.org/TR/xml-infoset/

INPATH

The SQL operator that is part of Oracle Text and is used for querying XMLType datatypes for searching for specific text within a specific XPath.

instance document

An XML document validated against an XML schema. If the instance document conforms to the rules of the schema, then it is said to be valid.

instantiate

A term used in object-based languages such as Java and C++ to refer to the creation of an object of a specific class.

Integrated Development Environment (IDE)

A set of programs designed to aid in the development of software run from a single user interface. JDeveloper is an IDE for Java development, because it includes an editor, compiler, debugger, syntax checker, help system, and so on, to permit Java software development through a single user interface.

Multimedia

The collection of complex datatypes and their access in Oracle. These include text, video, time-series, and spatial data.

Internet Inter-ORB Protocol (IIOP)

The protocol used by CORBA to exchange messages on a TCP/IP network such as the Internet.

J2EE

See Java 2 Platform, Enterprise Edition.

Java

A high-level programming language developed and maintained by Sun Microsystems where applications run in a virtual machine known as a JVM. The JVM is responsible for all interfaces to the operating system. This architecture permits developers to create Java applications that can run on any operating system or platform that has a JVM.

Java 2 Platform, Enterprise Edition (J2EE)

The Java platform (Sun Microsystems) that defines multitier enterprise computing.

Java API for XML Processing (JAXP)

Enables applications to parse and transform XML documents using an API that is independent of a particular XML processor implementation.

Java Architecture for XML Binding (JAXB)

API and tools that map to and from XML documents and Java objects. A JSR-31 recommendation.

JavaBeans

An independent program module that runs within a JVM, typically for creating user interfaces on the client. Also known as Java Bean. The server equivalent is called an Enterprise JavaBean (EJB). See also Enterprise JavaBean.

Java Database Connectivity (JDBC)

The programming API that enables Java applications to access a database through the SQL language. JDBC drivers are written in Java for platform independence but are specific to each database.

Java Developer's Kit (JDK)

The collection of Java classes, runtime, compiler, debugger, and usually source code for a version of Java that makes up a Java development environment. JDKs are designated by versions, and Java 2 is used to designate versions from 1.2 onward.

Java Naming and Directory Interface (JNDI)

A programming interface from Sun for connecting Java programs to naming and directory services such as DNS, LDAP, and NDS. Oracle XML DB Resource API for Java/JNDI supports JNDI.

Java Runtime Environment (JRE)

The collection of complied classes that make up the Java virtual machine on a platform. JREs are designated by versions, and Java 2 is used to designate versions from 1.2 onward.

JavaServer Pages (JSP)

An extension to the servlet functionality that enables a simple programmatic interface to Web pages. JSPs are HTML pages with special tags and embedded Java code that is executed on the Web server or application server providing dynamic functionality to HTML pages. JSPs are actually compiled into servlets when first requested and run in the JVM of the server.

Java Specification Request (JSR)

A recommendation of the Java Community Process organization (JCP), such as JAXB.

Java Virtual Machine (JVM)

The Java interpreter that converts the compiled Java bytecode into the machine language of the platform and runs it. JVMs can run on a client, in a browser, in a middle tier, on an intranet, on an application server, or in a database server.

JAXB

See Java Architecture for XML Binding.

JAXP

See Java API for XML Processing.

JDBC

See Java Database Connectivity.

JDeveloper

Oracle Java IDE that enables application, applet, and servlet development and includes an editor, compiler, debugger, syntax checker, help system, an integrated UML class modeler, and so on. JDeveloper has been enhanced to support XML-based development by including the Oracle Java XDK components, integrated for use along with XML support, in its editor.

JDK

See Java Developer's Kit.

JNDI

See Java Naming and Directory Interface

JSR

See Java Specification Request

JVM

See Java virtual machine.

lazy type conversions

A mechanism used by Oracle XML DB to only convert the XML data for Java when the Java application first asks for it. This saves typical type conversion bottlenecks with JDBC.

listener

A separate application process that monitors the input process.

LOB

See large object.

marshalling

The process of traversing a Java content tree and writing an XML document that reflects the content of the tree. It is the inverse of unmarshalling.

name-level locking

Oracle XML DB provides for name-level locking rather than collection-level locking. When a name is added to a collection, an exclusive write lock is not placed on the collection, only that name within the collection is locked. The name modification is put on a queue, and the collection is locked and modified only at commit time.

node

In XML, the term used to denote each addressable entity in the DOM tree.

notation attribute declaration

In XML, the declaration of a content type that is not part of those understood by the parser. These types include audio, video, and other multimedia.

OAG

Open Applications Group.

OASIS

See Organization for the Advancement of Structured Information.

Object Request Broker (ORB)

Software that manages message communication between requesting programs on clients and between objects on servers. ORBs pass the action request and its parameters to the object and return the results back. Common implementations are JCORB and EJBs. See also CORBA.

OCT

See Ordered Collection in Tables.

OC4J

Oracle Containers for J2EE, a J2EE deployment tool that comes with JDeveloper.

Oracle Application Server

The Oracle Application Server product integrates all the core services and features required for building, deploying, and managing high-performance, n-tier, transaction-oriented Web applications within an open standards framework.

ORACLE_HOME

The operating system environment variable that identifies the location of the Oracle database installation for use by applications.

Oracle CM SDK

See Oracle Content Management Software Development Kit.

Oracle Content Management SDK

The Oracle file system and Java-based development environment that either runs inside the database or on a middle tier and provides a means of creating, storing, and managing multiple types of documents in a single database repository.

Oracle XML Developer's Kit (XDK)

The set of libraries, components, and utilities that provide software developers with the standards-based functionality to XML-enable their applications. In the case of the Oracle Java components of XDK, the kit contains an XML parser, an XSLT processor, the XML class generator, the JavaBeans, and the XSQL Servlet.

Ordered Collection in Tables (OCT)

When elements of a VARRAY are stored in a separate table, they are referred to as an Ordered Collection in Tables.

Oracle Text

An Oracle tool that provides full-text indexing of documents and the capability to do SQL queries over documents, along with XPath-like searching.

Oracle XML DB

A high-performance XML storage and retrieval technology provided with Oracle database server. It is based on the W3C XML data model.

ORB

See Object Request Broker.

Organization for the Advancement of Structured Information (OASIS)

An organization of members chartered with promoting public information standards through conferences, seminars, exhibits, and other educational events. XML is a standard that OASIS is actively promoting as it is doing with SGML.

parent element

An element that surrounds another element, which is referred to as its child element. For example, <Parent><Child></Child></Parent> illustrates a parent element wrapping its child element.

Parsed Character Data (PCDATA)

The element content consisting of text that should be parsed but is not part of a tag or nonparsed data.

path name

The name of a resource that reflects its location in the repository hierarchy. A path name is composed of a root element (the first /), element separators (/) and various sub-elements (or path elements). A path element may be composed of any character in the database character set except ("\", "/" ). These characters have a special meaning for Oracle XML DB. Forward slash is the default name separator in a path name and backward slash may be used to escape characters.

PCDATA

See Parsed Character Data.

PDA

Personal Digital Assistant, such as a Palm Pilot.

principal

An entity that may be granted access control privileges to an Oracle XML DB resource. Oracle XML DB supports as principals:

Database users.

Database roles. A database role can be understood as a group, for example, the DBA role represents the DBA group of all the users granted the DBA role.

Users and roles imported from an LDAP server are also supported as a part of the database general authentication model.

prolog

The opening part of an XML document containing the XML declaration and any DTD or other declarations needed to process the document.

PUBLIC

The term used to specify the location on the Internet of the reference that follows.

RDF

Resource Definition Framework.

renderer

A software processor that produces a document in a specified format.

repository

The set of database objects, in any schema, that are mapped to path names. There is one root to the repository ("/") which contains a set of resources, each with a path name.

resource

An object in the repository hierarchy.

resource name

The name of a resource within its parent folder. Resource names must be unique (potentially subject to case-insensitivity) within a folder. Resource names are always in the UTF-8 character set (NVARCHAR2).

result set

The output of a SQL query consisting of one or more rows of data.

root element

The element that encloses all the other elements in an XML document and is between the optional prolog and epilog. An XML document is only permitted to have one root element.

SAX

See Simple API for XML.

schema

The definition of the structure and data types within a database. It can also be used to refer to an XML document that support the XML Schema W3C recommendation.

schema evolution

The process used to modify XML schemas that are registered with Oracle XML DB. Oracle XML DB provides the PL/SQL procedure DBMS_XMLSCHEMA.CopyEvolve(). This copies existing XML instance documents to temporary tables, drops and re-registers the XML schema with Oracle XML DB, and copies the XML instance documents to the new XMLType tables.

Secure Sockets Layer (SSL)

The primary security protocol on the Internet; it utilizes a public key /private key form of encryption between browsers and servers.

Server-Side Include (SSI)

The HTML command used to place data or other content into a Web page before sending it to the requesting browser.

servlet

A Java application that runs in a server, typically a Web or application server, and performs processing on that server. Servlets are the Java equivalent to CGI scripts.

SGML

See Structured Generalized Markup Language.

Simple API for XML (SAX)

An XML standard interface provided by XML parsers and used by event-based applications.

Simple Object Access Protocol (SOAP)

An XML-based protocol for exchanging information in a decentralized, distributed environment.

SOAP

See Simple Object Access Protocol.

SQL

See Structured Query Language.

SQL/XML

An ANSI specification for representing XML in SQL. Oracle SQL includes SQL/XML functions that query XML. The specification is not yet completed.

SSI

See Server-side Include.

SSL

See Secure Sockets Layer.

Structured Generalized Markup Language (SGML)

An ISO standard for defining the format of a text document implemented using markup and DTDs.

Structured Query Language (SQL)

The standard language used to access and process data in a relational database.

stylesheet

In XML, the term used to describe an XML document that consists of XSL processing instructions used by an XSLT processor to transform or format an input XML document into an output one.

SYSTEM

Specifies the location on the host operating system of the reference that follows.

SYS_XMLAGG

The native SQL function that returns as a single XML document the results of a passed-in SYS_XMLGEN SQL query. This can also be used to instantiate an XMLType.

SYS_XMLGEN

The native SQL function that returns as an XML document the results of a passed-in SQL query. This can also be used to instantiate an XMLType.

tag

A single piece of XML markup that delimits the start or end of an element. Tags start with < and end with >. In XML, there are start-tags (<name>), end-tags (</name>), and empty tags (<name/>).

TransX Utility

TransX Utility is a Java API that simplifies the loading of translated seed data and messages into a database.

UDDI

See Universal Description, Discovery and Integration.

UIX

See User Interface XML.

Uniform Resource Identifier (URI)

The address syntax that is used to create URLs and XPaths.

Uniform Resource Locator (URL)

The address that defines the location and route to a file on the Internet. URLs are used by browsers to navigate the World Wide Web and consist of a protocol prefix, port number, domain name, directory and subdirectory names, and the file name. For example, http://www.oracle.com:80/technology/tech/xml/index.htm specifies the location and path a browser will travel to find the OTN XML site on the World Wide Web.

Universal Description, Discovery and Integration (UDDI)

This specification provides a platform-independent framework using XML to describe services, discover businesses, and integrate business services on the Internet.

unmarshalling

The process of reading an XML document and constructing a tree of Java content objects. Each content object corresponds directly to an instance in the input document of the corresponding schema component.

See Also: marshalling

URI

See Uniform Resource Identifier.

URL

See Uniform Resource Locator.

User Interface XML (UIX)

A set of technologies that constitute a framework for building Web applications.

valid

The term used to refer to an XML document when its structure and element content is consistent with that declared in its associated DTD or XML schema.

W3C

See World Wide Web Consortium (W3C).

WebDAV

See World Wide Web distributed authoring and versioning.

Web Request Broker

The cartridge within Oracle Application Server that processes URLs and sends them to the appropriate cartridge.

Web Services Description Language (WSDL)

A general purpose XML language for describing the interface, protocol bindings, and deployment details of Web services.

well-formed

The term used to refer to an XML document that conforms to the syntax of the XML version declared in its XML declaration. This includes having a single root element, properly nested tags, and so forth.

Working Group (WG)

The committee within the W3C that is made up of industry members that implement the recommendation process in specific Internet technology areas.

World Wide Web Consortium (W3C)

An international industry consortium started in 1994 to develop standards for the World Wide Web. It is located at http://www.w3c.org.

World Wide Web Distributed Authoring and Versioning (WebDAV)

The Internet Engineering Task Force (IETF) standard for collaborative authoring on the Web. Oracle XML DB Foldering and Security features are WebDAV-compliant.

WSDL

See Web Services Description Language.

World Wide Web

A worldwide hypertext system that uses the Internet and the HTTP protocol.

XDBbinary

An XML element defined by the Oracle XML DB schema that contains binary data. XDBbinary elements are stored in the repository when completely unstructured binary data is uploaded into Oracle XML DB.

XDK

See Oracle XML Developer's Kit.

XLink

The XML Linking language consisting of the rules governing the use of hyperlinks in XML documents. These rules are being developed by the XML Linking Group under the W3C recommendation process. This is one of the three languages XML supports to manage document presentation and hyperlinks (XLink, XPointer, and XPath).

XML

See eXtensible Markup Language.

XML Base

A W3C recommendation that describes the use of the xml:base attribute, which can be inserted in an XML document to specify a base URI other than the base URI of the document or external entity. The URIs in the document are resolved by means of the given base.

XML Gateway

A set of services that allows for integration with the Oracle E-Business Suite to create and consume XML messages triggered by business events.

XML Namespaces

The term to describe a set of related element names or attributes within an XML document. The namespace syntax and its usage is defined by a W3C Recommendation. For example, the <xsl:apply-templates/ > element is identified as part of the XSL namespace. Namespaces are declared in the XML document or DTD before they are used, with the following attribute syntax: xmlns:xsl="http://www.w3.org/TR/WD-xsl".

XML Parser

In XML, a software program that receives an XML document and determines whether it is well-formed and, optionally, valid. The Oracle XML parser supports both SAX and DOM interfaces.

XML Pipeline Definition Language

W3C recommendation that enables you to describe the processing relations between XML resources.

XML processor

A software program that reads an XML document and processes it, that is, performs actions on the document based on a set of rules. Validity checkers and XML editors are examples of processors.

XML Query (XQuery)

The on-going effort of the W3C to create a standard for the language and syntax to query XML documents.

XML schema

A document written in the XML Schema language.

XML Schema

See XML Schema language.

XML Schema Definition

Equivalent to XML Schema language.

XML Schema language

The XML Schema language, also called simply "XML Schema," is a W3C standard for the use of simple data types and complex structures within an XML document. It addresses areas currently lacking in DTDs, including the definition and validation of data types.

Oracle XML Schema processor automatically ensures validity of XML documents and data used in e-business applications, including online exchanges. It adds simple and complex datatypes to XML documents and replaces DTD functionality with an XML schema definition XML document.

XMLSchema-instance mechanism

Allows Oracle XML DB protocol servers to recognize that an XML document inserted into Oracle XML DB repository is an instance of a registered XML schema. This means that the content of the instance document is automatically stored in the default table defined by that XML schema. Defined by the W3C XML Schema working group and based on adding attributes that identify the target XML schema to the root element of the instance document. These attributes are defined by the XMLSchema-instance namespace.

XMLSchema-instance namespace

Used to identify an instance document as a member of the class defined by a particular XML schema. You must declare the XMLSchema-instance namespace by adding a namespace declaration to the root element of the instance document. For example: xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance.

XML schema registration

When using Oracle XML DB, you must first register your XML schema. You can then use the XML schema URLs while creating XMLType tables, columns, and views.

XML SQL Utility (XSU)

This Oracle utility can generate an XML document (string or DOM) given a SQL query or a JDBC ResultSet object. XSU can also extract the data from an XML document, then insert, update, or delete rows in a database table.

XMLType

XMLType is an Oracle datatype that stores XML data using an underlying CLOB column, or object-relational columns, or a binary format within a table or view.

XMLType views

Oracle XML DB provides a way to wrap existing relational and object-relational data in XML format. This is especially useful if, for example, your legacy data is not in XML but you have to migrate it to an XML format.

XPath

The open standard syntax for addressing elements within a document used by XSL and XPointer. XPath is currently a W3C recommendation. It specifies the data model and grammar for navigating an XML document utilized by XSLT, XLink and XML Query.

XPath rewrite

Can be used when the XMLType is stored in structured storage (object-relational) using an XML schema. Queries using XPath can potentially be rewritten directly to underlying object-relational columns. XPath query rewrite is used for XPaths in SQL functions such as existsNode(), extract(), extractValue(), and updateXML(). It enables the XPath to be evaluated against the XML document without constructing the XML document in memory.

XPointer

The term and W3C recommendation to describe a reference to an XML document fragment. An XPointer can be used at the end of an XPath-formatted URI. It specifies the identification of individual entities or fragments within an XML document using XPath navigation.

XSL

See eXtensible Stylesheet Language.

XSLFO

See eXtensible Stylesheet Language Formatting Object.

XSLT

See eXtensible Stylesheet Language Transformation.

XSLT Virtual Machine (XVM)

Oracle's XSLT Virtual Machine is the software implementation of a "CPU" designed to run compiled XSLT code. The concept of virtual machine assumes a compiler compiling XSLT stylesheets to a program of byte-codes, or machine instructions for the "XSLT CPU".

XSQL pages

XML pages that contain instructions for the XSQL servlet.

XSQL servlet

A Java-based servlet that can dynamically generate XML documents from one or more SQL queries and optionally transform the documents in the server with an XSLT stylesheet.

XSU

See XML SQL Utility.

Index

A  B  C  D  E  F  G  H  I  J  L  M  N  O  P  R  S  T  U  V  W  X 

Symbols

<xsql:dml> action, 30.1, 30.1, 30.1, 30.1, 30.1, 30.1

<xsql:include-owa> action, 30.1

<xsql:include-param> action, 30.1

<xsql:include-posted-xml> action, 30.1

<xsql:include-request-params> action, 30.1

<xsql:include-xml> action, 30.1, 30.1, 30.1

<xsql:query> action, 30.1

<xsql:set-cookie> action, 30.1

<xsql:set-page-param> action, 30.1

<xsql:set-session-param> action, 30.1

<xsql:set-stylesheet-param> action, 30.1

A

access control entry, definition, Glossary

access control list, definition, Glossary

ACE, definition, Glossary

ACL, definition, Glossary

application server, definition, Glossary

attribute, definition, Glossary

B

B2B, definition, Glossary

B2C, definition, Glossary

Binary XML

saving text as, 4.3.4.1.3

binary XML

C, 19.1

decoder, 5.5.2

decoding, 5.3.2

encoder, 5.5.1

encoding, 5.3.1

Glossary, 5.2.1

models for using, 5.2

using Java, 5.5

vocabulary management, 5.4

XML DB, 5.5

binary XML for Java, 5

Binary XML Storage Format, 5.1.1

binding

clearBindValues(), 11.2.1.3

Built-in Action Handler, 15.8.1.2

Built-in Action Handler, XSQL, 15.8.1.2

Business-to-Business, definition, Glossary

Business-to-Consumer, definition, Glossary

C

C API, 16.4

C compile-time environment on UNIX

setting up, 16.2.4

C components

demos, 16.1, 17.3.1, 18.2.4, 20.4

directory structure, 16.1

globalization support

installation, 16.1

runtime environment on Windows, 16.3.3

samples, 16.1, 17.3.1, 18.2.4, 20.4

setting up Windows environment, 16.3

setting up Windows environment variables, 16.3.2

with Visual C/C++ on Windows, 16.3.5

C environment variables on UNIX, 16.2.2

C libraries

contents, 16.2.1

C runtime environment on UNIX, 16.2.3

C++ class generator, 1.2.4

C++ interface, 24.2

callback, definition, Glossary

cartridge, definition, Glossary

Cascading Style Sheets, definition, Glossary, Glossary

CDATA, definition, Glossary

Class Generator

XML C++, 29

Class Generator, definition, Glossary

CLASSPATH

XSQL Pages, 14.2.2.2

CLASSPATH, definition, Glossary

clearBindValues(), 11.2.1.3

clearUpdateColumnNames(), 11.4.6.2

command-line interface

oraxml, 4.2.3, 8.2.3

Common Object Request Broker API, definition, Glossary

Common Oracle Runtime Environment, definition, Glossary

Connection Definitions, 14.2.2.4

context, creating one in XSU PL/SQL API, 11.4.10

CORBA, definition, Glossary

CORE, definition, Glossary

creating context handles

getCtx, 11.2.1.3

custom connection manager, 15.8.4.1

D

DAD, definition, Glossary

Data Provider for .NET, 1.4.5

data variables into XML, 4.7.2

Database Access Descriptor, definition, Glossary

datagram, definition, Glossary

DB Access JavaBean, 10.1.3.3

DBMS_XMLQuery

clearBindValues(), 11.2.1.3

getXMLClob, 11.2.1.3

DBMS_XMLQuery(), 11.2.1.3

DBMS_XMLSave, 11.2.1.4

deleteXML, 11.2.1.4

getCtx, 11.2.1.4

insertXML, 11.2.1.4

updateXML, 11.2.1.4

DBMS_XMLSave(), 11.2.1.4

DBURITYPE, definition, Glossary

decoding binary XML, 5.3.2

Default SQL to XML Mapping, 11.5.1.1

demos

C components, 16.1, 17.3.1, 18.2.4, 20.4

directory structure

C, 16.1

DOCTYPE, definition, Glossary

document creation Java APIs, 2.3.3

Document Location Hint, definition, Glossary

Document Object Model, definition, Glossary

Document Type Definition, definition, Glossary

DOM

creating in Java, 4

specifications, 31.1.2.1

DOM fidelity, definition, Glossary

DOM, definition, Glossary

DOMBuilder Bean, 10.1.3.1

DTD, definition, Glossary

DTDs

external, 4.7.3.1

E

EDI, definition, Glossary

EJB, definition, Glossary

Electronic Data Interchange, definition, Glossary

element, definition, Glossary

empty element, definition, Glossary

encoding binary XML, 5.3.1

Enterprise JavaBean, definition, Glossary

entity, definition, Glossary

examples of document creation in Java, 2.3.3

eXtensible Stylesheet Language Formatting Object, definition, Glossary

eXtensible Stylesheet Language Transformation, definition, Glossary

eXtensible Stylesheet Language, definition, Glossary

F

FileReader not for system files, 4.7.4.1

FOP

serializer, 14.2.3

serializer to produce PDF, 15.7

FOP, definition, Glossary

G

generated XML

customizing, 11.5.1.3

generating XML, 11.2.4.1

using DBMS_XMLQuery, 11.2.1.3

using XSU command line, getXML, 11.2.4.1

getCtx, 11.2.1.3, 11.2.1.4

getXML, 11.2.4.1

getXMLClob, 11.2.1.3

globalization support

for the C components, 16.5

H

HASPATH, definition, Glossary

hierarchical indexing, definition, Glossary

HTML Form Parameters, 14.5.2.4

HTTP Parameters, 14.5.1

HTTP POST method, 14.5.3.2

HTTPURITYPE, definition, Glossary

I

IDE, definition, Glossary

IIOP, definition, Glossary

infoset, 5.3

infoset, definition, Glossary

INPATH, definition, Glossary

insert, XSU, 11.5.2.2

insertXML, 11.2.1.4

installation

C components, 16.1

instance document, definition, Glossary

instantiate, definition, Glossary

Integrated Development Environment, definition, Glossary

invalid characters, 4.7.4.6

J

JAR files, DTDs, 4.7.3.1

Java 2 Platform, Enterprise Edition, definition, Glossary

Java API for XML Processing (JAXP), definition, Glossary

Java Architecture for XML Binding (JAXB), definition, Glossary

Java classes deprecated, 2.3.1

Java components

creating a DOM, 4

environment in Windows, 3.3.2

installation, 3.1

parsing, 4

Java Database Connectivity, definition, Glossary

Java Naming and Directory Interface, definition, Glossary

Java Runtime Environment, definition, Glossary

Java, definition, Glossary

JavaBean, definition, Glossary

JAXB

class generator, 1.2.4

compared with JAXP, 8.1, 8.2

features not supported, 8.2.4

marshalling and unmarshalling, 8.1

validating, 8.1

what is, 8.2

JAXP

compared with JAXB, 8.1

JAXP (Java API for XML Processing), 4.5

JCR 1.0 standard, 4.1.2

JDBC driver, 11.2.1.1

JDBC, definition, Glossary, Glossary

JDeveloper, 1.4.1

JDeveloper, definition, Glossary

JDK, definition, Glossary

JNDI, definition, Glossary

JRE, definition, Glossary

JSP, definition, Glossary

JSR 170 standard, 4.1.2

JSR, definition, Glossary

JVM, definition, Glossary, Glossary

L

lazy type conversions, definition, Glossary

listener, definition, Glossary

M

make.bat file

editing on Window for C environment, 16.3.4.1.1

mapping

primer, XSU, 11.5.1

method

getDocument(), DOMBuilder Bean, 10.2.1.1

methods

addXSLTransformerListener(), 10.2.1.2

domBuilderError(), 10.2.1.1

DOMBuilderOver(), 10.2.1.1, 10.2.1.2

domBuilderStarted(), 10.2.1.1

Microsoft .NET, 1.4.5

Multimedia, definition, Glossary

N

name-level locking, definition, Glossary

namespace, definition, Glossary

.NET, 1.4.5

no rows exception, 11.3.9.2

node, definition, Glossary

notation attribute declaration, definition, Glossary

O

OAG, definition, Glossary

OASIS, definition, Glossary

OC4J, definition, Glossary

OCI and the XDK C, 18.7

OCI examples, 18.7.5

Open Applications Group, definition, Glossary

Oracle Content Management SDK, definition, Glossary

Oracle Text, definition, Glossary

Oracle XML DB, definition, Glossary

ORACLE_HOME, definition, Glossary

Oracle9i JVM, 4.2

OracleXML

XSU command line, 11.2.4

OracleXml namespace, 24.3

OracleXMLSQLException, 11.3.9

orastream functions, 18.4

oraxml, 4.2.3, 8.2.3

oraxsl

command line interfaces, 6.2.3

ORB, definition, Glossary

Ordered Collection in Tables, definition, Glossary

Out Variable, using xsql

dml, 14.5.2.5

P

Package Classes, 2.3.1

parent element, definition, Glossary

parseDTD() method, 4.7.3.1

Parser for Java, 4

constructor extension functions, 6.4.4

oraxsl, 6.2.3

return value extension function, 6.4.5

supported database, 4.2

using DTDs, 4.7.3

Parser for Java, overview, 4.2

path name, definition, Glossary

PCDATA, definition, Glossary

PDA, definition, Glossary

PDF results using FOP, 14.2.3

Personal Digital Assistant, definition, Glossary

Pipeline Definition Language, 9.1

Pipeline Definition Language, definition, Glossary

PL/SQL

generating XML with DBMS_XMLQuery, 11.2.1.3

principal, definition, Glossary

prolog, definition, Glossary

PUBLIC, definition, Glossary

R

renderer, definition, Glossary

Reports, Oracle, 1.4.3

repository, definition, Glossary

Resource Definition Framework, definition, Glossary

resource name, definition, Glossary

resource, definition, Glossary

result set, definition, Glossary

root element, definition, Glossary

S

samples

C components, 16.1, 17.3.1, 18.2.4, 20.4

SAX, definition, Glossary

schema evolution, definition, Glossary

schema, definition, Glossary

Secure Sockets Layer, definition, Glossary

security, XSQL Pages, 14.5.4

select

with XSU, 11.5.2.1

Server-Side Include (SSI), definition, Glossary

servlet, definition, Glossary

servlet, XSQL, 14, 15

setKeyColumn(), 11.3.8.2, 11.4.8.2

setMaxRows, 11.4.3

setRaiseNoRowsException(), 11.4.3

setSkipRows, 11.4.3

setStylesheetHeader(), 11.4.4

setUpdateColumnName(), 11.4.6.2

setUpdateColumnNames()

XML SQL Utility (XSU)

setUpdateColumnNames(), 11.2.3, 11.3.7.2

setXSLT(), 11.4.4

SGML, definition, Glossary

Simple API for XML, definition, Glossary

Simple Object Access Protocol (SOAP), definition, Glossary

SOAP

C clients, 22.1.2

C examples, 22.3

C Functions, 22.2

for C, 22.1

server, 22.1.3

what is, 22.1.1

SOAP, definition, Glossary

SQL, definition, Glossary

SQL/XML, definition, Glossary

SSI, definition, Glossary

storing XML in the database, 11.2.1.4

streaming validator, 20.5

opaque mode, 20.5.2

transparent mode, 20.5.1

string data, 4.7.4.6

stylesheet, definition, Glossary

SYS_XMLAGG, definition, Glossary

SYS_XMLGEN, definition, Glossary

SYSTEM, definition, Glossary

T

tag, definition, Glossary

TransX Utility, 12

TransX Utility, definition, Glossary

U

UIX, 1.4.2

UIX, definition, Glossary

Unicode in a system file, 4.7.4.1

unified C API for XDK and XML DB, 16.4

Unified Java API, 2, 2.1, 2.1

unified Java API, 2.1, 2.1, 2.1

Unified Java API new objects and methods, 2.3.3

Uniform Resource Identifier, definition, Glossary

Uniform Resource Locator, definition, Glossary

UNIX environment for C components

configuring, 16.2

update, XSU, 11.5.2.3

URI, definition, Glossary

URL, definition, Glossary

User Interface XML, 1.4.2

User Interface XML (UIX), definition, Glossary

UTF-16 Encoding, 4.7.4.5

UTF-8 output, 4.7.4.3

V

valid, definition, Glossary

validation

auto validation mode, 4.1.10, 4.1.10

DTD validating Mode, 4.1.10

partial validation mode, 4.1.10

schema validation, 4.1.10

schema validation mode, 4.1.10

Visual C/C++, 16.3.5

Visual Studio, 16.3.5

W

W3C, definition, Glossary

Web Request Broker, definition, Glossary

WebDAV, definition, Glossary, Glossary

well-formed, definition, Glossary

WG, definition, Glossary

Windows, 16.3

C components

with Visual C/C++, 16.3.5

C libraries, 16.3.1

editing make.bat file, 16.3.4.1.1

setting up C environment variables, 16.3.2

Windows environment for C components

setting up, 16.3

WML Document, 14.5.2.1

World Wide Web Consortium, definition, Glossary

World Wide Web Distributed Authoring and Versioning, definition, Glossary

World Wide Web, definition, Glossary

WRB, definition, Glossary

X

XDBbinary, definition, Glossary

Xdiff instance document, 21.2.6

Xdiff schema, 21.2.10

XDK components, 1.1

XDK version

using C, 16.2.5

using Java, 3.4, 23.2.5

XDK, definition, Glossary

XLink, definition, Glossary

XML Base, 31.1.1

XML Base, definition, Glossary

XML C++ Class Generator, 29

XML Developer's Kit (XDK), definition, Glossary

XML documents

generating from C, 1.3.2

generating from C++, 1.3.3

generating from Java, 1.3.1

XML Gateway, 1.4.4

XML Gateway, definition, Glossary

XML Namespaces 1.0, 31.1.1

XML output in UTF-8, 4.7.4.3

XML parser

oraxml command-line interface, 4.2.3, 8.2.3

XML parser for C

sample programs, 17.3.1, 18.2.4

XML parser, definition, Glossary

XML pull parser

example, 18.6.5

XML Pull Parser error handling, 18.6.4

XML Pull Parser for C, 18.6

XML Query, definition, Glossary

XML Schema

explained, 7.1.4

processor for Java

how to run the sample program, 6.2.2, 7.2.2, 8.2.2, 9.2.2, 12.2.2

XML schema for C

sample programs, 20.4

XML schema registration, definition, Glossary

XML Schema, definition, Glossary

XML SQL Utility, Glossary

XML SQL Utility (XSU), 1.2.7

advanced techniques, exception handling (PL/SQL), 11.4.9

clearBindValues() with PL/SQL API, 11.2.1.3

connecting with OCI* JDBC driver, 11.2.1.1

creating context handles with getCtx, 11.2.1.3

customizing generated XML, 11.5.1.3

DBMS_XMLQuery, 11.2.1.3

DBMS_XMLSave(), 11.2.1.4

dependencies and installation, 11.2.1

explained, 11.2

getXML command line, 11.2.4.1

getXMLClob, 11.2.1.3

inserts, 11.5.2.2

mapping primer, 11.5.1

selects, 11.5.2.1

setKeyColumn() function, 11.3.8.2

setRaiseNoRowsException(), 11.4.3

updates, 11.5.2.3

XML SQL Utility XSU)

setXSLT(), 11.4.4

XML, definition, Glossary

xmlcg usage, 29.3

XMLCompress JavaBean, 10.1.3.6

XMLDBAccess JavaBean, 10.1.3.4

XmlDiff command line utility, 21.2.4

XMLDiff example, 21.2.11

XMLDiff in C, 21.1

XMLDiff JavaBean, 10.1.3.5

XMLGEN, is obsolete. See DBMS_XMLQUERY and DBMS_XMLSAVE, 11.2.1

XmlHash, 21.4

XMLNode.selectNodes() method, 4.7.1

XmlPatch, 21.3

XMLSchema-instance mechanism, definition, Glossary

XMLSchema-instance namespace, definition, Glossary

XMLType views, definition, Glossary

XPath rewrite, definition, Glossary

XPath, definition, Glossary

XPointer, definition, Glossary

XSDBuilder, 4.1.10

XSL Transformation (XSLT) Processor, 1.2.2

XSL Transformation (XSLT) Processor for Java, 6.2, 9.2, 12.2

XSL Transformations Specifications, 31.1.2.2

XSL, definition, Glossary

XSLFO, definition, Glossary

XSLT

XSLTransformer bean, 10.2.1.2

XSLT compiler, 17.1

XSLT processor, 17.2

XSLT Processor for Java

hints for using, 6.5

XSLT stylesheets

setStylesheetHeader() in XSU PL/SQL, 11.4.4

setXSLT() with XSU PL/SQL, 11.4.4

XSLT, definition, Glossary

XSLTransformer JavaBean, 10.1.3.2

XSLValidator JavaBean, 10.1.3.7

XSQL

action handler errors, 15.4.2

advanced topics, 15

built-in action handler elements, 15.8.1.2

connection, 14.5.2.6, 14.5.2.7

current page name, 14.5.2.8

errors, 14.5.3.1

setting up demos, 14.2.3.1, 14.2.3.2

SOAP support, 14.5.2.6

stylesheets, 15.2

two queries, 14.5.2.3

XSQL Pages security, 14.5.4

XSQL servlet

hints, 14.5.2

XSQL Servlet examples, 14.2.3

XSQL, definition, Glossary, Glossary

XSU

generating XML, 11.2.4.1

mapping primer, 11.5.1

usage guidelines, 11.5.1

XSU (XML SQL Utility), 1.2.7

XSU usage techniques, 11.5

XVM

XSLT compiler, 17.1.2

XVM (XSLT Virtual Machine) processor, 17.1

XVM, definition, Glossary

XML documents can either be input to XML Parser or generate Java or C++ classes by JAXB or C++ Class Generator. The Java application can output XML.

XML Schema Validator can be optionally applied to the XML Parser output.

XML Schema can also be input to XML Schema Validator. The output classes as well as the XML Schema Validator output are input to SAX, or DOM, or XML Compressor. The DOM tree output is input to XSLT processor, which also receives input from an XSL Stylesheet.

The XSLT processor outputs a transformed XML document.

The compressed XML is another output, coming from the XML Compressor.

A window marked "Options" is shown with tab "Directories" selected. Library Files is in box "Show Directories for". The directory is shown as entered in the "Directories" box.

This diagram is explained in the following text.

An Internet Explorer window shows the XML results:

For ROW NUM = 1, CARRIER = VS, FLIGHTNUMBER = 344,

ORIGIN = London, DUE = 16:10, and so on

The figure is described in the follwing section.

The figure is described in the following basic steps.

This illustration is described in the surrounding section, "How to Use XSL Transformer JavaBean."

This illustration shows Industry Standard XML formatting in a window:

"flight airline", "number", and "arrives" as elements.

The illustration is described in the following basic steps list:

This illustration is described in the section containing it, "XML Schema Processor for C Usage Diagram."

This illustration is of a "Project Settings" window in Visual C++. The tab "Link" is selected. Settings for Win32 Debug is selected in FullDOM. Category selected is "General."

This illustration is described in the preceding text in this section, "XML SQL Utility in the Middle Tier."

This figure is described in the surrounding text.

The figure shows a section of the XSQL home page displayed in Internet Explorer.

The figure is described in the following section.

The figure is explained in the follwing section.

The illustration is described in following basic steps list.

This illustration also shows the main XDK for C components used when generating XML documents from the database. These components include XML Parser and XSLT processor. A user at a browser requests data from the database through a C program. This request is fed to the Parser, which can optionally use the XSLT processor. The output is displayed on the browser.

A window displays HTML of the same data --

output of flights as in the last illustrations in this chapter.

Three columns display an airline symbol, flight number and arrival time.

This illustration is described in the surrounding

section "DOMBuilder JavaBean Usage".

This illustration is described in the text above in the sections "Without DTD Input" and "With a DTD."

First create a JDBC connection. Send a SQL query to a JDBC Result Set, which is input to an OracleXMLQuery() instance, or directly to an OracleXMLQuery() instance which sends either a getXMLDOM() call to a DOM object, or a getXMLString() call to an XMLString object. These produce output for further processing.

The XML-SQL utility for Java stores and retrieves XML documents in the database. This illustration also shows the SQL or object queries passing through the XML-SQL Utility for Java, which produces an XML document of query results as a string or DOM tree.

A DTD file or XML schema file is input to XML Parser for Java,

which passes parsed data to Oracle JAXB Class Generator, which

outputs Java classes (one class per element) to the application.

The output from the application is a valid XML document.

A window shows the "Options" window. Tab "Directories" is selected, Win32 is the Platform, and the include path is entered in the "Directories" box.

This figure is described in the text above it.

The XML Parser reads the XML document. Storage units (entities) are output. These are divided into Unparsed and Parsed Data. The parsed data outputs characters, which are divided into character data and markup.

This illustration is described in the preceding text in this section, "XML SQL Utility in a Web Server." SQL data is inserted and selected from any database by JDBC, which inputs or outputs it into or from XSQL servlets and XML SQL Utility. XML is input and output by and to the user through the Internet.

Inputs to the encoder are XML text which is read via SAX events and the pull parser, and a schema from the repository, going through a vocabulary manger.

To register the table, you must set the options, insert XML into the table, and close.

The visual tool "XML Authority" displays the flight-list DTD.

This XML format is described immediately following the illustration.

An XML document is input to first, an XML parser, then an XSD processor, then an XSL processor, and then an XML compressor.

This illustration shows the XML document. The DOM interface creates a tree structure based on the XML document, which is useful for applications that include changes, for example, re-ordering, adding, or deleting elements. The SAX interface creates a series of linear events based on the XML document.

This figure is explained in the paragraphs that immediately precede it.

TransX Utility and XSQL Servlet depend on XML SQL Utility. XSQL Servlet also depends on the Web Server. XML SQL Utility depends on XML Schema Processor and JDBC driver. Class Generator and XML Schema Processor depend on XML Parser, XSLT processor, XML Pipeline, and JAXB. JDBC Driver depends on NLS. XML Parser, XSLT processor, XML Pipeline, JAXB, NLS, and the Web Server all depend on the JDK.

The development tools such as XSQL Pages Publishing Framework, JDeveloper, BC4J, Oracle Reports, and UIX, can feed into APIs which output to Oracle Application Server, Apache server, and Java-enabled server. The APIs also output XML documents for business data exchange, using AQ streams and IDAP.

This illustration is described in the surrounding section, "What Can I Do with Oracle XSQL Pages?" Web SErver is on top of Servlet Engine, which is on top of XSQL Servlet and JSPRuntime. XSQL Servlet is on top of XSQL Page Processor which contains the XML Parser, XML SQL, XSLT Processor, and JDBC.

This illustration is described in the text. It shows schematically the main XDK for Java components used when generating XML documents from the database. These components include XML Parser, Class Generator, XSQL Servlet, and XML SQL Utility.

XSQL Servlet consists of XML SQL Utility and XML Parser.

They have output in HTML, Text, or XML that can be displayed in a browser.

This diagram is explained in the text. These methods are also available to SAXParser():

setValidationMode()
setPreserveWhiteSpace()
setDocType()
setBaseURL()

This figure shows the original XML document, the optional DTD, and the optional Schema files as input to the parser. Parser output is then input to the DOM/SAX Parser, which also receives input from the XSL stylesheet. Parsed XSL commands and the parsed XML go to the XSLT processor, which outputs the transformed XML document.

This diagram is explained in the text. It shows how XML SQL Utility can run in the database to generate and store XML documents. It is described in this section, "XML SQL Utility in the Database".

This diagram is explained in the preceding text in the section "XML Schema Processor for Java Usage".

This illustration also shows the main XDK for C++ components used when generating XML documents from the database. These components include XML Parser, XSLT processor, and Class Generator. A user at a browser requests data from the database through a C++ program. This is fed to the Parser, which can optionally use the XSLT processor, or the C++ Class Generator. The output is displayed on the browser.

An XML document or DTD is input. The XML Parsers for Java, C, or C++ pass output to DOM/SAX for Java, C, or C++ respectively, which passes output to and from an application in Java, C, or C++ respectively.

This diagram is explained in the section around it, "DBAcess JavaBean Usage".

This illustration is described in the following section.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2012, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Alpha and Beta Draft Documentation Notice

If this document is in prerelease status:

This documentation is in prerelease status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.