uCosminexus Application Server XML Processor User Guide

uCosminexus Application Server

XML Processor User Guide

3020-3-Y22-10(E)

Contents

Notices

Summary of amendments

Preface

1. An Overview of Cosminexus XML Processor

1.1 Product Features of Cosminexus XML Processor

1.1.1 Enables Creation of Cross-platform Programs

1.1.2 Enables Easy Parsing of XML Documents Using Java Programs

1.1.3 Enables Easy Transformation of XML Documents Using Java Programs

1.1.4 Improves the ease in development of XML-based applications

1.2 Positioning of Cosminexus XML Processor

1.3 Range of Features Supported by Cosminexus XML Processor

1.3.1 Available functions such as the XML Parser and XSLT Transformer

1.3.2 Character encodings that can be processed

1.3.3 Shift_JIS Switch Function

1.3.4 XSLTC Transformer Function

1.3.5 Schema cache functionality

1.3.6 High-speed parse support function

1.3.7 Apache-specific functions

2. JAXP and JAXB Functionality

2.1 About JAXP

2.2 JAXP-defined Packages and Their Functionality

2.2.1 javax.xml.parsers Package

2.2.2 javax.xml.stream Package

2.2.3 javax.xml.stream.events Package

2.2.4 javax.xml.stream.util Package

2.2.5 javax.xml.transform Package

2.2.6 javax.xml.transform.dom Package

2.2.7 javax.xml.transform.sax Package

2.2.8 javax.xml.transform.stax Package

2.2.9 javax.xml.transform.stream Package

2.2.10 javax.xml.validation Package

2.2.11 javax.xml.xpath Package

2.2.12 javax.xml.namespace Package

2.2.13 javax.xml.datatype Package

2.2.14 javax.xml Package

2.2.15 org.w3c.dom Package

2.2.16 org.w3c.dom.bootstrap Package

2.2.17 org.w3c.dom.ls Package

2.2.18 org.w3c.dom.events Package

2.2.19 org.xml.sax Package

2.2.20 org.xml.sax.ext Package

2.2.21 org.xml.sax.helpers Package

2.3 About JAXB

2.4 JAXB-defined Packages and Their Functionality

2.5 JAXB commands

2.5.1 csmxjc command (Binding from the XML Schema to Java)

2.5.2 csmschemagen command (Mapping from Java to the XML Schema)

3. Extended Functions of Cosminexus XML Processor

3.1 Shift_JIS Switch Function

3.2 XSLTC Transformer Function

3.2.1 An Overview of XSLTC Transformer

3.2.2 XSLTC Transformer-based System Development and Operation

3.2.3 Class Used by the XSLTC Transformer

3.2.4 How to use the XSLTC Transformer

3.3 Schema cache functionality

3.3.1 Overview of the schema cache functionality

3.3.2 Processing of the schema cache functionality

3.3.3 Setting up the schema cache

3.3.4 Using the schema cache

3.3.5 Deleting and resetting the schema cache

3.3.6 About using the most appropriate schema cache

3.4 High-speed parse support function

3.4.1 Overview of the high-speed parse support function

3.4.2 Flow of operations for high-speed parse

3.4.3 Creating the Pre-Parse XML document

3.4.4 Generating the preparsed object

3.4.5 Setting up the preparsed object

3.4.6 Parsing the XML document

3.4.7 Classes used in preparing the high-speed parse support function

3.4.8 Coding example for using the high-speed parse support function

3.4.9 Tuning the Pre-Parse XML document

3.4.10 Details of the tuning summary file

3.4.11 Details of the tuning details file

3.5 Apache-specific functions

3.5.1 Features that can be set up

3.5.2 Properties that can be set up

3.5.3 Namespace URIs that can be set up

3.6 Correspondence Between Error Messages in XML Schema and W3C Specifications

3.7 Parser Switching functionality

3.7.1 Overview of the Parser Switching functionality

3.7.2 Usage of the Parser Switching functionality

3.7.3 Performance of the Parser Switching functionality

3.7.4 Notes on the Parser Switching functionality

3.8 Compatibility option functionality

3.8.1 Overview of the compatibility option functionality

3.8.2 How to set up the compatibility option functionality

4. How to Use Features and Properties

4.1 How to Use the SAX2 Features and Properties

4.2 How to use StAX properties

4.3 How to use XSLT features

4.4 How to Use the XML Schema Properties

4.4.1 How to Set the XML Schema Properties for the DOM Parser

4.4.2 How to Set the XML Schema Properties SAX Parser

4.4.3 How to Set the Schema Document in the XML Document

4.5 How to use the properties of the Shift_JIS switch function

4.5.1 How to Use the Shift_JIS Switch Function for the DOM Parser

4.5.2 How to Use the Shift_JIS Switch Function for the SAX Parser

4.5.3 How to Use the Shift_JIS Switch Function for the XSLT Transformer

4.6 How to use the properties of the high-speed parse support function

4.6.1 How to set up the preparsed object in DocumentBuilder

4.6.2 How to set up the preparsed object in SAXParser

4.6.3 How to set up the preparsed object in XMLReader

4.7 How to use the properties of JAXB

5. How to Create a Program

5.1 General Procedure for Creating a Program

5.2 Package Names Used by Cosminexus XML Processor

5.3 Troubleshooting Program Execution

5.4 Sample Program that Uses the DOM Parser

5.4.1 Processing Performed by the Sample Program

5.4.2 General Procedure for Creating the Sample Program

5.4.3 Sample program (SampleDOM.java)

5.4.4 Execution Result of the Sample Program (SampleDOM.java)

5.5 Sample Program that Uses the SAX Parser

5.5.1 Processing Performed by the Sample Program

5.5.2 General Procedure for Creating the Sample Program

5.5.3 XML Document to Use (SampleSAX.xml)

5.5.4 Sample Program (SampleSAX.java)

5.5.5 Execution Result of the Sample Program (SampleSAX.java)

5.6 Sample Program that Uses the XML Schema

5.6.1 Processing Performed by the Sample Program

5.6.2 XML Document to Use (purchaseOrder.xml and purchaseOrder-fail.xml)

5.6.3 Schema Documents to Use (purchaseOrder.xsd, personalData.xsd)

5.6.4 Sample Program When Using the DOM parser

5.6.5 Sample Program When Using the SAX Parser

5.7 Sample Program that Uses the XSLT Transformer

5.7.1 Processing Performed by the Sample Program

5.7.2 General Procedure for Creating the Sample Program

5.7.3 XML Document to Use (SampleXSLT.xml)

5.7.4 XSL File to Use (SampleXSLT.xsl)

5.7.5 Sample Program (SampleXSLT.java)

5.7.6 Execution Result of the Sample Program (SampleXSLT.java)

5.8 Sample Program that Uses the XSLTC Transformer

6. Notes on Using Cosminexus XML Processor

6.1 Notes common to JAXP1.4 functions

6.1.1 Range supported in the javax.xml.transform.stax.StAXSource class and the javax.xml.transform.stax.StAXResult class

6.1.2 Other notes

6.2 Notes on the DOM Parser

6.3 Notes on the SAX Parser

6.4 Notes on StAX

6.5 Notes on the Schema Validation

6.6 General Notes on XSLT and XSLTC

6.7 Notes on XSLT

6.7.1 Cases Where XSLT Does Not Report Errors

6.7.2 Other Notes

6.8 Notes on XSLTC

6.8.1 Notes on the Stylesheet Size

6.8.2 Notes on Transformation Performance

6.8.3 Notes on XSLT Elements

6.8.4 Notes on the XPath Expression

6.8.5 Cases where XSLTC Does Not Report Errors

6.8.6 Other Notes

6.9 Notes on the javax.xml.datatype Package

6.10 Notes on the javax.xml.validation Package

6.11 Notes on the javax.xml.xpath Package

6.12 Notes on the org.w3c.dom Package

6.13 Notes on the org.w3c.dom.bootstrap Package

6.14 Notes on the org.w3c.dom.ls Package

6.15 Notes on the org.xml.sax.ext Package

6.16 Notes on XInclude

6.17 Notes on implementation-dependent specifications

6.18 Precautions related to the schema cache functionality

6.18.1 Precautions related to performance

6.18.2 Precautions related to error output

6.18.3 Precautions related to schema definition files

6.18.4 Precautions related to reset up and deletion of a cache

6.19 Notes on the high-speed parse support function

6.19.1 Notes on setting up the preparsed object

6.19.2 Notes on the XML parser using the preparsed object

6.19.3 Notes on XML1.1

6.19.4 Notes on XInclude (high-speed parse support function)

6.19.5 Notes on how to specify an absolute path

6.19.6 Notes on the Pre-Parse XML document

6.19.7 Notes on tuning information

6.19.8 Notes on parse performance

6.20 Notes on JAXB

6.20.1 Common notes

6.20.2 Notes on schema compiler

6.20.3 Notes on schema generator

6.20.4 Notes on runtime

6.21 General XML Processor related notes

Appendixes

A. Differences Between Versions

A.1 Differences in Behaviors Between DOM and SAX Parser Versions

A.2 Differences in Behaviors Between DOM Parser Versions

A.3 Differences in Behaviors Between SAX Parser Versions

A.4 Differences in Behaviors of Schema Validation Between Versions

A.5 Differences in Behaviors of XSLT Between Versions

A.6 Differences in the JAXB operation

A.7 Differences in the operation of the javax.xml.datatype package

A.8 Differences in the operation of the high-speed parse functionality

A.9 Differences in the operation of StAX

A.10 Differences in the operations of the Apache-specific functionality

B. Support Range of JAXB Specifications

B.1 Support range of the JAXB functions

B.2 Support range for JAXB characters

B.3 Support range of functions assumed as vendor-specific according to JAXB specifications

C. Efficiently using XML Processor

C.1 Basic functionality of XML Processor

C.2 Application functionality of XML Processor

C.3 Know-how for efficiently using XML Processor

D. Glossary

Index