Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XercesParserLiaison Class Reference

#include <XercesParserLiaison.hpp>

Inheritance diagram for XercesParserLiaison

Inheritance graph

[legend]
Collaboration diagram for XercesParserLiaison:

Collaboration graph

[legend]
List of all members.

Public Types

Public Methods

Static Public Methods

Protected Methods


Member Typedef Documentation

typedef std::map<const XalanDocument*, XercesDocumentBridge*> XercesParserLiaison::DocumentMapType
 


Constructor & Destructor Documentation

XercesParserLiaison::XercesParserLiaison ( XercesDOMSupport & theSupport )
 

Construct a XercesParserLiaison instance.

Parameters:
theSupport   instance of DOMSupport object

virtual XercesParserLiaison::~XercesParserLiaison ( ) [virtual]
 


Member Function Documentation

virtual DOMParser* XercesParserLiaison::CreateDOMParser ( ) [protected, virtual]
 

virtual SAXParser* XercesParserLiaison::CreateSAXParser ( ) [protected, virtual]
 

virtual void XercesParserLiaison::SetShouldExpandEntityRefs ( bool b ) [virtual]
 

Set whether to expand all entity references in the source and style trees.

Parameters:
b   true if entity references should be expanded

Reimplemented from XMLParserLiaison.

virtual XalanDocument* XercesParserLiaison::createDOMFactory ( ) [virtual]
 

Get a factory object required to create nodes in the result tree.

Returns:
A XalanDocument instance.

Reimplemented from XMLParserLiaison.

XercesDocumentBridge * XercesParserLiaison::createDocument ( const DOM_Document & theXercesDocument,
bool threadSafe,
bool buildBridge ) [protected, virtual]
 

Create a XalanDocument proxy for an existing Xerces document.

Parameters:
theXercesDocument   The Xerces document.
threadSafe   If true, read access to the tree will be thread-safe (implies buildBridge == true).
buildBridge   If true, the entire bridge structure is built.
Returns:
a pointer to a new XercesDocumentBridge instance.

XalanDocument * XercesParserLiaison::createDocument ( const DOM_Document & theXercesDocument ) [virtual]
 

Create a XalanDocument proxy for an existing Xerces document.

The parser liaison owns the instance, and you must not delete it. The liaison will delete it when reset() is called, or the liaison is destroyed.

Parameters:
theXercesDocument   The Xerces document.
Returns:
a pointer to a new XalanDocument-derived instance.

virtual XalanDocument* XercesParserLiaison::createDocument ( ) [virtual]
 

Create an empty DOM Document.

Mainly used for creating an output document.

Returns:
DOM document created

Reimplemented from XMLParserLiaison.

virtual void XercesParserLiaison::destroyDocument ( XalanDocument * theDocument ) [virtual]
 

Destroy the supplied XalanDocument instance.

It must be an instance that was created by a previous call to createDocument() or getDOMFactory().

Parameters:
theDocument   The XalanDocument instance to destroy.

Reimplemented from XMLParserLiaison.

virtual void XercesParserLiaison::error ( const SAXParseException & exception ) [virtual]
 

virtual void XercesParserLiaison::fatalError ( const SAXParseException & exception ) [virtual]
 

void XercesParserLiaison::formatErrorMessage ( const SAXParseException & e,
XalanDOMString & theMessage ) [static]
 

bool XercesParserLiaison::getBuildBridgeNodes ( ) const []
 

This functions returns the state of the liaison's build-bridge-nodes flag.

Returns:
true, if the bridge nodes are automatically built, false otherwise.

bool XercesParserLiaison::getDoNamespaces ( ) const [virtual]
 

This method returns the state of the parser's namespace handling capability.

Returns:
true, if the parser is currently configured to understand namespaces, false otherwise.

See also:
setDoNamespaces()

const EntityResolver * XercesParserLiaison::getEntityResolver ( ) const [virtual]
 

This method returns the installed entity resolver.

Suitable for 'rvalue' usages.

Returns:
A const pointer to the installed entity resolver object.

EntityResolver * XercesParserLiaison::getEntityResolver ( ) [virtual]
 

This method returns the installed entity resolver.

Suitable for 'lvalue' usages.

Returns:
The pointer to the installed entity resolver object.

const ErrorHandler * XercesParserLiaison::getErrorHandler ( ) const [virtual]
 

This method returns the installed error handler.

Suitable for 'rvalue' usages.

Returns:
A const pointer to the installed error handler object.

ErrorHandler * XercesParserLiaison::getErrorHandler ( ) [virtual]
 

This method returns the installed error handler.

Suitable for 'lvalue' usages.

Returns:
The pointer to the installed error handler object.

virtual ExecutionContext* XercesParserLiaison::getExecutionContext ( ) const [virtual]
 

Reimplemented from XMLParserLiaison.

bool XercesParserLiaison::getExitOnFirstFatalError ( ) const [virtual]
 

This method returns the state of the parser's exit-on-First-Fatal-Error flag.

Returns:
true, if the parser is currently configured to exit on the first fatal error, false otherwise.

See also:
setExitOnFirstFatalError()

bool XercesParserLiaison::getIncludeIgnorableWhitespace ( ) const [virtual]
 

Get the 'include ignorable whitespace' flag.

This method returns the state of the parser's include ignorable whitespace flag.

Returns:
'true' if the include ignorable whitespace flag is set on the parser, 'false' otherwise.

See also:
setIncludeIgnorableWhitespace()

virtual int XercesParserLiaison::getIndent ( ) const [virtual]
 

Get the amount to indent when indent-result="yes".

Returns:
number of characters to indent

Reimplemented from XMLParserLiaison.

virtual const XalanDOMString XercesParserLiaison::getParserDescription ( ) const [virtual]
 

Return a string suitable for telling the user what parser is being used.

Returns:
string describing parser

Reimplemented from XMLParserLiaison.

virtual bool XercesParserLiaison::getShouldExpandEntityRefs ( ) const [virtual]
 

Determine whether to expand all entity references in the source and style trees.

Returns:
true if entity references should be expanded

Reimplemented from XMLParserLiaison.

virtual const XalanDOMString& XercesParserLiaison::getSpecialCharacters ( ) const [virtual]
 

Get special characters for attributes that will be escaped.

Returns:
string containing characters

Reimplemented from XMLParserLiaison.

bool XercesParserLiaison::getThreadSafe ( ) const []
 

This functions returns the state of the liaison's thread-safe flag.

If true, documents created will be safe when data is read. By default, documents are _not_ thread-safe.

Note -- modifications are _never_ synchronized.

Returns:
true, if the new documents will be thread safe, false otherwise.

virtual bool XercesParserLiaison::getUseValidation ( ) const [virtual]
 

Get whether or not validation will be performed.

Validation is off by default.

Returns:
true to perform validation

Reimplemented from XMLParserLiaison.

XercesDocumentBridge * XercesParserLiaison::mapDocument ( const XalanDocument * theDocument ) const
 

Map a pointer to a XalanDocument instance to its implementation class pointer.

Normally, you should have no reason for doing this. The liaison will return a null pointer if it did not create the instance passed.

Parameters:
theDocument   A pointer to a XalanDocument instance.
Returns:
A pointer to the XercesDocumentBridge instance.

DOM_Document XercesParserLiaison::mapXercesDocument ( const XalanDocument * theDocument ) const
 

Map a pointer to a XalanDocument instance to its corresponding class pointer.

Normally, you should have no reason for doing this. The liaison will return a null pointer if it did not create the instance passed.

Parameters:
theDocument   A pointer to a XalanDocument instance.
Returns:
A pointer to the XercesDocumentBridge instance.

virtual void XercesParserLiaison::parseXMLStream ( const InputSource & urlInputSource,
DocumentHandler & handler,
const XalanDOMString & identifier = XalanDOMString() ) [virtual]
 

Parse the text pointed at by the reader as XML.

It is recommended that you pass in some sort of recognizable name, such as the filename or URI, with which the reader can be recognized if the parse fails.

Parameters:
urlInputSource   input source that should hold valid XML
handler   instance of a DocumentHandler
identifier   used for diagnostic purposes only, some sort of identification for error reporting, default an empty string

Reimplemented from XMLParserLiaison.

virtual XalanDocument* XercesParserLiaison::parseXMLStream ( const InputSource & reader,
const XalanDOMString & identifier = XalanDOMString() ) [virtual]
 

Parse the text pointed at by the reader as XML, and return a DOM Document interface.

It is recommended that you pass in some sort of recognizable name, such as the filename or URI, with which the reader can be recognized if the parse fails.

Parameters:
reader   stream that should hold valid XML
identifier   used for diagnostic purposes only, some sort of identification for error reporting, default an empty string
Returns:
DOM document created

Reimplemented from XMLParserLiaison.

virtual void XercesParserLiaison::reset ( ) [virtual]
 

Reset the instance.

Reimplemented from XMLParserLiaison.

virtual void XercesParserLiaison::resetErrors ( ) [virtual]
 

void XercesParserLiaison::setBuildBridgeNodes ( bool newState ) []
 

This functions sets the state of the liaison's build-bridge-nodes flag.

This flag must be set for the document to be thread safe. It can also be set to true to increase performance. If this flag is set to false, then the thread-safe flag will also be set to false.

Parameters:
newState   The new state for the flag.

void XercesParserLiaison::setDoNamespaces ( bool newState ) [virtual]
 

This method allows users to enable or disable the parser's namespace processing.

When set to true, parser starts enforcing all the constraints / rules specified by the NameSpace specification.

The parser's default state is: false.

This flag is ignored by the underlying scanner if the installed validator indicates that namespace constraints should be enforced.

Parameters:
newState   The value specifying whether NameSpace rules should be enforced or not.

See also:
getDoNamespaces()

void XercesParserLiaison::setEntityResolver ( EntityResolver * resolver ) [virtual]
 

This method installs the user specified entity resolver on the parser.

It allows applications to trap and redirect calls to external entities.

Parameters:
handler   A pointer to the entity resolver to be called when the parser comes across references to entities in the XML file.

See also:
Parser::setEntityResolver

void XercesParserLiaison::setErrorHandler ( ErrorHandler * handler ) [virtual]
 

This method installs the user specified error handler on the parser.

Parameters:
handler   A pointer to the error handler to be called when the parser comes across 'error' events as per the SAX specification.

See also:
Parser::setErrorHandler

virtual void XercesParserLiaison::setExecutionContext ( ExecutionContext & theContext ) [virtual]
 

Reimplemented from XMLParserLiaison.

void XercesParserLiaison::setExitOnFirstFatalError ( bool newState ) [virtual]
 

This method allows users to set the parser's behaviour when it encounters the first fatal error.

If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.

The default value is 'true' and the parser exits on the first fatal error.

Parameters:
newState   The value specifying whether the parser should continue or exit when it encounters the first fatal error.

See also:
getExitOnFirstFatalError()

void XercesParserLiaison::setIncludeIgnorableWhitespace ( bool include ) [virtual]
 

Set the 'include ignorable whitespace' flag.

This method allows the user to specify whether a validating parser should include ignorable whitespaces as text nodes. It has no effect on non-validating parsers which always include non-markup text.

When set to true (also the default), ignorable whitespaces will be added to the DOM tree as text nodes. The method DOM_Text::isIgnorableWhitespace() will return true for those text nodes only.

When set to false, all ignorable whitespace will be discarded and no text node is added to the DOM tree. Note: applications intended to process the "xml:space" attribute should not set this flag to false.

Parameters:
include   The new state of the include ignorable whitespace flag.

See also:
getIncludeIgnorableWhitespace()

virtual void XercesParserLiaison::setIndent ( int i ) [virtual]
 

Set the amount to indent when indent-result="yes".

Parameters:
i   number of characters to indent

Reimplemented from XMLParserLiaison.

virtual void XercesParserLiaison::setSpecialCharacters ( const XalanDOMString & str ) [virtual]
 

Set special characters for attributes that will be escaped.

Parameters:
str   string containing characters

Reimplemented from XMLParserLiaison.

void XercesParserLiaison::setThreadSafe ( bool newState ) []
 

This functions sets the state of the liaison's thread-safe flag.

This flag must be set for the document to be thread safe. If this flag is set to true, then the build-bridge-nodes flag will also be set to true.

Parameters:
newState   The new state for the flag.

virtual void XercesParserLiaison::setUseValidation ( bool b ) [virtual]
 

If set to true, validation will be performed.

Validation is off by default.

Parameters:
b   true to perform validation

Reimplemented from XMLParserLiaison.

virtual bool XercesParserLiaison::supportsSAX ( ) const [virtual]
 

Determine if the liaison supports the SAX DocumentHandler interface.

Returns:
true if SAX supported

Reimplemented from XMLParserLiaison.

virtual void XercesParserLiaison::warning ( const SAXParseException & exception ) [virtual]
 


The documentation for this class was generated from the following file:

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.