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  

XalanSourceTreeParserLiaison Class Reference

#include <XalanSourceTreeParserLiaison.hpp>

Inheritance diagram for XalanSourceTreeParserLiaison

Inheritance graph

[legend]
Collaboration diagram for XalanSourceTreeParserLiaison:

Collaboration graph

[legend]
List of all members.

Public Types

Public Methods


Member Typedef Documentation

typedef std::map<const XalanDocument*, XalanSourceTreeDocument*> XalanSourceTreeParserLiaison::DocumentMapType
 


Constructor & Destructor Documentation

XalanSourceTreeParserLiaison::XalanSourceTreeParserLiaison ( XalanSourceTreeDOMSupport & theSupport )
 

Construct a XalanSourceTreeParserLiaison instance.

Parameters:
theSupport   instance of DOMSupport object

virtual XalanSourceTreeParserLiaison::~XalanSourceTreeParserLiaison ( ) [virtual]
 


Member Function Documentation

virtual void XalanSourceTreeParserLiaison::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* XalanSourceTreeParserLiaison::createDOMFactory ( ) [virtual]
 

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

Returns:
A XalanDocument instance.

Reimplemented from XMLParserLiaison.

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

Create an empty DOM Document.

Mainly used for creating an output document.

Returns:
DOM document created

Reimplemented from XMLParserLiaison.

XalanSourceTreeDocument * XalanSourceTreeParserLiaison::createXalanSourceTreeDocument ( )
 

Create a XalanSourceTreeDocument instance.

Returns:
A pointer to the XalanSourceTreeDocument instance.

virtual void XalanSourceTreeParserLiaison::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.

bool XalanSourceTreeParserLiaison::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 * XalanSourceTreeParserLiaison::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 * XalanSourceTreeParserLiaison::getEntityResolver ( ) [virtual]
 

This method returns the installed entity resolver.

Suitable for 'lvalue' usages.

Returns:
The pointer to the installed entity resolver object.

const ErrorHandler * XalanSourceTreeParserLiaison::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 * XalanSourceTreeParserLiaison::getErrorHandler ( ) [virtual]
 

This method returns the installed error handler.

Suitable for 'lvalue' usages.

Returns:
The pointer to the installed error handler object.

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

Reimplemented from XMLParserLiaison.

bool XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::getIndent ( ) const [virtual]
 

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

Returns:
number of characters to indent

Reimplemented from XMLParserLiaison.

virtual const XalanDOMString XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::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& XalanSourceTreeParserLiaison::getSpecialCharacters ( ) const [virtual]
 

Get special characters for attributes that will be escaped.

Returns:
string containing characters

Reimplemented from XMLParserLiaison.

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

Get whether or not validation will be performed.

Validation is off by default.

Returns:
true to perform validation

Reimplemented from XMLParserLiaison.

XalanSourceTreeDocument * XalanSourceTreeParserLiaison::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 XalanSourceTreeDocument instance.

void XalanSourceTreeParserLiaison::parseXMLStream ( const InputSource & theInputSource,
ContentHandler & theContentHandler,
DTDHandler * theDTDHandler = 0,
LexicalHandler * theLexicalHandler = 0,
const XalanDOMString & theIdentifier = XalanDOMString() ) [virtual]
 

Parse using a SAX2 ContentHandler, DTDHandler, and LexicalHandler.

Parameters:
theInputSource   The input source for the parser
theContentHandler   The ContentHandler to use
theDTDHandler   The DTDHandler to use. May be null.
theLexicalHandler   The LexicalHandler to use. May be null.
identifier   Used for error reporting only.

virtual void XalanSourceTreeParserLiaison::parseXMLStream ( const InputSource & inputSource,
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* XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::reset ( ) [virtual]
 

Reset the instance.

Reimplemented from XMLParserLiaison.

void XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::setExecutionContext ( ExecutionContext & theContext ) [virtual]
 

Reimplemented from XMLParserLiaison.

void XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::setSpecialCharacters ( const XalanDOMString & str ) [virtual]
 

Set special characters for attributes that will be escaped.

Parameters:
str   string containing characters

Reimplemented from XMLParserLiaison.

virtual void XalanSourceTreeParserLiaison::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 XalanSourceTreeParserLiaison::supportsSAX ( ) const [virtual]
 

Determine if the liaison supports the SAX DocumentHandler interface.

Returns:
true if SAX supported

Reimplemented from XMLParserLiaison.


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.