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  

XMLParserLiaison Class Reference

#include <XMLParserLiaison.hpp>

Inheritance diagram for XMLParserLiaison

Inheritance graph

[legend]
Collaboration diagram for XMLParserLiaison:

Collaboration graph

[legend]
List of all members.

Public Methods


Constructor & Destructor Documentation

XMLParserLiaison::XMLParserLiaison ( )
 

virtual XMLParserLiaison::~XMLParserLiaison ( ) [virtual]
 


Member Function Documentation

XalanDocument * XMLParserLiaison::createDOMFactory ( ) [pure virtual]
 

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

The liaison owns the XalanDocument instance, and will delete it when when asked (see DestroyDocument()), or when the liaison is reset, or goes out of scope.

Returns:
A XalanDocument instance.

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

XalanDocument * XMLParserLiaison::createDocument ( ) [pure virtual]
 

Create an empty DOM Document.

Mainly used for creating an output document.

The liaison owns the XalanDocument instance, and will delete it when when asked (see DestroyDocument()), or when the liaison is reset, or goes out of scope.

Returns:
DOM document created

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

void XMLParserLiaison::destroyDocument ( XalanDocument * theDocument ) [pure 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 in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

unsigned long XMLParserLiaison::getDocumentNumber ( ) [pure virtual]
 

Get a unique number for identifying the document.

The number need only be unique to the parser liaison instance.

Returns:
The unique number

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

EntityResolver * XMLParserLiaison::getEntityResolver ( ) [pure virtual]
 

This method returns the installed entity resolver.

Returns:
The pointer to the installed entity resolver object.

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual ExecutionContext* XMLParserLiaison::getExecutionContext ( ) const [pure virtual]
 

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

int XMLParserLiaison::getIndent ( ) const [pure virtual]
 

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

Returns:
number of characters to indent

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

const XalanDOMString XMLParserLiaison::getParserDescription ( ) const [pure virtual]
 

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

Returns:
string describing parser

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

bool XMLParserLiaison::getUseValidation ( ) const [pure virtual]
 

Get whether or not validation will be performed.

Validation is off by default.

Returns:
true to perform validation

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

void XMLParserLiaison::parseXMLStream ( const InputSource & inputSource,
DocumentHandler & handler,
const XalanDOMString & identifier = XalanDOMString() ) [pure 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:
inputSource   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 in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

XalanDocument * XMLParserLiaison::parseXMLStream ( const InputSource & inputSource,
const XalanDOMString & identifier = XalanDOMString() ) [pure 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.

The liaison owns the XalanDocument instance, and will delete it when when asked (see DestroyDocument()), or when the liaison is reset, or goes out of scope.

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 in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::reset ( ) [pure virtual]
 

Reset the instance.

Reimplemented from Resettable.

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

void XMLParserLiaison::setEntityResolver ( EntityResolver * resolver ) [pure 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.

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setExecutionContext ( ExecutionContext & theContext ) [pure virtual]
 

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

void XMLParserLiaison::setIndent ( int i ) [pure virtual]
 

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

Parameters:
i   number of characters to indent

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.

void XMLParserLiaison::setUseValidation ( bool b ) [pure virtual]
 

If set to true, validation will be performed.

Validation is off by default.

Parameters:
b   true to perform validation

Reimplemented in XMLParserLiaisonDefault, XalanSourceTreeParserLiaison, and XercesParserLiaison.


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.