Package com.goldencode.p2j.xml

Classes used to simplify manipulation of XML documents, including parsing, programmatic creation, and serialization.

See: Description

Interface Summary

Interface	Description
Encoding	Defines the ENCODING attribute.
SaxAttributes	Interface describing SAX-Attributes specific features of the SAX objects.
SaxEntity	Interface describing the common features for SAX Reader, SAX Writer and SAX Attributes Progress support objects.
SaxReader	Interface describing SAX-Reader specific features of the SAX objects.
SaxWriter	Interface describing SAX-Writer specific features of the SAX objects.
XCommon	Interface decribing the common features for XML related objects.
XDocument	Interface describing X-Document specific features of the DOM XML objects.
XEntity	Interface describing the common features for DOM and SAX XML support objects.
XmlSchema	Defines the SCHEMA-LOCATION and SCHEMA-PATH attribute.
XmlTokenTypes	Token types necessary to represent an XML Document Object Model in AST form.
XNodeRef	Interface describing X-Node-Reference specific features of the DOM XML objects.

Class Summary

Class	Description
EscapeControlCharsReader	Escape all ISO control characters from this reader, to be valid in XML 1.1.
SaxAttributesImpl	Interface describing SAX-Attributes specific features of the SAX objects.
SaxEntityImpl	Implementation the common features for SAX Reader, SAX Writer and SAX Attributes Progress support objects.
SaxReaderImpl	Implementation SAX-Reader specific features of the SAX objects.
SaxReaderImpl.FileInputStreamWrapper	Special wrapper to wrap read from file in lazy mode.
SaxReaderImpl.LongcharInputStream	Special wrapper to wrap read from longchar in lazy mode.
SaxReaderImpl.MemptrInputStream	Special wrapper to wrap read from memptr in lazy mode.
SaxWriterImpl	Implementation SAX-Writer specific features of the SAX objects.
SaxWriterImpl.FileOutputStreamWrapper	Special wrapper to wrap write to file in lazy mode.
SaxWriterImpl.LongcharOutputStream	Special wrapper to wrap write to longchar in lazy mode.
SaxWriterImpl.MemptrOutputStream	Special wrapper to wrap write to memptr in lazy mode.
XCommonImpl	Implementation the common features for XML related Progress objects.
XDocumentImpl	Implementation of the X-Document specific features of the Progress DOM XML support objects.
XEntityImpl	Implementation of the common features for DOM.
XmlAst	Provides symbolic token name lookups that are specific to the XML AST.
XMLCallbackWrapper	This class provides implementations for all of the possible 4gl-sax callbacks.
XmlFactory	The set of methods to work with DOM XML and SAX support implementation in P2J.
XmlPatternWorker	A pattern worker that provides services to support the manipulation of XML ASTs and their persistence in document object model (DOM) form.
XNodeRefImpl	Implementation of the X-Node-Reference specific features of the Progress DOM XML support objects.

Enum Summary

Enum	Description
SaxReader.ReadStatus	List of possible states of SAX-READER object, returned by the PARSE-STATUS attribute: SaxReader.ReadStatus.SAX_UNINITIALIZED -The SAX-UNINITIALIZED constant which in 4GL is the integer value 1. SaxReader.ReadStatus.SAX_RUNNING - The SAX-RUNNING constant which in 4GL is the integer 2. SaxReader.ReadStatus.SAX_COMPLETE - The SAX-COMPLETE constant which in 4GL is the integer 3. SaxReader.ReadStatus.SAX_PARSER_ERROR - The SAX-PARSER-ERROR constant which in 4GL is the integer 4.
SaxWriter.WriteStatus	List of possible states of SAX-READER object, returned by the PARSE-STATUS attribute: SaxWriter.WriteStatus.SAX_WRITE_IDLE -The SAX-WRITE-IDLE constant which in 4GL is the integer value 1. SaxWriter.WriteStatus.SAX_WRITE_BEGIN - The SAX-WRITE-BEGIN constant which in 4GL is the integer 2.
XMLCallbackWrapper.CallBack	List of possible callbacks of SAX-READER object: XMLCallbackWrapper.CallBack.StartDocument -Start Document callback. XMLCallbackWrapper.CallBack.EndDocument - End Document callback. XMLCallbackWrapper.CallBack.ResolveEntity - ResolveEntity callback. XMLCallbackWrapper.CallBack.NotationDecl - Notation Declaration callback. XMLCallbackWrapper.CallBack.UnparsedEntityDecl - Unparsed Entity Declaration callback. XMLCallbackWrapper.CallBack.StartPrefixMapping - Start Prefix Mapping callback. XMLCallbackWrapper.CallBack.EndPrefixMapping - End Prefix Mapping callback. XMLCallbackWrapper.CallBack.StartElement - Start Element callback. XMLCallbackWrapper.CallBack.EndElement - End Element callback. XMLCallbackWrapper.CallBack.Characters - Characters callback. XMLCallbackWrapper.CallBack.IgnorableWhitespace - Ignorable Whitespace callback. XMLCallbackWrapper.CallBack.ProcessingInstruction - Processing Instruction callback. XMLCallbackWrapper.CallBack.Warning - Warning callback. XMLCallbackWrapper.CallBack.Error - Error callback. XMLCallbackWrapper.CallBack.FatalError - FatalError callback.

Exception Summary

Exception	Description
MismatchedNumberParametersException	Special exception that is thrown then number of parameters in invoked procedure is not equal.
MismatchedParametersException	Special error throws if some parameter mismatch type.

Package com.goldencode.p2j.xml Description

Classes used to simplify manipulation of XML documents, including parsing, programmatic creation, and serialization.

Author	Eric Faulhaber
Date	June 14, 2007
Access Control	CONFIDENTIAL

Contents

Introduction
Dependencies
TODOs

Introduction

This package contains classes which provide simplified access to XML documents using the Document Object Model (DOM) idiom. Transformation between DOM objects and AST representations is supported. XML Document objects can originate from various sources:

• parsed from an XML document in the file system or a character stream, using an XML parser;
• dynamically built in memory using the org.w3c.dom package;
• transformed from an AST.

Once in memory a DOM can be:

• serialized to a file or character stream, either formatted (pretty printed), or unformatted (no additional whitespace);
• transformed into an AST.

Dependencies

This package has dependencies on the following J2SE packages:

• javax.xml.parsers
• javax.xml.transform
• javax.xml.transform.dom
• javax.xml.transform.stream
• org.w3c.dom

The current implementation uses only public APIs within these packages, however, there is one vendor specific dependency introduced when porting this package to Java Standard Edition 6. Namely, the XmlHelper.write(Document dom, Writer writer, boolean pretty) method currently relies upon the Apache Xalan XSLT processor for formating support when performing pretty printing. Specifically, we pass an output property of "{http://xml.apache.org/xslt}indent-amount" (a Xalan-specific extension) to the Transformer class when serializing a DOM to an output stream. The intention is to remove this dependency in a future implementation, which will insulate us from changes to the underlying XSLT implementation, should this change in future Java versions.

TODOs

1. Remove the Xalan XSLT processor dependency for pretty printing.
2. Invent a mechanism for tracking line and column numbers for XML documents, as well as source file names for those documents which originate from the file system. This would be very helpful for providing more useful diagnostic information when reporting TRPL errors and warnings.
3. Add logging.